221 Pay API reference

Payments, payment links, refunds, payouts and balances, with a key scoped to payments.

Try it from this page

The "Try" button calls the API from your browser. Without a key, the call counts against the anonymous quota (100 calls per day and per IP address); with a key in the Authorization field, the quota rises to 1,000. The key stays in your browser. Get a key

Balances Get

Authorization

AuthorizationBearer <token>

Clé API d'un projet : en-tête Authorization: Bearer sk_221_pay_test_… (ou sk_221_pay_live_…).

In: header

Query Parameters

project_id?string

lang?string

Header Parameters

Authorization?string

X-API-Key?string

X-221-External-Ref?string

X-221-Project-Id?string

Accept-Language?string

Response Body

`application/json`

curl -X GET "https://example.com/v1/balances"

{  "gateway_mode": "simulated",  "livemode": true,  "rails": {    "property1": {      "available": "2500",      "pending": "2500",      "reserved": "2500"    },    "property2": {      "available": "2500",      "pending": "2500",      "reserved": "2500"    }  }}

Customers List

Authorization

AuthorizationBearer <token>

Clé API d'un projet : en-tête Authorization: Bearer sk_221_pay_test_… (ou sk_221_pay_live_…).

In: header

Query Parameters

project_id?string

lang?string

limit?string

offset?string

q?string

from?string

to?string

Header Parameters

Authorization?string

X-API-Key?string

X-221-External-Ref?string

X-221-Project-Id?string

Accept-Language?string

Response Body

`application/json`

curl -X GET "https://example.com/v1/customers"

{  "data": [    {      "created_at": "2019-08-24T14:15:22Z",      "email": "string",      "id": "string",      "livemode": true,      "name": "string",      "payments_count": 0,      "phone": "string",      "phone_country_code": "+221",      "total_amount": "2500"    }  ],  "livemode": true,  "total_count": 0}

Customers Get

Authorization

AuthorizationBearer <token>

Clé API d'un projet : en-tête Authorization: Bearer sk_221_pay_test_… (ou sk_221_pay_live_…).

In: header

Path Parameters

id*string

Query Parameters

project_id?string

lang?string

Header Parameters

Authorization?string

X-API-Key?string

X-221-External-Ref?string

X-221-Project-Id?string

Accept-Language?string

Response Body

`application/json`

curl -X GET "https://example.com/v1/customers/string"

{  "created_at": "2019-08-24T14:15:22Z",  "email": "string",  "id": "string",  "livemode": true,  "name": "string",  "payments_count": 0,  "phone": "string",  "phone_country_code": "+221",  "total_amount": "2500"}

Disputes List

Authorization

AuthorizationBearer <token>

Clé API d'un projet : en-tête Authorization: Bearer sk_221_pay_test_… (ou sk_221_pay_live_…).

In: header

Query Parameters

project_id?string

lang?string

limit?string

offset?string

payment_id?string

status?string

from?string

to?string

Header Parameters

Authorization?string

X-API-Key?string

X-221-External-Ref?string

X-221-Project-Id?string

Accept-Language?string

Response Body

`application/json`

curl -X GET "https://example.com/v1/disputes"

{  "data": [    {      "amount": "2500",      "challenge_required_by": "2019-08-24T14:15:22Z",      "created_at": "2019-08-24T14:15:22Z",      "currency": "XOF",      "evidence": [        {          "created_at": "2019-08-24T14:15:22Z",          "evidence_type": "receipt",          "file_name": "string",          "id": "0d8f6c1e-3b0a-4c58-9a57-2f1f0f4b8f10",          "size": 0        }      ],      "id": "0d8f6c1e-3b0a-4c58-9a57-2f1f0f4b8f10",      "is_already_refunded": true,      "livemode": true,      "payment_id": "0d8f6c1e-3b0a-4c58-9a57-2f1f0f4b8f10",      "project_id": "0d8f6c1e-3b0a-4c58-9a57-2f1f0f4b8f10",      "reason": "not_received",      "stage": "pre_dispute",      "status": "opened",      "updated_at": "2019-08-24T14:15:22Z"    }  ],  "livemode": true,  "total_count": 0}

Disputes Create

Authorization

AuthorizationBearer <token>

Clé API d'un projet : en-tête Authorization: Bearer sk_221_pay_test_… (ou sk_221_pay_live_…).

In: header

Query Parameters

project_id?string

lang?string

Header Parameters

Authorization?string

X-API-Key?string

X-221-External-Ref?string

X-221-Project-Id?string

Accept-Language?string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

amount*string

Au plus le montant du paiement.

Match^[0-9]+$

payment_id*string

Paiement confirmé du projet.

Formatuuid

reason*string

Value in

"not_received"
"not_as_described"
"unauthorized"
"duplicate"
"other_documented"

Response Body

`application/json`

curl -X POST "https://example.com/v1/disputes" \  -H "Content-Type: application/json" \  -d '{    "amount": "2500",    "payment_id": "0d8f6c1e-3b0a-4c58-9a57-2f1f0f4b8f10",    "reason": "not_received"  }'

{  "amount": "2500",  "challenge_required_by": "2019-08-24T14:15:22Z",  "created_at": "2019-08-24T14:15:22Z",  "currency": "XOF",  "evidence": [    {      "created_at": "2019-08-24T14:15:22Z",      "evidence_type": "receipt",      "file_name": "string",      "id": "0d8f6c1e-3b0a-4c58-9a57-2f1f0f4b8f10",      "size": 0    }  ],  "id": "0d8f6c1e-3b0a-4c58-9a57-2f1f0f4b8f10",  "is_already_refunded": true,  "livemode": true,  "payment_id": "0d8f6c1e-3b0a-4c58-9a57-2f1f0f4b8f10",  "project_id": "0d8f6c1e-3b0a-4c58-9a57-2f1f0f4b8f10",  "reason": "not_received",  "stage": "pre_dispute",  "status": "opened",  "updated_at": "2019-08-24T14:15:22Z"}

Disputes Get

Authorization

AuthorizationBearer <token>

Clé API d'un projet : en-tête Authorization: Bearer sk_221_pay_test_… (ou sk_221_pay_live_…).

In: header

Path Parameters

id*string

Query Parameters

project_id?string

lang?string

Header Parameters

Authorization?string

X-API-Key?string

X-221-External-Ref?string

X-221-Project-Id?string

Accept-Language?string

Response Body

`application/json`

curl -X GET "https://example.com/v1/disputes/string"

{  "amount": "2500",  "challenge_required_by": "2019-08-24T14:15:22Z",  "created_at": "2019-08-24T14:15:22Z",  "currency": "XOF",  "evidence": [    {      "created_at": "2019-08-24T14:15:22Z",      "evidence_type": "receipt",      "file_name": "string",      "id": "0d8f6c1e-3b0a-4c58-9a57-2f1f0f4b8f10",      "size": 0    }  ],  "id": "0d8f6c1e-3b0a-4c58-9a57-2f1f0f4b8f10",  "is_already_refunded": true,  "livemode": true,  "payment_id": "0d8f6c1e-3b0a-4c58-9a57-2f1f0f4b8f10",  "project_id": "0d8f6c1e-3b0a-4c58-9a57-2f1f0f4b8f10",  "reason": "not_received",  "stage": "pre_dispute",  "status": "opened",  "updated_at": "2019-08-24T14:15:22Z"}

Disputes Accept

Authorization

