API Reference

Create Scheduled Payment

post
https://earthnode-dev.vopay.com/api/v2/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. Only applies to daily, weekly, monthly, and annually. Defaults to 1.

string

Pins payments to a specific weekday. Only applies to weekly and monthly. For weekly, use a two-letter abbreviation: MO, TU, WE, TH, FR, SA, SU. For monthly, prefix with an ordinal (1–4) or -1 for last: 1MO, 3FR, -1FR. Example: Repeats=monthly with ByDay=3FR fires on the 3rd Friday of each month.

integer

The number of payments to process (required if Repeats is specified)

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

Updated 22 days ago

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

Updated 22 days ago