Sign in
Bulk Actions

Create bulk action

Create a bulk action on a list of items.

post/bulk_actions

Request body

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.

fail_on_validation_errorboolean

When set to true, if any item in items has an invalid payload, the bulk action will not be created. When set to false, the bulk action will be created and all items with valid payloads will be processed, whereas items with invalid payloads will be counted as failed. The default value is true.

itemsobject[] required

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 actions was processed.

created_atstring date-time required

The UTC timestamp of the creation of the bulk action.

Example response

{
  "object": "bulk_action",
  "status": "created",
  "total_items": 50,
  "created_at": "2024-01-03T11:53:19.734182Z"
}

Changes

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