Delete counterparty

This operation deletes a counterparty. Note that this operation will delete all entries under the counterparty.

DELETE /payments/counterparty/{counterparty_id}

Python

import cobo_waas2
from cobo_waas2.models.delete_counterparty_by_id200_response import (
    DeleteCounterpartyById200Response,
)
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"

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

200

{
  "deleted_counterparty_id": "46beeab4-6a8e-476e-bc69-99b89aacbc6f"
}

Python

import cobo_waas2
from cobo_waas2.models.delete_counterparty_by_id200_response import (
    DeleteCounterpartyById200Response,
)
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"

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

Authorizations

CoboAuthOAuth2

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.

Response

200

application/json

The request was successful.

deleted_counterparty_id · string · required

The deleted counterparty ID.

Example:

"46beeab4-6a8e-476e-bc69-99b89aacbc6f"