Skip to main content
DELETE
/
payments
/
counterparty_entry
/
{counterparty_entry_id}
import cobo_waas2
from cobo_waas2.models.delete_counterparty_entry200_response import (
    DeleteCounterpartyEntry200Response,
)
from cobo_waas2.models.entry_type import EntryType
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_entry_id = "123e4567-e89b-12d3-a456-426614174003"
    counterparty_id = "5b0ed293-f728-40b4-b1f6-86b88cd51384"
    entry_type = "Address"

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

// Import classes:
import com.cobo.waas2.ApiClient;
import com.cobo.waas2.ApiException;
import com.cobo.waas2.Configuration;
import com.cobo.waas2.Env;
import com.cobo.waas2.api.PaymentApi;
import com.cobo.waas2.model.*;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    // Select the development environment. To use the production environment, replace `Env.DEV` with
    // `Env.PROD
    defaultClient.setEnv(Env.DEV);

    // Replace `<YOUR_PRIVATE_KEY>` with your private key
    defaultClient.setPrivKey("<YOUR_PRIVATE_KEY>");
    PaymentApi apiInstance = new PaymentApi();
    String counterpartyEntryId = "123e4567-e89b-12d3-a456-426614174003";
    String counterpartyId = "5b0ed293-f728-40b4-b1f6-86b88cd51384";
    EntryType entryType = EntryType.fromValue("Address");
    try {
      DeleteCounterpartyEntry200Response result =
          apiInstance.deleteCounterpartyEntry(counterpartyEntryId, counterpartyId, entryType);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling PaymentApi#deleteCounterpartyEntry");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

package main

import (
	"context"
	"fmt"
	coboWaas2 "github.com/CoboGlobal/cobo-waas2-go-sdk/cobo_waas2"
	"github.com/CoboGlobal/cobo-waas2-go-sdk/cobo_waas2/crypto"
	"os"
)

func main() {
	counterpartyEntryId := "123e4567-e89b-12d3-a456-426614174003"
	counterpartyId := "5b0ed293-f728-40b4-b1f6-86b88cd51384"
	entryType := coboWaas2.EntryType("Address")

	configuration := coboWaas2.NewConfiguration()
	// Initialize the API client
	apiClient := coboWaas2.NewAPIClient(configuration)
	ctx := context.Background()

	// Select the development environment. To use the production environment, replace coboWaas2.DevEnv with coboWaas2.ProdEnv
	ctx = context.WithValue(ctx, coboWaas2.ContextEnv, coboWaas2.DevEnv)
	// Replace `<YOUR_PRIVATE_KEY>` with your private key
	ctx = context.WithValue(ctx, coboWaas2.ContextPortalSigner, crypto.Ed25519Signer{
		Secret: "<YOUR_PRIVATE_KEY>",
	})
	resp, r, err := apiClient.PaymentAPI.DeleteCounterpartyEntry(ctx, counterpartyEntryId).
		CounterpartyId(counterpartyId).
		EntryType(entryType).
		Execute()
	if err != nil {
		fmt.Fprintf(
			os.Stderr,
			"Error when calling `PaymentAPI.DeleteCounterpartyEntry``: %v\n",
			err,
		)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `DeleteCounterpartyEntry`: DeleteCounterpartyEntry200Response
	fmt.Fprintf(os.Stdout, "Response from `PaymentAPI.DeleteCounterpartyEntry`: %v\n", resp)
}

const CoboWaas2 = require("@cobo/cobo-waas2");
// Initialize the API client
const apiClient = CoboWaas2.ApiClient.instance;
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
apiClient.setEnv(CoboWaas2.Env.DEV);
// Replace `<YOUR_PRIVATE_KEY>` with your private key
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
// Call the API
const apiInstance = new CoboWaas2.PaymentApi();
const counterparty_entry_id = "123e4567-e89b-12d3-a456-426614174003";
const counterparty_id = "5b0ed293-f728-40b4-b1f6-86b88cd51384";
const opts = {
  entry_type: "Address",
};
apiInstance
  .deleteCounterpartyEntry(counterparty_entry_id, counterparty_id, opts)
  .then(
    (data) => {
      console.log("API called successfully. Returned data: " + data);
    },
    (error) => {
      console.error(error);
    },
  );

{
  "deleted_counterparty_entry_id": "46beeab4-6a8e-476e-bc69-99b89aacbc6f"
}
{
"error_code": 123,
"error_message": "<string>",
"error_id": "0b6ddf19083c4bd1a9ca01bec44b24dd"
}
{
"error_code": 123,
"error_message": "<string>",
"error_id": "0b6ddf19083c4bd1a9ca01bec44b24dd"
}
{
"error_code": 123,
"error_message": "<string>",
"error_id": "0b6ddf19083c4bd1a9ca01bec44b24dd"
}
import cobo_waas2
from cobo_waas2.models.delete_counterparty_entry200_response import (
    DeleteCounterpartyEntry200Response,
)
from cobo_waas2.models.entry_type import EntryType
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_entry_id = "123e4567-e89b-12d3-a456-426614174003"
    counterparty_id = "5b0ed293-f728-40b4-b1f6-86b88cd51384"
    entry_type = "Address"

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

// Import classes:
import com.cobo.waas2.ApiClient;
import com.cobo.waas2.ApiException;
import com.cobo.waas2.Configuration;
import com.cobo.waas2.Env;
import com.cobo.waas2.api.PaymentApi;
import com.cobo.waas2.model.*;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    // Select the development environment. To use the production environment, replace `Env.DEV` with
    // `Env.PROD
    defaultClient.setEnv(Env.DEV);

    // Replace `<YOUR_PRIVATE_KEY>` with your private key
    defaultClient.setPrivKey("<YOUR_PRIVATE_KEY>");
    PaymentApi apiInstance = new PaymentApi();
    String counterpartyEntryId = "123e4567-e89b-12d3-a456-426614174003";
    String counterpartyId = "5b0ed293-f728-40b4-b1f6-86b88cd51384";
    EntryType entryType = EntryType.fromValue("Address");
    try {
      DeleteCounterpartyEntry200Response result =
          apiInstance.deleteCounterpartyEntry(counterpartyEntryId, counterpartyId, entryType);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling PaymentApi#deleteCounterpartyEntry");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

package main

import (
	"context"
	"fmt"
	coboWaas2 "github.com/CoboGlobal/cobo-waas2-go-sdk/cobo_waas2"
	"github.com/CoboGlobal/cobo-waas2-go-sdk/cobo_waas2/crypto"
	"os"
)

func main() {
	counterpartyEntryId := "123e4567-e89b-12d3-a456-426614174003"
	counterpartyId := "5b0ed293-f728-40b4-b1f6-86b88cd51384"
	entryType := coboWaas2.EntryType("Address")

	configuration := coboWaas2.NewConfiguration()
	// Initialize the API client
	apiClient := coboWaas2.NewAPIClient(configuration)
	ctx := context.Background()

	// Select the development environment. To use the production environment, replace coboWaas2.DevEnv with coboWaas2.ProdEnv
	ctx = context.WithValue(ctx, coboWaas2.ContextEnv, coboWaas2.DevEnv)
	// Replace `<YOUR_PRIVATE_KEY>` with your private key
	ctx = context.WithValue(ctx, coboWaas2.ContextPortalSigner, crypto.Ed25519Signer{
		Secret: "<YOUR_PRIVATE_KEY>",
	})
	resp, r, err := apiClient.PaymentAPI.DeleteCounterpartyEntry(ctx, counterpartyEntryId).
		CounterpartyId(counterpartyId).
		EntryType(entryType).
		Execute()
	if err != nil {
		fmt.Fprintf(
			os.Stderr,
			"Error when calling `PaymentAPI.DeleteCounterpartyEntry``: %v\n",
			err,
		)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `DeleteCounterpartyEntry`: DeleteCounterpartyEntry200Response
	fmt.Fprintf(os.Stdout, "Response from `PaymentAPI.DeleteCounterpartyEntry`: %v\n", resp)
}

const CoboWaas2 = require("@cobo/cobo-waas2");
// Initialize the API client
const apiClient = CoboWaas2.ApiClient.instance;
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
apiClient.setEnv(CoboWaas2.Env.DEV);
// Replace `<YOUR_PRIVATE_KEY>` with your private key
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
// Call the API
const apiInstance = new CoboWaas2.PaymentApi();
const counterparty_entry_id = "123e4567-e89b-12d3-a456-426614174003";
const counterparty_id = "5b0ed293-f728-40b4-b1f6-86b88cd51384";
const opts = {
  entry_type: "Address",
};
apiInstance
  .deleteCounterpartyEntry(counterparty_entry_id, counterparty_id, opts)
  .then(
    (data) => {
      console.log("API called successfully. Returned data: " + data);
    },
    (error) => {
      console.error(error);
    },
  );

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_entry_id
string
required

The counterparty entry ID. For example, the wallet address ID.

Query Parameters

counterparty_id
string
required

The counterparty ID.

entry_type
enum<string>

The type of the counterparty entry.

  • Address: The counterparty entry is an address.
  • BankAccount: The counterparty entry is a bank account.

The type of the counterparty entry.

  • Address: The entry is a wallet address.
  • BankAccount: The entry is a bank account.
Available options:
Address,
BankAccount
Example:

"Address"

Response

The request was successful.

deleted_counterparty_entry_id
string
required

The deleted counterparty entry ID.

Example:

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