Skip to main content
PUT
/
remittance_accounts
/
{remittance_account}
Update a remittance account
curl --request PUT \
  --url https://sandbox.nmbr.co/services/payroll/remittance_accounts/{remittance_account} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "label": "CRA Payroll Account - Main",
  "account_identifier": "123456789RP0002",
  "remitter_type": "accelerated_threshold_1",
  "remittance_management": "automatic",
  "note": "Updated main payroll remittance account",
  "address_line_1": "555 MacKenzie Ave",
  "city": "Ottawa",
  "administrative_area": "ON",
  "country_code": "CA",
  "postal_code": "K1A 0L5"
}
'
import requests

url = "https://sandbox.nmbr.co/services/payroll/remittance_accounts/{remittance_account}"

payload = {
"label": "CRA Payroll Account - Main",
"account_identifier": "123456789RP0002",
"remitter_type": "accelerated_threshold_1",
"remittance_management": "automatic",
"note": "Updated main payroll remittance account",
"address_line_1": "555 MacKenzie Ave",
"city": "Ottawa",
"administrative_area": "ON",
"country_code": "CA",
"postal_code": "K1A 0L5"
}
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({
label: 'CRA Payroll Account - Main',
account_identifier: '123456789RP0002',
remitter_type: 'accelerated_threshold_1',
remittance_management: 'automatic',
note: 'Updated main payroll remittance account',
address_line_1: '555 MacKenzie Ave',
city: 'Ottawa',
administrative_area: 'ON',
country_code: 'CA',
postal_code: 'K1A 0L5'
})
};

fetch('https://sandbox.nmbr.co/services/payroll/remittance_accounts/{remittance_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/remittance_accounts/{remittance_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([
'label' => 'CRA Payroll Account - Main',
'account_identifier' => '123456789RP0002',
'remitter_type' => 'accelerated_threshold_1',
'remittance_management' => 'automatic',
'note' => 'Updated main payroll remittance account',
'address_line_1' => '555 MacKenzie Ave',
'city' => 'Ottawa',
'administrative_area' => 'ON',
'country_code' => 'CA',
'postal_code' => 'K1A 0L5'
]),
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/remittance_accounts/{remittance_account}"

payload := strings.NewReader("{\n \"label\": \"CRA Payroll Account - Main\",\n \"account_identifier\": \"123456789RP0002\",\n \"remitter_type\": \"accelerated_threshold_1\",\n \"remittance_management\": \"automatic\",\n \"note\": \"Updated main payroll remittance account\",\n \"address_line_1\": \"555 MacKenzie Ave\",\n \"city\": \"Ottawa\",\n \"administrative_area\": \"ON\",\n \"country_code\": \"CA\",\n \"postal_code\": \"K1A 0L5\"\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/remittance_accounts/{remittance_account}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"label\": \"CRA Payroll Account - Main\",\n \"account_identifier\": \"123456789RP0002\",\n \"remitter_type\": \"accelerated_threshold_1\",\n \"remittance_management\": \"automatic\",\n \"note\": \"Updated main payroll remittance account\",\n \"address_line_1\": \"555 MacKenzie Ave\",\n \"city\": \"Ottawa\",\n \"administrative_area\": \"ON\",\n \"country_code\": \"CA\",\n \"postal_code\": \"K1A 0L5\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://sandbox.nmbr.co/services/payroll/remittance_accounts/{remittance_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 \"label\": \"CRA Payroll Account - Main\",\n \"account_identifier\": \"123456789RP0002\",\n \"remitter_type\": \"accelerated_threshold_1\",\n \"remittance_management\": \"automatic\",\n \"note\": \"Updated main payroll remittance account\",\n \"address_line_1\": \"555 MacKenzie Ave\",\n \"city\": \"Ottawa\",\n \"administrative_area\": \"ON\",\n \"country_code\": \"CA\",\n \"postal_code\": \"K1A 0L5\"\n}"

response = http.request(request)
puts response.read_body
{
  "id": "<id>",
  "object": "remittance_account",
  "data": {
    "business_entity": {
      "id": "<id>",
      "object": "business_entity",
      "links": {
        "self": "/business_entities/<id>"
      }
    },
    "source_tax_property": {
      "id": "<id>",
      "object": "tax_property",
      "links": {
        "self": "/tax_properties/<id>"
      }
    },
    "account_provider": "ca_cra",
    "is_default": false,
    "is_editable": true,
    "is_deletable": true,
    "category": "ca_tax_agency",
    "label": "CRA Payroll Account - Main",
    "label_translations": null,
    "label_translated": "CRA Payroll Account - Main",
    "account_identifier": "123456789RP0002",
    "remitter_type": "accelerated_threshold_1",
    "remittance_management": "automatic",
    "note": "Updated main payroll remittance account",
    "address_line_1": "555 MacKenzie Ave",
    "address_line_2": null,
    "city": "Ottawa",
    "administrative_area": "ON",
    "province_code": "ON",
    "country_code": "CA",
    "postal_code": "K1A 0L5",
    "has_payments": false,
    "current_enrollments_count": 0,
    "pending_enrollments_count": 0,
    "metadata": null,
    "created_at": "2026-01-01T00:00:00.000000Z",
    "updated_at": "2026-01-01T00:00:00.000000Z"
  },
  "links": {
    "self": "/remittance_accounts/<id>"
  }
}

Authorizations

Authorization
string
header
required

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

Path Parameters

remittance_account
string
required

Body

application/json
is_default
boolean
account_provider
string
category
enum<string>
Available options:
ca_benefit_provider,
ca_provincial_government,
ca_tax_agency,
ca_union,
ca_workers_compensation
label
string
Maximum string length: 255
label_translations
object | null

Optional translations for the label property.

account_identifier
string | null

Editing is prevented when is_editable is false

Maximum string length: 255
remitter_type
enum<string>
Available options:
accelerated_threshold_1,
accelerated_threshold_2,
quarterly,
regular
remittance_management
enum<string>
Available options:
automatic,
manual
note
string | null
address_line_1
string | null
address_line_2
string | null
city
string | null
administrative_area
string | null
Maximum string length: 255
province_code
string | null

In Canada, must be an uppercase 2-letter province code: AB, BC, MB, NB, NL, NS, NT, NU, ON, PE, QC, SK, YT

country_code
string | null

Must be an uppercase 2-letter country code (ISO 3166-1 alpha-2, e.g., CA).

postal_code
string | null
Maximum string length: 10
metadata
Workers’ compensation · object

Additional data points for this account. The available fields depend on the account's category; null for categories that capture no metadata.

Response

200 - application/json

OK

id
string
read-only

The unique identifier of the object in Nmbr.

object
string
read-only

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

data
Remittance Account · object