Skip to main content
POST

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.

Body

application/json

The request body to create a batch allocation request.

request_id
string
required

The request ID that is used to track a batch allocation request. The request ID is provided by you and must be unique.

Example:

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

allocation_params
object[]
required

Response

The allocation request was successfully created.

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"

created_timestamp
integer
required

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

Example:

1744689600

updated_timestamp
integer
required

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

Example:

1744689600

allocation_params
object[]
initiator
string

The initiator of this batch allocation, usually the API key you used to create the batch allocation.

Example:

"b2ae1b5aaade686c968ef2bbd31cc75ba94e5a85fd9cb0b35b81dcc15f520e9d"

status
enum<string>

The status of the batch allocation.

Available options:
Pending,
Processing,
Completed,
PartiallyCompleted,
Failed
Example:

"Pending"