AuthorizationBearer <token>

Clé API d'un projet : en-tête Authorization: Bearer sk_221_pay_test_… (ou sk_221_pay_live_…).

In: header

Path Parameters

id*string

Query Parameters

project_id?string

lang?string

Header Parameters

Authorization?string

X-API-Key?string

X-221-External-Ref?string

X-221-Project-Id?string

Accept-Language?string

Response Body

`application/json`

curl -X POST "https://example.com/v1/disputes/string/accept"

{  "amount": "2500",  "challenge_required_by": "2019-08-24T14:15:22Z",  "created_at": "2019-08-24T14:15:22Z",  "currency": "XOF",  "evidence": [    {      "created_at": "2019-08-24T14:15:22Z",      "evidence_type": "receipt",      "file_name": "string",      "id": "0d8f6c1e-3b0a-4c58-9a57-2f1f0f4b8f10",      "size": 0    }  ],  "id": "0d8f6c1e-3b0a-4c58-9a57-2f1f0f4b8f10",  "is_already_refunded": true,  "livemode": true,  "payment_id": "0d8f6c1e-3b0a-4c58-9a57-2f1f0f4b8f10",  "project_id": "0d8f6c1e-3b0a-4c58-9a57-2f1f0f4b8f10",  "reason": "not_received",  "stage": "pre_dispute",  "status": "opened",  "updated_at": "2019-08-24T14:15:22Z"}

Disputes Challenge

Authorization

AuthorizationBearer <token>

Clé API d'un projet : en-tête Authorization: Bearer sk_221_pay_test_… (ou sk_221_pay_live_…).

In: header

Path Parameters

id*string

Query Parameters

project_id?string

lang?string

Header Parameters

Authorization?string

X-API-Key?string

X-221-External-Ref?string

X-221-Project-Id?string

Accept-Language?string

Content-Type?string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

file_ids*array<>

Pièces déjà envoyées au litige, distinctes.

Items1 <= items <= 10

Response Body

`application/json`

curl -X POST "https://example.com/v1/disputes/string/evidence" \  -H "Content-Type: application/json" \  -d '{    "file_ids": [      "0d8f6c1e-3b0a-4c58-9a57-2f1f0f4b8f10"    ]  }'

{  "amount": "2500",  "challenge_required_by": "2019-08-24T14:15:22Z",  "created_at": "2019-08-24T14:15:22Z",  "currency": "XOF",  "evidence": [    {      "created_at": "2019-08-24T14:15:22Z",      "evidence_type": "receipt",      "file_name": "string",      "id": "0d8f6c1e-3b0a-4c58-9a57-2f1f0f4b8f10",      "size": 0    }  ],  "id": "0d8f6c1e-3b0a-4c58-9a57-2f1f0f4b8f10",  "is_already_refunded": true,  "livemode": true,  "payment_id": "0d8f6c1e-3b0a-4c58-9a57-2f1f0f4b8f10",  "project_id": "0d8f6c1e-3b0a-4c58-9a57-2f1f0f4b8f10",  "reason": "not_received",  "stage": "pre_dispute",  "status": "opened",  "updated_at": "2019-08-24T14:15:22Z"}

Disputes Evidence Upload

Authorization

AuthorizationBearer <token>

Clé API d'un projet : en-tête Authorization: Bearer sk_221_pay_test_… (ou sk_221_pay_live_…).

In: header

Path Parameters

id*string

Query Parameters

project_id?string

lang?string

Header Parameters

Authorization?string

X-API-Key?string

X-221-External-Ref?string

X-221-Project-Id?string

Accept-Language?string

Content-Type?string

Request Body

multipart/form-data

TypeScript Definitions

Use the request body type in TypeScript.

dispute_id?string

Facultatif ; doit être celui de l'URL.

Formatuuid

evidence_type*string

Value in

"receipt"
"delivery_proof"
"customer_communication"
"other"

file*file

JPEG, PNG ou PDF, 5 Mo au plus : le type est vérifié sur le contenu du fichier.

Formatbinary

Response Body

`application/json`

curl -X PUT "https://example.com/v1/disputes/string/evidence" \  -F evidence_type="receipt" \  -F file="string"

{  "id": "0d8f6c1e-3b0a-4c58-9a57-2f1f0f4b8f10",  "livemode": true}

Fees Get

Authorization

AuthorizationBearer <token>

Clé API d'un projet : en-tête Authorization: Bearer sk_221_pay_test_… (ou sk_221_pay_live_…).

In: header

Query Parameters

project_id?string

lang?string

Header Parameters

Authorization?string

X-API-Key?string

X-221-External-Ref?string

X-221-Project-Id?string

Accept-Language?string

Response Body

`application/json`

curl -X GET "https://example.com/v1/fees"

{  "bank_max": 5000000,  "bank_min": 200000,  "bank_monthly_cap": 10000000,  "bank_tiers": [    {      "bps": 500,      "from": 200000,      "to": 499999    }  ],  "livemode": true}

Kyc Documents

Authorization

AuthorizationBearer <token>

Clé API d'un projet : en-tête Authorization: Bearer sk_221_pay_test_… (ou sk_221_pay_live_…).

In: header

Query Parameters

project_id?string

lang?string

Header Parameters

Authorization?string

X-API-Key?string

X-221-External-Ref?string

X-221-Project-Id?string

Accept-Language?string

Response Body

`application/json`

curl -X GET "https://example.com/v1/kyc/documents"

{  "data": [    {      "country": "SN",      "documents": [        {          "enabled": true,          "type": "national_id"        }      ]    }  ],  "livemode": true}

Kyc Sessions Create

Authorization

AuthorizationBearer <token>

Clé API d'un projet : en-tête Authorization: Bearer sk_221_pay_test_… (ou sk_221_pay_live_…).

In: header

Query Parameters

project_id?string

lang?string

Header Parameters

Authorization?string

X-API-Key?string

X-221-External-Ref?string

X-221-Project-Id?string

Accept-Language?string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

country*string

Pays émetteur de la pièce, parmi ceux de GET /v1/kyc/documents.

document_type*string

Value in

"national_id"
"passport"
"residence_permit"
"driving_licence"

Response Body

`application/json`

curl -X POST "https://example.com/v1/kyc/sessions" \  -H "Content-Type: application/json" \  -d '{    "country": "SN",    "document_type": "national_id"  }'

{  "captures": [    {      "content_types": [        "string"      ],      "expires_at": "2019-08-24T14:15:22Z",      "max_bytes": 0,      "method": "string",      "name": "front",      "url": "http://example.com"    }  ],  "expires_at": "2019-08-24T14:15:22Z",  "handoff_url": "http://example.com",  "livemode": true,  "status": "pending",  "submitted": true,  "uploaded": [    "string"  ],  "verification_id": "string"}

Kyc Sessions Uploads

Authorization

AuthorizationBearer <token>

Clé API d'un projet : en-tête Authorization: Bearer sk_221_pay_test_… (ou sk_221_pay_live_…).

In: header

Query Parameters

project_id?string

lang?string

Header Parameters

Authorization?string

X-API-Key?string

X-221-External-Ref?string

X-221-Project-Id?string

Accept-Language?string

Response Body

`application/json`

curl -X POST "https://example.com/v1/kyc/sessions/uploads"

