import cobo_waas2
from cobo_waas2.models.top_up_address import TopUpAddress
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)
    token_id = "ETH_USDT"
    custom_payer_id = "payer_0001"
    merchant_id = "M1001"

    try:
        # Get top-up address
        api_response = api_instance.get_top_up_address(
            token_id, custom_payer_id, merchant_id=merchant_id
        )
        print("The response of PaymentApi->get_top_up_address:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PaymentApi->get_top_up_address: %s\n" % e)

{
  "address": "0x1234567890abcdef...",
  "payer_id": "P20250619T0310056d7aa",
  "custom_payer_id": "user_abc_10001",
  "merchant_id": "M1001",
  "token_id": "ETH_USDT",
  "min_amount": "0.1",
  "chain": "ETH",
  "developer_fee_rate": "0.01",
  "created_timestamp": 1744689600,
  "updated_timestamp": 1744689600
}

Top-up Mode

Create/Get top-up address

This operation creates or retrieves a unique top-up address for a payer.

In the request, you need to provide the custom_payer_id parameter to identify the payer in your system and link them to the top-up address.

If no address exists for the payer on the specified chain, a new address will be created and returned.
If an address already exists for the payer on the specified chain, the existing address details will be returned.

You can also provide the merchant_id parameter to specify the merchant to which the payer belongs. If not provided, the default merchant will be used.

GET

payments

topup

address

import cobo_waas2
from cobo_waas2.models.top_up_address import TopUpAddress
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)
    token_id = "ETH_USDT"
    custom_payer_id = "payer_0001"
    merchant_id = "M1001"

    try:
        # Get top-up address
        api_response = api_instance.get_top_up_address(
            token_id, custom_payer_id, merchant_id=merchant_id
        )
        print("The response of PaymentApi->get_top_up_address:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PaymentApi->get_top_up_address: %s\n" % e)

{
  "address": "0x1234567890abcdef...",
  "payer_id": "P20250619T0310056d7aa",
  "custom_payer_id": "user_abc_10001",
  "merchant_id": "M1001",
  "token_id": "ETH_USDT",
  "min_amount": "0.1",
  "chain": "ETH",
  "developer_fee_rate": "0.01",
  "created_timestamp": 1744689600,
  "updated_timestamp": 1744689600
}

import cobo_waas2
from cobo_waas2.models.top_up_address import TopUpAddress
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)
    token_id = "ETH_USDT"
    custom_payer_id = "payer_0001"
    merchant_id = "M1001"

    try:
        # Get top-up address
        api_response = api_instance.get_top_up_address(
            token_id, custom_payer_id, merchant_id=merchant_id
        )
        print("The response of PaymentApi->get_top_up_address:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PaymentApi->get_top_up_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

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

custom_payer_id

string

required

Unique customer identifier on the merchant side, used to allocate a dedicated top-up address

merchant_id

string

The merchant ID.

Response

The request was successful.

address

string

required

The dedicated top-up address assigned to a specific payer under a merchant on a specified chain.

Example:

"0x1234567890abcdef..."

payer_id

string

required

A unique identifier assigned by Cobo to track and identify individual payers.

Example:

"P20250619T0310056d7aa"

custom_payer_id

string

required

A unique identifier assigned by the developer to track and identify individual payers in their system.

Example:

"user_abc_10001"

merchant_id

string

required

The merchant ID.

Example:

"M1001"

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}.

Example:

"ETH_USDT"

min_amount

string

required

The minimum top-up amount allowed for this address. Top-ups below this threshold will not be credited to merchant or developer funds.

Example:

"0.1"

chain

string

The chain ID.

Example:

"ETH"

developer_fee_rate

string

The developer fee rate applied to top-up transactions made to this address. Expressed as a decimal string where "0.1" represents 10%.

Example:

"0.01"

created_timestamp

integer

The creation time of the top-up address, represented as a UNIX timestamp in seconds.

Example:

1744689600

updated_timestamp

integer

The last update time of the top-up address, represented as a UNIX timestamp in seconds.

Example:

1744689600

Error codes Batch create top-up addresses

⌘I

Documentation Index

Authorizations

Query Parameters

Response