Create Scheduled Payment

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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Form Data
string
required

Your account ID

string
required

API key for the account

string
required

Hashed signature for the request

number
required

The transaction amount

string
required

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

string
required

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

string
required

The payment rail to use for the transaction

date-time
required

The start date and time for the scheduled payment

string
required

The payment token for the transaction

string
enum

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).

integer
1 to 365
Defaults to 1

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.

string

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.

integer

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.

date

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.

string

Client reference number for the transaction

string

Additional notes for the scheduled payment

string

General ledger code for accounting purposes

string

The client account ID for the transaction

Response

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json