{  "captures": [    {      "content_types": [        "string"      ],      "expires_at": "2019-08-24T14:15:22Z",      "max_bytes": 0,      "method": "string",      "name": "front",      "url": "http://example.com"    }  ],  "expires_at": "2019-08-24T14:15:22Z",  "handoff_url": "http://example.com",  "livemode": true,  "status": "pending",  "submitted": true,  "uploaded": [    "string"  ],  "verification_id": "string"}

Kyc Status

Authorization

AuthorizationBearer <token>

Clé API d'un projet : en-tête Authorization: Bearer sk_221_pay_test_… (ou sk_221_pay_live_…).

In: header

Query Parameters

project_id?string

lang?string

Header Parameters

Authorization?string

X-API-Key?string

X-221-External-Ref?string

X-221-Project-Id?string

Accept-Language?string

Response Body

`application/json`

curl -X GET "https://example.com/v1/kyc/status"

{  "country": "string",  "document_type": "string",  "livemode": true,  "merchant_status": "pending",  "reason_code": "string",  "review_eta": "2019-08-24T14:15:22Z",  "status": "not_started",  "submitted": true,  "uploaded": [    "string"  ],  "verification_id": "string",  "withdrawals_blocked": true,  "withdrawals_blocked_reason": "string"}

Kyc Submit

Authorization

AuthorizationBearer <token>

Clé API d'un projet : en-tête Authorization: Bearer sk_221_pay_test_… (ou sk_221_pay_live_…).

In: header

Query Parameters

project_id?string

lang?string

Header Parameters

Authorization?string

X-API-Key?string

X-221-External-Ref?string

X-221-Project-Id?string

Accept-Language?string

Response Body

`application/json`

curl -X POST "https://example.com/v1/kyc/submit"

{  "captures": [    {      "content_types": [        "string"      ],      "expires_at": "2019-08-24T14:15:22Z",      "max_bytes": 0,      "method": "string",      "name": "front",      "url": "http://example.com"    }  ],  "expires_at": "2019-08-24T14:15:22Z",  "handoff_url": "http://example.com",  "livemode": true,  "status": "pending",  "submitted": true,  "uploaded": [    "string"  ],  "verification_id": "string"}

Offers List

Authorization

AuthorizationBearer <token>

Clé API d'un projet : en-tête Authorization: Bearer sk_221_pay_test_… (ou sk_221_pay_live_…).

In: header

Query Parameters

project_id?string

lang?string

limit?string

offset?string

status?string

Header Parameters

Authorization?string

X-API-Key?string

X-221-External-Ref?string

X-221-Project-Id?string

Accept-Language?string

Response Body

`application/json`

curl -X GET "https://example.com/v1/offers"

{  "data": [    {      "benefit": {        "max_amount": "2500",        "type": "percent",        "value": "2500"      },      "created_at": "2019-08-24T14:15:22Z",      "description": "string",      "end_time": "2019-08-24T14:15:22Z",      "id": "0d8f6c1e-3b0a-4c58-9a57-2f1f0f4b8f10",      "livemode": true,      "max_order_amount": "2500",      "min_order_amount": "2500",      "offer_code": "string",      "start_time": "2019-08-24T14:15:22Z",      "status": "active",      "title": "string",      "usage_count": 0    }  ],  "livemode": true,  "total_count": 0}

Offers Create

Authorization

AuthorizationBearer <token>

Clé API d'un projet : en-tête Authorization: Bearer sk_221_pay_test_… (ou sk_221_pay_live_…).

In: header

Query Parameters

project_id?string

lang?string

Header Parameters

Authorization?string

X-API-Key?string

X-221-External-Ref?string

X-221-Project-Id?string

Accept-Language?string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

benefit*

description?string

Lengthlength <= 200

end_time?|

Postérieure à start_time.

Formatdate-time

max_order_amount?|

Montant en francs CFA entiers (XOF), écrit en chaîne de chiffres, sans espace ni décimale.

Match^[0-9]+$

min_order_amount?|

Montant en francs CFA entiers (XOF), écrit en chaîne de chiffres, sans espace ni décimale.

Match^[0-9]+$

offer_code*string

Mis en majuscules ; unique par projet.

Match^[A-Za-z0-9]{4,16}$

start_time?|

Formatdate-time

title*string

Length1 <= length <= 60

Response Body

`application/json`

curl -X POST "https://example.com/v1/offers" \  -H "Content-Type: application/json" \  -d '{    "benefit": {      "type": "percent",      "value": "2500"    },    "offer_code": "BIENVENUE",    "title": "string"  }'

{  "benefit": {    "max_amount": "2500",    "type": "percent",    "value": "2500"  },  "created_at": "2019-08-24T14:15:22Z",  "description": "string",  "end_time": "2019-08-24T14:15:22Z",  "id": "0d8f6c1e-3b0a-4c58-9a57-2f1f0f4b8f10",  "livemode": true,  "max_order_amount": "2500",  "min_order_amount": "2500",  "offer_code": "string",  "start_time": "2019-08-24T14:15:22Z",  "status": "active",  "title": "string",  "usage_count": 0}

Offers Delete

Authorization

AuthorizationBearer <token>

Clé API d'un projet : en-tête Authorization: Bearer sk_221_pay_test_… (ou sk_221_pay_live_…).

In: header

Path Parameters

id*string

Query Parameters

project_id?string

lang?string

Header Parameters

Authorization?string

X-API-Key?string

X-221-External-Ref?string

X-221-Project-Id?string

Accept-Language?string

Response Body

`application/json`

curl -X DELETE "https://example.com/v1/offers/string"

{  "benefit": {    "max_amount": "2500",    "type": "percent",    "value": "2500"  },  "created_at": "2019-08-24T14:15:22Z",  "description": "string",  "end_time": "2019-08-24T14:15:22Z",  "id": "0d8f6c1e-3b0a-4c58-9a57-2f1f0f4b8f10",  "livemode": true,  "max_order_amount": "2500",  "min_order_amount": "2500",  "offer_code": "string",  "start_time": "2019-08-24T14:15:22Z",  "status": "active",  "title": "string",  "usage_count": 0}

Offers Get

Authorization

AuthorizationBearer <token>

Clé API d'un projet : en-tête Authorization: Bearer sk_221_pay_test_… (ou sk_221_pay_live_…).

In: header

Path Parameters

id*string

Query Parameters

project_id?string

lang?string

Header Parameters

Authorization?string

X-API-Key?string

X-221-External-Ref?string

X-221-Project-Id?string

Accept-Language?string

Response Body

`application/json`

curl -X GET "https://example.com/v1/offers/string"

{  "benefit": {    "max_amount": "2500",    "type": "percent",    "value": "2500"  },  "created_at": "2019-08-24T14:15:22Z",  "description": "string",  "end_time": "2019-08-24T14:15:22Z",  "id": "0d8f6c1e-3b0a-4c58-9a57-2f1f0f4b8f10",  "livemode": true,  "max_order_amount": "2500",  "min_order_amount": "2500",  "offer_code": "string",  "start_time": "2019-08-24T14:15:22Z",  "status": "active",  "title": "string",  "usage_count": 0}

Offers Status

Authorization

AuthorizationBearer <token>

Clé API d'un projet : en-tête Authorization: Bearer sk_221_pay_test_… (ou sk_221_pay_live_…).

In: header

Path Parameters

id*string

Query Parameters

project_id?string

lang?string

Header Parameters

Authorization?string

X-API-Key?string

X-221-External-Ref?string

X-221-Project-Id?string

Accept-Language?string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

status*string

