Skip to main content
GET
/
payments
/
settlement_info
import cobo_waas2
from cobo_waas2.models.acquiring_type import AcquiringType
from cobo_waas2.models.get_settlement_info_by_ids200_response import (
    GetSettlementInfoByIds200Response,
)
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)
    merchant_ids = "M1001,M1002,M1003"
    currency = "USD"
    acquiring_type = cobo_waas2.AcquiringType()

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


{
  "psp_token_balances": [
    {
      "available_amount": "500.00",
      "merchant_id": "123",
      "token_id": "ETH_USDT",
      "available_currency_balance": "500.00",
      "pending_amount": "500.00",
      "pending_currency_balance": "500.00",
      "settled_amount": "500.00",
      "available_balance": "500.00",
      "total_balance": "500.00",
      "acquiring_type": "Order",
      "created_timestamp": 1744689600,
      "updated_timestamp": 1744689600
    }
  ],
  "token_balances": [
    {
      "available_amount": "500.00",
      "merchant_id": "123",
      "token_id": "ETH_USDT",
      "available_currency_balance": "500.00",
      "pending_amount": "500.00",
      "pending_currency_balance": "500.00",
      "settled_amount": "500.00",
      "available_balance": "500.00",
      "total_balance": "500.00",
      "acquiring_type": "Order",
      "created_timestamp": 1744689600,
      "updated_timestamp": 1744689600
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://cobo.com/payments/llms.txt

Use this file to discover all available pages before exploring further.

import cobo_waas2
from cobo_waas2.models.acquiring_type import AcquiringType
from cobo_waas2.models.get_settlement_info_by_ids200_response import (
    GetSettlementInfoByIds200Response,
)
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)
    merchant_ids = "M1001,M1002,M1003"
    currency = "USD"
    acquiring_type = cobo_waas2.AcquiringType()

    try:
        # Get withdrawable balances
        api_response = api_instance.get_settlement_info_by_ids(
            merchant_ids=merchant_ids, currency=currency, acquiring_type=acquiring_type
        )
        print("The response of PaymentApi->get_settlement_info_by_ids:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PaymentApi->get_settlement_info_by_ids: %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

A list of merchant IDs to query.

​
currency
string
default:USD

The currency for the operation. Currently, only USD is supported.

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

​
psp_token_balances
object[]
​
token_balances
object[]