Skip to main content
PUT

Authorizations

BIZ-API-KEY
string
header
required

The API key. For more details, refer to API key.

In the API playground, enter your API secret, and your API key will be accordingly calculated.

Path Parameters

counterparty_id
string
required

The counterparty ID.

Body

application/json

The request body to update a counterparty.

updated_counterparty_name
string
required

The updated counterparty name.

Example:

"Counterparty A"

updated_counterparty_type
enum<string>
required

The type of the counterparty:

  • Individual: The counterparty is an individual.
  • Organization: The counterparty is an organization.
Available options:
Individual,
Organization
Example:

"Individual"

updated_country
string

The updated country of the counterparty, in ISO 3166-1 alpha-3 format.

Example:

"USA"

updated_email
string

The updated email of the counterparty.

updated_contact_address
string

The updated contact address of the counterparty.

Example:

"123 Main St, Anytown, USA"

Response

The request was successful.

counterparty_type
enum<string>
required

The type of the counterparty:

  • Individual: The counterparty is an individual.
  • Organization: The counterparty is an organization.
Available options:
Individual,
Organization
Example:

"Individual"

counterparty_name
string
required

The counterparty name.

Example:

"Counterparty A"

created_timestamp
integer
required

The created time of the counterparty, represented as a UNIX timestamp in seconds.

Example:

1744689600

updated_timestamp
integer
required

The updated time of the counterparty, represented as a UNIX timestamp in seconds.

Example:

1744689600

counterparty_id
string<uuid>

The counterparty ID.

Example:

"123e4567-e89b-12d3-a456-426614174003"

country
string

The country of the counterparty, in ISO 3166-1 alpha-3 format.

Example:

"USA"

email
string

The email of the counterparty.

contact_address
string

The contact address of the counterparty.

Example:

"123 Main St, Anytown, USA"