Update Counterparty

Updates a counterparty. Payment accounts can be added but not removed
or changed, since a payment account's details are immutable. A changed
legal name requires fresh identity verification alongside it.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Body Params

All attributes are optional; anything omitted is left unchanged. Payment accounts can be added but not removed. Restating an existing payment account is allowed only with unchanged account details, optionally carrying fresh ownership verification.

identity
object

The verifiable identity of the counterparty, separate from any of their payment accounts

payment_accounts
array of objects
payment_accounts
metadata
object | null

Use for your custom data. A place to store any miscellaneous information your system may need in regards to the record you are creating. This will be included in associated webhook payloads under the resource_metadata key. Nested values (i.e., objects and arrays) are not allowed. The maximum size of this parameter is 2kb.

Headers
string
^\d{8}$
Defaults to 20250101

API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.

Responses

403

forbidden

404

not found

500

Internal Server Error

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json