Skip to main content
GET
/
payments
/
destination_entry
import cobo_waas2
from cobo_waas2.models.bank_account_status import BankAccountStatus
from cobo_waas2.models.entry_type import EntryType
from cobo_waas2.models.list_destination_entries200_response import (
    ListDestinationEntries200Response,
)
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)
    entry_type = cobo_waas2.EntryType()
    limit = 10
    before = "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1"
    after = "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk"
    destination_id = "46beeab4-6a8e-476e-bc69-99b89aacbc6f"
    chain_ids = "ETH"
    wallet_address = "0x1234567890abcdef..."
    keyword = "keyword"
    bank_account_status = "Pending"

    try:
        # List destination entries
        api_response = api_instance.list_destination_entries(
            entry_type,
            limit=limit,
            before=before,
            after=after,
            destination_id=destination_id,
            chain_ids=chain_ids,
            wallet_address=wallet_address,
            keyword=keyword,
            bank_account_status=bank_account_status,
        )
        print("The response of PaymentApi->list_destination_entries:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PaymentApi->list_destination_entries: %s\n" % e)


{
  "wallet_addresses": [
    {
      "destination_id": "123e4567-e89b-12d3-a456-426614174003",
      "destination_name": "Destination A",
      "destination_type": "Individual",
      "wallet_address_id": "123e4567-e89b-12d3-a456-426614174003",
      "address": "0x1234567890abcdef...",
      "chain_id": "TRON",
      "updated_timestamp": 1744689600,
      "merchant_id": "M1001"
    }
  ],
  "bank_accounts": [
    {
      "destination_id": "123e4567-e89b-12d3-a456-426614174003",
      "destination_name": "Destination A",
      "destination_type": "Individual",
      "bank_account_id": "123e4567-e89b-12d3-a456-426614174003",
      "account_alias": "Main Payout Account",
      "account_number": "4111111111111111",
      "swift_code": "BOFAUS33",
      "currency": "USD",
      "beneficiary_name": "John Doe",
      "beneficiary_address": "123 Main St, Anytown, USA",
      "bank_name": "ABC Bank",
      "bank_address": "456 Bank Ave, Cityville, USA",
      "bank_account_status": "Pending",
      "destination_email": "[email protected]",
      "destination_country": "USA",
      "destination_contact_address": "123 Main St, Anytown, USA",
      "destination_merchant_id": "M1001",
      "iban_code": "12345678901234567890",
      "further_credit": "further credit sample",
      "intermediary_bank_info": {
        "bank_name": "Intermediary Bank",
        "bank_address": "456 Bank Ave, Cityville, USA",
        "bank_swift_code": "BOFAUS33"
      },
      "created_timestamp": 1744689600,
      "updated_timestamp": 1744689600
    }
  ],
  "pagination": {
    "before": "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
    "after": "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk",
    "total_count": 10000
  }
}
import cobo_waas2
from cobo_waas2.models.bank_account_status import BankAccountStatus
from cobo_waas2.models.entry_type import EntryType
from cobo_waas2.models.list_destination_entries200_response import (
    ListDestinationEntries200Response,
)
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)
    entry_type = cobo_waas2.EntryType()
    limit = 10
    before = "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1"
    after = "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk"
    destination_id = "46beeab4-6a8e-476e-bc69-99b89aacbc6f"
    chain_ids = "ETH"
    wallet_address = "0x1234567890abcdef..."
    keyword = "keyword"
    bank_account_status = "Pending"

    try:
        # List destination entries
        api_response = api_instance.list_destination_entries(
            entry_type,
            limit=limit,
            before=before,
            after=after,
            destination_id=destination_id,
            chain_ids=chain_ids,
            wallet_address=wallet_address,
            keyword=keyword,
            bank_account_status=bank_account_status,
        )
        print("The response of PaymentApi->list_destination_entries:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PaymentApi->list_destination_entries: %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.

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

EntryType defines 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"

​
destination_id
string

The destination ID.

​
chain_ids
string

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

​
wallet_address
string

The wallet address.

​
keyword
string

A search term for performing fuzzy matches in the search query. The keyword.

​
bank_account_status
enum<string>

BankAccountStatus defines the status of the bank account:

  • Pending: The bank account is pending verification by Cobo.
  • Approved: The bank account has been approved by Cobo.
  • Rejected: The bank account has been rejected by Cobo.
Available options:
Pending,
Approved,
Rejected
Example:

"Pending"

Response

The request was successful.

​
wallet_addresses
object[]
​
bank_accounts
object[]
​
pagination
object

The pagination information of the returned data.