Sign in
Bulk Actions

Retrieve bulk action

Retrieve the details of a bulk action.

get/bulk_actions/{id}

Path parameters

idstring required

The ID of the bulk action.

Response

200

idstring required

The bulk action ID.

objectstring required

Type of the object, bulk_action.

target_object'payment_order' | 'internal_account' required

The object related to the bulk action.

action'create' | 'approve' | 'cancel' required

The action to execute on the items included in the bulk action.

If target_action is payment_order, can be create, approve or cancel. If target_action is internal_account, can be create.

status'created' | 'processing' | 'executed' required

The status of the bulk action. Either created, processing, or executed.

total_itemsinteger required

The number of items included in the bulk action.

total_successfulinteger required

The number of items successfully processed.

total_failedinteger required

The number of items that failed to be processed.

processed_atstring date-time nullable required

The UTC timestamp when the bulk action was processed.

created_atstring date-time required

The UTC timestamp of the creation of the bulk action.

Example response

{
  "object": "bulk_action",
  "status": "processing",
  "total_items": 50,
  "total_successful": 24,
  "total_failed": 2,
  "created_at": "2024-01-03T11:53:19.734182Z"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.