Sign in

v1

latestOpenAPI 3.0.02026-07-2640301.0 MB
Bank Account Endpoints

bank-account/default-bank-account

This endpoint retrieves the default bank account associated with your VoPay account

get/bank-account/default-bank-account

Query parameters

AccountIDstring required

Your account ID

Keystring required

API key for the account

Signaturestring required

Hashed signature for the request

ClientAccountIDstring

When provided, this endpoint will return the default bank account associated with this Client Account ID

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,
  "DefaultOperationalBankAccount": {
    "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",
      "DateAdded": "2019-11-03 01:00:00"
    }
  },
  "DefaultBillingBankAccount": {
    "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",
      "DateAdded": "2019-11-03 01:00:00"
    }
  }
}