VOvopay
EFT Endpoint

eft/withdraw

This endpoint is used to take funds out of your VoPay account, and deposit them to the specified recipient's bank account. In the below endpoint, either CompanyName OR FirstName and LastName must be provided.

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

If the bank information is provided (FinancialInstitutionNumber, BranchTransitNumber, and AccountNumber), then the Address1, City, Province, Country, and PostalCode 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.

post/eft/withdraw

Request

  • Base URL
    https://earthnode-dev.vopay.com/api/v2
  • URL
    https://earthnode-dev.vopay.com/api/v2/eft/withdraw
  • 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

ContactIDstring

The ID of the contact to use for this transactions. The contacts payment method associated with this transaction type will be used.

FirstNamestring required

Recipient's first name

LastNamestring required

Recipient's last name

CompanyNamestring required

Company's name

Address1string required

Recipient's address line 1

Citystring required

Recipient's city

Provincestring required

Recipient's province specified using two character abbreviation (eg. BC, AB)

Countrystring required

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

PostalCodestring required

Recipient's postal code.

AccountNumberstring required

Recipient's bank account number. This is the account that funds will be deposited into.

FinancialInstitutionNumberstring required

Canadian banks. Three digit institution number.

BranchTransitNumberstring required

Canadian banks. Transit number for the Recipient's account.

Amountnumber required

The amount in the specified currency to deposit into the recipient's bank 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. NOTE: Currently the eft/withdraw API endpoint only supports CAD and USD transactions

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

ParentTransactionIDstring

The parent transaction where the withdrawal will be linked to, can become a split payment with multiple withdrawals. When funds of the parent transaction have been released the system will generate the distributions of these funds automatically.

TransactionTypeCodestring

CPA transaction code. Use the /api/v2/account/transactions/codes endpoint to retrieve a list of valid transaction codes. If not specified, the transaction will be created using code 450 (miscellaneous).

TransactionLabelstring

TransactionLabel overrides originator short name

Notesstring

An optional note to associate with the transaction.

IdempotencyKeystring

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

GLCodestring

An optional unique identification general ledger code.

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

TransactionIDinteger required

The unique ID of the transaction that was just performed. This ID should be saved as it is required in order to look up status information on the transaction.

Flaggedstring

Details on why the transaction was flagged, if applicable. Flagged transactions will need to be confirmed by using the /account/transaction/confirm endpoint.

Example response

{
  "Success": true,
  "Flagged": "The transaction has been flagged as a potential duplicate."
}

Changes

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