API referencePayout schedules

List payout schedules

GET
/api/b/v1/payout-schedules

Authorization

OAuth2PasswordBearer
AuthorizationBearer <token>

In: header

Query Parameters

include_ended?Include Ended
Defaultfalse
admin_access_token?string|null

Response Body

application/json

application/json

curl -X GET "https://example.com/api/b/v1/payout-schedules"
{  "schedules": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "name": "string",      "currency": "string",      "cadence": "daily",      "status": "active",      "day_of_month": 0,      "day_of_week": 0,      "run_hour": 0,      "run_minute": 0,      "timezone": "string",      "line_count": 0,      "total_minor": 158000000,      "next_run_at": "2019-08-24T14:15:22Z",      "last_run_at": "2019-08-24T14:15:22Z",      "ends_at": "2019-08-24T14:15:22Z",      "created_at": "2019-08-24T14:15:22Z"    }  ]}

Cancel a batch POST

Previous Page

Create a payout schedule POST

Set up a recurring run. Nothing is validated against a rail here — the lines are checked when each occurrence materialises, so a beneficiary blocked after the schedule was created is caught on the run rather than being paid on stale information.