{ "item": [ { "name": "v1", "description": "", "item": [ { "name": "checkout", "description": "", "item": [ { "name": "sessions", "description": "", "item": [ { "id": "0a82f88c-b738-49da-8719-cf2d3279b9de", "name": "Create a checkout session", "request": { "name": "Create a checkout session", "description": { "content": "A session is a payment intent. Create it server-side, then redirect your customer to\n`url`, the hosted payment page, which handles the operator choice, the Wave\nredirection, Orange Money OTP codes and card payments.\n\nAccepts the secret key, or the public key (widget) which can do nothing else.\nA session created with a test key is a test transaction (`livemode: false`); so is any\nsession of a workspace not switched live yet (identity not verified), whatever the key.\n\nNever fulfil an order on the sole basis of the redirection to `success_url`: wait\nfor the `payment.completed` webhook or check the status server-side.\n", "type": "text/plain" }, "url": { "path": [ "v1", "checkout", "sessions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "A unique string per order or per transfer. A replayed call returns the existing object with HTTP `200` and `Idempotent-Replayed: true`. Kept at 120 characters at most for transfers.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"currency\": \"XOF\",\n \"customer_name\": \"\",\n \"customer_email\": \"\",\n \"customer_phone\": \"\",\n \"description\": \"\",\n \"success_url\": \"\",\n \"cancel_url\": \"\",\n \"metadata\": {\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": 2280.861039951458\n },\n \"merchant_name\": \"\",\n \"merchant_logo\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "afb8e14f-0489-44df-9f22-b48509a168ae", "name": "Idempotent replay, the existing session is returned unchanged.", "originalRequest": { "url": { "path": [ "v1", "checkout", "sessions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "A unique string per order or per transfer. A replayed call returns the existing object with HTTP `200` and `Idempotent-Replayed: true`. Kept at 120 characters at most for transfers.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"currency\": \"XOF\",\n \"customer_name\": \"\",\n \"customer_email\": \"\",\n \"customer_phone\": \"\",\n \"description\": \"\",\n \"success_url\": \"\",\n \"cancel_url\": \"\",\n \"metadata\": {\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": 2280.861039951458\n },\n \"merchant_name\": \"\",\n \"merchant_logo\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Idempotent-Replayed", "value": "" } ], "body": "{\n \"id\": \"\",\n \"object\": \"\",\n \"url\": \"\",\n \"order_id\": \"\",\n \"amount\": \"\",\n \"currency\": \"\",\n \"status\": \"refunded\",\n \"livemode\": \"\",\n \"created\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8c3547e3-dd59-4d58-9f17-72ebb4d30880", "name": "Session created.", "originalRequest": { "url": { "path": [ "v1", "checkout", "sessions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "A unique string per order or per transfer. A replayed call returns the existing object with HTTP `200` and `Idempotent-Replayed: true`. Kept at 120 characters at most for transfers.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"currency\": \"XOF\",\n \"customer_name\": \"\",\n \"customer_email\": \"\",\n \"customer_phone\": \"\",\n \"description\": \"\",\n \"success_url\": \"\",\n \"cancel_url\": \"\",\n \"metadata\": {\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": 2280.861039951458\n },\n \"merchant_name\": \"\",\n \"merchant_logo\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"object\": \"\",\n \"url\": \"\",\n \"order_id\": \"\",\n \"amount\": \"\",\n \"currency\": \"\",\n \"status\": \"refunded\",\n \"livemode\": \"\",\n \"created\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5999be41-3e7a-43ad-9155-fd1018bbf2a2", "name": "`amount` is missing or not greater than zero.", "originalRequest": { "url": { "path": [ "v1", "checkout", "sessions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "A unique string per order or per transfer. A replayed call returns the existing object with HTTP `200` and `Idempotent-Replayed: true`. Kept at 120 characters at most for transfers.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"currency\": \"XOF\",\n \"customer_name\": \"\",\n \"customer_email\": \"\",\n \"customer_phone\": \"\",\n \"description\": \"\",\n \"success_url\": \"\",\n \"cancel_url\": \"\",\n \"metadata\": {\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": 2280.861039951458\n },\n \"merchant_name\": \"\",\n \"merchant_logo\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4268d2fe-caa1-492f-b53d-0a33a11b6e53", "name": "API key missing or invalid.", "originalRequest": { "url": { "path": [ "v1", "checkout", "sessions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "A unique string per order or per transfer. A replayed call returns the existing object with HTTP `200` and `Idempotent-Replayed: true`. Kept at 120 characters at most for transfers.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"currency\": \"XOF\",\n \"customer_name\": \"\",\n \"customer_email\": \"\",\n \"customer_phone\": \"\",\n \"description\": \"\",\n \"success_url\": \"\",\n \"cancel_url\": \"\",\n \"metadata\": {\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": 2280.861039951458\n },\n \"merchant_name\": \"\",\n \"merchant_logo\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f5e6c8a3-1cbb-43eb-b88b-b1eb8e1a8c9b", "name": "More than 60 sessions per minute from this IP.", "originalRequest": { "url": { "path": [ "v1", "checkout", "sessions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "A unique string per order or per transfer. A replayed call returns the existing object with HTTP `200` and `Idempotent-Replayed: true`. Kept at 120 characters at most for transfers.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"currency\": \"XOF\",\n \"customer_name\": \"\",\n \"customer_email\": \"\",\n \"customer_phone\": \"\",\n \"description\": \"\",\n \"success_url\": \"\",\n \"cancel_url\": \"\",\n \"metadata\": {\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": 2280.861039951458\n },\n \"merchant_name\": \"\",\n \"merchant_logo\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7f9c5368-f750-4c1e-a640-73d97b489bcc", "name": "Internal error. Retry, then contact Cartflox if it persists.", "originalRequest": { "url": { "path": [ "v1", "checkout", "sessions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "A unique string per order or per transfer. A replayed call returns the existing object with HTTP `200` and `Idempotent-Replayed: true`. Kept at 120 characters at most for transfers.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"currency\": \"XOF\",\n \"customer_name\": \"\",\n \"customer_email\": \"\",\n \"customer_phone\": \"\",\n \"description\": \"\",\n \"success_url\": \"\",\n \"cancel_url\": \"\",\n \"metadata\": {\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": 2280.861039951458\n },\n \"merchant_name\": \"\",\n \"merchant_logo\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{id}", "description": "", "item": [ { "name": "status", "description": "", "item": [ { "id": "451d2fe4-64c2-46db-bf41-1806c0d3d71c", "name": "Get the status of a session", "request": { "name": "Get the status of a session", "description": { "content": "Current state of a session, for polling: at the customer's return on `success_url`,\nor to catch up on a missed webhook. While the session is `PENDING`, Cartflox also\nchecks the payment directly with the aggregator (at most once every 8 seconds per\nsession). Accepts the secret key or the public key.\n\nOnly this status and the webhook are authoritative: the redirection to `success_url`\ncan happen before the operator confirms.\n", "type": "text/plain" }, "url": { "path": [ "v1", "checkout", "sessions", ":id", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Session identifier returned at creation.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "3ecd2603-f4c1-4bc5-a002-699ce66c7516", "name": "Current status.", "originalRequest": { "url": { "path": [ "v1", "checkout", "sessions", ":id", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Session identifier returned at creation.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"status\": \"REFUNDED\",\n \"paid\": \"\",\n \"amount\": \"\",\n \"currency\": \"\",\n \"order_id\": \"\",\n \"livemode\": \"\",\n \"provider\": \"\",\n \"provider_reference\": \"\",\n \"failure_message\": \"\",\n \"next_action\": {\n \"type\": \"ussd\",\n \"message\": \"\",\n \"ussd_code\": \"\",\n \"url\": \"\",\n \"application\": \"\"\n },\n \"customer_name\": \"\",\n \"customer_email\": \"\",\n \"customer_phone\": \"\",\n \"metadata\": {\n \"key_0\": true,\n \"key_1\": 7029.454370070184,\n \"key_2\": \"string\"\n },\n \"completed_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e7b7e2d8-ff44-42b2-aae9-3edf2eb561db", "name": "API key missing or invalid.", "originalRequest": { "url": { "path": [ "v1", "checkout", "sessions", ":id", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Session identifier returned at creation.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "db41c121-6896-4c09-b92b-bfd1c7afee97", "name": "Session not found, or not owned by this workspace.", "originalRequest": { "url": { "path": [ "v1", "checkout", "sessions", ":id", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Session identifier returned at creation.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b47a9101-a638-46e6-9faf-a543a6558bb0", "name": "Internal error. Retry, then contact Cartflox if it persists.", "originalRequest": { "url": { "path": [ "v1", "checkout", "sessions", ":id", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Session identifier returned at creation.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "methods", "description": "", "item": [ { "id": "bdf6cf64-10f5-45f8-a1cb-07b568be5a83", "name": "List the payment methods of a session", "request": { "name": "List the payment methods of a session", "description": { "content": "The operators available for a session, optionally filtered by country, for merchants\nwho build their own operator picker. Card methods (UEMOA, international) are returned\nwhatever the country asked. Operator codes depend on the gateway serving them: do not\nhard-code them, read them from the response. Accepts the secret key or the public key.\n", "type": "text/plain" }, "url": { "path": [ "v1", "checkout", "sessions", ":id", "methods" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "ISO 3166-1 alpha-2 code (`ci`, `sn`, `bj`, `ml`, `bf`, `tg`, `cm`, `gh`, `ng`, `ke`...) or country name. Without it, every active operator is returned.", "type": "text/plain" }, "key": "country", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Session identifier returned at creation.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "83621713-9853-40f5-a7fe-1426ca5a77ba", "name": "Available methods.", "originalRequest": { "url": { "path": [ "v1", "checkout", "sessions", ":id", "methods" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "ISO 3166-1 alpha-2 code (`ci`, `sn`, `bj`, `ml`, `bf`, `tg`, `cm`, `gh`, `ng`, `ke`...) or country name. Without it, every active operator is returned.", "type": "text/plain" }, "key": "country", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Session identifier returned at creation.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"currency\": \"\",\n \"methods\": [\n {\n \"code\": \"\",\n \"gatewayId\": \"\",\n \"name\": \"\",\n \"provider\": \"\",\n \"country\": \"\",\n \"type\": \"\",\n \"flag\": \"\",\n \"logo\": \"\"\n },\n {\n \"code\": \"\",\n \"gatewayId\": \"\",\n \"name\": \"\",\n \"provider\": \"\",\n \"country\": \"\",\n \"type\": \"\",\n \"flag\": \"\",\n \"logo\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cb803759-80a2-438e-9573-166f955649f4", "name": "API key missing or invalid.", "originalRequest": { "url": { "path": [ "v1", "checkout", "sessions", ":id", "methods" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "ISO 3166-1 alpha-2 code (`ci`, `sn`, `bj`, `ml`, `bf`, `tg`, `cm`, `gh`, `ng`, `ke`...) or country name. Without it, every active operator is returned.", "type": "text/plain" }, "key": "country", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Session identifier returned at creation.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "81d3c2f2-900a-48c6-8a10-083368fc35d0", "name": "Session not found, or not owned by this workspace.", "originalRequest": { "url": { "path": [ "v1", "checkout", "sessions", ":id", "methods" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "ISO 3166-1 alpha-2 code (`ci`, `sn`, `bj`, `ml`, `bf`, `tg`, `cm`, `gh`, `ng`, `ke`...) or country name. Without it, every active operator is returned.", "type": "text/plain" }, "key": "country", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Session identifier returned at creation.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ce34a8ae-19a6-4264-95c3-9812b1cb0745", "name": "Internal error. Retry, then contact Cartflox if it persists.", "originalRequest": { "url": { "path": [ "v1", "checkout", "sessions", ":id", "methods" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "ISO 3166-1 alpha-2 code (`ci`, `sn`, `bj`, `ml`, `bf`, `tg`, `cm`, `gh`, `ng`, `ke`...) or country name. Without it, every active operator is returned.", "type": "text/plain" }, "key": "country", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Session identifier returned at creation.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] } ] }, { "name": "payment-links", "description": "", "item": [ { "id": "67ffde53-b820-46ca-9801-b14152520126", "name": "Create a payment link", "request": { "name": "Create a payment link", "description": { "content": "A payment link is a hosted page with a fixed amount, to share by WhatsApp, e-mail or\nsocial networks. The customer's phone number is always requested on the page, for\nMobile Money. The link is created `active` and never expires by itself.\n", "type": "text/plain" }, "url": { "path": [ "v1", "payment-links" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"title\": \"\",\n \"amount\": \"\",\n \"currency\": \"XOF\",\n \"description\": \"\",\n \"metadata\": {\n \"key_0\": 7720\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "03ac62a9-f13c-4002-a4cf-97f58c8aa736", "name": "Link created (the API answers `200`, not `201`).", "originalRequest": { "url": { "path": [ "v1", "payment-links" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"title\": \"\",\n \"amount\": \"\",\n \"currency\": \"XOF\",\n \"description\": \"\",\n \"metadata\": {\n \"key_0\": 7720\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"id\": \"\",\n \"url\": \"\",\n \"slug\": \"\",\n \"amount\": \"\",\n \"currency\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3a33adf4-028b-4db2-8779-3e4b7e36cd81", "name": "`title` or `amount` is missing.", "originalRequest": { "url": { "path": [ "v1", "payment-links" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"title\": \"\",\n \"amount\": \"\",\n \"currency\": \"XOF\",\n \"description\": \"\",\n \"metadata\": {\n \"key_0\": 7720\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a2f5a311-3878-43b3-b4b8-2d5f2b46dd4e", "name": "API key missing or invalid.", "originalRequest": { "url": { "path": [ "v1", "payment-links" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"title\": \"\",\n \"amount\": \"\",\n \"currency\": \"XOF\",\n \"description\": \"\",\n \"metadata\": {\n \"key_0\": 7720\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "73528ddf-7c3d-4e7f-958e-994b8c9a2fe0", "name": "Test key: payment links live in production only (`code: test_mode`). Create a test checkout session instead.", "originalRequest": { "url": { "path": [ "v1", "payment-links" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"title\": \"\",\n \"amount\": \"\",\n \"currency\": \"XOF\",\n \"description\": \"\",\n \"metadata\": {\n \"key_0\": 7720\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6ba37051-4ffa-423e-aed9-56f3bd6c4683", "name": "More than 60 links per minute from this IP.", "originalRequest": { "url": { "path": [ "v1", "payment-links" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"title\": \"\",\n \"amount\": \"\",\n \"currency\": \"XOF\",\n \"description\": \"\",\n \"metadata\": {\n \"key_0\": 7720\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "89b766ba-6a1d-4c39-92e7-78b255f023fa", "name": "Internal error. Retry, then contact Cartflox if it persists.", "originalRequest": { "url": { "path": [ "v1", "payment-links" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"title\": \"\",\n \"amount\": \"\",\n \"currency\": \"XOF\",\n \"description\": \"\",\n \"metadata\": {\n \"key_0\": 7720\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{id}", "description": "", "item": [ { "name": "check", "description": "", "item": [ { "id": "c3b6dc04-628b-4256-832a-f8a502689283", "name": "Check whether a payment link has been paid", "request": { "name": "Check whether a payment link has been paid", "description": { "content": "Returns the most recent successful payment of the link, if any. Until a payment\nsucceeds, the answer is `{ \"success\": true, \"paid\": false, \"status\": \"WAITING\" }`,\nor the status of the latest non-failed attempt.\n", "type": "text/plain" }, "url": { "path": [ "v1", "payment-links", ":id", "check" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Identifier of the payment link (`id` returned at creation, not the slug).", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "83e37e13-fd1a-4b65-aea8-d1245bb46d51", "name": "Payment state of the link.", "originalRequest": { "url": { "path": [ "v1", "payment-links", ":id", "check" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identifier of the payment link (`id` returned at creation, not the slug).", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"paid\": \"\",\n \"status\": \"WAITING\",\n \"transaction\": {\n \"id\": \"\",\n \"amount\": \"\",\n \"customerName\": \"\",\n \"customerEmail\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c078e580-9fe8-4566-875c-a23b83078fd4", "name": "API key missing or invalid.", "originalRequest": { "url": { "path": [ "v1", "payment-links", ":id", "check" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identifier of the payment link (`id` returned at creation, not the slug).", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fe62470e-e593-45e0-9a29-86470684274a", "name": "Internal error. Retry, then contact Cartflox if it persists.", "originalRequest": { "url": { "path": [ "v1", "payment-links", ":id", "check" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identifier of the payment link (`id` returned at creation, not the slug).", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] }, { "name": "route", "description": "", "item": [ { "id": "eeea49b8-9101-4e59-80a3-a806af3627d6", "name": "Routing decision for a payment", "request": { "name": "Routing decision for a payment", "description": { "content": "Returns the best aggregator for a given context (country, amount, currency, operator),\nwith ordered fallbacks and a confidence score. When `paymentMethod` is absent and\n`phone` is present, the operator is inferred from the number prefix. Requires a secret key.\n", "type": "text/plain" }, "url": { "path": [ "v1", "route" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"country\": \"\",\n \"amount\": \"\",\n \"availableProviders\": [\n \"coinbase\"\n ],\n \"currency\": \"\",\n \"paymentMethod\": \"orange-money\",\n \"phone\": \"\",\n \"preferredProvider\": \"feexpay\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "76a77235-3a34-4ce9-ae2d-bf697a10a7f0", "name": "Routing decision.", "originalRequest": { "url": { "path": [ "v1", "route" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"country\": \"\",\n \"amount\": \"\",\n \"availableProviders\": [\n \"coinbase\"\n ],\n \"currency\": \"\",\n \"paymentMethod\": \"orange-money\",\n \"phone\": \"\",\n \"preferredProvider\": \"feexpay\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"routing\": {\n \"provider\": \"\",\n \"reason\": \"\",\n \"alternates\": [\n \"\",\n \"\"\n ],\n \"confidence\": \"\"\n },\n \"detectedOperator\": \"wizall\",\n \"availableMethods\": [\n {\n \"method\": \"airtel\",\n \"providers\": [\n \"\",\n \"\"\n ]\n },\n {\n \"method\": \"wave\",\n \"providers\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"rankedProviders\": [\n {\n \"provider\": \"\",\n \"score\": \"\"\n },\n {\n \"provider\": \"\",\n \"score\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "555b54fd-1743-4494-bebd-83307a4d7d12", "name": "`country`, `amount` (number) or `availableProviders` (non-empty array) is missing.", "originalRequest": { "url": { "path": [ "v1", "route" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"country\": \"\",\n \"amount\": \"\",\n \"availableProviders\": [\n \"coinbase\"\n ],\n \"currency\": \"\",\n \"paymentMethod\": \"orange-money\",\n \"phone\": \"\",\n \"preferredProvider\": \"feexpay\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "64e151e7-e4bc-45ee-bf5d-cc72f98102cd", "name": "API key missing or invalid.", "originalRequest": { "url": { "path": [ "v1", "route" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"country\": \"\",\n \"amount\": \"\",\n \"availableProviders\": [\n \"coinbase\"\n ],\n \"currency\": \"\",\n \"paymentMethod\": \"orange-money\",\n \"phone\": \"\",\n \"preferredProvider\": \"feexpay\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a865be36-2f43-4cc6-8bf9-59786ca3ab65", "name": "More than 120 calls per minute from this IP.", "originalRequest": { "url": { "path": [ "v1", "route" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"country\": \"\",\n \"amount\": \"\",\n \"availableProviders\": [\n \"coinbase\"\n ],\n \"currency\": \"\",\n \"paymentMethod\": \"orange-money\",\n \"phone\": \"\",\n \"preferredProvider\": \"feexpay\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e61a1992-bbdd-46cc-a257-9766a5964075", "name": "Internal error. Retry, then contact Cartflox if it persists.", "originalRequest": { "url": { "path": [ "v1", "route" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"country\": \"\",\n \"amount\": \"\",\n \"availableProviders\": [\n \"coinbase\"\n ],\n \"currency\": \"\",\n \"paymentMethod\": \"orange-money\",\n \"phone\": \"\",\n \"preferredProvider\": \"feexpay\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e4e1c62d-4a37-4671-b120-30756b7dd09b", "name": "Available methods and ranked providers for a country", "request": { "name": "Available methods and ranked providers for a country", "description": { "content": "Quick check, without a decision: the payment methods available in a country for the\ngiven providers, and the providers ranked by estimated reliability. Without\n`providers`, every provider known to Cartflox is considered. This endpoint does not\nrequire an API key.\n", "type": "text/plain" }, "url": { "path": [ "v1", "route" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ISO 3166-1 alpha-2 country code.", "type": "text/plain" }, "key": "country", "value": "" }, { "disabled": false, "description": { "content": "Comma-separated provider keys (`paydunya,cinetpay`).", "type": "text/plain" }, "key": "providers", "value": "" }, { "disabled": false, "description": { "content": "ISO 4217 currency code.", "type": "text/plain" }, "key": "currency", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "c4920ddb-f1e7-4fb9-8f34-eb0a050423ea", "name": "Methods and ranking.", "originalRequest": { "url": { "path": [ "v1", "route" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ISO 3166-1 alpha-2 country code.", "type": "text/plain" }, "key": "country", "value": "" }, { "disabled": false, "description": { "content": "Comma-separated provider keys (`paydunya,cinetpay`).", "type": "text/plain" }, "key": "providers", "value": "" }, { "disabled": false, "description": { "content": "ISO 4217 currency code.", "type": "text/plain" }, "key": "currency", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"country\": \"\",\n \"availableMethods\": [\n {\n \"method\": \"free-money\",\n \"providers\": [\n \"\",\n \"\"\n ]\n },\n {\n \"method\": \"wizall\",\n \"providers\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"rankedProviders\": [\n {\n \"provider\": \"\",\n \"score\": \"\"\n },\n {\n \"provider\": \"\",\n \"score\": \"\"\n }\n ],\n \"currency\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "45ea8514-3c06-4a21-b785-ae754c294c3f", "name": "`country` is missing.", "originalRequest": { "url": { "path": [ "v1", "route" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ISO 3166-1 alpha-2 country code.", "type": "text/plain" }, "key": "country", "value": "" }, { "disabled": false, "description": { "content": "Comma-separated provider keys (`paydunya,cinetpay`).", "type": "text/plain" }, "key": "providers", "value": "" }, { "disabled": false, "description": { "content": "ISO 4217 currency code.", "type": "text/plain" }, "key": "currency", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ccaf8562-0fe4-4edd-8026-0f548c07c3d4", "name": "Internal error. Retry, then contact Cartflox if it persists.", "originalRequest": { "url": { "path": [ "v1", "route" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ISO 3166-1 alpha-2 country code.", "type": "text/plain" }, "key": "country", "value": "" }, { "disabled": false, "description": { "content": "Comma-separated provider keys (`paydunya,cinetpay`).", "type": "text/plain" }, "key": "providers", "value": "" }, { "disabled": false, "description": { "content": "ISO 4217 currency code.", "type": "text/plain" }, "key": "currency", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "transactions", "description": "", "item": [ { "name": "export", "description": "", "item": [ { "id": "c07d2396-48d7-44c9-b8ce-ed705d2c044b", "name": "Export the transactions of the selected workspace", "request": { "name": "Export the transactions of the selected workspace", "description": { "content": "CSV (default) or JSON export of up to 10 000 transactions, newest first. This endpoint\nis used by the dashboard: it is authenticated by the dashboard session cookie, not by\nan API key (an API key gets `401 Unauthorized`). Test transactions never appear in\nproduction exports.\n", "type": "text/plain" }, "url": { "path": [ "v1", "transactions", "export" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": " (This can only be one of csv,json)", "type": "text/plain" }, "key": "format", "value": "csv" }, { "disabled": false, "description": { "content": "Filter on a status; `ALL` or absent means every status. (This can only be one of ALL,PENDING,SUCCESS,FAILED,CANCELLED,REFUNDED)", "type": "text/plain" }, "key": "status", "value": "CANCELLED" }, { "disabled": false, "description": { "content": "Start date (inclusive), `YYYY-MM-DD`.", "type": "text/plain" }, "key": "from", "value": "" }, { "disabled": false, "description": { "content": "End date (inclusive, until 23:59:59.999), `YYYY-MM-DD`.", "type": "text/plain" }, "key": "to", "value": "" }, { "disabled": false, "description": { "content": "Case-insensitive search on `orderId`, `customerName` and `customerEmail`.", "type": "text/plain" }, "key": "search", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "text/csv" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "cartflox.session_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "bea42d81-040e-433d-a52f-a7b3f162eece", "name": "The export.", "originalRequest": { "url": { "path": [ "v1", "transactions", "export" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": " (This can only be one of csv,json)", "type": "text/plain" }, "key": "format", "value": "csv" }, { "disabled": false, "description": { "content": "Filter on a status; `ALL` or absent means every status. (This can only be one of ALL,PENDING,SUCCESS,FAILED,CANCELLED,REFUNDED)", "type": "text/plain" }, "key": "status", "value": "CANCELLED" }, { "disabled": false, "description": { "content": "Start date (inclusive), `YYYY-MM-DD`.", "type": "text/plain" }, "key": "from", "value": "" }, { "disabled": false, "description": { "content": "End date (inclusive, until 23:59:59.999), `YYYY-MM-DD`.", "type": "text/plain" }, "key": "to", "value": "" }, { "disabled": false, "description": { "content": "Case-insensitive search on `orderId`, `customerName` and `customerEmail`.", "type": "text/plain" }, "key": "search", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "text/csv" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "cartflox.session_token", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"orderId\": \"\",\n \"amount\": \"\",\n \"currency\": \"\",\n \"status\": \"REFUNDED\",\n \"createdAt\": \"\",\n \"applicationId\": \"\",\n \"paymentType\": \"BANK_TRANSFER\",\n \"provider\": \"\",\n \"providerRef\": \"\",\n \"customerName\": \"\",\n \"customerEmail\": \"\",\n \"customerPhone\": \"\",\n \"metadata\": {\n \"key_0\": 6688.608327258704,\n \"key_1\": \"string\"\n },\n \"updatedAt\": \"\",\n \"completedAt\": \"\"\n },\n {\n \"id\": \"\",\n \"orderId\": \"\",\n \"amount\": \"\",\n \"currency\": \"\",\n \"status\": \"CANCELLED\",\n \"createdAt\": \"\",\n \"applicationId\": \"\",\n \"paymentType\": \"CARD\",\n \"provider\": \"\",\n \"providerRef\": \"\",\n \"customerName\": \"\",\n \"customerEmail\": \"\",\n \"customerPhone\": \"\",\n \"metadata\": {\n \"key_0\": 8330.481445555537\n },\n \"updatedAt\": \"\",\n \"completedAt\": \"\"\n }\n ],\n \"total\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f82d48d5-f252-44f6-9fe0-ff38cdfc83f0", "name": "No workspace selected in the dashboard session.", "originalRequest": { "url": { "path": [ "v1", "transactions", "export" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": " (This can only be one of csv,json)", "type": "text/plain" }, "key": "format", "value": "csv" }, { "disabled": false, "description": { "content": "Filter on a status; `ALL` or absent means every status. (This can only be one of ALL,PENDING,SUCCESS,FAILED,CANCELLED,REFUNDED)", "type": "text/plain" }, "key": "status", "value": "CANCELLED" }, { "disabled": false, "description": { "content": "Start date (inclusive), `YYYY-MM-DD`.", "type": "text/plain" }, "key": "from", "value": "" }, { "disabled": false, "description": { "content": "End date (inclusive, until 23:59:59.999), `YYYY-MM-DD`.", "type": "text/plain" }, "key": "to", "value": "" }, { "disabled": false, "description": { "content": "Case-insensitive search on `orderId`, `customerName` and `customerEmail`.", "type": "text/plain" }, "key": "search", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "cartflox.session_token", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "83f1968f-d02b-47fb-8536-4454fd207221", "name": "No dashboard session.", "originalRequest": { "url": { "path": [ "v1", "transactions", "export" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": " (This can only be one of csv,json)", "type": "text/plain" }, "key": "format", "value": "csv" }, { "disabled": false, "description": { "content": "Filter on a status; `ALL` or absent means every status. (This can only be one of ALL,PENDING,SUCCESS,FAILED,CANCELLED,REFUNDED)", "type": "text/plain" }, "key": "status", "value": "CANCELLED" }, { "disabled": false, "description": { "content": "Start date (inclusive), `YYYY-MM-DD`.", "type": "text/plain" }, "key": "from", "value": "" }, { "disabled": false, "description": { "content": "End date (inclusive, until 23:59:59.999), `YYYY-MM-DD`.", "type": "text/plain" }, "key": "to", "value": "" }, { "disabled": false, "description": { "content": "Case-insensitive search on `orderId`, `customerName` and `customerEmail`.", "type": "text/plain" }, "key": "search", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "cartflox.session_token", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "18ecb23e-68c5-4324-8f2a-a7829c4ec9bd", "name": "Internal error. Retry, then contact Cartflox if it persists.", "originalRequest": { "url": { "path": [ "v1", "transactions", "export" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": " (This can only be one of csv,json)", "type": "text/plain" }, "key": "format", "value": "csv" }, { "disabled": false, "description": { "content": "Filter on a status; `ALL` or absent means every status. (This can only be one of ALL,PENDING,SUCCESS,FAILED,CANCELLED,REFUNDED)", "type": "text/plain" }, "key": "status", "value": "CANCELLED" }, { "disabled": false, "description": { "content": "Start date (inclusive), `YYYY-MM-DD`.", "type": "text/plain" }, "key": "from", "value": "" }, { "disabled": false, "description": { "content": "End date (inclusive, until 23:59:59.999), `YYYY-MM-DD`.", "type": "text/plain" }, "key": "to", "value": "" }, { "disabled": false, "description": { "content": "Case-insensitive search on `orderId`, `customerName` and `customerEmail`.", "type": "text/plain" }, "key": "search", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "cartflox.session_token", "value": "" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "transfers", "description": "", "item": [ { "id": "eed21cd4-070c-4b04-962e-f748254c19ad", "name": "Send money to a Mobile Money account", "request": { "name": "Send money to a Mobile Money account", "description": { "content": "Sends an amount to the Mobile Money account of a supplier, an employee or a customer to\nrefund. Cartflox hands the transfer to one of your gateways that can send money\n(PawaPay, PayDunya, Hub2, Notch Pay, Monetbil, Flutterwave, Paystack, FedaPay,\nFeexPay), with your own keys. The money leaves your aggregator's wallet, with the\naggregator's own fees: `fee` is `0`.\n\nRequires the **secret** key: the public key is refused. Connect workspaces (money held\nby Cartflox) do not have access to transfers for now (`403 connect_non_disponible`).\n\nSend an `Idempotency-Key` header (or the `idempotency_key` field): a replayed call\nreturns the existing transfer with HTTP `200` and `Idempotent-Replayed: true` instead\nof sending the money a second time.\n\nThe status right after the call is most often `processing`. Follow it with\n`GET /v1/transfers/{id}` and the `transfer.succeeded` / `transfer.failed` webhooks.\n", "type": "text/plain" }, "url": { "path": [ "v1", "transfers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "A unique string per order or per transfer. A replayed call returns the existing object with HTTP `200` and `Idempotent-Replayed: true`. Kept at 120 characters at most for transfers.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"country\": \"ZM\",\n \"operator\": \"\",\n \"phone\": \"\",\n \"currency\": \"\",\n \"recipient_name\": \"\",\n \"description\": \"\",\n \"idempotency_key\": \"\",\n \"metadata\": {\n \"key_0\": 5361.062579085304,\n \"key_1\": \"string\",\n \"key_2\": 5436.755319782985\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "1a390167-dd90-4778-8337-c904ead27048", "name": "Idempotent replay, the existing transfer is returned.", "originalRequest": { "url": { "path": [ "v1", "transfers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "A unique string per order or per transfer. A replayed call returns the existing object with HTTP `200` and `Idempotent-Replayed: true`. Kept at 120 characters at most for transfers.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"country\": \"ZM\",\n \"operator\": \"\",\n \"phone\": \"\",\n \"currency\": \"\",\n \"recipient_name\": \"\",\n \"description\": \"\",\n \"idempotency_key\": \"\",\n \"metadata\": {\n \"key_0\": 5361.062579085304,\n \"key_1\": \"string\",\n \"key_2\": 5436.755319782985\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Idempotent-Replayed", "value": "" } ], "body": "{\n \"id\": \"\",\n \"reference\": \"\",\n \"status\": \"failed\",\n \"amount\": \"\",\n \"currency\": \"\",\n \"fee\": \"\",\n \"country\": \"\",\n \"operator\": \"\",\n \"phone\": \"\",\n \"livemode\": \"\",\n \"created\": \"\",\n \"provider_operator\": \"\",\n \"recipient_name\": \"\",\n \"description\": \"\",\n \"provider\": \"\",\n \"provider_reference\": \"\",\n \"failure\": {\n \"code\": \"\",\n \"message\": \"\"\n },\n \"idempotency_key\": \"\",\n \"completed\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1afc8e25-c71b-4ae0-bd17-ba701c4e4427", "name": "Transfer created and handed to the provider.", "originalRequest": { "url": { "path": [ "v1", "transfers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "A unique string per order or per transfer. A replayed call returns the existing object with HTTP `200` and `Idempotent-Replayed: true`. Kept at 120 characters at most for transfers.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"country\": \"ZM\",\n \"operator\": \"\",\n \"phone\": \"\",\n \"currency\": \"\",\n \"recipient_name\": \"\",\n \"description\": \"\",\n \"idempotency_key\": \"\",\n \"metadata\": {\n \"key_0\": 5361.062579085304,\n \"key_1\": \"string\",\n \"key_2\": 5436.755319782985\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"reference\": \"\",\n \"status\": \"failed\",\n \"amount\": \"\",\n \"currency\": \"\",\n \"fee\": \"\",\n \"country\": \"\",\n \"operator\": \"\",\n \"phone\": \"\",\n \"livemode\": \"\",\n \"created\": \"\",\n \"provider_operator\": \"\",\n \"recipient_name\": \"\",\n \"description\": \"\",\n \"provider\": \"\",\n \"provider_reference\": \"\",\n \"failure\": {\n \"code\": \"\",\n \"message\": \"\"\n },\n \"idempotency_key\": \"\",\n \"completed\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4bde34b7-2826-4d48-8b87-9a207a27d1d7", "name": "Invalid request. `code` is one of `invalid_body`, `pays_non_desservi`,\n`operateur_manquant`, `operateur_non_desservi`, `methode_desactivee`,\n`telephone_invalide`, `devise_invalide`, `montant_invalide`.", "originalRequest": { "url": { "path": [ "v1", "transfers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "A unique string per order or per transfer. A replayed call returns the existing object with HTTP `200` and `Idempotent-Replayed: true`. Kept at 120 characters at most for transfers.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"country\": \"ZM\",\n \"operator\": \"\",\n \"phone\": \"\",\n \"currency\": \"\",\n \"recipient_name\": \"\",\n \"description\": \"\",\n \"idempotency_key\": \"\",\n \"metadata\": {\n \"key_0\": 5361.062579085304,\n \"key_1\": \"string\",\n \"key_2\": 5436.755319782985\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f0290c94-4d67-4508-b9c9-e94d3b46255b", "name": "Key missing, invalid, or public key (`code: unauthorized`).", "originalRequest": { "url": { "path": [ "v1", "transfers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "A unique string per order or per transfer. A replayed call returns the existing object with HTTP `200` and `Idempotent-Replayed: true`. Kept at 120 characters at most for transfers.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"country\": \"ZM\",\n \"operator\": \"\",\n \"phone\": \"\",\n \"currency\": \"\",\n \"recipient_name\": \"\",\n \"description\": \"\",\n \"idempotency_key\": \"\",\n \"metadata\": {\n \"key_0\": 5361.062579085304,\n \"key_1\": \"string\",\n \"key_2\": 5436.755319782985\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0c8d8fe0-859e-4ce7-9f4c-fb1541b6eb41", "name": "Insufficient Connect balance (`code: solde_insuffisant`).", "originalRequest": { "url": { "path": [ "v1", "transfers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "A unique string per order or per transfer. A replayed call returns the existing object with HTTP `200` and `Idempotent-Replayed: true`. Kept at 120 characters at most for transfers.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"country\": \"ZM\",\n \"operator\": \"\",\n \"phone\": \"\",\n \"currency\": \"\",\n \"recipient_name\": \"\",\n \"description\": \"\",\n \"idempotency_key\": \"\",\n \"metadata\": {\n \"key_0\": 5361.062579085304,\n \"key_1\": \"string\",\n \"key_2\": 5436.755319782985\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Payment Required", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cce01a08-6ec9-470e-b60f-fb93b7420abb", "name": "`test_mode` (test key: transfers move real money), `transferts_inactifs` (closed by Cartflox administration), `connect_non_disponible` (Connect workspace) or `identite_non_verifiee`.", "originalRequest": { "url": { "path": [ "v1", "transfers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "A unique string per order or per transfer. A replayed call returns the existing object with HTTP `200` and `Idempotent-Replayed: true`. Kept at 120 characters at most for transfers.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"country\": \"ZM\",\n \"operator\": \"\",\n \"phone\": \"\",\n \"currency\": \"\",\n \"recipient_name\": \"\",\n \"description\": \"\",\n \"idempotency_key\": \"\",\n \"metadata\": {\n \"key_0\": 5361.062579085304,\n \"key_1\": \"string\",\n \"key_2\": 5436.755319782985\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9cf67893-08f4-4bcd-aea5-201166689f18", "name": "Workspace not found (`code: espace_introuvable`).", "originalRequest": { "url": { "path": [ "v1", "transfers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "A unique string per order or per transfer. A replayed call returns the existing object with HTTP `200` and `Idempotent-Replayed: true`. Kept at 120 characters at most for transfers.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"country\": \"ZM\",\n \"operator\": \"\",\n \"phone\": \"\",\n \"currency\": \"\",\n \"recipient_name\": \"\",\n \"description\": \"\",\n \"idempotency_key\": \"\",\n \"metadata\": {\n \"key_0\": 5361.062579085304,\n \"key_1\": \"string\",\n \"key_2\": 5436.755319782985\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d5801f95-0828-411a-81c6-4e3d589d4d5e", "name": "`rate_limited` (more than 30 transfers per minute) or `plafond_journalier` (daily cap of the workspace reached, resets at midnight GMT).", "originalRequest": { "url": { "path": [ "v1", "transfers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "A unique string per order or per transfer. A replayed call returns the existing object with HTTP `200` and `Idempotent-Replayed: true`. Kept at 120 characters at most for transfers.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"country\": \"ZM\",\n \"operator\": \"\",\n \"phone\": \"\",\n \"currency\": \"\",\n \"recipient_name\": \"\",\n \"description\": \"\",\n \"idempotency_key\": \"\",\n \"metadata\": {\n \"key_0\": 5361.062579085304,\n \"key_1\": \"string\",\n \"key_2\": 5436.755319782985\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4342c564-1ebf-4c85-8934-a367af979158", "name": "Internal error, the transfer was not created (`code: internal`).", "originalRequest": { "url": { "path": [ "v1", "transfers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "A unique string per order or per transfer. A replayed call returns the existing object with HTTP `200` and `Idempotent-Replayed: true`. Kept at 120 characters at most for transfers.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"country\": \"ZM\",\n \"operator\": \"\",\n \"phone\": \"\",\n \"currency\": \"\",\n \"recipient_name\": \"\",\n \"description\": \"\",\n \"idempotency_key\": \"\",\n \"metadata\": {\n \"key_0\": 5361.062579085304,\n \"key_1\": \"string\",\n \"key_2\": 5436.755319782985\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7a67e54b-6e53-49c1-b3d9-5731d4ab30a9", "name": "List transfers, or the countries and operators open to the workspace", "request": { "name": "List transfers, or the countries and operators open to the workspace", "description": { "content": "Without `options`, the latest transfers of the workspace, newest first, filterable by\nstatus. With `options=1`, the countries, currencies and operators the workspace can\nsend to, given its gateways (the shape of the response is then `TransferOptions`).\n", "type": "text/plain" }, "url": { "path": [ "v1", "transfers" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Set to `1` to get the countries and operators instead of the list.", "type": "text/plain" }, "key": "options", "value": "" }, { "disabled": false, "description": { "content": " (This can only be one of pending,processing,succeeded,failed)", "type": "text/plain" }, "key": "status", "value": "succeeded" }, { "disabled": false, "description": { "content": "Number of transfers (1 to 200).", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "bf4e1fb0-78e0-4142-affc-52c896802698", "name": "The list, or the options.", "originalRequest": { "url": { "path": [ "v1", "transfers" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Set to `1` to get the countries and operators instead of the list.", "type": "text/plain" }, "key": "options", "value": "" }, { "disabled": false, "description": { "content": " (This can only be one of pending,processing,succeeded,failed)", "type": "text/plain" }, "key": "status", "value": "succeeded" }, { "disabled": false, "description": { "content": "Number of transfers (1 to 200).", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"reference\": \"\",\n \"status\": \"succeeded\",\n \"amount\": \"\",\n \"currency\": \"\",\n \"fee\": \"\",\n \"country\": \"\",\n \"operator\": \"\",\n \"phone\": \"\",\n \"livemode\": \"\",\n \"created\": \"\",\n \"provider_operator\": \"\",\n \"recipient_name\": \"\",\n \"description\": \"\",\n \"provider\": \"\",\n \"provider_reference\": \"\",\n \"failure\": {\n \"code\": \"\",\n \"message\": \"\"\n },\n \"idempotency_key\": \"\",\n \"completed\": \"\"\n },\n {\n \"id\": \"\",\n \"reference\": \"\",\n \"status\": \"succeeded\",\n \"amount\": \"\",\n \"currency\": \"\",\n \"fee\": \"\",\n \"country\": \"\",\n \"operator\": \"\",\n \"phone\": \"\",\n \"livemode\": \"\",\n \"created\": \"\",\n \"provider_operator\": \"\",\n \"recipient_name\": \"\",\n \"description\": \"\",\n \"provider\": \"\",\n \"provider_reference\": \"\",\n \"failure\": {\n \"code\": \"\",\n \"message\": \"\"\n },\n \"idempotency_key\": \"\",\n \"completed\": \"\"\n }\n ],\n \"count\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a4c8f7b7-034a-4b45-98b8-17c418faf2cb", "name": "Key missing, invalid, or public key (`code: unauthorized`).", "originalRequest": { "url": { "path": [ "v1", "transfers" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Set to `1` to get the countries and operators instead of the list.", "type": "text/plain" }, "key": "options", "value": "" }, { "disabled": false, "description": { "content": " (This can only be one of pending,processing,succeeded,failed)", "type": "text/plain" }, "key": "status", "value": "succeeded" }, { "disabled": false, "description": { "content": "Number of transfers (1 to 200).", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{id}", "description": "", "item": [ { "id": "157ba50a-ddb6-4e11-a1e2-815cb66cf926", "name": "Get a transfer", "request": { "name": "Get a transfer", "description": { "content": "By Cartflox identifier (`id`) or by `reference`.", "type": "text/plain" }, "url": { "path": [ "v1", "transfers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Transfer `id` or `reference`.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "5917ead9-961d-4a0b-a0df-4fc4fe5c96a3", "name": "The transfer.", "originalRequest": { "url": { "path": [ "v1", "transfers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Transfer `id` or `reference`.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"reference\": \"\",\n \"status\": \"failed\",\n \"amount\": \"\",\n \"currency\": \"\",\n \"fee\": \"\",\n \"country\": \"\",\n \"operator\": \"\",\n \"phone\": \"\",\n \"livemode\": \"\",\n \"created\": \"\",\n \"provider_operator\": \"\",\n \"recipient_name\": \"\",\n \"description\": \"\",\n \"provider\": \"\",\n \"provider_reference\": \"\",\n \"failure\": {\n \"code\": \"\",\n \"message\": \"\"\n },\n \"idempotency_key\": \"\",\n \"completed\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "97d5642b-1877-436b-8b1c-ae5e0f4dea36", "name": "Key missing, invalid, or public key (`code: unauthorized`).", "originalRequest": { "url": { "path": [ "v1", "transfers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Transfer `id` or `reference`.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a57d14ee-9698-4aec-88f6-5b6440e34f52", "name": "Not found in this workspace (`code: not_found`).", "originalRequest": { "url": { "path": [ "v1", "transfers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Transfer `id` or `reference`.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "webhooks", "description": "", "item": [ { "name": "deliveries", "description": "", "item": [ { "id": "6ca16583-6752-48e2-8970-5c223660912e", "name": "List webhook deliveries", "request": { "name": "List webhook deliveries", "description": { "content": "The delivery log of the workspace, newest first (50 by default, 200 at most). A test key\nsees only test deliveries, a production key only production ones. `status=pending` also\ncovers deliveries being sent right now.\n", "type": "text/plain" }, "url": { "path": [ "v1", "webhooks", "deliveries" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Only the deliveries about this payment (session id).", "type": "text/plain" }, "key": "transaction_id", "value": "" }, { "disabled": false, "description": { "content": " (This can only be one of pending,delivered,failed)", "type": "text/plain" }, "key": "status", "value": "failed" }, { "disabled": false, "description": { "content": "Only the deliveries of this event. (This can only be one of payment.completed,payment.failed,payment.cancelled,payment.updated,transfer.succeeded,transfer.failed)", "type": "text/plain" }, "key": "event", "value": "payment.cancelled" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "92985a5c-b030-404e-9106-ce1b660ecadf", "name": "Deliveries.", "originalRequest": { "url": { "path": [ "v1", "webhooks", "deliveries" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Only the deliveries about this payment (session id).", "type": "text/plain" }, "key": "transaction_id", "value": "" }, { "disabled": false, "description": { "content": " (This can only be one of pending,delivered,failed)", "type": "text/plain" }, "key": "status", "value": "failed" }, { "disabled": false, "description": { "content": "Only the deliveries of this event. (This can only be one of payment.completed,payment.failed,payment.cancelled,payment.updated,transfer.succeeded,transfer.failed)", "type": "text/plain" }, "key": "event", "value": "payment.cancelled" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"object\": \"\",\n \"data\": [\n {\n \"id\": \"\",\n \"object\": \"\",\n \"event\": \"transfer.failed\",\n \"url\": \"\",\n \"status\": \"delivered\",\n \"attempts\": \"\",\n \"max_attempts\": \"\",\n \"livemode\": \"\",\n \"created_at\": \"\",\n \"next_attempt_at\": \"\",\n \"last_status_code\": \"\",\n \"last_error\": \"\",\n \"response_ms\": \"\",\n \"transaction_id\": \"\",\n \"transfer_id\": \"\",\n \"delivered_at\": \"\"\n },\n {\n \"id\": \"\",\n \"object\": \"\",\n \"event\": \"transfer.failed\",\n \"url\": \"\",\n \"status\": \"delivered\",\n \"attempts\": \"\",\n \"max_attempts\": \"\",\n \"livemode\": \"\",\n \"created_at\": \"\",\n \"next_attempt_at\": \"\",\n \"last_status_code\": \"\",\n \"last_error\": \"\",\n \"response_ms\": \"\",\n \"transaction_id\": \"\",\n \"transfer_id\": \"\",\n \"delivered_at\": \"\"\n }\n ],\n \"count\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7b787392-689a-4065-9e16-d818c4f4a1f4", "name": "`status` is not `pending`, `delivered` or `failed`, or `event` is unknown (the body then lists `available_events`).", "originalRequest": { "url": { "path": [ "v1", "webhooks", "deliveries" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Only the deliveries about this payment (session id).", "type": "text/plain" }, "key": "transaction_id", "value": "" }, { "disabled": false, "description": { "content": " (This can only be one of pending,delivered,failed)", "type": "text/plain" }, "key": "status", "value": "failed" }, { "disabled": false, "description": { "content": "Only the deliveries of this event. (This can only be one of payment.completed,payment.failed,payment.cancelled,payment.updated,transfer.succeeded,transfer.failed)", "type": "text/plain" }, "key": "event", "value": "payment.cancelled" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "11f0ea1e-305b-4934-8fe7-3caa77a7e8fe", "name": "API key missing or invalid.", "originalRequest": { "url": { "path": [ "v1", "webhooks", "deliveries" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Only the deliveries about this payment (session id).", "type": "text/plain" }, "key": "transaction_id", "value": "" }, { "disabled": false, "description": { "content": " (This can only be one of pending,delivered,failed)", "type": "text/plain" }, "key": "status", "value": "failed" }, { "disabled": false, "description": { "content": "Only the deliveries of this event. (This can only be one of payment.completed,payment.failed,payment.cancelled,payment.updated,transfer.succeeded,transfer.failed)", "type": "text/plain" }, "key": "event", "value": "payment.cancelled" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{id}", "description": "", "item": [ { "id": "e58d83ae-0ec0-40ff-a9a4-88c6e893d546", "name": "Get a webhook delivery", "request": { "name": "Get a webhook delivery", "description": {}, "url": { "path": [ "v1", "webhooks", "deliveries", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Webhook delivery identifier.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "a0afd516-1276-4b2d-a47e-3e1d83eb1506", "name": "The delivery.", "originalRequest": { "url": { "path": [ "v1", "webhooks", "deliveries", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Webhook delivery identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"object\": \"\",\n \"event\": \"payment.updated\",\n \"url\": \"\",\n \"status\": \"failed\",\n \"attempts\": \"\",\n \"max_attempts\": \"\",\n \"livemode\": \"\",\n \"created_at\": \"\",\n \"next_attempt_at\": \"\",\n \"last_status_code\": \"\",\n \"last_error\": \"\",\n \"response_ms\": \"\",\n \"transaction_id\": \"\",\n \"transfer_id\": \"\",\n \"delivered_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1bfcc8f8-c53f-4442-9027-b4533169cad0", "name": "API key missing or invalid.", "originalRequest": { "url": { "path": [ "v1", "webhooks", "deliveries", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Webhook delivery identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "15287248-0df6-48ef-be81-49c7e135df06", "name": "Object not found, or not owned by this workspace.", "originalRequest": { "url": { "path": [ "v1", "webhooks", "deliveries", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Webhook delivery identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "resend", "description": "", "item": [ { "id": "0ed3875e-8f12-490c-8876-c82fd9a27c6e", "name": "Resend a webhook delivery", "request": { "name": "Resend a webhook delivery", "description": { "content": "Sends the delivery again right away, whatever its state (delivered, failed or pending),\nwith a fresh signature, to the current URL of the workspace, and returns it updated.\n`404` when it does not belong to the workspace (or to the other mode).\n", "type": "text/plain" }, "url": { "path": [ "v1", "webhooks", "deliveries", ":id", "resend" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) Webhook delivery identifier.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "9614c7eb-98f6-4b58-b6a7-da4144ba4cdd", "name": "The delivery after the new attempt.", "originalRequest": { "url": { "path": [ "v1", "webhooks", "deliveries", ":id", "resend" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Webhook delivery identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"object\": \"\",\n \"event\": \"payment.updated\",\n \"url\": \"\",\n \"status\": \"failed\",\n \"attempts\": \"\",\n \"max_attempts\": \"\",\n \"livemode\": \"\",\n \"created_at\": \"\",\n \"next_attempt_at\": \"\",\n \"last_status_code\": \"\",\n \"last_error\": \"\",\n \"response_ms\": \"\",\n \"transaction_id\": \"\",\n \"transfer_id\": \"\",\n \"delivered_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ea4cfb5e-00d2-483b-bae1-10c30536cc18", "name": "API key missing or invalid.", "originalRequest": { "url": { "path": [ "v1", "webhooks", "deliveries", ":id", "resend" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Webhook delivery identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "82dfc737-f2ac-48e7-971c-1ff62ef20e0a", "name": "Object not found, or not owned by this workspace.", "originalRequest": { "url": { "path": [ "v1", "webhooks", "deliveries", ":id", "resend" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Webhook delivery identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9a43bf10-82d2-49b1-adf3-20dd2b77707f", "name": "More than 30 resends per minute for this workspace (`code: rate_limited`).", "originalRequest": { "url": { "path": [ "v1", "webhooks", "deliveries", ":id", "resend" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Webhook delivery identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] } ] }, { "name": "config", "description": "", "item": [ { "name": "webhook", "description": "", "item": [ { "id": "448084f2-7e05-46b9-bccc-1f56087cf415", "name": "Get the webhook configuration", "request": { "name": "Get the webhook configuration", "description": { "content": "Production URL, test URL and the events the workspace receives (`events` lists every event when none was selected).", "type": "text/plain" }, "url": { "path": [ "v1", "config", "webhook" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "5d610c45-b58f-40cc-8138-162048d9355b", "name": "Current configuration.", "originalRequest": { "url": { "path": [ "v1", "config", "webhook" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"webhookUrl\": \"\",\n \"testWebhookUrl\": \"\",\n \"events\": [\n \"payment.cancelled\",\n \"payment.updated\"\n ],\n \"available_events\": [\n \"transfer.succeeded\",\n \"payment.failed\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a291d468-f016-471c-8ebb-fa0d9eec7043", "name": "API key missing or invalid.", "originalRequest": { "url": { "path": [ "v1", "config", "webhook" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "97559de1-9ce1-4eb3-9fd3-8fa662b47dd3", "name": "Internal error. Retry, then contact Cartflox if it persists.", "originalRequest": { "url": { "path": [ "v1", "config", "webhook" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "46508405-7902-4ac8-b639-1ee7ae0dfccc", "name": "Set the webhook URL, the test URL or the events", "request": { "name": "Set the webhook URL, the test URL or the events", "description": { "content": "Pass `webhookUrl`, `events`, or both. `webhookUrl` must be a public `https` address:\nlocal addresses, private networks and cloud metadata hosts are refused; an empty string\nremoves the webhook. `mode` says which address is set: `live` or `test`; when absent,\nthe address of the key's own mode (a test key sets the test address). Without a test\naddress, the production address receives test events with `livemode: false`.\n`events` selects the events you receive; the full list (or an empty one) means all of\nthem, future events included.\n", "type": "text/plain" }, "url": { "path": [ "v1", "config", "webhook" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"webhookUrl\": 5516.986028940199\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "54abdfbf-6486-47a1-a373-9414cb7f6df2", "name": "Configuration saved.", "originalRequest": { "url": { "path": [ "v1", "config", "webhook" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"webhookUrl\": 5516.986028940199\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"webhookUrl\": \"\",\n \"testWebhookUrl\": \"\",\n \"events\": [\n \"payment.cancelled\",\n \"payment.updated\"\n ],\n \"available_events\": [\n \"transfer.succeeded\",\n \"payment.failed\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "71ba9c4f-cdce-43bc-9cf8-f51194ddeb40", "name": "No JSON body, nothing to update (neither `webhookUrl` nor `events`), `webhookUrl` not a string or not a public https URL, `events` not an array, or unknown event names (the body then lists `available_events`).", "originalRequest": { "url": { "path": [ "v1", "config", "webhook" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"webhookUrl\": 5516.986028940199\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2a7e09bf-265f-4f7f-aa7c-ee0df6c3fc7a", "name": "API key missing or invalid.", "originalRequest": { "url": { "path": [ "v1", "config", "webhook" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"webhookUrl\": 5516.986028940199\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7d5d3524-69f6-47c8-9454-be8eee600aaf", "name": "Internal error. Retry, then contact Cartflox if it persists.", "originalRequest": { "url": { "path": [ "v1", "config", "webhook" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"webhookUrl\": 5516.986028940199\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "partner", "description": "", "item": [ { "name": "merchants", "description": "", "item": [ { "id": "ac4ef401-b134-4a47-8a8a-6a9232bb7139", "name": "Provision a merchant for a partner product", "request": { "name": "Provision a merchant for a partner product", "description": { "content": "Reserved to Cartflox partner products (LinkAfr / Ma Boutique). Creates the user if\nabsent, the workspace (`own_keys` payment mode) and its API keys. Idempotent by\n(`email`, `shop_name`): calling again returns the existing merchant, and updates the\nwebhook URL when a different one is given.\n", "type": "text/plain" }, "url": { "path": [ "v1", "partner", "merchants" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"shop_name\": \"\",\n \"name\": \"\",\n \"whatsapp\": \"\",\n \"webhook_url\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-partner-secret" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "e67b2b0a-d8db-4bd8-9e6c-9d9557f03413", "name": "The merchant and its keys.", "originalRequest": { "url": { "path": [ "v1", "partner", "merchants" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-partner-secret", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"shop_name\": \"\",\n \"name\": \"\",\n \"whatsapp\": \"\",\n \"webhook_url\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"application_id\": \"\",\n \"public_key\": \"\",\n \"secret_key\": \"\",\n \"payment_mode\": \"\",\n \"commission_bps\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a4dfd792-cf12-4920-8653-9e006d539bb6", "name": "Invalid `email` or `shop_name` shorter than 2 characters.", "originalRequest": { "url": { "path": [ "v1", "partner", "merchants" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-partner-secret", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"shop_name\": \"\",\n \"name\": \"\",\n \"whatsapp\": \"\",\n \"webhook_url\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5ae879e6-7894-408c-98e7-ef30f0c8ed02", "name": "Invalid partner secret.", "originalRequest": { "url": { "path": [ "v1", "partner", "merchants" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-partner-secret", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"shop_name\": \"\",\n \"name\": \"\",\n \"whatsapp\": \"\",\n \"webhook_url\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e5e43fec-460d-4891-bf69-4d3f65397653", "name": "Internal error. Retry, then contact Cartflox if it persists.", "originalRequest": { "url": { "path": [ "v1", "partner", "merchants" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-partner-secret", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"shop_name\": \"\",\n \"name\": \"\",\n \"whatsapp\": \"\",\n \"webhook_url\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9904fbe6-8e9c-4fd7-b1b8-124fe36b7d5e", "name": "Partner API disabled on this server (shared secret not configured).", "originalRequest": { "url": { "path": [ "v1", "partner", "merchants" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-partner-secret", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"shop_name\": \"\",\n \"name\": \"\",\n \"whatsapp\": \"\",\n \"webhook_url\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{id}", "description": "", "item": [ { "name": "balance", "description": "", "item": [ { "id": "3126434b-7558-4016-9e72-d4413c9ba336", "name": "Balance of a partner merchant", "request": { "name": "Balance of a partner merchant", "description": {}, "url": { "path": [ "v1", "partner", "merchants", ":id", "balance" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) `application_id` returned when the merchant was provisioned.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-partner-secret" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "b6479b67-15e8-4030-b80f-fecda2711b4e", "name": "Ledger balance, pending payouts and available amount, in XOF.", "originalRequest": { "url": { "path": [ "v1", "partner", "merchants", ":id", "balance" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) `application_id` returned when the merchant was provisioned.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-partner-secret", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"balance\": \"\",\n \"pending_payouts\": \"\",\n \"available\": \"\",\n \"currency\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e445245c-f7ad-439b-9728-4219b95769af", "name": "Invalid partner secret.", "originalRequest": { "url": { "path": [ "v1", "partner", "merchants", ":id", "balance" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) `application_id` returned when the merchant was provisioned.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-partner-secret", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "88346e7c-3600-472d-ace7-ada6562ed2bb", "name": "No partner merchant with this identifier.", "originalRequest": { "url": { "path": [ "v1", "partner", "merchants", ":id", "balance" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) `application_id` returned when the merchant was provisioned.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-partner-secret", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f46137ff-c45e-464a-93e4-f63dc6ec3081", "name": "Internal error. Retry, then contact Cartflox if it persists.", "originalRequest": { "url": { "path": [ "v1", "partner", "merchants", ":id", "balance" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) `application_id` returned when the merchant was provisioned.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-partner-secret", "value": "" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d934d0b7-43b1-4b49-b092-86f28984d8dd", "name": "Partner API disabled on this server (shared secret not configured).", "originalRequest": { "url": { "path": [ "v1", "partner", "merchants", ":id", "balance" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) `application_id` returned when the merchant was provisioned.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-partner-secret", "value": "" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "payouts", "description": "", "item": [ { "id": "d07a68f4-13cb-4712-be62-8ee47aa9f5ac", "name": "Payout history of a partner merchant", "request": { "name": "Payout history of a partner merchant", "description": { "content": "The 20 most recent payout requests, newest first.", "type": "text/plain" }, "url": { "path": [ "v1", "partner", "merchants", ":id", "payouts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) `application_id` returned when the merchant was provisioned.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-partner-secret" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "832f814f-d3c0-40f9-898c-951c6459fee2", "name": "Payouts.", "originalRequest": { "url": { "path": [ "v1", "partner", "merchants", ":id", "payouts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) `application_id` returned when the merchant was provisioned.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-partner-secret", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"payouts\": [\n {\n \"id\": \"\",\n \"amount\": \"\",\n \"currency\": \"\",\n \"status\": \"PENDING\",\n \"requestedAt\": \"\",\n \"method\": \"\",\n \"recipient\": \"\",\n \"processedAt\": \"\"\n },\n {\n \"id\": \"\",\n \"amount\": \"\",\n \"currency\": \"\",\n \"status\": \"PAID\",\n \"requestedAt\": \"\",\n \"method\": \"\",\n \"recipient\": \"\",\n \"processedAt\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d7c9cfb4-1f76-4d95-a925-9dbb3fbab260", "name": "Invalid partner secret.", "originalRequest": { "url": { "path": [ "v1", "partner", "merchants", ":id", "payouts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) `application_id` returned when the merchant was provisioned.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-partner-secret", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c891f169-d749-472b-88f4-8f574b90b4ba", "name": "No partner merchant with this identifier.", "originalRequest": { "url": { "path": [ "v1", "partner", "merchants", ":id", "payouts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) `application_id` returned when the merchant was provisioned.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-partner-secret", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "160e5d29-26da-4791-be81-215e03957d29", "name": "Internal error. Retry, then contact Cartflox if it persists.", "originalRequest": { "url": { "path": [ "v1", "partner", "merchants", ":id", "payouts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) `application_id` returned when the merchant was provisioned.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-partner-secret", "value": "" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "060c9b08-a284-4fc6-9b2b-5b9ab9b8fc3c", "name": "Partner API disabled on this server (shared secret not configured).", "originalRequest": { "url": { "path": [ "v1", "partner", "merchants", ":id", "payouts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) `application_id` returned when the merchant was provisioned.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-partner-secret", "value": "" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1abba743-6081-444a-9324-1577b18ddb25", "name": "Request a payout for a partner merchant", "request": { "name": "Request a payout for a partner merchant", "description": { "content": "Same rules as the dashboard: minimum 1 000 F, `available = balance - pending payouts`.\nThe amount is truncated to a whole number. Cartflox administration is notified and\nprocesses the payout by hand.\n", "type": "text/plain" }, "url": { "path": [ "v1", "partner", "merchants", ":id", "payouts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) `application_id` returned when the merchant was provisioned.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"method\": \"moov\",\n \"recipient\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-partner-secret" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "632ad04c-f2f9-4809-b319-7b86dd9abec4", "name": "Payout requested.", "originalRequest": { "url": { "path": [ "v1", "partner", "merchants", ":id", "payouts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) `application_id` returned when the merchant was provisioned.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-partner-secret", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"method\": \"moov\",\n \"recipient\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"status\": \"REJECTED\",\n \"amount\": \"\",\n \"method\": \"moov\",\n \"recipient\": \"\",\n \"requested_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "beef9579-4202-414d-8d40-57193979323c", "name": "Invalid method, invalid recipient number (fewer than 8 digits), amount below 1 000 F, or insufficient available balance.", "originalRequest": { "url": { "path": [ "v1", "partner", "merchants", ":id", "payouts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) `application_id` returned when the merchant was provisioned.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-partner-secret", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"method\": \"moov\",\n \"recipient\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f896bb7e-ad7a-4ede-85f8-04bd3ff52261", "name": "Invalid partner secret.", "originalRequest": { "url": { "path": [ "v1", "partner", "merchants", ":id", "payouts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) `application_id` returned when the merchant was provisioned.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-partner-secret", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"method\": \"moov\",\n \"recipient\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "64a34770-d5e5-47ea-a3a8-90dd0c3ad31d", "name": "No partner merchant with this identifier.", "originalRequest": { "url": { "path": [ "v1", "partner", "merchants", ":id", "payouts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) `application_id` returned when the merchant was provisioned.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-partner-secret", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"method\": \"moov\",\n \"recipient\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b13cc146-54ea-4425-8822-5867f014fbb1", "name": "Internal error. Retry, then contact Cartflox if it persists.", "originalRequest": { "url": { "path": [ "v1", "partner", "merchants", ":id", "payouts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) `application_id` returned when the merchant was provisioned.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-partner-secret", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"method\": \"moov\",\n \"recipient\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e75eb8e8-0943-43c9-9025-df9de1659759", "name": "Partner API disabled on this server (shared secret not configured).", "originalRequest": { "url": { "path": [ "v1", "partner", "merchants", ":id", "payouts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) `application_id` returned when the merchant was provisioned.", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-partner-secret", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"method\": \"moov\",\n \"recipient\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] } ] } ] }, { "name": "checkout", "description": "", "item": [ { "name": "sandbox", "description": "", "item": [ { "id": "d7c37d9a-71ed-421d-acb6-c22456ece6b1", "name": "Settle a test session without opening the payment page", "request": { "name": "Settle a test session without opening the payment page", "description": { "content": "Simulated outcome of a **test** payment, for automated tests. Marks the session\n`SUCCESS` or `FAILED` with `provider: \"sandbox\"` and sends the `payment.completed` or\n`payment.failed` webhook exactly as in production, with `livemode: false`. No API key\nis needed: the session identifier, impossible to guess, is enough.\n\nRefused for a production session of a live workspace (`403`) and for a session already\nsettled (`409`). Note the path: `/checkout/sandbox`, not under `/v1`. Errors use the\npayment page shape `{ \"success\": false, \"message\": \"...\" }`.\n", "type": "text/plain" }, "url": { "path": [ "checkout", "sandbox" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"transactionId\": \"\",\n \"issue\": \"succes\",\n \"customerDetails\": {\n \"name\": \"\",\n \"email\": \"\",\n \"phone\": \"\"\n },\n \"methodCode\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "c4f351f4-960e-407b-98a1-9b4df2ef88a6", "name": "Session settled, webhook sent.", "originalRequest": { "url": { "path": [ "checkout", "sandbox" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"transactionId\": \"\",\n \"issue\": \"succes\",\n \"customerDetails\": {\n \"name\": \"\",\n \"email\": \"\",\n \"phone\": \"\"\n },\n \"methodCode\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"sandbox\": \"\",\n \"status\": \"FAILED\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "42063a44-4663-452e-811b-33c7c5c05951", "name": "`transactionId` missing, or `issue` not `succes` / `echec`.", "originalRequest": { "url": { "path": [ "checkout", "sandbox" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"transactionId\": \"\",\n \"issue\": \"succes\",\n \"customerDetails\": {\n \"name\": \"\",\n \"email\": \"\",\n \"phone\": \"\"\n },\n \"methodCode\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d651ae54-6239-47c9-9eda-74aaf84beb2d", "name": "The workspace collects real money and this session is not a test session.", "originalRequest": { "url": { "path": [ "checkout", "sandbox" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"transactionId\": \"\",\n \"issue\": \"succes\",\n \"customerDetails\": {\n \"name\": \"\",\n \"email\": \"\",\n \"phone\": \"\"\n },\n \"methodCode\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4564f4f9-e30b-471f-bb3e-c51c111b94da", "name": "Session not found.", "originalRequest": { "url": { "path": [ "checkout", "sandbox" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"transactionId\": \"\",\n \"issue\": \"succes\",\n \"customerDetails\": {\n \"name\": \"\",\n \"email\": \"\",\n \"phone\": \"\"\n },\n \"methodCode\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8168c91a-36a2-4ee9-9928-7916dbde19b0", "name": "The session is no longer payable (already `SUCCESS`, `REFUNDED` or `CANCELLED`).", "originalRequest": { "url": { "path": [ "checkout", "sandbox" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"transactionId\": \"\",\n \"issue\": \"succes\",\n \"customerDetails\": {\n \"name\": \"\",\n \"email\": \"\",\n \"phone\": \"\"\n },\n \"methodCode\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "515f19e5-cdfc-4671-9a2a-762de4dee01e", "name": "More than 30 calls per minute from this IP.", "originalRequest": { "url": { "path": [ "checkout", "sandbox" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"transactionId\": \"\",\n \"issue\": \"succes\",\n \"customerDetails\": {\n \"name\": \"\",\n \"email\": \"\",\n \"phone\": \"\"\n },\n \"methodCode\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ], "auth": { "type": "bearer", "bearer": [ { "type": "any", "value": "{{bearerToken}}", "key": "token" } ] }, "event": [], "variable": [ { "key": "baseUrl", "value": "https://cartflox.com/api" } ], "info": { "_postman_id": "e6791aa7-ec72-49b1-91d2-4ea6d58fd1d3", "name": "Cartflox API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "Cartflox is a payment orchestration API for Africa. Collect Mobile Money and card\npayments through the aggregators you already use (PayDunya, PawaPay, CinetPay,\nFlutterwave, Paystack, FedaPay, Hub2, Stripe and more), send money out to Mobile\nMoney accounts, and receive signed webhooks when a payment or a transfer changes state.\n\nCartflox est une API d'orchestration des paiements pour l'Afrique : encaissez par\nMobile Money et carte avec vos propres passerelles.\n\n## Authentication\n\nEvery server-side call is authenticated with the **secret key** of your workspace,\neither as `Authorization: Bearer ` or in the `x-api-key` header.\n\n| Key | Role |\n|---|---|\n| `af_live_pub_...` / `af_test_pub_...` | Public key. Can appear client-side (widget, SoftPay). It can only create a checkout session and read that session's status and payment methods. |\n| `af_live_sec_...` / `af_test_sec_...` | Secret key. Signs your API calls and your webhooks. Server side only. |\n\nPartner endpoints (`/v1/partner/*`) use a separate shared secret in the `x-partner-secret` header.\n\n## Test mode and `livemode`\n\nEvery workspace has two sets of keys: production (`af_live_*`) and test (`af_test_*`).\nSame API, same routes. A session created with a test key is a **test transaction**: no\naggregator is called, the hosted payment page shows a \"Test mode\" banner with two\nbuttons (simulate a success / a failure), and webhooks are sent normally.\n\nTest data is isolated: it never appears in production lists, statistics or exports, and\nit is purged after 90 days. Every object response (session, status, transfer, webhook\ndelivery) and every webhook body carries `\"livemode\": true|false`.\n\nA distinct test `webhookUrl` can be set with `PATCH /v1/config/webhook` and `{\"mode\": \"test\"}`;\notherwise the production URL receives test events with `livemode: false`.\n\nA workspace whose identity is not verified yet is entirely in test mode: even its\nproduction keys create test sessions (`livemode: false`) until Cartflox switches it live.\nTransfers are refused with a test key (`403`, code `test_mode`) and payment links live in\nproduction only. For automated tests, `POST /checkout/sandbox` settles a test session\n(success or failure) without opening the payment page.\n\n## Idempotency\n\n`POST /v1/checkout/sessions` and `POST /v1/transfers` accept an optional `Idempotency-Key`\nheader (a unique string per order or per transfer). When the same call is replayed, the\nexisting object is returned with HTTP `200` and the header `Idempotent-Replayed: true`\ninstead of creating a second one. For transfers this is strongly recommended: it is what\nprevents sending the money twice.\n\n## Rate limits\n\nLimits apply per minute. Beyond them the response is `429`; `POST /v1/checkout/sessions`\nalso sets a `Retry-After` header (seconds).\n\n| Endpoint | Limit |\n|---|---|\n| `POST /v1/checkout/sessions` | 60 per minute per IP |\n| `POST /v1/payment-links` | 60 per minute per IP |\n| `POST /v1/route` | 120 per minute per IP |\n| `POST /v1/transfers` | 30 per minute per workspace, plus a daily cap (200 transfers per day by default, error code `plafond_journalier`) |\n| `POST /v1/webhooks/deliveries/{id}/resend` | 30 per minute per workspace |\n| `POST /checkout/sandbox` | 30 per minute per IP |\n\nNeed more for a peak (launch, ticketing)? Contact Cartflox before the event.\n\n## Webhooks\n\nCartflox sends a `POST` request to your webhook URL on every status change of a payment\nor a transfer. The body is `{ \"event\", \"livemode\", \"data\", \"timestamp\" }`. Events:\n`payment.completed`, `payment.failed`, `payment.cancelled`, `payment.updated`,\n`transfer.succeeded`, `transfer.failed`. You choose the events you receive with\n`PATCH /v1/config/webhook` and `{\"events\": [...]}`; by default all of them are sent.\n\n**Delivery and retries.** Every send is logged as a `webhook.delivery` object. Your\nendpoint has 10 seconds to answer; any `2xx` counts as an acknowledgement. Failed\ndeliveries are retried automatically: 10 attempts over 72 hours (immediately, then\n+1 min, +5 min, +15 min, +1 h, +3 h, +6 h, +12 h, +24 h, +24 h). Deliveries can be\nlisted and resent with the `/v1/webhooks/deliveries` endpoints.\n\n**Headers.** Every request also carries `X-Afriflow-Event` (the event name) and\n`X-Afriflow-Delivery` (the delivery id, identical from one attempt to the next: use it to\ndeduplicate), with `User-Agent: Cartflox-Webhooks/2`.\n\n**Signature.** Each request carries `X-Afriflow-Timestamp` (Unix seconds) and\n`X-Afriflow-Signature: t=,v1=` where `v1` is the HMAC-SHA256, with your secret\nkey (production key, or test key for a test event), of the string `.`.\nCompare in constant time and reject the request when `|now - ts|` exceeds 5 minutes.\n\n## Accepted currencies\n\nXOF, XAF, GHS, NGN, KES, TZS, UGX, RWF, ZMW, MWK, CDF, ETB, MZN, ZAR, EGP, MAD, GNF, SLE,\nLRD, GMD, MGA, MUR, USD, EUR, GBP. Currencies without minor units (amounts are whole\nnumbers): XOF, XAF, GNF, UGX, RWF, CDF, MGA, KMF, DJF, BIF.\n\n## Errors\n\nErrors are reported by the HTTP status code and a JSON body `{ \"error\": \"\" }`.\nTransfer endpoints add a machine-readable `code`.\n\n| Status | Meaning |\n|---|---|\n| `400` | Missing or invalid parameter (`amount` missing, `webhookUrl` not public, incomplete link...) |\n| `401` | API key missing or invalid: `Missing API key` or `Invalid API Key` |\n| `402` | Insufficient balance (transfers from a Connect balance) |\n| `403` | Forbidden: transfers closed on this workspace, Connect workspace, unverified identity, or gateway not owned by this application |\n| `404` | Session, link, transfer, delivery or gateway not found |\n| `409` | The session can no longer be paid (already cancelled or refunded) |\n| `429` | Too many requests: honour the `Retry-After` header (seconds) |\n| `500` | Internal error: retry, then contact Cartflox if it persists |\n| `502` | The aggregator could not initiate the payment: the message contains its answer |\n| `503` | Partner API disabled (shared secret not configured) |\n\n\nContact Support:\n Name: Cartflox support\n Email: support@cartflox.com", "type": "text/plain" } } }