Appearance
Get upcoming scheduled payouts​
GET
/v2/payments/collect/upcoming
Requires COLLECTIONS_READ, granted by PAYMENTS_READ or COLLECTIONS_WRITE (bundles)
Returns one entry per active payout schedule in your business, with the next run time, its cut-off and the total queued so far. A schedule with nothing queued shows a zero total and no run times.
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"Responses​
OK
application/json
JSON
[
{
"scheduleId": "1a7c3e5b-9d2f-4b6a-8e0c-2f4a6b8d0e1c",
"currency": "USDC",
"nextRunAt": 1792771200000,
"cutoffAt": 1792764000000,
"totalAmount": "54.20",
"eventCount": 1
}
]
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.