Skip to main content
GET
/
v1
/
payout
/
{payoutId}
cURL
curl --request GET \
  --url https://api.example.com/v1/payout/{payoutId} \
  --header 'Authorization: Bearer <token>'
{
  "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>"
}

​
Payout Retrieval API

This API allows you to retrieve information about a specific payout using its unique identifier.

​
Endpoint

GET /v1/payout/{payoutId}

​
Path Parameters

NameTypeDescription
payoutIdstringThe unique identifier of the payout.

​
Responses

​
200 OK

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

​
404 Not Found

{
  "error": "Payout not found"
}

​
Example Request

GET /v1/payout/{payoutId}

{
  "payoutId": "string"
}

​
Example Response

{
  "id": "payout_12345",
  "amount": 1500,
  "currency": "usd",
  "status": "completed",
  "createdAt": "2024-01-01T12:00:00Z",
  "updatedAt": "2024-01-02T12:00:00Z"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
payoutId
string
required

Response

200 - application/json

Payout returned

​
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