Bank Account Endpoints

bank-account/add

This endpoint allows you to add a bank account to your VoPay account

post/bank-account/add

Request

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

Contact ID.

AccountHolderNamestring

String that defines the account holder name.

AccountNumberstring

Customer's bank account number.

FinancialInstitutionNumberstring

Three digit institution number for a Canadian bank account.

BranchTransitNumberstring

Five digit branch transit number for a Canadian bank account.

ABARoutingNumberstring

Nine digit ABA Routing number of a US bank account.

IBANstring

International Bank Account Number (IBAN) of a UK or European bank account. Can be used instead of the Canadian or US bank account details.

SortCodestring

Sort code of a UK bank account. Digits only, maximum 6 characters.

FlinksAccountIDstring

Flinks Account ID. Must be accompanied by a FlinksLoginID. VoPay will fetch the associated bank account details from Flinks.

FlinksLoginIDstring

Flinks Login ID. Must be accompanied by a FlinksAccountID. VoPay will fetch the associated bank account details from Flinks.

PlaidProcessorTokenstring

Plaid Processor Token. VoPay will fetch the associated bank account details from Plaid.

MxProcessorTokenstring

Mx Processor Token. VoPay will fetch the associated bank account details from Mx.

Currencystring

Three letter currency code.

Address1string

First line of the address. Ex: 123 Main St.

Citystring

City

Statestring

State

ZipCodestring

Zip code

Provincestring

Province

PostalCodestring

Postal code

Countrystring

Two letter country 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

Example response

{
  "Success": true
}

Changes

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