Skip to main content
GET

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