Get available allocation amount

This operation retrieves the available amount that can be allocated from a source account to a destination account.

GET /payments/allocation_amount

Python

import cobo_waas2
from cobo_waas2.models.payment_allocation_amount import PaymentAllocationAmount
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"
    source_account = "source_account_example"
    destination_account = "destination_account_example"

    try:
        # Get available allocation amount
        api_response = api_instance.get_available_allocation_amount(
            token_id, source_account, destination_account
        )
        print("The response of PaymentApi->get_available_allocation_amount:\n")
        pprint(api_response)
    except Exception as e:
        print(
            "Exception when calling PaymentApi->get_available_allocation_amount: %s\n"
            % e
        )

200

{
  "token_id": "ETH_USDT",
  "allocation_amount": "1.23"
}

Python

import cobo_waas2
from cobo_waas2.models.payment_allocation_amount import PaymentAllocationAmount
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"
    source_account = "source_account_example"
    destination_account = "destination_account_example"

    try:
        # Get available allocation amount
        api_response = api_instance.get_available_allocation_amount(
            token_id, source_account, destination_account
        )
        print("The response of PaymentApi->get_available_allocation_amount:\n")
        pprint(api_response)
    except Exception as e:
        print(
            "Exception when calling PaymentApi->get_available_allocation_amount: %s\n"
            % e
        )

Authorizations

CoboAuthOAuth2

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

source_account · string · required

The source account.

• If the source account is a merchant account, provide the merchant's ID (e.g., "M1001").
• If the source account is the developer account, use the string "developer".

destination_account · string · required

The destination account.

• If the destination account is a merchant account, provide the merchant's ID (e.g., "M1001").
• If the destination account is the developer account, use the string "developer".

Response

200

application/json

The available allocation amount was successfully retrieved.

token_id · string · required

The ID of the cryptocurrency.

Example:

"ETH_USDT"

allocation_amount · string · required

The available amount that can be allocated from the source account to the destination account for the given cryptocurrency.

Example:

"1.23"