List collection activity

GET

/v2/payments/collections/history

Requires COLLECTIONS_READ, granted by PAYMENTS_READ or COLLECTIONS_WRITE (bundles)

Returns one feed of payments received from payers and completed settlements of collected funds, newest first, across every account in your business. A status other than SETTLED leaves settlements out.

Parameters

Query Parameters

limit

Maximum number of entries to return.

Type

integer

Example50

Default

50

offset

Number of entries to skip, for paging.

Type

integer

Example0

Default

0

status

Settlement status of payments: PENDING, SETTLED or FAILED.

Type

string

Example"SETTLED"

from

Only include entries received at or after this time, in Unix milliseconds.

Type

integer

Example1792627200000

Format

"int64"

to

Only include entries received before this time, in Unix milliseconds.

Type

integer

Example1792713600000

Format

"int64"

minAmount

Smallest payment amount to include, as a decimal string.

Type

string

Example"100.00"

maxAmount

Largest payment amount to include, as a decimal string.

Type

string

Example"5000.00"

currency

Only include payments with this currency on any leg: deposit, conversion or payout.

Type

string

Example"ZAR"

reference

Payer reference, or part of one. Not case-sensitive.

Type

string

Example"VLR4F7K2"

query

Free-text search. A date (YYYY-MM-DD) matches that whole day, a number matches an exact amount, and anything else matches a currency or payer reference. Explicit filters take precedence.

Type

string

Example"2026-10-22"

tz

IANA time zone used to interpret a date in query, e.g. Africa/Johannesburg.

Type

string

Example"Africa/Johannesburg"

Responses

OK

Content-Type

application/json

{

"items": [

{

"kind": "SETTLEMENT",

"id": "c4e8a2f6-7b1d-4e3a-8c5f-9d0b1a2c3e4f",

"date": 1792684950000,

"status": "SETTLED",

"amount": "1240.75",

"currency": "USDC",

"convertedAmount": null,

"convertedCurrency": null,

"from": "Collections",

"to": "USDC Wallet",

"reference": "Settlement",

"paymentId": null,

"settlementId": "c4e8a2f6-7b1d-4e3a-8c5f-9d0b1a2c3e4f"

},

{

"kind": "PAYMENT",

"id": "8d2f4b6a-1c3e-4f5a-9b7d-2e4c6a8b0d1f",

"date": 1792660500000,

"status": "COMPLETED",

"amount": "1500.00",

"currency": "ZAR",

"convertedAmount": "82.45",

"convertedCurrency": "USDC",

"from": "Thandi Nkosi",

"to": "Collections",

"reference": "VLR4F7K2Q9",

"paymentId": "8d2f4b6a-1c3e-4f5a-9b7d-2e4c6a8b0d1f",

"settlementId": "c4e8a2f6-7b1d-4e3a-8c5f-9d0b1a2c3e4f"

}

],

"total": 2,

"limit": 50,

"offset": 0

}

Samples

Errors

HTTP	Error	When
400	BAD_REQUEST	A query parameter or field is invalid.
403	-16098PAYMENTS_USER_ACCESS_NOT_CONFIGURED	Payments haven't been set up for your business yet.
500	INTERNAL_ERROR	Unexpected error in the payments service.
502	-16097EXCHANGE_API_ERROR	The payments service failed to process the request.
502	EXCHANGE_API_ERROR	The payments service couldn't complete the request. Try again later.
503	-16099PAYMENTS_BACKEND_PROXY_DISABLED	Payments endpoints are temporarily unavailable.

Plus the errors common to all signed endpoints.