Skip to content

Close batches

The Close batches operations includes APIs for closing batches of transactions.

Operations

Close a Batch

Request

Manually close a batch of transactions. Closing a batch initiates the settlement process for all captured transactions in the batch.

Security
ApiKeyAuth
Headers
Client-Idstring, (ulid)required
X-Acting-As-Client-Idstring, (ulid)

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.

Bodyapplication/json
client_idstringrequired

The unique identifier of the client whose batch should be closed.

batch_idstring or null

The unique identifier of the specific batch to close. Omit to close all open batches for the client.

processorstring(Processor)required

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 ValueDescription
Tsys

TSYS payment processor

Vericheck

Vericheck ACH processor

batch_typestring(BatchType)required

The type of batch.

Enum ValueDescription
Credit

Credit batch — contains credit/sale transactions.

Debit

Debit batch — contains debit transactions.

created_atstring, (date-time)required

ISO 8601 timestamp of when the batch was created.

timezonestring or null

IANA timezone identifier for the batch (e.g. America/New_York).

{
  "client_id": "CLIENT-01KFDKXMQ637EKEAY410MSQSXB",
  "batch_id": "BATCH-01KEW32V6YNV11T33XGDR7TGWC",
  "processor": "Tsys",
  "batch_type": "Credit",
  "created_at": "2026-07-15T08:00:00Z",
  "timezone": "America/New_York"
}

Responses

Batch closed successfully

Headers
x-request-idstring, (uuid)^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...required

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.

Bodyapplication/json
response_textstringrequired

Human-readable message describing the outcome of the batch close.

correlation_idstring(CorrelationId)

Identifier the gateway assigns to the request and carries across the services that handled it. Quote it when reporting a problem.

Response
{
  "response_text": "Batch closed successfully. 1 batch submitted for settlement.",
  "correlation_id": "01KFDKXMQ637EKEAY410MSQSXB"
}