Manually close a batch of transactions. Closing a batch initiates the settlement process for all captured transactions in the batch.
The child client this request acts on behalf of. A reseller still authenticates as itself — Api-Key and Client-Id stay the reseller's — and names the child here.
This works only from a parent to its own children. Merchants have no children, so a merchant calling as itself omits the header. Sending your own client ULID here is not the same as omitting it, and is rejected on some operations.
The unique identifier of the client whose batch should be closed.
The unique identifier of the specific batch to close. Omit to close all open batches for the client.
The payment processor or service provider for the integration. Send the value exactly as spelled here. On the integration operations the gateway parses this field case-sensitively, so TSYS is rejected.
| Enum Value | Description |
|---|---|
| Tsys | TSYS payment processor |
| Vericheck | Vericheck ACH processor |
The type of batch.
| Enum Value | Description |
|---|---|
| Credit | Credit batch — contains credit/sale transactions. |
| Debit | Debit batch — contains debit transactions. |
ISO 8601 timestamp of when the batch was created.
- Mock server (simulated responses)https://developer.paradisepayments.com/_mock/apis/openapi/v1/batches/close
{ "client_id": "CLIENT-01KFDKXMQ637EKEAY410MSQSXB", "batch_id": "01KEWZ8R5MT3V9N2QXHDK7BPF4", "processor": "Tsys", "batch_type": "Credit", "created_at": "2026-07-15T08:00:00Z", "timezone": "America/New_York" }
Batch closed successfully
Unique identifier assigned to the request by the API server. Returned on every response, including errors. Log this value and supply it when contacting support so that a specific request can be traced.
Human-readable message describing the outcome of the batch close.
{ "response_text": "Batch closed successfully. 1 batch submitted for settlement.", "correlation_id": "01KFDKXMQ637EKEAY410MSQSXB" }