Create a bank account.

post

https://api.helcim.com/v2/customers/{customerId}/bank-accounts

Path Params

customerId

number

required

Customer ID.

Body Params

Bank information.

accountCorporate

int8

enum

required

The bank account type:

1 - Personal
2 - Corporate

Allowed:

accountType

int8

enum

required

The bank account type:

1 - Checking
2 - Savings

Allowed:

bankAccountNumber

string

required

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

bankFinancialNumber

string

This 3 digit number is needed for Canadian bank accounts.

bankRoutingNumber

string

This 9 digit number is needed for US bank accounts.

bankTransitNumber

string

This 5 digit number is needed for Canadian bank accounts.

city

string

required

countryAlpha2

string

required

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

firstName

string

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

lastName

string

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

companyName

string

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

postalCode

string

required

provinceAlpha2

string

required

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

streetAddress

string

required

Responses

403

User does not have valid permissions.

500

Unexpected internal error.

Language

Credentials

Header

URL

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

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

400Invalid request.