Value in

"active"
"inactive"

Response Body

`application/json`

curl -X POST "https://example.com/v1/offers/string/status" \  -H "Content-Type: application/json" \  -d '{    "status": "active"  }'

{  "benefit": {    "max_amount": "2500",    "type": "percent",    "value": "2500"  },  "created_at": "2019-08-24T14:15:22Z",  "description": "string",  "end_time": "2019-08-24T14:15:22Z",  "id": "0d8f6c1e-3b0a-4c58-9a57-2f1f0f4b8f10",  "livemode": true,  "max_order_amount": "2500",  "min_order_amount": "2500",  "offer_code": "string",  "start_time": "2019-08-24T14:15:22Z",  "status": "active",  "title": "string",  "usage_count": 0}

Payment Links List

Authorization

AuthorizationBearer <token>

Clé API d'un projet : en-tête Authorization: Bearer sk_221_pay_test_… (ou sk_221_pay_live_…).

In: header

Query Parameters

project_id?string

lang?string

limit?string

offset?string

status?string

from?string

to?string

Header Parameters

Authorization?string

X-API-Key?string

X-221-External-Ref?string

X-221-Project-Id?string

Accept-Language?string

Response Body

`application/json`

curl -X GET "https://example.com/v1/payment-links"

{  "data": [    {      "amount": "2500",      "created_at": "2019-08-24T14:15:22Z",      "currency": "XOF",      "description": "string",      "expiry": "2019-08-24T14:15:22Z",      "id": "0d8f6c1e-3b0a-4c58-9a57-2f1f0f4b8f10",      "link_to_pay": "http://example.com",      "livemode": true,      "status": "active"    }  ],  "livemode": true,  "total_count": 0}

Payment Links Create

Authorization

AuthorizationBearer <token>

Clé API d'un projet : en-tête Authorization: Bearer sk_221_pay_test_… (ou sk_221_pay_live_…).

In: header

Query Parameters

project_id?string

lang?string

Header Parameters

Authorization?string

X-API-Key?string

X-221-External-Ref?string

X-221-Project-Id?string

Accept-Language?string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

amount*string

Montant en francs CFA entiers (XOF), écrit en chaîne de chiffres, sans espace ni décimale.

Match^[0-9]+$

description*string

Length1 <= length <= 80

expiry?string

Fin de validité, dans le futur ; sans valeur le lien n'expire pas.

Formatdate-time

return_url?string

Match^https://

Formaturi

Response Body

`application/json`

curl -X POST "https://example.com/v1/payment-links" \  -H "Content-Type: application/json" \  -d '{    "amount": "2500",    "description": "Abonnement de novembre"  }'

{  "amount": "2500",  "created_at": "2019-08-24T14:15:22Z",  "currency": "XOF",  "description": "string",  "expiry": "2019-08-24T14:15:22Z",  "id": "0d8f6c1e-3b0a-4c58-9a57-2f1f0f4b8f10",  "link_to_pay": "http://example.com",  "livemode": true,  "status": "active"}

Payment Links Get

Authorization

AuthorizationBearer <token>

Clé API d'un projet : en-tête Authorization: Bearer sk_221_pay_test_… (ou sk_221_pay_live_…).

In: header

Path Parameters

id*string

Query Parameters

project_id?string

lang?string

Header Parameters

Authorization?string

X-API-Key?string

X-221-External-Ref?string

X-221-Project-Id?string

Accept-Language?string

Response Body

`application/json`

curl -X GET "https://example.com/v1/payment-links/string"

{  "amount": "2500",  "created_at": "2019-08-24T14:15:22Z",  "currency": "XOF",  "description": "string",  "expiry": "2019-08-24T14:15:22Z",  "id": "0d8f6c1e-3b0a-4c58-9a57-2f1f0f4b8f10",  "link_to_pay": "http://example.com",  "livemode": true,  "status": "active"}

Payment Links Status

Authorization

AuthorizationBearer <token>

Clé API d'un projet : en-tête Authorization: Bearer sk_221_pay_test_… (ou sk_221_pay_live_…).

In: header

Path Parameters

id*string

Query Parameters

project_id?string

lang?string

Header Parameters

Authorization?string

X-API-Key?string

X-221-External-Ref?string

X-221-Project-Id?string

Accept-Language?string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

status*string

Un lien expiré ne peut pas être réactivé.

Value in

"active"
"inactive"

Response Body

`application/json`

curl -X POST "https://example.com/v1/payment-links/string/status" \  -H "Content-Type: application/json" \  -d '{    "status": "active"  }'

{  "amount": "2500",  "created_at": "2019-08-24T14:15:22Z",  "currency": "XOF",  "description": "string",  "expiry": "2019-08-24T14:15:22Z",  "id": "0d8f6c1e-3b0a-4c58-9a57-2f1f0f4b8f10",  "link_to_pay": "http://example.com",  "livemode": true,  "status": "active"}

Payments List

Authorization

AuthorizationBearer <token>

Clé API d'un projet : en-tête Authorization: Bearer sk_221_pay_test_… (ou sk_221_pay_live_…).

In: header

Query Parameters

project_id?string

lang?string

limit?string

offset?string

cursor?string

status?array<string>|null

method?string

rail?string

from?string

to?string

q?string

customer_phone?string

Header Parameters

Authorization?string

X-API-Key?string

X-221-External-Ref?string

X-221-Project-Id?string

Accept-Language?string

Response Body

`application/json`

curl -X GET "https://example.com/v1/payments"

{  "data": [    {      "amount": "2500",      "checkout_url": "http://example.com",      "created_at": "2019-08-24T14:15:22Z",      "currency": "XOF",      "discount_amount": "2500",      "fee": "2500",      "id": "0d8f6c1e-3b0a-4c58-9a57-2f1f0f4b8f10",      "livemode": true,      "merchant_reference": "string",      "net": "2500",      "next_action": {        "deep_links": {          "property1": "string",          "property2": "string"        },        "expires_at": "2019-08-24T14:15:22Z",        "message": "string",        "qr_code": "string",        "type": "redirect",        "url": "http://example.com"      },      "offer_code": "string",      "original_amount": "2500",      "payment_link_description": "string",      "rail": "sn_wave",      "status": "created",      "withdrawal_eligibility": "confirmed"    }  ],  "livemode": true,  "next_cursor": "string",  "total_count": 0}

Payments Create

Authorization

AuthorizationBearer <token>

Clé API d'un projet : en-tête Authorization: Bearer sk_221_pay_test_… (ou sk_221_pay_live_…).

In: header

Query Parameters

project_id?string

lang?string

Header Parameters

Authorization?string

X-API-Key?string

X-221-External-Ref?string

X-221-Project-Id?string

Accept-Language?string

Idempotency-Key*string

Valeur unique par opération. Un renvoi avec la même valeur et le même corps rend le résultat déjà obtenu ; un corps différent donne IDEMPOTENCY_CONFLICT.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

amount*string

Montant à encaisser, au moins min_amount du moyen de paiement.

Match^[0-9]+$

currency*"XOF"

Value in

"XOF"

customer_device?string

Appareil du client. sn_orange : mobile (par défaut) ouvre l'app Max it, desktop donne un QR code à scanner (next_action de type qr). Sans effet sur les autres moyens. EN: the customer's device. sn_orange: mobile (default) opens the Max it app, desktop returns a QR code to scan (next_action of type qr). No effect on other rails.

Value in

