Skip to main content
GET
/
v1
/
payouts
cURL
curl --request GET \
  --url https://api.example.com/v1/payouts \
  --header 'Authorization: Bearer <token>' \
  --header 'idempotency-key: <idempotency-key>'
{
  "id": "payout_ci_123456789",
  "status": "processing",
  "amount": 10000,
  "currency": "XOF",
  "destination_number": "+22507123456",
  "reference": "PAYOUT_001",
  "description": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z",
  "failure_reason": "<string>",
  "transaction_fee": 50,
  "ussd_reference": "USSD123456",
  "idempotency_key": "<string>"
}

​
Payouts API

This API allows you to retrieve a list of all payouts.

​
Endpoint

GET /v1/payouts

​
Responses

​
200 OK

[
  {
    "id": "string",
    "amount": 0,
    "currency": "string",
    "status": "string",
    "createdAt": "string",
    "updatedAt": "string"
  }
]

​
500 Internal Server Error

{
  "error": "An unexpected error occurred"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
idempotency-key
string
required

UUID

Maximum string length: 1000

Response

Payout already exist

​
id
string
Example:

"payout_ci_123456789"

​
status
enum<string>
Available options:
pending,
processing,
completed,
failed,
cancelled
Example:

"processing"

​
amount
integer
Example:

10000

​
currency
string
Example:

"XOF"

​
destination_number
string
Example:

"+22507123456"

​
reference
string
Example:

"PAYOUT_001"

​
description
string
​
created_at
string<date-time>
​
completed_at
string<date-time> | null
​
failure_reason
string | null
​
transaction_fee
integer
Example:

50

​
ussd_reference
string
Example:

"USSD123456"

​
idempotency_key
string