Sign in

v1

latestOpenAPI 3.0.1MIT2026-07-26294473.4 KB

Query all payouts with filtering, sorting, and pagination capabilities

get/payouts/all

Query parameters

startDatestring date

Start date for filtering payouts . Accepted formats : YYYY-MM-DD or DD-MM-YYYY

endDatestring date

End date for filtering payouts . Accepted formats : YYYY-MM-DD or DD-MM-YYYY

channel'BANK TRANSFER' | 'MOBILE MONEY'

Payout channel filter

currencystring

Currency filter (e.g., TZS, USD)

orderReferencestring

Order reference filter

status'SUCCESS' | 'PROCESSING' | 'PENDING' | 'FAILED' | 'REFUNDED' | 'REVERSED'

Payout status filter

transferType'ACH' | 'RTGS'

Settlement type filter

clientIdstring

Client ID filter

sortBystring

Field to sort by (default: createdAt). All response fields are sortable including beneficiary fields

orderBy'ASC' | 'DESC'

Sort order (default: DESC)

skipinteger

Number of records to skip for pagination

limitinteger

Number of records to return

Response

Query all payouts response

totalCountinteger

Total number of payouts matching the query criteria

Example response

{
  "data": [
    {
      "exchanged": true,
      "exchange": {
        "sourceCurrency": "USD",
        "targetCurrency": "TZS",
        "sourceAmount": 1000,
        "rate": 2500
      }
    }
  ]
}