"mobile"
"desktop"

customer_otp?string

Code composé par le client. Requis seulement si otp_required vaut true pour le moyen de paiement, refusé sinon.

Match^[0-9]{4,8}$

customer_phone?string

Numéro mobile du client, valide pour le pays du moyen de paiement. Requis en mode live.

merchant_reference*string

Référence de votre commande, unique par projet et par mode.

Match^[A-Za-z0-9._:/#-]{1,128}$

offer_code?string

Code promo du projet (insensible à la casse).

Match^[A-Za-z0-9]{4,16}$

rail*string

Moyen de paiement : pays et opérateur (liste et état : GET /v1/rails).

Value in

"sn_wave"
"sn_orange"
"ci_wave"
"ci_orange"
"ci_mtn"
"ci_moov"
"bf_orange"
"bf_wave"
"bf_moov"
"tg_moov"
"tg_togocell"
"bj_moov"
"bj_mtn"

return_url*string

Où renvoyer le client après le paiement : https obligatoire.

Match^https://

Formaturi

Response Body

`application/json`

curl -X POST "https://example.com/v1/payments" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "amount": "2500",    "currency": "XOF",    "merchant_reference": "CMD-2026-0042",    "rail": "sn_wave",    "return_url": "https://boutique.example.sn/merci"  }'

{  "amount": "2500",  "checkout_url": "http://example.com",  "created_at": "2019-08-24T14:15:22Z",  "currency": "XOF",  "discount_amount": "2500",  "fee": "2500",  "id": "0d8f6c1e-3b0a-4c58-9a57-2f1f0f4b8f10",  "livemode": true,  "merchant_reference": "string",  "net": "2500",  "next_action": {    "deep_links": {      "property1": "string",      "property2": "string"    },    "expires_at": "2019-08-24T14:15:22Z",    "message": "string",    "qr_code": "string",    "type": "redirect",    "url": "http://example.com"  },  "offer_code": "string",  "original_amount": "2500",  "payment_link_description": "string",  "rail": "sn_wave",  "status": "created",  "withdrawal_eligibility": "confirmed"}

Ouvrir le tableau de bord des paiements (Control Center)

Query Parameters

lang?string

Response Body

`application/json`

curl -X GET "https://example.com/v1/payments/console"

Empty

Payments Get

Authorization

AuthorizationBearer <token>

Clé API d'un projet : en-tête Authorization: Bearer sk_221_pay_test_… (ou sk_221_pay_live_…).

In: header

Path Parameters

id*string

Query Parameters

project_id?string

lang?string

Header Parameters

Authorization?string

X-API-Key?string

X-221-External-Ref?string

X-221-Project-Id?string

Accept-Language?string

Response Body

`application/json`

curl -X GET "https://example.com/v1/payments/string"

{  "amount": "2500",  "attempts": [    {      "amount": "2500",      "error_code": "string",      "error_message": "string",      "id": "string",      "status": "string"    }  ],  "checkout_url": "http://example.com",  "created_at": "2019-08-24T14:15:22Z",  "currency": "XOF",  "customer": {    "email": "string",    "name": "string",    "phone": "string"  },  "discount_amount": "2500",  "disputes": [    {      "amount": "2500",      "challenge_required_by": "2019-08-24T14:15:22Z",      "created_at": "2019-08-24T14:15:22Z",      "currency": "XOF",      "evidence": [        {          "created_at": "2019-08-24T14:15:22Z",          "evidence_type": "receipt",          "file_name": "string",          "id": "0d8f6c1e-3b0a-4c58-9a57-2f1f0f4b8f10",          "size": 0        }      ],      "id": "0d8f6c1e-3b0a-4c58-9a57-2f1f0f4b8f10",      "is_already_refunded": true,      "livemode": true,      "payment_id": "0d8f6c1e-3b0a-4c58-9a57-2f1f0f4b8f10",      "project_id": "0d8f6c1e-3b0a-4c58-9a57-2f1f0f4b8f10",      "reason": "not_received",      "stage": "pre_dispute",      "status": "opened",      "updated_at": "2019-08-24T14:15:22Z"    }  ],  "error_code": "string",  "error_message": "string",  "fee": "2500",  "id": "0d8f6c1e-3b0a-4c58-9a57-2f1f0f4b8f10",  "livemode": true,  "merchant_reference": "string",  "modified_at": "2019-08-24T14:15:22Z",  "net": "2500",  "next_action": {    "deep_links": {      "property1": "string",      "property2": "string"    },    "expires_at": "2019-08-24T14:15:22Z",    "message": "string",    "qr_code": "string",    "type": "redirect",    "url": "http://example.com"  },  "offer_code": "string",  "original_amount": "2500",  "payment_link_description": "string",  "rail": "sn_wave",  "refunds": [    {      "amount": "2500",      "created_at": "2019-08-24T14:15:22Z",      "currency": "XOF",      "customer_receives": "2500",      "fee": "2500",      "fee_payer": "merchant",      "id": "0d8f6c1e-3b0a-4c58-9a57-2f1f0f4b8f10",      "merchant_debited": "2500",      "payment_id": "0d8f6c1e-3b0a-4c58-9a57-2f1f0f4b8f10",      "reason": "customer_request",      "status": "requested",      "updated_at": "2019-08-24T14:15:22Z"    }  ],  "status": "created",  "withdrawal_eligibility": "confirmed"}

Payout Destinations List

Authorization

AuthorizationBearer <token>

Clé API d'un projet : en-tête Authorization: Bearer sk_221_pay_test_… (ou sk_221_pay_live_…).

In: header

Query Parameters

project_id?string

lang?string

Header Parameters

Authorization?string

X-API-Key?string

X-221-External-Ref?string

X-221-Project-Id?string

Accept-Language?string

Response Body

`application/json`

curl -X GET "https://example.com/v1/payout-destinations"

{  "data": [    {      "available_at": "2019-08-24T14:15:22Z",      "bank_code": "SN012",      "holder_name": "string",      "id": "0d8f6c1e-3b0a-4c58-9a57-2f1f0f4b8f10",      "livemode": true,      "phone_last_digits": "4567",      "rail": "sn_wave",      "rib_last4": "0185",      "type": "mobile",      "verification": {        "attempts_left": 5,        "expires_at": "2019-08-24T14:15:22Z"      },      "verified": true    }  ],  "livemode": true}

Payout Destinations Add

Authorization

AuthorizationBearer <token>

Clé API d'un projet : en-tête Authorization: Bearer sk_221_pay_test_… (ou sk_221_pay_live_…).

In: header

Query Parameters

project_id?string

lang?string

Header Parameters

Authorization?string

X-API-Key?string

X-221-External-Ref?string

X-221-Project-Id?string

Accept-Language?string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

holder_name?string

Titulaire du compte : 2 à 70 caractères, lettres, espaces, apostrophe, tiret et point. EN: account holder, 2 to 70 characters.

phone?string

Numéro mobile valide pour le pays du moyen de paiement.

rail?string

Moyen de paiement : pays et opérateur (liste et état : GET /v1/rails).

Value in

"sn_wave"
"sn_orange"
"ci_wave"
"ci_orange"
"ci_mtn"
"ci_moov"
"bf_orange"
"bf_wave"
"bf_moov"
"tg_moov"
"tg_togocell"
"bj_moov"
"bj_mtn"

rib?string

