Look up bank account details

curl --request POST \ --url https://sandbox.nmbr.co/services/payroll/bank_accounts/lookup \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "institution_number": "001", "transit_number": "00011" } '

{ "object": "bank_account_lookup", "data": { "warnings": { "object": "list", "data": [] }, "institution_name": "Bank of Montreal", "institution_name_translations": { "en": "Bank of Montreal", "fr": "Banque de Montréal" }, "institution_name_translated": "Bank of Montreal", "transit_address": "Montreal (Succ. Principale), 119 rue Saint-Jacques, Montreal, QC H2Y 1L6" } }

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

institution_number

string

The institution number to look up. Optional.

transit_number

string

The transit number to look up. Optional.

account_number

string

The account number to validate. Optional.

Response

200 - application/json

string

read-only

The unique identifier of the object in Nmbr.

object

string

read-only

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

data

Bank Account Lookup · object

Hide child attributes

data.warnings

object

A collection of advisory warnings for the submitted account, in the same shape as the warnings on a bank account.

Hide child attributes

data.warnings.object

string | null

data.warnings.data

object

data.institution_name

string | null

The name of the banking institution matching the submitted institution number, or null if it was not provided or not recognized. Always the English name; see institution_name_translated for the value in the request's locale.

data.institution_name_translations

object

Hide child attributes

data.institution_name_translations.en

string | null

data.institution_name_translations.fr

string | null

data.institution_name_translated

string

read-only

The translation of the institution_name property for the request locale. Computed using the values in institution_name and institution_name_translations and the value of the request's Accept-Language header.

data.transit_address

string | null

The address of the branch matching the submitted institution and transit numbers, or null if either was not provided or the pair is not recognized.