Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

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

Query Parameters

startDate
string<date>

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

endDate
string<date>

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

status
enum<string>

Payment status filter

Available options:
SUCCESS,
SETTLED,
PROCESSING,
PENDING,
FAILED
collectedCurrency
string

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

channel
string

Payment channel filter

orderReference
string

Order reference filter

clientId
string

Client ID filter

sortBy
string

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

orderBy
enum<string>
default:DESC

Sort order (default: DESC)

Available options:
ASC,
DESC
skip
integer
default:0

Number of records to skip for pagination

Required range: x >= 0
limit
integer
default:20

Number of records to return

Required range: x >= 1

Response

Query all payments response

data
object[]

Array of payment records

totalCount
integer

Total number of payments matching the query criteria