Skip to main content
GET
/
payments
/
balance
/
psp
import cobo_waas2
from cobo_waas2.models.psp_balance import PspBalance
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"

    try:
        # Get developer balance
        api_response = api_instance.get_psp_balance(token_id)
        print("The response of PaymentApi->get_psp_balance:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PaymentApi->get_psp_balance: %s\n" % e)


{
  "token_id": "ETH_USDT",
  "developer_fee_amount": "1.23",
  "settled_amount": "1.23",
  "payout_amount": "1.23",
  "refunded_amount": "<string>",
  "total_balance": "1.23",
  "available_balance": "1.23",
  "locked_balance": "1.23"
}
import cobo_waas2
from cobo_waas2.models.psp_balance import PspBalance
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"

    try:
        # Get developer balance
        api_response = api_instance.get_psp_balance(token_id)
        print("The response of PaymentApi->get_psp_balance:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PaymentApi->get_psp_balance: %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

​
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

Response

The request was successful.

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

​
developer_fee_amount
string

The total amount of the token that has been received as developer fee.

Example:

"1.23"

​
settled_amount
string

The total amount of the token that has been paid out from the developer's balance.

Example:

"1.23"

​
payout_amount
string

This field is reserved for future use.

Example:

"1.23"

​
refunded_amount
string

The total amount of the token that has been refunded from the developer's balance.

​
total_balance
string

The total balance of the token available for payout or refund for the developer.

For more information, please refer to Accounts and fund allocation

Example:

"1.23"

​
available_balance
string

This field has been deprecated.

Example:

"1.23"

​
locked_balance
string

This field is reserved for future use.

Example:

"1.23"