Skip to main content
GET
/
payments
/
counterparty_entry
import cobo_waas2
from cobo_waas2.models.entry_type import EntryType
from cobo_waas2.models.list_counterparty_entries200_response import (
    ListCounterpartyEntries200Response,
)
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)
    limit = 10
    before = "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1"
    after = "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk"
    entry_type = "Address"
    counterparty_id = "5b0ed293-f728-40b4-b1f6-86b88cd51384"
    chain_ids = "ETH"
    wallet_address = "0x1234567890abcdef..."

    try:
        # List counterparty entries
        api_response = api_instance.list_counterparty_entries(
            limit=limit,
            before=before,
            after=after,
            entry_type=entry_type,
            counterparty_id=counterparty_id,
            chain_ids=chain_ids,
            wallet_address=wallet_address,
        )
        print("The response of PaymentApi->list_counterparty_entries:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PaymentApi->list_counterparty_entries: %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();
    Integer limit = 10;
    String before = "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1";
    String after = "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk";
    EntryType entryType = EntryType.fromValue("Address");
    String counterpartyId = "5b0ed293-f728-40b4-b1f6-86b88cd51384";
    String chainIds = "ETH";
    String walletAddress = "0x1234567890abcdef...";
    try {
      ListCounterpartyEntries200Response result =
          apiInstance.listCounterpartyEntries(
              limit, before, after, entryType, counterpartyId, chainIds, walletAddress);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling PaymentApi#listCounterpartyEntries");
      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() {
	limit := int32(10)
	before := "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1"
	after := "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk"
	entryType := coboWaas2.EntryType("Address")
	counterpartyId := "5b0ed293-f728-40b4-b1f6-86b88cd51384"
	chainIds := "ETH"
	walletAddress := "0x1234567890abcdef..."

	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.ListCounterpartyEntries(ctx).
		Limit(limit).
		Before(before).
		After(after).
		EntryType(entryType).
		CounterpartyId(counterpartyId).
		ChainIds(chainIds).
		WalletAddress(walletAddress).
		Execute()
	if err != nil {
		fmt.Fprintf(
			os.Stderr,
			"Error when calling `PaymentAPI.ListCounterpartyEntries``: %v\n",
			err,
		)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ListCounterpartyEntries`: ListCounterpartyEntries200Response
	fmt.Fprintf(os.Stdout, "Response from `PaymentAPI.ListCounterpartyEntries`: %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 opts = {
  limit: 10,
  before: "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
  after: "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk",
  entry_type: "Address",
  counterparty_id: "5b0ed293-f728-40b4-b1f6-86b88cd51384",
  chain_ids: "ETH",
  wallet_address: "0x1234567890abcdef...",
};
apiInstance.listCounterpartyEntries(opts).then(
  (data) => {
    console.log("API called successfully. Returned data: " + data);
  },
  (error) => {
    console.error(error);
  },
);

{
  "wallet_addresses": [
    {
      "counterparty_id": "123e4567-e89b-12d3-a456-426614174003",
      "counterparty_name": "Counterparty A",
      "counterparty_type": "Individual",
      "wallet_address_id": "123e4567-e89b-12d3-a456-426614174003",
      "address": "0x1234567890abcdef...",
      "chain_id": "TRON",
      "updated_timestamp": 1744689600
    }
  ],
  "pagination": {
    "before": "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
    "after": "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk",
    "total_count": 10000
  }
}
{
  "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.entry_type import EntryType
from cobo_waas2.models.list_counterparty_entries200_response import (
    ListCounterpartyEntries200Response,
)
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)
    limit = 10
    before = "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1"
    after = "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk"
    entry_type = "Address"
    counterparty_id = "5b0ed293-f728-40b4-b1f6-86b88cd51384"
    chain_ids = "ETH"
    wallet_address = "0x1234567890abcdef..."

    try:
        # List counterparty entries
        api_response = api_instance.list_counterparty_entries(
            limit=limit,
            before=before,
            after=after,
            entry_type=entry_type,
            counterparty_id=counterparty_id,
            chain_ids=chain_ids,
            wallet_address=wallet_address,
        )
        print("The response of PaymentApi->list_counterparty_entries:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PaymentApi->list_counterparty_entries: %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();
    Integer limit = 10;
    String before = "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1";
    String after = "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk";
    EntryType entryType = EntryType.fromValue("Address");
    String counterpartyId = "5b0ed293-f728-40b4-b1f6-86b88cd51384";
    String chainIds = "ETH";
    String walletAddress = "0x1234567890abcdef...";
    try {
      ListCounterpartyEntries200Response result =
          apiInstance.listCounterpartyEntries(
              limit, before, after, entryType, counterpartyId, chainIds, walletAddress);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling PaymentApi#listCounterpartyEntries");
      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() {
	limit := int32(10)
	before := "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1"
	after := "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk"
	entryType := coboWaas2.EntryType("Address")
	counterpartyId := "5b0ed293-f728-40b4-b1f6-86b88cd51384"
	chainIds := "ETH"
	walletAddress := "0x1234567890abcdef..."

	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.ListCounterpartyEntries(ctx).
		Limit(limit).
		Before(before).
		After(after).
		EntryType(entryType).
		CounterpartyId(counterpartyId).
		ChainIds(chainIds).
		WalletAddress(walletAddress).
		Execute()
	if err != nil {
		fmt.Fprintf(
			os.Stderr,
			"Error when calling `PaymentAPI.ListCounterpartyEntries``: %v\n",
			err,
		)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ListCounterpartyEntries`: ListCounterpartyEntries200Response
	fmt.Fprintf(os.Stdout, "Response from `PaymentAPI.ListCounterpartyEntries`: %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 opts = {
  limit: 10,
  before: "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
  after: "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk",
  entry_type: "Address",
  counterparty_id: "5b0ed293-f728-40b4-b1f6-86b88cd51384",
  chain_ids: "ETH",
  wallet_address: "0x1234567890abcdef...",
};
apiInstance.listCounterpartyEntries(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.

Query Parameters

limit
integer<int32>
default:10

The maximum number of objects to return. For most operations, the value range is [1, 50].

before
string

A cursor indicating the position before the current page. This value is generated by Cobo and returned in the response. If you are paginating forward from the beginning, you do not need to provide it on the first request. When paginating backward (to the previous page), you should pass the before value returned from the last response.

after
string

A cursor indicating the position after the current page. This value is generated by Cobo and returned in the response. You do not need to provide it on the first request. When paginating forward (to the next page), you should pass the after value returned from the last response.

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"

counterparty_id
string

The counterparty ID.

chain_ids
string

The chain ID, which is the unique identifier of a blockchain.

wallet_address
string

The wallet address.

Response

The request was successful.

wallet_addresses
object[]
pagination
object

The pagination information of the returned data.