Sign in

v1

latestOpenAPI 3.0.02026-07-2671142187.3 KB
Customer

Create a bank account.

post/customers/{customerId}/bank-accounts

Path parameters

customerIdnumber required

Customer ID.

Request body

accountCorporate1 | 2 required

The bank account type:

  • 1 - Personal
  • 2 - Corporate
accountType1 | 2 required

The bank account type:

  • 1 - Checking
  • 2 - Savings
bankAccountNumberstring required

7-12 digits for Canadian bank accounts and 8-12 for US bank accounts.

bankFinancialNumberstring

This 3 digit number is needed for Canadian bank accounts.

bankRoutingNumberstring

This 9 digit number is needed for US bank accounts.

bankTransitNumberstring

This 5 digit number is needed for Canadian bank accounts.

citystring required
countryAlpha2string required

Country name in ISO2 format, e.g "CA", "US"

firstNamestring

Either first and last name or company name need to be specified.

lastNamestring

Either first and last name or company name need to be specified.

companyNamestring

Either first and last name or company name need to be specified.

postalCodestring required
provinceAlpha2string required

Province/State name in ISO2 format, e.g "AB", "ON"

streetAddressstring required

Example request

{
  "accountCorporate": 1,
  "accountType": 2,
  "bankAccountNumber": "123456789",
  "bankFinancialNumber": "123",
  "bankTransitNumber": "12345",
  "city": "Calgary",
  "countryAlpha2": "CA",
  "firstName": "John",
  "lastName": "Doe",
  "postalCode": "T2P5E9",
  "provinceAlpha2": "AB",
  "streetAddress": "440 2 Ave SW"
}

Response

Successfully created new bank account. A bank authorization was also emailed to the customer.

Example response

{
  "data": {
    "message": "Successfully created new bank account with ID #12345. A bank authorization email was also emailed to customer@helcim.com.",
    "bankAccount": {
      "id": 12345
    }
  }
}