Skip to main content
GET
/
payments
/
balance
/
payer
/
address
import cobo_waas2
from cobo_waas2.models.received_amount_per_address import ReceivedAmountPerAddress
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)
    payer_id = "P20250619T0310056d7aa"
    token_id = "ETH_USDT"
    merchant_id = "M1001"

    try:
        # Get payer balance
        api_response = api_instance.get_payer_balance_by_address(
            payer_id, token_id, merchant_id=merchant_id
        )
        print("The response of PaymentApi->get_payer_balance_by_address:\n")
        pprint(api_response)
    except Exception as e:
        print(
            "Exception when calling PaymentApi->get_payer_balance_by_address: %s\n" % e
        )

[
  {
    "address": "0xF8e4bfc10A2821DF52D3322cB5170E5E9276b537",
    "total_received_amount": "0.15"
  }
]
import cobo_waas2
from cobo_waas2.models.received_amount_per_address import ReceivedAmountPerAddress
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)
    payer_id = "P20250619T0310056d7aa"
    token_id = "ETH_USDT"
    merchant_id = "M1001"

    try:
        # Get payer balance
        api_response = api_instance.get_payer_balance_by_address(
            payer_id, token_id, merchant_id=merchant_id
        )
        print("The response of PaymentApi->get_payer_balance_by_address:\n")
        pprint(api_response)
    except Exception as e:
        print(
            "Exception when calling PaymentApi->get_payer_balance_by_address: %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

merchant_id
string

The merchant ID.

payer_id
string
required

Unique payer identifier on the Cobo side, auto-generated by the system.

token_id
string
required

The token ID, which is a unique identifier that specifies both the blockchain network and cryptocurrency token in the format {CHAIN}_{TOKEN}. Supported values include:

  • USDC: ETH_USDC, ARBITRUM_USDCOIN, SOL_USDC, BASE_USDC, MATIC_USDC2, BSC_USDC
  • USDT: TRON_USDT, ETH_USDT, ARBITRUM_USDT, SOL_USDT, BASE_USDT, MATIC_USDT, BSC_USDT

Response

The request was successful.

The total amount received for a specific payer on a list of receiving addresses.

address
string
required

The receiving address.

Example:

"0xF8e4bfc10A2821DF52D3322cB5170E5E9276b537"

total_received_amount
string
required

The total amount of the token that has been received at this address.

Example:

"0.15"