Update a bank account

curl --request PUT \
  --url https://sandbox.nmbr.co/services/payroll/bank_accounts/{bank_account} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "account_number": "3654916",
  "transit_number": "02002",
  "institution_number": "320"
}
'

import requests

url = "https://sandbox.nmbr.co/services/payroll/bank_accounts/{bank_account}"

payload = {
    "account_number": "3654916",
    "transit_number": "02002",
    "institution_number": "320"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({account_number: '3654916', transit_number: '02002', institution_number: '320'})
};

fetch('https://sandbox.nmbr.co/services/payroll/bank_accounts/{bank_account}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sandbox.nmbr.co/services/payroll/bank_accounts/{bank_account}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'account_number' => '3654916',
    'transit_number' => '02002',
    'institution_number' => '320'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://sandbox.nmbr.co/services/payroll/bank_accounts/{bank_account}"

	payload := strings.NewReader("{\n  \"account_number\": \"3654916\",\n  \"transit_number\": \"02002\",\n  \"institution_number\": \"320\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://sandbox.nmbr.co/services/payroll/bank_accounts/{bank_account}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"account_number\": \"3654916\",\n  \"transit_number\": \"02002\",\n  \"institution_number\": \"320\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandbox.nmbr.co/services/payroll/bank_accounts/{bank_account}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"account_number\": \"3654916\",\n  \"transit_number\": \"02002\",\n  \"institution_number\": \"320\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<id>",
  "object": "bank_account",
  "data": {
    "business_entity": {
      "id": "<id>",
      "object": "business_entity",
      "links": {
        "self": "/business_entities/<id>"
      }
    },
    "name": null,
    "institution_number": "320",
    "institution_name": "President's Choice Bank",
    "institution_name_translations": {
      "en": "President's Choice Bank",
      "fr": "Banque le Choix du Président"
    },
    "institution_name_translated": "President's Choice Bank",
    "transit_number": "02002",
    "transit_address": "600-500 Lakeshore Blvd West POBOX600, Toronto, ON M5V 2V9",
    "account_number_last_3": "916",
    "is_primary": false,
    "is_deletable": true,
    "warnings": {
      "object": "list",
      "data": []
    },
    "is_pad_signed": false,
    "pad_signer_name": null,
    "pad_signer_email": null,
    "pad_signer_title": null,
    "pad_signed_at": null,
    "pad_file": null,
    "created_at": "2026-01-01T00:00:00.000000Z",
    "updated_at": "2026-01-01T00:00:00.000000Z"
  },
  "links": {
    "self": "/bank_accounts/<id>"
  }
}

PUT

bank_accounts

{bank_account}

Update a bank account

curl --request PUT \
  --url https://sandbox.nmbr.co/services/payroll/bank_accounts/{bank_account} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "account_number": "3654916",
  "transit_number": "02002",
  "institution_number": "320"
}
'

import requests

url = "https://sandbox.nmbr.co/services/payroll/bank_accounts/{bank_account}"

payload = {
    "account_number": "3654916",
    "transit_number": "02002",
    "institution_number": "320"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({account_number: '3654916', transit_number: '02002', institution_number: '320'})
};

fetch('https://sandbox.nmbr.co/services/payroll/bank_accounts/{bank_account}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sandbox.nmbr.co/services/payroll/bank_accounts/{bank_account}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'account_number' => '3654916',
    'transit_number' => '02002',
    'institution_number' => '320'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://sandbox.nmbr.co/services/payroll/bank_accounts/{bank_account}"

	payload := strings.NewReader("{\n  \"account_number\": \"3654916\",\n  \"transit_number\": \"02002\",\n  \"institution_number\": \"320\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://sandbox.nmbr.co/services/payroll/bank_accounts/{bank_account}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"account_number\": \"3654916\",\n  \"transit_number\": \"02002\",\n  \"institution_number\": \"320\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandbox.nmbr.co/services/payroll/bank_accounts/{bank_account}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"account_number\": \"3654916\",\n  \"transit_number\": \"02002\",\n  \"institution_number\": \"320\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<id>",
  "object": "bank_account",
  "data": {
    "business_entity": {
      "id": "<id>",
      "object": "business_entity",
      "links": {
        "self": "/business_entities/<id>"
      }
    },
    "name": null,
    "institution_number": "320",
    "institution_name": "President's Choice Bank",
    "institution_name_translations": {
      "en": "President's Choice Bank",
      "fr": "Banque le Choix du Président"
    },
    "institution_name_translated": "President's Choice Bank",
    "transit_number": "02002",
    "transit_address": "600-500 Lakeshore Blvd West POBOX600, Toronto, ON M5V 2V9",
    "account_number_last_3": "916",
    "is_primary": false,
    "is_deletable": true,
    "warnings": {
      "object": "list",
      "data": []
    },
    "is_pad_signed": false,
    "pad_signer_name": null,
    "pad_signer_email": null,
    "pad_signer_title": null,
    "pad_signed_at": null,
    "pad_file": null,
    "created_at": "2026-01-01T00:00:00.000000Z",
    "updated_at": "2026-01-01T00:00:00.000000Z"
  },
  "links": {
    "self": "/bank_accounts/<id>"
  }
}

Authorizations

Authorization

string

header

required

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

Path Parameters

bank_account

string

required

Body

application/json

account_number

string

transit_number

string

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_number

string

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

name

string | null

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

Maximum string length: 255

is_primary

boolean

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_name

string | null

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

pad_signer_email

string

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

pad_signer_title

string | null

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

pad_signed_at

string<date>

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

pad_file

string

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").

data

Bank Account · object

Hide child attributes

data.business_entity

object

The Business Entity that owns this bank account. Present only for Business Entity bank accounts.

Hide child attributes

data.business_entity.id

string

read-only

The unique identifier of the object in Nmbr.

data.business_entity.object

string

read-only

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

data.name

string | null

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

Maximum string length: 255

data.institution_number

string

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

data.institution_name

string | null

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

data.institution_name_translations

object | null

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_number

string

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.

data.transit_address

string | null

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

data.account_number_last_3

string | null

The last 3 digits of the bank account number.

data.is_primary

boolean

Whether this is the primary bank account for its owner.

data.is_deletable

boolean

Whether this bank account can be deleted.

data.warnings

object | null

A collection of data validation warnings for this bank account. Warnings indicate incomplete or potentially incorrect data, such as an unrecognized institution or transit number.

Hide child attributes

data.warnings.object

string | null

data.warnings.data

object | null

data.is_pad_signed

boolean

Whether a PAD agreement has been signed. Only present for Business Entity bank accounts.

data.pad_signer_name

string | null

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

Maximum string length: 255

data.pad_signer_email

string | null

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

Maximum string length: 255

data.pad_signer_title

string | null

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

Maximum string length: 255

data.pad_signed_at

string<dateTime> | null

read-only

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

data.pad_file

any

The signed PAD agreement file. Only present for Business Entity bank accounts.

data.created_at

string<dateTime>

read-only

The date and time the object was created in Nmbr.

data.updated_at

string<dateTime>

read-only

The date and time the object was last updated in Nmbr.

Overview

Bulk & Batch Operations

Partner

Companies

Employees

Contractors

Payrolls

Line Items

Banking

Reporting

Forms

Vacation Pay

Lookups

Calculations

Miscellaneous

Update a bank account

Authorizations

Path Parameters

Body

Response