Sign in
Bank Accounts

Update a bank account

put/bank_accounts/{bank_account}

Path parameters

bank_accountstring required

Request body

account_numberstring
transit_numberstring

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

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. To set a primary bank account as not primary, set another account as primary.

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

OK

idstring

The unique identifier of the object in Nmbr.

objectstring

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

Changes