v1

latestOpenAPI 3.0.02026-07-2640301.0 MB

Bank Account Endpoints

bank-account

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

get/bank-account

Query parameters

AccountIDstring required

Your account ID

Keystring required

API key for the account

Signaturestring required

Hashed signature for the request

Tokenstring

When provided, this endpoint will only return the bank account associated with this token

ClientAccountIDstring

When provided, this endpoint will only return bank accounts associated with this Client Account ID

ClientControlledboolean

When set to true, this endpoint will only return bank accounts linked to your VoPay account. When set to false, it will return a list of your customer's bank accounts.

Limit integer

Limit the number of records that are returned.

Offset integer

Use this parameter to set the starting point in the dataset.

SearchTextstring

A text string to search for account holder name.

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,
  "BankAccounts": {
    "0": {
      "AccountHolderName": "John Smith",
      "InstitutionName": "CIBC",
      "FinancialInstituionNumber": "010",
      "BranchTransitNumber": "00390",
      "AccountNumber": "*****1234",
      "Currency": "CAD",
      "Token": "ACBDF-GAFSHD-AHBS-123456",
      "FlinksAccountID": "ACBDF-GAFSHD-AHBS-123456",
      "FlinksLoginID": "ACBDF-GAFSHD-AHBS-123456",
      "PlaidAccountID": "ACBDF-GAFSHD-AHBS-123456",
      "InveriteRequestGUID": "ACBDF-GAFSHD-AHBS-123456",
      "ClientControlledBankAccount": true,
      "IsDefault": true,
      "ClientAccountID": "ClientAccount1",
      "ClientReferenceNumber": "ABC123",
      "Address": "123 Fake st",
      "City": "Vancouver",
      "Province": "BC",
      "PostalCode": "A1A1A1",
      "Verified": true,
      "ConnectionType": "online",
      "DateAdded": "2019-11-03 01:00:00"
    }
  },
  "Pagination": {
    "TotalRecords": "1000",
    "Offset": "1000",
    "Limit": "1000"
  }
}