Create Scheduled Payment

Your account ID

API key for the account

Hashed signature for the request

The transaction amount

The currency code (e.g., USD, CAD)

The type of payment (e.g., debit, credit)

The payment rail to use for the transaction

The start date and time for the scheduled payment

The payment token for the transaction

The recurrence frequency. Omit for a one-time payment. Accepted values: daily, weekly, bi-weekly, monthly, semi-monthly (15th and last day of month), quarterly, semi-annually, annually, weekdays (Mon–Fri).

How many units to advance per period. For example, Repeats=weekly with Interval=2 fires every other week. Must be a whole number from 1 to 365. Only applies to daily, weekly, monthly, and annually — for bi-weekly, semi-monthly, quarterly, semi-annually, and weekdays the interval is fixed and this value is ignored. Interval never affects the first payment date. Defaults to 1 when omitted.

Pins payments to specific weekdays. Only applies to Repeats weekly or monthly. For weekly, provide one weekday abbreviation or a comma-separated list of them — MO, TU, WE, TH, FR, SA, SU (e.g. FR, or MO,WE,FR); each weekday may appear at most once. For monthly, provide exactly one value with a mandatory ordinal prefix, 1–4 or -1 for last (e.g. 1MO, 3FR, -1FR); comma-separated lists are not accepted for monthly. Input is case-insensitive; for weekly, whitespace around each entry is ignored, but a monthly value must have no surrounding whitespace. The stored and echoed value is canonicalized — uppercased and, for weekly, re-ordered into calendar order starting Monday — so ByDay=FR,MO is returned as MO,FR. A weekday repeated within one value is rejected rather than de-duplicated. Weeks run Monday to Sunday: the first payment is the earliest selected weekday on or after StartDateTime, so a schedule starting on a Thursday with ByDay=MO,WE,FR fires only on the Friday of its first week.

The number of payments to process. Required if Repeats is specified and EndDate is omitted. When both NumberOfPayments and EndDate are provided, NumberOfPayments takes precedence and the end date is derived from it.

The last date of the schedule in YYYY-MM-DD format (inclusive: a payment landing on this date still runs). Alternative to NumberOfPayments for recurring schedules — the number of payments is derived from StartDateTime, Repeats and EndDate. Ignored for one-time payments and when NumberOfPayments is provided.

Client reference number for the transaction

Additional notes for the scheduled payment

General ledger code for accounting purposes

The client account ID for the transaction

Indicates whether the request was successful

Error message if the request failed

The transaction amount

The ID of the created scheduled payment

The recurrence frequency

The interval in effect (1 if not specified). Only meaningful for daily, weekly, monthly, and annually; ignored for the fixed frequencies.

The weekday pin in effect, in canonical form — uppercased and, for weekly, re-ordered into calendar order starting Monday (so a request of FR,MO is echoed as MO,FR). Empty string if not specified.

Notes for the scheduled payment

Client reference number

General ledger code

The start date and time

The date of the final payment in YYYY-MM-DD format. Always set: derived from NumberOfPayments when EndDate was not provided, and equal to the payment date for one-time payments.

The total number of payments in the schedule. Always set: derived from EndDate when NumberOfPayments was not provided, and 1 for one-time payments.