RIB UEMOA de 24 caractères, espaces acceptés : code banque (2 lettres, 3 chiffres), guichet (5 chiffres), compte (12), clé (2 chiffres) vérifiée. EN: 24-character UEMOA RIB, spaces accepted; the key is checked.

type?string

mobile par défaut : rail et phone ; bank : rib et holder_name.

Value in

"mobile"
"bank"

Response Body

`application/json`

curl -X POST "https://example.com/v1/payout-destinations" \  -H "Content-Type: application/json" \  -d '{}'

{  "available_at": "2019-08-24T14:15:22Z",  "bank_code": "SN012",  "holder_name": "string",  "id": "0d8f6c1e-3b0a-4c58-9a57-2f1f0f4b8f10",  "livemode": true,  "phone_last_digits": "4567",  "rail": "sn_wave",  "rib_last4": "0185",  "type": "mobile",  "verification": {    "attempts_left": 5,    "expires_at": "2019-08-24T14:15:22Z"  },  "verified": true}

Payout Destinations Remove

Authorization

AuthorizationBearer <token>

Clé API d'un projet : en-tête Authorization: Bearer sk_221_pay_test_… (ou sk_221_pay_live_…).

In: header

Path Parameters

id*string

Query Parameters

project_id?string

lang?string

Header Parameters

Authorization?string

X-API-Key?string

X-221-External-Ref?string

X-221-Project-Id?string

Accept-Language?string

Response Body

`application/json`

curl -X DELETE "https://example.com/v1/payout-destinations/string"

Empty

Payout Destinations Resend

Authorization

AuthorizationBearer <token>

Clé API d'un projet : en-tête Authorization: Bearer sk_221_pay_test_… (ou sk_221_pay_live_…).

In: header

Path Parameters

id*string

Query Parameters

project_id?string

lang?string

Header Parameters

Authorization?string

X-API-Key?string

X-221-External-Ref?string

X-221-Project-Id?string

Accept-Language?string

Response Body

`application/json`

curl -X POST "https://example.com/v1/payout-destinations/string/resend"

{  "available_at": "2019-08-24T14:15:22Z",  "bank_code": "SN012",  "holder_name": "string",  "id": "0d8f6c1e-3b0a-4c58-9a57-2f1f0f4b8f10",  "livemode": true,  "phone_last_digits": "4567",  "rail": "sn_wave",  "rib_last4": "0185",  "type": "mobile",  "verification": {    "attempts_left": 5,    "expires_at": "2019-08-24T14:15:22Z"  },  "verified": true}

Payout Destinations Verify

Authorization

AuthorizationBearer <token>

Clé API d'un projet : en-tête Authorization: Bearer sk_221_pay_test_… (ou sk_221_pay_live_…).

In: header

Path Parameters

id*string

Query Parameters

project_id?string

lang?string

Header Parameters

Authorization?string

X-API-Key?string

X-221-External-Ref?string

X-221-Project-Id?string

Accept-Language?string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

code*string

Code à 6 chiffres reçu par e-mail par le propriétaire du compte.

Response Body

`application/json`

curl -X POST "https://example.com/v1/payout-destinations/string/verify" \  -H "Content-Type: application/json" \  -d '{    "code": "123456"  }'

{  "available_at": "2019-08-24T14:15:22Z",  "bank_code": "SN012",  "holder_name": "string",  "id": "0d8f6c1e-3b0a-4c58-9a57-2f1f0f4b8f10",  "livemode": true,  "phone_last_digits": "4567",  "rail": "sn_wave",  "rib_last4": "0185",  "type": "mobile",  "verification": {    "attempts_left": 5,    "expires_at": "2019-08-24T14:15:22Z"  },  "verified": true}

Payout Quotes Create

Authorization

AuthorizationBearer <token>

Clé API d'un projet : en-tête Authorization: Bearer sk_221_pay_test_… (ou sk_221_pay_live_…).

In: header

Query Parameters

project_id?string

lang?string

Header Parameters

Authorization?string

X-API-Key?string

X-221-External-Ref?string

X-221-Project-Id?string

Accept-Language?string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

amount*string

Montant débité du solde disponible, frais compris.

Match^[0-9]+$

destination_id*string

Numéro ou compte enregistré par POST /v1/payout-destinations, sur le même moyen de paiement.

Formatuuid

rail?string

Requis pour un numéro mobile ; absent pour un compte bancaire.

Value in

"sn_wave"
"sn_orange"
"ci_wave"
"ci_orange"
"ci_mtn"
"ci_moov"
"bf_orange"
"bf_wave"
"bf_moov"
"tg_moov"
"tg_togocell"
"bj_moov"
"bj_mtn"

Response Body

`application/json`

curl -X POST "https://example.com/v1/payout-quotes" \  -H "Content-Type: application/json" \  -d '{    "amount": "2500",    "destination_id": "0d8f6c1e-3b0a-4c58-9a57-2f1f0f4b8f10"  }'

{  "amount": "2500",  "debits": [    {      "amount": "2500",      "rail": "sn_wave"    }  ],  "delay": "3-5 business days",  "destination_id": "0d8f6c1e-3b0a-4c58-9a57-2f1f0f4b8f10",  "destination_type": "bank",  "expires_at": "2019-08-24T14:15:22Z",  "fee": "2500",  "fee_rate": 0,  "livemode": true,  "net": "2500",  "quote_hash": "string",  "rail": "sn_wave"}

Payouts List

Authorization

AuthorizationBearer <token>

Clé API d'un projet : en-tête Authorization: Bearer sk_221_pay_test_… (ou sk_221_pay_live_…).

In: header

Query Parameters

project_id?string

lang?string

Header Parameters

Authorization?string

X-API-Key?string

X-221-External-Ref?string

X-221-Project-Id?string

Accept-Language?string

Response Body

`application/json`

curl -X GET "https://example.com/v1/payouts"

{  "data": [    {      "amount": "2500",      "created_at": "2019-08-24T14:15:22Z",      "destination_id": "0d8f6c1e-3b0a-4c58-9a57-2f1f0f4b8f10",      "destination_type": "mobile",      "failure_reason": "destination_limit",      "fee": "2500",      "id": "0d8f6c1e-3b0a-4c58-9a57-2f1f0f4b8f10",      "livemode": true,      "net": "2500",      "rail": "sn_wave",      "release_at": "2019-08-24T14:15:22Z",      "status": "processing"    }  ],  "livemode": true}

Payouts Create

Authorization

AuthorizationBearer <token>

Clé API d'un projet : en-tête Authorization: Bearer sk_221_pay_test_… (ou sk_221_pay_live_…).

In: header

Query Parameters

project_id?string

lang?string

Header Parameters

Authorization?string

X-API-Key?string

X-221-External-Ref?string

X-221-Project-Id?string

Accept-Language?string

Idempotency-Key*string

Valeur unique par opération. Un renvoi avec la même valeur et le même corps rend le résultat déjà obtenu ; un corps différent donne IDEMPOTENCY_CONFLICT.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

quote_hash*string

Response Body

`application/json`

curl -X POST "https://example.com/v1/payouts" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "quote_hash": "string"  }'

{  "amount": "2500",  "created_at": "2019-08-24T14:15:22Z",  "destination_id": "0d8f6c1e-3b0a-4c58-9a57-2f1f0f4b8f10",  "destination_type": "mobile",  "failure_reason": "destination_limit",  "fee": "2500",  "id": "0d8f6c1e-3b0a-4c58-9a57-2f1f0f4b8f10",  "livemode": true,  "net": "2500",  "rail": "sn_wave",  "release_at": "2019-08-24T14:15:22Z",  "status": "processing"}

