Sign in
Scheduled Payments

Create Scheduled Payment

Create a new scheduled transaction to be processed on a particular time depending on the frequency.

post/scheduled-payment

Response

Scheduled payment created successfully

Successboolean

Indicates whether the request was successful

ErrorMessagestring

Error message if the request failed

Amountnumber

The transaction amount

ScheduledPaymentsIDinteger

The ID of the created scheduled payment

Repeatsstring

The recurrence frequency

Intervalinteger

The interval in effect (1 if not specified)

ByDaystring

The weekday pin in effect (empty string if not specified)

Notesstring

Notes for the scheduled payment

ClientReferenceNumberstring

Client reference number

GLCodestring

General ledger code

StartDateTimestring date-time

The start date and time

Changes

No recorded changes to this endpoint across all 1 revision of this API.