Batch Payments - API
How to submit and manage bulk payments via the Lorum API, including the upload endpoint, CSV file format, and batch status reference.
Batch payments allow you to submit multiple outbound payments in a single API call by uploading a CSV file. Each valid row in the file is submitted as an individual payment instruction.
Uploading a Batch File
Upload a batch payment file via Upload Payment Batch File
POST /v1/transactions/batches/files.
The request must be a multipart/form-data upload.
All batch upload requests must include an
Idempotency-Keyheader. See Understanding Idempotency for details.
| Field | Type | Required | Description |
|---|---|---|---|
batch_type | string | ✅ | The type of batch being created - currently only LocalPayment is supported |
file | file | ✅ | The CSV file to upload - see Batch Payment CSV Reference for the full column reference |
file_name | string | ✅ | The filename of the batch being uploaded |
Retrieving Batches
List all batches via List Batches
GET /v1/transactions/batches.
Get a single batch via Get Batch
GET /v1/transactions/batches/{batch_id}.
The batch response includes the overall batch status and a breakdown of individual payment statuses within the batch.
Batch Statuses
| Status | Description |
|---|---|
Pending | Batch has been uploaded and is awaiting validation |
Processing | Batch is being processed |
Completed | All payments in the batch have been processed successfully |
Failed | Batch failed to process - check individual payment statuses for details |
PartiallyCompleted | Some payments completed successfully, others failed |
Updated 4 days ago