Payouts Get

Authorization

AuthorizationBearer <token>

Clé API d'un projet : en-tête Authorization: Bearer sk_221_pay_test_… (ou sk_221_pay_live_…).

In: header

X-221-External-Ref?string

X-221-Project-Id?string

Accept-Language?string

Response Body

`application/json`

curl -X GET "https://example.com/v1/payouts/string"

{  "amount": "2500",  "created_at": "2019-08-24T14:15:22Z",  "destination_id": "0d8f6c1e-3b0a-4c58-9a57-2f1f0f4b8f10",  "destination_type": "mobile",  "failure_reason": "destination_limit",  "fee": "2500",  "id": "0d8f6c1e-3b0a-4c58-9a57-2f1f0f4b8f10",  "livemode": true,  "net": "2500",  "rail": "sn_wave",  "release_at": "2019-08-24T14:15:22Z",  "status": "processing"}

Payouts Receipt

Authorization

AuthorizationBearer <token>

Clé API d'un projet : en-tête Authorization: Bearer sk_221_pay_test_… (ou sk_221_pay_live_…).

In: header

X-221-External-Ref?string

X-221-Project-Id?string

Accept-Language?string

Response Body

`application/json`

curl -X GET "https://example.com/v1/payouts/string/receipt"

{  "amount": "2500",  "destination_last_digits": "4567",  "destination_type": "mobile",  "fee": "2500",  "id": "0d8f6c1e-3b0a-4c58-9a57-2f1f0f4b8f10",  "livemode": true,  "net": "2500",  "rail": "sn_wave",  "rail_label": "Wave",  "succeeded_at": "2019-08-24T14:15:22Z"}

Rails List

Authorization

AuthorizationBearer <token>

Clé API d'un projet : en-tête Authorization: Bearer sk_221_pay_test_… (ou sk_221_pay_live_…).

In: header

Query Parameters

project_id?string

lang?string

Header Parameters

Authorization?string

X-API-Key?string

X-221-External-Ref?string

X-221-Project-Id?string

Accept-Language?string

Response Body

`application/json`

curl -X GET "https://example.com/v1/rails"

{  "currency": "XOF",  "data": [    {      "country": "SN",      "country_label": "Sénégal",      "enabled_for_project": true,      "fees": {        "collection_bps": 0,        "example_10000": {          "amount": "2500",          "collection_fee": "2500",          "refund_fee": "2500",          "withdrawal_fee": "2500"        },        "refund_bps": 0,        "withdrawal_bps": 0      },      "label": "Wave",      "livemode": true,      "min_amount": "2500",      "operator": "wave",      "operator_label": "Wave",      "otp_required": true,      "platform_state": "open",      "rail": "sn_wave"    }  ],  "livemode": true}

Rails Set Enabled

Authorization

AuthorizationBearer <token>

Clé API d'un projet : en-tête Authorization: Bearer sk_221_pay_test_… (ou sk_221_pay_live_…).

In: header

X-221-External-Ref?string

X-221-Project-Id?string

Accept-Language?string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

enabled*boolean

Response Body

`application/json`

curl -X PUT "https://example.com/v1/rails/string/enabled" \  -H "Content-Type: application/json" \  -d '{    "enabled": true  }'

{  "country": "SN",  "country_label": "Sénégal",  "enabled_for_project": true,  "fees": {    "collection_bps": 0,    "example_10000": {      "amount": "2500",      "collection_fee": "2500",      "refund_fee": "2500",      "withdrawal_fee": "2500"    },    "refund_bps": 0,    "withdrawal_bps": 0  },  "label": "Wave",  "livemode": true,  "min_amount": "2500",  "operator": "wave",  "operator_label": "Wave",  "otp_required": true,  "platform_state": "open",  "rail": "sn_wave"}

Refund Quotes Create

Authorization

AuthorizationBearer <token>

Clé API d'un projet : en-tête Authorization: Bearer sk_221_pay_test_… (ou sk_221_pay_live_…).

In: header

Query Parameters

project_id?string

lang?string

Header Parameters

Authorization?string

X-API-Key?string

X-221-External-Ref?string

X-221-Project-Id?string

Accept-Language?string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

amount*string

Montant à rembourser, au plus le reste remboursable du paiement.

Match^[0-9]+$

fee_payer?string

Qui supporte les frais ; par défaut refund_fee_payer_default du projet.

Value in

"merchant"
"customer"

payment_id*string

Formatuuid

Response Body

`application/json`

curl -X POST "https://example.com/v1/refund-quotes" \  -H "Content-Type: application/json" \  -d '{    "amount": "2500",    "payment_id": "0d8f6c1e-3b0a-4c58-9a57-2f1f0f4b8f10"  }'

{  "amount": "2500",  "customer_receives": "2500",  "expires_at": "2019-08-24T14:15:22Z",  "fee": "2500",  "fee_payer": "merchant",  "livemode": true,  "merchant_debited": "2500",  "payment_id": "0d8f6c1e-3b0a-4c58-9a57-2f1f0f4b8f10",  "quote_hash": "string"}

Refunds List

Authorization

AuthorizationBearer <token>

Clé API d'un projet : en-tête Authorization: Bearer sk_221_pay_test_… (ou sk_221_pay_live_…).

In: header

Query Parameters

project_id?string

lang?string

limit?string

offset?string

payment_id?string

status?string

from?string

to?string

Header Parameters

Authorization?string

X-API-Key?string

X-221-External-Ref?string

X-221-Project-Id?string

Accept-Language?string

Response Body

`application/json`

curl -X GET "https://example.com/v1/refunds"

{  "data": [    {      "amount": "2500",      "created_at": "2019-08-24T14:15:22Z",      "currency": "XOF",      "customer_receives": "2500",      "fee": "2500",      "fee_payer": "merchant",      "id": "0d8f6c1e-3b0a-4c58-9a57-2f1f0f4b8f10",      "livemode": true,      "merchant_debited": "2500",      "payment_id": "0d8f6c1e-3b0a-4c58-9a57-2f1f0f4b8f10",      "reason": "customer_request",      "status": "requested",      "updated_at": "2019-08-24T14:15:22Z"    }  ],  "livemode": true,  "total_count": 0}

Refunds Create

Authorization

AuthorizationBearer <token>

Clé API d'un projet : en-tête Authorization: Bearer sk_221_pay_test_… (ou sk_221_pay_live_…).

In: header

Query Parameters

project_id?string

lang?string

Header Parameters

Authorization?string

X-API-Key?string

X-221-External-Ref?string

X-221-Project-Id?string

Accept-Language?string

Idempotency-Key*string

Valeur unique par opération. Un renvoi avec la même valeur et le même corps rend le résultat déjà obtenu ; un corps différent donne IDEMPOTENCY_CONFLICT.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

amount*string

Montant en francs CFA entiers (XOF), écrit en chaîne de chiffres, sans espace ni décimale.

Match^[0-9]+$

fee_payer?string

Doit être celui de la cotation.

Value in

"merchant"
"customer"

payment_id*string

Formatuuid

quote_hash*string

reason*string

Value in

"customer_request"
"duplicate"
"product_not_delivered"
"other_documented"

Response Body

`application/json`

