Skip to main content
GET
/
payments
/
merchants
import cobo_waas2
from cobo_waas2.models.list_merchants200_response import ListMerchants200Response
from cobo_waas2.models.wallet_setup import WalletSetup
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)
    limit = 10
    before = "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1"
    after = "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk"
    keyword = "keyword"
    wallet_id = "f47ac10b-58cc-4372-a567-0e02b2c3d479"
    wallet_setup = cobo_waas2.WalletSetup("Default")

    try:
        # List all merchants
        api_response = api_instance.list_merchants(
            limit=limit,
            before=before,
            after=after,
            keyword=keyword,
            wallet_id=wallet_id,
            wallet_setup=wallet_setup,
        )
        print("The response of PaymentApi->list_merchants:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PaymentApi->list_merchants: %s\n" % e)


{
  "data": [
    {
      "merchant_id": "1",
      "name": "Merchant-1",
      "wallet_id": "123e4567-e89b-12d3-a456-426614174001",
      "developer_fee_rate": "0.01",
      "wallet_setup": "Shared",
      "created_timestamp": 1744689600,
      "updated_timestamp": 1744689600
    }
  ],
  "pagination": {
    "before": "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
    "after": "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk",
    "total_count": 10000
  }
}
import cobo_waas2
from cobo_waas2.models.list_merchants200_response import ListMerchants200Response
from cobo_waas2.models.wallet_setup import WalletSetup
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)
    limit = 10
    before = "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1"
    after = "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk"
    keyword = "keyword"
    wallet_id = "f47ac10b-58cc-4372-a567-0e02b2c3d479"
    wallet_setup = cobo_waas2.WalletSetup("Default")

    try:
        # List all merchants
        api_response = api_instance.list_merchants(
            limit=limit,
            before=before,
            after=after,
            keyword=keyword,
            wallet_id=wallet_id,
            wallet_setup=wallet_setup,
        )
        print("The response of PaymentApi->list_merchants:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PaymentApi->list_merchants: %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
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 used for fuzzy matching of merchant names.

​
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).
Available options:
Default,
Shared,
Separate
Example:

"Shared"

Response

The request was successful.

​
data
object[]
​
pagination
object

The pagination information of the returned data.