Skip to main content
PUT
/
payments
/
counterparty
/
{counterparty_id}
import cobo_waas2
from cobo_waas2.models.counterparty import Counterparty
from cobo_waas2.models.update_counterparty_request import UpdateCounterpartyRequest
from cobo_waas2.rest import ApiException
from pprint import pprint

# See configuration.py for a list of all supported configurations.
configuration = cobo_waas2.Configuration(
    # Replace `<YOUR_PRIVATE_KEY>` with your private key
    api_private_key="<YOUR_PRIVATE_KEY>",
    # Select the development environment. To use the production environment, change the URL to https://api.cobo.com/v2.
    host="https://api.dev.cobo.com/v2",
)
# Enter a context with an instance of the API client
with cobo_waas2.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cobo_waas2.PaymentApi(api_client)
    counterparty_id = "5b0ed293-f728-40b4-b1f6-86b88cd51384"
    update_counterparty_request = cobo_waas2.UpdateCounterpartyRequest(
        updated_counterparty_name="Counterparty A",
        updated_counterparty_type="Individual",
    )

    try:
        # Update counterparty
        api_response = api_instance.update_counterparty(
            counterparty_id, update_counterparty_request=update_counterparty_request
        )
        print("The response of PaymentApi->update_counterparty:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PaymentApi->update_counterparty: %s\n" % e)


{
  "counterparty_type": "Individual",
  "counterparty_name": "Counterparty A",
  "created_timestamp": 1744689600,
  "updated_timestamp": 1744689600,
  "counterparty_id": "123e4567-e89b-12d3-a456-426614174003",
  "country": "USA",
  "email": "[email protected]",
  "contact_address": "123 Main St, Anytown, USA"
}
import cobo_waas2
from cobo_waas2.models.counterparty import Counterparty
from cobo_waas2.models.update_counterparty_request import UpdateCounterpartyRequest
from cobo_waas2.rest import ApiException
from pprint import pprint

# See configuration.py for a list of all supported configurations.
configuration = cobo_waas2.Configuration(
    # Replace `<YOUR_PRIVATE_KEY>` with your private key
    api_private_key="<YOUR_PRIVATE_KEY>",
    # Select the development environment. To use the production environment, change the URL to https://api.cobo.com/v2.
    host="https://api.dev.cobo.com/v2",
)
# Enter a context with an instance of the API client
with cobo_waas2.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cobo_waas2.PaymentApi(api_client)
    counterparty_id = "5b0ed293-f728-40b4-b1f6-86b88cd51384"
    update_counterparty_request = cobo_waas2.UpdateCounterpartyRequest(
        updated_counterparty_name="Counterparty A",
        updated_counterparty_type="Individual",
    )

    try:
        # Update counterparty
        api_response = api_instance.update_counterparty(
            counterparty_id, update_counterparty_request=update_counterparty_request
        )
        print("The response of PaymentApi->update_counterparty:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PaymentApi->update_counterparty: %s\n" % e)

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.

Example:

"[email protected]"

​
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.

Example:

"[email protected]"

​
contact_address
string

The contact address of the counterparty.

Example:

"123 Main St, Anytown, USA"