Sign in

v1

latestOpenAPI 3.0.02026-07-2640301.0 MB
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

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"
}