curl -X POST "https://example.com/v1/refunds" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "amount": "2500",    "payment_id": "0d8f6c1e-3b0a-4c58-9a57-2f1f0f4b8f10",    "quote_hash": "string",    "reason": "customer_request"  }'

{  "amount": "2500",  "created_at": "2019-08-24T14:15:22Z",  "currency": "XOF",  "customer_receives": "2500",  "fee": "2500",  "fee_payer": "merchant",  "id": "0d8f6c1e-3b0a-4c58-9a57-2f1f0f4b8f10",  "livemode": true,  "merchant_debited": "2500",  "payment_id": "0d8f6c1e-3b0a-4c58-9a57-2f1f0f4b8f10",  "reason": "customer_request",  "status": "requested",  "updated_at": "2019-08-24T14:15:22Z"}

Refunds Get

Authorization

AuthorizationBearer <token>

Clé API d'un projet : en-tête Authorization: Bearer sk_221_pay_test_… (ou sk_221_pay_live_…).

In: header

X-221-External-Ref?string

X-221-Project-Id?string

Accept-Language?string

Response Body

`application/json`

curl -X GET "https://example.com/v1/refunds/string"

{  "amount": "2500",  "created_at": "2019-08-24T14:15:22Z",  "currency": "XOF",  "customer_receives": "2500",  "fee": "2500",  "fee_payer": "merchant",  "id": "0d8f6c1e-3b0a-4c58-9a57-2f1f0f4b8f10",  "livemode": true,  "merchant_debited": "2500",  "payment_id": "0d8f6c1e-3b0a-4c58-9a57-2f1f0f4b8f10",  "reason": "customer_request",  "status": "requested",  "updated_at": "2019-08-24T14:15:22Z"}

Settings Get

Authorization

AuthorizationBearer <token>

Clé API d'un projet : en-tête Authorization: Bearer sk_221_pay_test_… (ou sk_221_pay_live_…).

In: header

Query Parameters

project_id?string

lang?string

Header Parameters

Authorization?string

X-API-Key?string

X-221-External-Ref?string

X-221-Project-Id?string

Accept-Language?string

Response Body

`application/json`

curl -X GET "https://example.com/v1/settings"

{  "livemode": true,  "rails_enabled": [    "sn_wave"  ],  "rate_limit_per_minute": 0,  "refund_fee_payer_default": "merchant"}

Settings Update

Authorization

AuthorizationBearer <token>

Clé API d'un projet : en-tête Authorization: Bearer sk_221_pay_test_… (ou sk_221_pay_live_…).

In: header

Query Parameters

project_id?string

lang?string

Header Parameters

Authorization?string

X-API-Key?string

X-221-External-Ref?string

X-221-Project-Id?string

Accept-Language?string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

refund_fee_payer_default*string

Value in

"merchant"
"customer"

Response Body

`application/json`

curl -X PUT "https://example.com/v1/settings" \  -H "Content-Type: application/json" \  -d '{    "refund_fee_payer_default": "merchant"  }'

{  "livemode": true,  "rails_enabled": [    "sn_wave"  ],  "rate_limit_per_minute": 0,  "refund_fee_payer_default": "merchant"}

Webhook Events List

Authorization

AuthorizationBearer <token>

Clé API d'un projet : en-tête Authorization: Bearer sk_221_pay_test_… (ou sk_221_pay_live_…).

In: header

Query Parameters

project_id?string

lang?string

limit?string

offset?string

created_after?string

created_before?string

object_id?string

event_id?string

Header Parameters

Authorization?string

X-API-Key?string

X-221-External-Ref?string

X-221-Project-Id?string

Accept-Language?string

Response Body

`application/json`

curl -X GET "https://example.com/v1/webhook-events"

{  "events": [    {      "created_at": "2019-08-24T14:15:22Z",      "event_class": "payments",      "id": "evt_0d8f6c1e-3b0a-4c58-9a57-2f1f0f4b8f10",      "initial_attempt_id": "string",      "is_delivery_successful": true,      "merchant_id": "string",      "object_id": "string",      "type": "payment.succeeded"    }  ],  "livemode": true,  "total_count": 0}

Webhook Event Attempts

Authorization

AuthorizationBearer <token>

Clé API d'un projet : en-tête Authorization: Bearer sk_221_pay_test_… (ou sk_221_pay_live_…).

In: header

X-221-External-Ref?string

X-221-Project-Id?string

Accept-Language?string

Response Body

`application/json`

curl -X GET "https://example.com/v1/webhook-events/string/attempts"

[  {    "created_at": "2019-08-24T14:15:22Z",    "delivery_attempt": 0,    "id": "0d8f6c1e-3b0a-4c58-9a57-2f1f0f4b8f10",    "is_delivery_successful": true,    "livemode": true,    "request": {      "body": null,      "headers": null    },    "response": {      "body": null,      "error_message": "string",      "headers": null,      "status_code": 0    }  }]

Webhook Event Retry

Authorization

AuthorizationBearer <token>

Clé API d'un projet : en-tête Authorization: Bearer sk_221_pay_test_… (ou sk_221_pay_live_…).

In: header

X-221-External-Ref?string

X-221-Project-Id?string

Accept-Language?string

Response Body

`application/json`

curl -X POST "https://example.com/v1/webhook-events/string/retry"

{  "created_at": "2019-08-24T14:15:22Z",  "delivery_attempt": 0,  "id": "0d8f6c1e-3b0a-4c58-9a57-2f1f0f4b8f10",  "is_delivery_successful": true,  "livemode": true,  "request": {    "body": null,    "headers": null  },  "response": {    "body": null,    "error_message": "string",    "headers": null,    "status_code": 0  }}

221 Pay API reference

Balances GetCopy Anchor Link

AuthorizationCopy Anchor Link

Query ParametersCopy Anchor Link

Header ParametersCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

400application/json

401application/json

403application/json

429application/json

503application/json

defaultapplication/json

Customers ListCopy Anchor Link

AuthorizationCopy Anchor Link

Query ParametersCopy Anchor Link

Header ParametersCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

400application/json

401application/json

403application/json

429application/json

503application/json

defaultapplication/json

Customers GetCopy Anchor Link

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Query ParametersCopy Anchor Link

Header ParametersCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

400application/json

401application/json

403application/json

404application/json

429application/json

503application/json

defaultapplication/json

Disputes ListCopy Anchor Link

AuthorizationCopy Anchor Link

Query ParametersCopy Anchor Link

Header ParametersCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

400application/json

401application/json

403application/json

429application/json

503application/json

defaultapplication/json

Disputes CreateCopy Anchor Link

AuthorizationCopy Anchor Link

Query ParametersCopy Anchor Link

Header ParametersCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

201application/json

400application/json

401application/json

403application/json

404application/json

409application/json

413application/json

429application/json

503application/json

defaultapplication/json

Disputes GetCopy Anchor Link

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Query ParametersCopy Anchor Link

Header ParametersCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

400application/json

401application/json

403application/json

404application/json

429application/json

503application/json

Balances Get

Authorization

Query Parameters

Header Parameters

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

Customers List

Authorization

Query Parameters

Header Parameters

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

Customers Get

Authorization

Path Parameters

Query Parameters

Header Parameters

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

Disputes List

Authorization

Query Parameters

Header Parameters

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

Disputes Create

Authorization

Query Parameters

Header Parameters

Request Body

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

Disputes Get

Authorization

Path Parameters

Query Parameters

Header Parameters

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`