Sign in

v1

latestOpenAPI 3.1.02026-07-24180245513.9 KB
Bulk Actions

Retrieve bulk action related items

get/bulk_actions/{id}/items

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.

succeededobject[] required
failedobject[] required
processed_atstring date-time 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": "executed",
  "total_items": 5,
  "total_successful": 3,
  "total_failed": 2,
  "succeeded": [
    {
      "id": "629fc72d-9a4f-40e3-bd45-da7cfe7db989",
      "idempotency_key": "219aaa62-bd80-42a3-87cd-01be95e277d6"
    },
    {
      "id": "f2ae00d5-87b7-4769-a37c-81cbbc220bf3",
      "idempotency_key": "5bc66ab3-6bd8-47a5-8254-09cf83e5d936"
    },
    {
      "id": "910fc09b-1ddc-4815-96f4-c902459d31f3",
      "idempotency_key": "623d0493-a877-4d2b-9891-16608dc98a7f"
    }
  ],
  "failed": [
    {
      "idempotency_key": "c3dba9ea-5807-4316-b51e-b886eacff48b",
      "error": "conflicting idempotency_key"
    },
    {
      "idempotency_key": "c4a3c141-5c1e-46cb-a057-7b867067bce5",
      "error": "conflicting idempotency_key"
    }
  ],
  "processed_at": "2024-01-03T11:54:19.734183Z",
  "created_at": "2024-01-03T11:53:19.734182Z"
}