Bulk Requests

A Bulk Request represents a request to asynchronously operate on a given resource in bulk. When creating a Bulk Request, Modern Treasury requires an action_type, a resource_type and an array of resources. Each item in resources represents the input parameters for a single request to perform an action_type operation on resource_type resource.

For example, to create Payment Orders in bulk, the action_type is create, the resource_type is payment_order and each item in the resources array has valid create-payment-order-params.

When processing a Bulk Request, Modern Treasury generates one Bulk Result for each row in the resources array. As each array item is processed, Modern Treasury moves the associated Bulk Result to either the successful or failed state, and increments summary result counts (success_result_count, failed_result_count) on the Bulk Request object accordingly. When all resources have been processed, Modern Treasury transitions the Bulk Request to the completed state.

Row-level processing results may be monitored or reviewed using the List Bulk Results API, by specifying the request_type=bulk_request and requester_id=BULK_REQUEST_ID.

Please be advised that certain parameters are not supported when using bulk requests for ledger transactions. Specifically, the following parameters cannot be included in bulk ledger transaction requests:
ledger_entries.lock_version, ledger_entries.show_resulting_ledger_account_balances , ledger_entries.available_balance_amount , ledger_entries.posted_balance_amount, ledger_entries.pending_balance_amount, ledger_account_category_balance_locks, archive_on_balance_lock_failure
These limitations are in place to ensure optimal performance when processing large volumes. For workflows requiring these parameters, we recommend using single API requests instead of bulk operations. For more information about synchronous and asynchronous processing of ledger entries see our documentation on designing a ledger for concurrency

{
  "id": "91c9117f-4855-419c-ad57-0801a58553d4",
  "object": "bulk_request",
  "live_mode": true,
  "action_type": "create",
  "resource_type": "payment_order",
  "status": "pending",
  "total_resource_count": 10,
  "success_result_count": 0,
  "failed_result_count": 0,
  "created_at": "2023-08-25T14:02:52Z",
  "updated_at": "2023-08-25T14:02:52Z"
}