Sign in

v1

latestOpenAPI 3.1.02026-07-2478315484.9 KB
Schedules

Get scheduled payment details

Returns the current view of a single scheduled payment, including its identity within the schedule, due date, amount, reference, status and number of recorded attempts.

get/schedules/v1/{schedule_id}/payments/{scheduled_payment_id}

Path parameters

schedule_idstring uuid required

The id of the schedule.

scheduled_payment_idstring uuid required

The id of the scheduled payment.

Response

The scheduled payment details.

scheduled_payment_idstring uuid required

The id of the scheduled payment.

schedule_idstring uuid required

The id of the schedule this payment belongs to.

occurrence_indexinteger required

The zero-based index of this payment within the schedule.

due_datestring date required

The date the payment is due to be executed.

referencestring nullable required

The reference applied to the payment, when set.

status'PLANNED' | 'SCHEDULED' | 'PROCESSING' | 'COMPLETED' | 'FAILED' | 'SKIPPED' | 'EXPIRED' | 'CANCELLED' required

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.
attempt_countinteger required

The number of execution attempts made for this payment.

created_atstring date-time required

The date and time the scheduled payment was created.

updated_atstring date-time nullable required

The date and time the scheduled payment was last updated.