API Reference

eft/withdraw/schedule

post
https://earthnode-dev.vopay.com/api/v2/eft/withdraw/schedule

This endpoint is used to create a scheduled transaction ahead of time that can be a single or recurring payment.

Either CompanyName OR FirstName and LastName must be provided.

If either Token, Flinks (FlinksAccountID, FlinksLoginID), Inverite (InveriteRequestGUID), or Plaid (PlaidPublicToken/PlaidAccessToken, PlaidAccountID) is provided, the FinancialInstitutionNumber, BranchTransitNumber, and AccountNumber will not be required.

If the bank information is provided (FinancialInstitutionNumber, BranchTransitNumber, and AccountNumber), then the Address1, City, Country, and PostalCode and Province are required.

If a ClientAccountID is provided, the client account's first/last name, address, and default bank account will be used for the transaction.

For additional details of the scheduled transactions, please visit https://docs.vopay.com/docs/schedule-a-payment.

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

string

Client Account ID

number
required

The amount to schedule in the transactions

string
required

The frequency of the scheduled: single or recurring.

string
required

Name of frequency of the scheduled transaction (Only for recurring option), the posibles values are: weekly, biweekly, semi-monthly, monthly, bimonthly, 3 months, 6 months, yearly.

string
required

Date from which the schedule will be started

string
required

Date when the transaction processing will end (Only for recurring option), Either provide ScheduleEndDate or EndingAfterPayments

integer
required

Number of payments after which the transaction processing will end (Only for recurring option), Either provide ScheduleEndDate or EndingAfterPayments

integer

Type of semi-monthly frequency. This field is only required when NameOfFrequency is set to semi-monthly. The possible values are: SemiMonthFirstAndFifteenth, SemiMonthFifteenthAndLast

string
required

Description of the schedule transaction

string

An optional note to associate with the transaction.

string
required

Customer's first name

string
required

Customer's last name

string
required

Company's name

string
required

Customer's address line 1

string
required

Customer's city

string
required

Customer's province specified using two character abbreviations (eg. BC, AB)

string
required

Customer's country specified using full country name or ISO 3166-1 alpha-2 code.

string
required

Customer's postal code.

string
required

Customer's bank account number for funds to be debited from.

string
required

Three digit institution number for a Canadian bank.

string
required

Transit number for the customer's account.

string
required

3 character currency code for the currency to fetch transactions for. If this is not specified the transaction will use the account's local currency.

string

An optional reference number to associate with the transaction.

string

Used by clients with a Flinks account

string

Used by clients with a Flinks account

string

Your iQ11 Token that has been generated using Custom Iframe. See iQ11 API Endpoints.

string

Used by clients with a Plaid account

string

Used by clients with a Plaid account

string

Used by clients with a Plaid account

string

Used by clients with a Plaid account. If you use this field PlaidPublicToken, PlaidAccessToken, and PlaidAccountID are not neccesary

string

Used by clients with an MX account.

string

Used by clients with an Inverite account

string

A unique key which the server can use to recognize and reject subsequent retries of the same request.

Response

Updated 3 months ago

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

Updated 3 months ago

Did this page help you?