Bulk action object

AttributeDescription
id
string
The bulk action ID.
object
string
Always bulk_action.
target_object
string
The object related to the bulk action. Only payment_order is supported for now.
action
string
The action to execute on the items included in the bulk action. Only create, approve, and cancel are supported for now.
status
string
The status of the bulk action. Either created, processing, or executed.
total_items
integer
The number of items included in the bulk action
total_successful
integer
The number of items successfully processed
total_failed
integer
The number of items that failed to be processed.
processed_at
datetime
The UTC timestamp when the bulk action was processed.
created_at
datetime
The UTC timestamp of the creation of the bulk action.

Below is an example of a bulk action object:

{
  "id": "daa012d7-542e-412c-859e-9777079ffda4",
  "object": "bulk_action",
  "target_object": "payment_order",
  "action": "create",
  "status": "executed",
  "total_items": 200,
  "total_successful": 198,
  "total_failed": 2,
  "processed_at": "2024-03-17T16:17:02.445697Z",
  "created_at": "2024-03-17T16:16:40.445697Z"
}