Skip to main content
GET
/
payments
/
balance
/
merchants
import cobo_waas2
from cobo_waas2.models.acquiring_type import AcquiringType
from cobo_waas2.models.list_merchant_balances200_response import (
    ListMerchantBalances200Response,
)
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"
    merchant_ids = "M1001,M1002,M1003"
    acquiring_type = cobo_waas2.AcquiringType("Order")

    try:
        # List merchant balances
        api_response = api_instance.list_merchant_balances(
            token_id, merchant_ids=merchant_ids, acquiring_type=acquiring_type
        )
        print("The response of PaymentApi->list_merchant_balances:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PaymentApi->list_merchant_balances: %s\n" % e)


{
  "data": [
    {
      "merchant_id": "1",
      "token_id": "ETH_USDT",
      "acquiring_type": "Order",
      "total_received_amount": "1.23",
      "settled_amount": "1.23",
      "payout_amount": "1.23",
      "refunded_amount": "1.23",
      "total_balance": "1.23",
      "available_balance": "1.23",
      "locked_balance": "1.23"
    }
  ]
}
import cobo_waas2
from cobo_waas2.models.acquiring_type import AcquiringType
from cobo_waas2.models.list_merchant_balances200_response import (
    ListMerchantBalances200Response,
)
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"
    merchant_ids = "M1001,M1002,M1003"
    acquiring_type = cobo_waas2.AcquiringType("Order")

    try:
        # List merchant balances
        api_response = api_instance.list_merchant_balances(
            token_id, merchant_ids=merchant_ids, acquiring_type=acquiring_type
        )
        print("The response of PaymentApi->list_merchant_balances:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PaymentApi->list_merchant_balances: %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_ids
string

The comma-separated list of merchant IDs to filter by.

At least one of merchant_ids or token_id must be provided.

For more information about merchants, refer to Cobo Payments Guide.

​
token_id
string

The token ID that identifies the cryptocurrency.

At least one of merchant_ids or token_id must be provided.

For a complete list of supported tokens, refer to Cobo Payments Guide.

​
acquiring_type
enum<string>

This parameter has been deprecated The payment acquisition type.

  • Order: Payers pay by fixed-amount orders. Ideal for specific purchases and one-time transactions.
  • TopUp: Account recharge flow where payers deposit funds to their dedicated top-up addresses. Ideal for flexible or usage-based payment models.
Available options:
Order,
TopUp
Example:

"Order"

Response

The request was successful.

​
data
object[]