Sign in

v1

latestOpenAPI 3.0.1MIT2026-07-26294473.4 KB

Query all payments with filtering, sorting, and pagination capabilities

get/payments/all

Query parameters

startDatestring date

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

endDatestring date

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

status'SUCCESS' | 'SETTLED' | 'PROCESSING' | 'PENDING' | 'FAILED'

Payment status filter

collectedCurrencystring

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

channelstring

Payment channel filter

orderReferencestring

Order reference filter

clientIdstring

Client ID filter

sortBystring

Field to sort by (default: createdAt). All response fields are sortable including customer 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 payments response

totalCountinteger

Total number of payments matching the query criteria

Example response

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