Get a scheduled payment

GET

/v2/payments/collect/events/{id}

Requires COLLECTIONS_READ, granted by PAYMENTS_READ or COLLECTIONS_WRITE (bundles)

Returns one payment on a payout schedule, with the deposit it came from and its timeline. It must be on one of your business's payout schedules.

Parameters

Path Parameters

id*

Scheduled payment ID, from List queued scheduled payments or List processed scheduled payments.

Type

string

Required

Example"6b0d2f4a-8c1e-4a3b-9d5f-7e9a1b3c5d7e"

Format

"uuid"

Responses

OK

Content-Type

application/json

{

"id": "6b0d2f4a-8c1e-4a3b-9d5f-7e9a1b3c5d7e",

"withdrawalCurrency": "USDC",

"withdrawalAmount": "54.20",

"receivedAt": 1792744300000,

"status": "SCHEDULED",

"depositCurrency": "ZAR",

"depositAmount": "985.00",

"payerName": "Sipho Dlamini",

"reference": "VLR8M3N6P1",

"timeline": [

{

"type": "CONVERSION",

"label": "Converted to 54.20 USDC",

"status": "COMPLETE",

"data": {

"fromCurrency": "ZAR",

"fromAmount": "985.00",

"toCurrency": "USDC",

"toAmount": "54.20",

"rate": "18.1734",

"conversionId": "d1f3b5a7-9e2c-4d6f-8a0b-5c7e9f1a3b6d"

},

"traceId": "d1f3b5a7-9e2c-4d6f-8a0b-5c7e9f1a3b6d",

"at": 1792744270000

},

{

"type": "SETTLEMENT",

"label": "Settlement pending",

"status": "PENDING",

"data": {

"currency": "USDC",

"amount": "54.20",

"scheduledFor": "2026-10-23T16:00:00Z"

},

"traceId": null,

"at": 1792771200000

}

]

}

Samples

Errors

HTTP	Error	When
400	BAD_REQUEST	A query parameter or field is invalid.
400	-11INVALID_REQUEST	The scheduled payment ID isn't a valid UUID.
403	-16098PAYMENTS_USER_ACCESS_NOT_CONFIGURED	Payments haven't been set up for your business yet.
404	NOT_FOUND	No scheduled payment with this ID exists on your business's payout schedules.
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.