Skip to main content
GET
/
v1
/
payouts
/
search
cURL
curl --request GET \
  --url https://api.example.com/v1/payouts/search \
  --header 'Authorization: Bearer <token>'
{
  "payouts": [
    {
      "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>"
    }
  ],
  "total_count": 123,
  "has_more": true,
  "next_offset": 123
}

​
Payout Search API

This API allows you to search for payouts based on various criteria.

​
Endpoint

GET /v1/payouts/search

​
Query Parameters

NameTypeDescription
statusstringThe status of the payouts to filter by.
fromDatestringThe start date for the search range (ISO 8601 format).
toDatestringThe end date for the search range (ISO 8601 format).
limitintegerThe maximum number of results to return.

​
Responses

​
200 OK

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

​
400 Bad Request

{
  "error": "Invalid query parameters"
}

​
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.

Query Parameters

​
reference
string
​
destination_number
string
​
status
enum<string>[]
Available options:
pending,
processing,
completed,
failed,
cancelled
​
limit
integer
default:50

Response

200 - application/json

Payout founded

​
payouts
object[]
​
total_count
integer
​
has_more
boolean
​
next_offset
integer