VOvopay
EFT Endpoint

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.

post/eft/withdraw/schedule

Request

  • Base URL
    https://earthnode-dev.vopay.com/api/v2
  • URL
    https://earthnode-dev.vopay.com/api/v2/eft/withdraw/schedule
  • Auth
    none declared

Request body application/x-www-form-urlencoded

AccountIDstring required

Your account ID

Keystring required

API key for the account

Signaturestring required

Hashed signature for the request

ClientAccountIDstring

Client Account ID

Amountnumber required

The amount to schedule in the transactions

Frequencystring required

The frequency of the scheduled: single or recurring.

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

ScheduleStartDatestring required

Date from which the schedule will be started

ScheduleEndDatestring required

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

EndingAfterPaymentsinteger required

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

SemiMonthlyFrequencyTypeinteger

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

Descriptionstring required

Description of the schedule transaction

Notesstring

An optional note to associate with the transaction.

FirstNamestring required

Customer's first name

LastNamestring required

Customer's last name

CompanyNamestring required

Company's name

Address1string required

Customer's address line 1

Citystring required

Customer's city

Provincestring required

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

Countrystring required

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

PostalCodestring required

Customer's postal code.

AccountNumberstring required

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

FinancialInstitutionNumberstring required

Three digit institution number for a Canadian bank.

BranchTransitNumberstring required

Transit number for the customer's account.

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

ClientReferenceNumberstring

An optional reference number to associate with the transaction.

FlinksAccountIDstring

Used by clients with a Flinks account

FlinksLoginIDstring

Used by clients with a Flinks account

Tokenstring

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

PlaidPublicTokenstring

Used by clients with a Plaid account

PlaidAccessTokenstring

Used by clients with a Plaid account

PlaidAccountIDstring

Used by clients with a Plaid account

PlaidProcessorTokenstring

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

MxAuthorizationCodestring

Used by clients with an MX account.

InveriteRequestGUIDstring

Used by clients with an Inverite account

IdempotencyKeystring

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

Response

Successboolean required

True if the request was successful, false if it failed

ErrorMessagestring required

Contains a description of the error if the request failed

Amountnumber required

The dollar amount of the schedule transaction

ScheduledTransactionIDinteger required

ID of the schedule Transaction.

Frequencystring required

The frequency of the transaction

Descriptionstring required

Description of the schedule transaction

ScheduleStartDatestring date required

Date from which the transaction will be started

Statusstring required

A message indicating the current transaction status. Statuses are: cancelled, pending approval, completed or in progress

Example response

{
  "Success": true,
  "Frequency": "single",
  "ScheduleStartDate": "2020-01-01",
  "Status": "in progress"
}

Changes

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