Sign in
Remittance Accounts

Update a remittance account

put/remittance_accounts/{remittance_account}

Path parameters

remittance_accountstring required

Request body

is_defaultboolean
account_providerstring
category'ca_benefit_provider' | 'ca_provincial_government' | 'ca_tax_agency' | 'ca_union' | 'ca_workers_compensation'
labelstring
account_identifierstring nullable

Editing is prevented when is_editable is false

remitter_type'accelerated_threshold_1' | 'accelerated_threshold_2' | 'quarterly' | 'regular'
remittance_management'automatic' | 'manual'
notestring nullable
address_line_1string nullable
address_line_2string nullable
citystring nullable
administrative_areastring nullable
province_codestring nullable

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

country_codestring nullable

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

postal_codestring nullable

Response

OK

idstring

The unique identifier of the object in Nmbr.

objectstring

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

Changes