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

# bank-account

`GET /bank-account`

## Request

- Base URL: `https://earthnode-dev.vopay.com/api/v2`
- URL: `https://earthnode-dev.vopay.com/api/v2/bank-account`
- Auth: none declared

This endpoint retrieves a list of bank accounts associated with your VoPay account

## Query parameters

- `AccountID` string, required
- `Key` string, required
- `Signature` string, required
- `Token` string
- `ClientAccountID` string
- `ClientControlled` boolean
- `MasterAccountOnly` boolean
- `Limit ` integer
- `Offset ` integer
- `SearchText` string

## 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
  - `BankAccounts` object, required: Array serialized as a JSON object (JSON_FORCE_OBJECT): numeric string keys '0','1',... Empty {} when no items. Collection of the bank accounts belonging to the account or client account
    - `0` object
      - `AccountHolderName` string, required: Account Holder's name.
      - `InstitutionName` string, required: Financial institution name.
      - `FinancialInstituionNumber` string, required: Financial Instituion Number of the bank account.
      - `BranchTransitNumber` string, required: Branch Transit Number of the bank account
      - `AccountNumber` string, required: Masked account number of the bank account.
      - `Currency` string, required: Currency of bank account.
      - `Token` string, required: Bank account token.
      - `FlinksAccountID` string, required: Set for clients with a Flinks account
      - `FlinksLoginID` string, required: Set for clients with a Flinks account
      - `PlaidAccountID` string, required: Set for clients with a Plaid account
      - `InveriteRequestGUID` string, required: Used by clients with an Inverite account
      - `ClientControlledBankAccount` boolean, required: Set to 1 if the bank account is linked to your VoPay account
      - `IsDefault` boolean, required: Is this the VoPay account holder's default bank account
      - `ClientAccountID` string, required: ClientAccountID attached to the bank account.
      - `ClientReferenceNumber` string, required: ClientReferenceNumber attached to the bank account.
      - `Address` string, required: Civic address of the account holder.
      - `City` string, required: City of the account holder.
      - `Province` string, required: Province of the account holder.
      - `PostalCode` string, required: Postal Code of the account holder.
      - `Verified` boolean, required: Has the bank account been verified.
      - `ConnectionType` string, required: The bank account connection type. Possible values are: online, manual.
      - `DateAdded` string, date, required: Date the bank account was added
  - `Pagination` object: Pagination metadata
    - `TotalRecords` string, required: Total number of bank account records in that search range.
    - `Offset` string, required: Use this parameter to set the starting point in the dataset.
    - `Limit` string, required: Limit the number of records that are returned.

---

[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)