Appearance
List a payout run's payments​
GET
/v2/payments/collect/runs/{id}/payments
Requires COLLECTIONS_READ, granted by PAYMENTS_READ or COLLECTIONS_WRITE (bundles)
Returns the payments a scheduled payout run includes. An ID that isn't one of your business's runs returns an empty page.
Parameters​
Path Parameters
id*
Payout run ID.
Type
Requiredstring
Example
"c4e8a2f6-7b1d-4e3a-8c5f-9d0b1a2c3e4f"Format
"uuid"Query Parameters
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": "8d2f4b6a-1c3e-4f5a-9b7d-2e4c6a8b0d1f",
"depositId": "3f1c2a9e-8b4d-4c1e-9f2a-6d7e8b9c0a1b",
"status": "COMPLETED",
"mode": "SCHEDULED",
"type": "COLLECTION",
"inflowCurrency": "ZAR",
"inflowAmount": "1500.00",
"convertedCurrency": "USDC",
"convertedAmount": "82.45",
"outflowCurrency": "USDC",
"outflowAmount": "82.45",
"receivedAt": 1792660500000,
"settlementAt": 1792684950000,
"settlementStatus": "SETTLED",
"settlementRef": null,
"settlementId": "c4e8a2f6-7b1d-4e3a-8c5f-9d0b1a2c3e4f",
"linked": true,
"payerName": "Thandi Nkosi",
"reference": "VLR4F7K2Q9",
"timeline": null,
"payouts": null
}
],
"total": 23,
"limit": 1,
"offset": 0
}
Samples​
Errors
| HTTP | Error | When |
|---|---|---|
| 400 | BAD_REQUEST | A query parameter or field is invalid. |
| 400 | -11INVALID_REQUEST | The run ID isn't a valid UUID. |
| 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.