Skip to main content
GET
/
payments
/
batch_allocations
/
{batch_allocation_id}
import cobo_waas2
from cobo_waas2.models.batch_allocation_detail import BatchAllocationDetail
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)
    batch_allocation_id = "5b0ed293-f728-40b4-b1f6-86b88cd51384"

    try:
        # Get batch allocation information
        api_response = api_instance.get_batch_allocation_by_id(batch_allocation_id)
        print("The response of PaymentApi->get_batch_allocation_by_id:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PaymentApi->get_batch_allocation_by_id: %s\n" % e)


{
  "batch_allocation_id": "123e457-e89b-12d3-a456-426614174004",
  "request_id": "123e457-e89b-12d3-a456-426614174004",
  "allocation_items": [
    {
      "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>"
    }
  ],
  "initiator": "b2ae1b5aaade686c968ef2bbd31cc75ba94e5a85fd9cb0b35b81dcc15f520e9d",
  "created_timestamp": 1744689600,
  "updated_timestamp": 1744689600
}
import cobo_waas2
from cobo_waas2.models.batch_allocation_detail import BatchAllocationDetail
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)
    batch_allocation_id = "5b0ed293-f728-40b4-b1f6-86b88cd51384"

    try:
        # Get batch allocation information
        api_response = api_instance.get_batch_allocation_by_id(batch_allocation_id)
        print("The response of PaymentApi->get_batch_allocation_by_id:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PaymentApi->get_batch_allocation_by_id: %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.

Path Parameters

​
batch_allocation_id
string
required

The batch allocation ID.

Response

The details of a batch allocation were successfully retrieved.

​
batch_allocation_id
string
required

The batch allocation ID generated by Cobo.

Example:

"123e457-e89b-12d3-a456-426614174004"

​
request_id
string
required

The request ID provided by you when creating the batch allocation.

Example:

"123e457-e89b-12d3-a456-426614174004"

​
allocation_items
object[]
​
initiator
string

The initiator of this batch allocation, usually the user's API key.

Example:

"b2ae1b5aaade686c968ef2bbd31cc75ba94e5a85fd9cb0b35b81dcc15f520e9d"

​
created_timestamp
integer

The created time of the batch allocation, represented as a UNIX timestamp in seconds.

Example:

1744689600

​
updated_timestamp
integer

The updated time of the batch allocation, represented as a UNIX timestamp in seconds.

Example:

1744689600