Bank Accounts

Create a bank account

post/bank_accounts

Request body

employee_idstring

Must be present when contractor_id and business_entity_id is either empty or not set.

contractor_idstring

Must be present when employee_id and business_entity_id is either empty or not set.

business_entity_idstring

Must be present when employee_id and contractor_id is either empty or not set.

account_numberstring required

The bank account number. 1 to 12 digits, sent as a string. An account number that fails its institution's check-digit rules raises a bank_account_invalid_account warning rather than failing the request, so a successful response is not confirmation the account is valid. Validate details first with POST /bank_accounts/lookup.

transit_numberstring required

The 5-digit bank transit number. A transit that is not a known branch of the given institution raises a bank_account_unrecognized_transit warning rather than failing the request.

institution_numberstring required

The 3-digit bank institution number. An institution Nmbr does not hold raises a bank_account_unrecognized_institution warning rather than failing the request.

namestring nullable

An optional human-readable label for the bank account, such as "Main chequing". Useful for distinguishing accounts at the same institution.

is_primaryboolean

Whether this is the primary bank account for its owner.

Indicates that this bank account is the primary bank account. Optional. Cannot be set to false is there is no other bank account for the same employee, contractor or business entity.

pad_signer_namestring nullable

The name of the person who signed the PAD agreement. Only applicable to Business Entity bank accounts.

pad_signer_emailstring

The email address of the PAD agreement signer. Only applicable to Business Entity bank accounts.

pad_signer_titlestring nullable

The title or role of the PAD agreement signer. Only applicable to Business Entity bank accounts.

pad_signed_atstring date

The date and time the PAD agreement was signed. Only applicable to Business Entity bank accounts.

pad_filestring

Response

Created

idstring

The unique identifier of the object in Nmbr.

objectstring

The type of the object in Nmbr ("bank_account").

Changes