Appearance
List queued scheduled payments​
GET
/v2/payments/collect/events
Requires COLLECTIONS_READ, granted by PAYMENTS_READ or COLLECTIONS_WRITE (bundles)
Returns payments waiting for their next scheduled payout run, newest first, across every payout schedule in your business.
Parameters​
Query Parameters
currency
Only include schedules that pay out in this currency. Use the upper-case code, e.g. USDC.
Type
string
Example
"USDC"limit
Maximum number of payments to return.
Type
integer
Example
50Default
50offset
Number of payments to skip, for paging.
Type
integer
Example
0Default
0Responses​
OK
application/json
JSON
{
"items": [
{
"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": null
}
],
"total": 1,
"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.