v1

latestOpenAPI 3.1.02026-07-24180245513.9 KB

Bulk Actions

List bulk actions

List and filter bulk actions.

get/bulk_actions

Query parameters

limitinteger

starting_afterstring uuid

The ID of the object from which your list request will start. It is not included in the result.

sort_order'asc' | 'desc'

Order is based on attribute created_at. If asc, results are fetched in chronological order. If desc, results are fetched in reversed chronological order. Default order is desc.

start_datestring date

The creation date of the bulk action.

end_datestring date

The creation date of the bulk action.

target_object'payment_order' | 'internal_account'

The object related to the bulk action.

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

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'

Response

200

Example response

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