Appearance
List payout schedules​
GET
/v2/payments/collect/schedules
Requires COLLECTIONS_READ, granted by PAYMENTS_READ or COLLECTIONS_WRITE (bundles)
Returns every payout schedule set up for your business, including inactive ones. Schedules are managed by VALR.
Responses​
OK
application/json
JSON
[
{
"id": "1a7c3e5b-9d2f-4b6a-8e0c-2f4a6b8d0e1c",
"currency": "USDC",
"kind": "CRYPTO",
"intervalType": "DAILY",
"timeOfDay": "18:00",
"zoneId": "Africa/Johannesburg",
"dayOfWeek": null,
"cutoffMinutes": 120,
"paymentInstrumentId": "e2a4c6b8-0d1f-4e3a-b5c7-9d1e3f5a7b9c",
"isActive": true,
"createdAt": 1790848800000,
"updatedAt": 1792067400000
}
]
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.