v1
latestOpenAPI 3.1.02026-07-2478315484.9 KBSchedules
List scheduled payments
Returns a paginated list of the scheduled payments belonging to a schedule, optionally filtered by status and due-date range.
get/schedules/v1/{schedule_id}/payments
Path parameters
schedule_idstring uuid required
The id of the schedule.
Query parameters
status'PLANNED' | 'SCHEDULED' | 'PROCESSING' | 'COMPLETED' | 'FAILED' | 'SKIPPED' | 'EXPIRED' | 'CANCELLED'
The lifecycle status of a scheduled payment.
- PLANNED — the payment has been planned but has not yet been scheduled for execution.
- SCHEDULED — the payment is scheduled and waiting to be attempted.
- PROCESSING — the payment is currently being attempted.
- COMPLETED — the payment completed successfully.
- FAILED — the payment reached a failed terminal state.
- SKIPPED — the payment was skipped and will not be attempted.
- EXPIRED — the payment expired before completion.
- CANCELLED — the payment was cancelled before completion.
Filter scheduled payments by status.
fromDatestring date
Only return scheduled payments due on or after this date (inclusive).
toDatestring date
Only return scheduled payments due on or before this date (inclusive).
pageinteger
The page you're requesting - returns page 0 of a response if not specified.
sizeinteger
The number of objects you want to return as a page size.
Response
A paginated list of scheduled payments.