---
title: "bank-account/add"
method: POST
path: "/bank-account/add"
tags: ["Bank Account Endpoints"]
---

# bank-account/add

`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

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

## Request body `application/x-www-form-urlencoded`

- object
  - `AccountID` string, required: Your account ID
  - `Key` string, required: API key for the account
  - `Signature` string, required: Hashed signature for the request
  - `ClientAccountID` string: Client Account ID
  - `ContactID` string: Contact ID.
  - `AccountHolderName` string: String that defines the account holder name.
  - `AccountNumber` string: Customer's bank account number.
  - `FinancialInstitutionNumber` string: Three digit institution number for a Canadian bank account.
  - `BranchTransitNumber` string: Five digit branch transit number for a Canadian bank account.
  - `ABARoutingNumber` string: Nine digit ABA Routing number of a US bank account.
  - `IBAN` string: International Bank Account Number (IBAN) of a UK or European bank account. Can be used instead of the Canadian or US bank account details.
  - `SortCode` string: Sort code of a UK bank account. Digits only, maximum 6 characters.
  - `FlinksAccountID` string: Flinks Account ID. Must be accompanied by a FlinksLoginID. VoPay will fetch the associated bank account details from Flinks.
  - `FlinksLoginID` string: Flinks Login ID. Must be accompanied by a FlinksAccountID. VoPay will fetch the associated bank account details from Flinks.
  - `PlaidProcessorToken` string: Plaid Processor Token. VoPay will fetch the associated bank account details from Plaid.
  - `MxProcessorToken` string: Mx Processor Token. VoPay will fetch the associated bank account details from Mx.
  - `Currency` string: Three letter currency code.
  - `Address1` string: First line of the address. Ex: 123 Main St.
  - `City` string: City
  - `State` string: State
  - `ZipCode` string: Zip code
  - `Province` string: Province
  - `PostalCode` string: Postal code
  - `Country` string: Two letter country code.

## Response `200`

- object
  - `Success` boolean, required: True if the request was successful, false if it failed
  - `ErrorMessage` string, required: Contains a description of the error if the request failed

---

[API](https://skmtc.dev/vopay/apis/payment-methods.md) - [All operations](https://skmtc.dev/vopay/apis/payment-methods/llms.txt) - [OpenAPI document](https://skmtc.dev/vopay/apis/payment-methods/revisions/b566c8002410?raw)