Sign in
Schedules

Register a schedule

Registers a new schedule (recurring or explicit) against an existing, authorized consent.

post/schedules/v1

Headers

Idempotency-Keystring required

Unique key used to ensure idempotency of requests. Must be unique per operation.

Request body

referencestring nullable

A default reference applied to payments created by this schedule.

purposestring nullable

The payment purpose code applied to payments created by this schedule. Optional; omit when not applicable.

consent_idstring uuid required

The id of the authorized consent the schedule is registered against.

Response

The schedule was registered.

schedule_idstring uuid required

The id of the newly registered schedule.

consent_idstring uuid required

The id of the consent the schedule was registered against.

status'PENDING' | 'ACTIVE' | 'PAUSED' | 'CONSENT_BLOCKED' | 'CANCELLED' | 'COMPLETED' required

The lifecycle status of a schedule.

  • PENDING — registered, not yet active.
  • ACTIVE — active; payments are attempted on their due dates.
  • PAUSED — temporarily paused; no payments attempted until resumed.
  • CONSENT_BLOCKED — the underlying consent is no longer usable.
  • CANCELLED — terminated by the client or due to consent state.
  • COMPLETED — all planned payments have been executed.

Changes