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

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.

keyword
string

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

wallet_id
string<uuid>

This parameter has been deprecated.

wallet_setup
enum<string>

The type of wallet setup for the merchant. Each wallet contains multiple cryptocurrency addresses that serve as the merchant’s receiving addresses.

  • Shared: Multiple merchants share the same wallet. The wallet’s addresses may be used to receive payments for multiple merchants simultaneously.
  • Separate: Create a dedicated wallet for the merchant to achieve complete fund isolation. All addresses in this wallet are only used to receive payments for this merchant.
  • Default: The default wallet automatically created by the system for the default merchant (the merchant that shares the same name as your organization).

The type of wallet setup for the merchant. Each wallet contains multiple cryptocurrency addresses that serve as the merchant’s receiving addresses.

  • Shared: (Default) Multiple merchants share the same wallet. The wallet’s addresses may be used to receive payments for multiple merchants simultaneously.
  • Separate: Create a dedicated wallet for the merchant to achieve complete fund isolation. All addresses in this wallet are only used to receive payments for this merchant.
  • Default: The default wallet automatically created by the system for the default merchant (the merchant that shares the same name as your organization). Do not select this option when creating a merchant.
Available options:
Default,
Shared,
Separate
Example:

"Shared"

Response

The request was successful.

data
object[]
pagination
object

The pagination information of the returned data.