Sign in

v1

latestOpenAPI 3.0.02026-07-2671142187.3 KB
Customer

Get customer bank accounts.

get/customers/{customerId}/bank-accounts

Path parameters

customerIdinteger required

The ID of the customer

Query parameters

bankTokenstring

The bank account token.

verifiednumber

If the bank account is verified or not. Use 1 or 0.

readynumber

If the bank account is verified or not. Use 1 or 0.

Response

Successful

idinteger

The id of the bank account.

customerIdinteger

The id of the customer owning the bank account.

dateCreatedstring

The date when the bank account is created.

dateUpdatedstring

The date when the bank account last got updated.

dateLastUsedstring

The date when the bank account last got used.

dateVerifiedstring

The date when the bank account is verified.

bankTokenstring

The token of the bank account.

accountTypestring

The type of the bank account, such as CHECKING | SAVINGS.

accountCorporatestring

The corporate type of the bank account, such as PERSONAL | CORPORATE.

verifiedstring

Verified status of the bank account, 1|0.

readystring

Ready status of the bank account, 1|0.

bankIdNumberstring

The institution number of Canadian Bank Account that identifies the bank.

transitNumberstring

The transit number of Canadian Bank Account. Shows which branch you opened your account at.

routingNumberstring

The routing number of US Bank Account. Identifies the financial institution on which it was drawn.

bankAccountNumberL4string

Last 4 digits of the bank account number.

Example response

[
  {
    "id": 12312,
    "customerId": 2222,
    "dateCreated": "2025-01-30 13:35:36",
    "dateUpdated": "2025-01-30 13:35:36",
    "dateLastUsed": "2025-01-30 13:35:36",
    "dateVerified": "2025-01-30 13:35:36",
    "bankToken": "JHKJHKLKJLOHKJ876545KJBK",
    "accountType": "CHECKING",
    "accountCorporate": "PERSONAL",
    "bankIdNumber": "333",
    "transitNumber": "55555",
    "routingNumber": "999999999",
    "bankAccountNumberL4": "9999",
    "address": {
      "name": "John Smith/Helcim",
      "street1": "123 Street",
      "city": "Calgary",
      "province": "AB",
      "country": "CAN",
      "postalCode": "H0H0H0",
      "phone": "1234567890",
      "email": "john@example.com"
    }
  }
]