Skip to main content
GET
/
payments
/
allocation_items
import cobo_waas2
from cobo_waas2.models.list_allocation_items200_response import (
    ListAllocationItems200Response,
)
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"
    source_account = "source_account_example"
    destination_account = "destination_account_example"
    token_id = "ETH_USDT"
    batch_allocation_id = "5b0ed293-f728-40b4-b1f6-86b88cd51384"

    try:
        # List all allocation items
        api_response = api_instance.list_allocation_items(
            limit=limit,
            before=before,
            after=after,
            source_account=source_account,
            destination_account=destination_account,
            token_id=token_id,
            batch_allocation_id=batch_allocation_id,
        )
        print("The response of PaymentApi->list_allocation_items:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PaymentApi->list_allocation_items: %s\n" % e)


{
  "data": [
    {
      "allocation_item_id": "123e457-e89b-12d3-a456-426614174004",
      "batch_allocation_id": "123e457-e89b-12d3-a456-426614174004",
      "token_id": "ETH_USDT",
      "amount": "500.00",
      "description": "<string>",
      "source_account": "<string>",
      "destination_account": "<string>"
    }
  ],
  "pagination": {
    "before": "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
    "after": "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk",
    "total_count": 10000
  }
}

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.list_allocation_items200_response import (
    ListAllocationItems200Response,
)
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"
    source_account = "source_account_example"
    destination_account = "destination_account_example"
    token_id = "ETH_USDT"
    batch_allocation_id = "5b0ed293-f728-40b4-b1f6-86b88cd51384"

    try:
        # List all allocation items
        api_response = api_instance.list_allocation_items(
            limit=limit,
            before=before,
            after=after,
            source_account=source_account,
            destination_account=destination_account,
            token_id=token_id,
            batch_allocation_id=batch_allocation_id,
        )
        print("The response of PaymentApi->list_allocation_items:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PaymentApi->list_allocation_items: %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<int32>
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.

​
source_account
string

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

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".
​
token_id
string

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
​
batch_allocation_id
string

The batch allocation ID.

Response

The request was successful.

​
data
object[]
​
pagination
object

The pagination information of the returned data.