Bank Accounts

Look up bank account details

Changed on
post/bank_accounts/lookup

Request

  • Base URL
    https://sandbox.nmbr.co/services/payroll
  • Auth
    HTTP bearer

Request body

institution_numberstring

The 3-digit institution number to look up. Optional.

transit_numberstring

The 5-digit transit number to look up. Optional. Resolves a branch address only when sent alongside a recognised institution number.

account_numberstring

The account number to validate. Optional. Checked against the check-digit rules published for the given institution.

transaction_type'credit' | 'debit'

How the account will be used. Optional, defaults to credit. Send credit for an account that receives payments, such as an employee's or contractor's, and debit for an account that payroll is funded from, such as a business's. Some institutions have account numbers that accept credits only, which warn as invalid for debit.

Response

OK

idstring

The unique identifier of the object in Nmbr.

objectstring

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

Changes