Batch Management
Group, track, and reconcile transactions with ease through structured batch processing.
PCE allows you to process multiple individual transactions as a single group, called a batch. These batches are opened and closed at regular intervals (daily, weekly, or another defined cycle).
Batch Management defines how transactions are grouped before settlement. At the end of a business day (or defined cycle), all captured transactions are collected into a batch, which is then processed for settlement.
Benefits:
- Clear visibility into daily sales and settlement activity.
- Simplified reconciliation with processor and funding reports.
- Faster identification of any discrepancies or missing transactions.
Key Concepts:
- Batch Closure: Transactions are grouped into a batch at closure. Only settled batches are eligible for funding.
Batch Settings
What are batch settings?
Batch settings refer to the rules and configurations that determine how and when credit card transactions are grouped (or “batched”) together for settlement. Instead of processing each transaction individually, batching allows multiple transactions to be processed and settled together, typically once per day.
This is common in payment processing systems to improve efficiency, reduce fees, and streamline reconciliation.
Default Configurations for Merchants
When a merchant is onboarded to the platform, the following default batch settings apply:
Auto-Batch Time
- Enabled by default.
- Time: 4:00 AM UTC
- Any transactions captured during the day will be grouped into a batch and automatically closed at this time.
Terminal Auto-Close
- This setting allows terminals (such as standalone payment devices) to have their own batch auto-close time, separate from other sources like Virtual Terminal or API.
- To enable terminal-specific batching, a Device ID must be transmitted, and the source must be set to “terminal.”
Manual Batch Management (Optional) If Auto-Close is disabled, the merchant becomes fully responsible for manually closing their batch. Failure to close a batch manually may result in:
- Higher interchange fees
- Delayed funding
- Increased risk of chargebacks
Batch Closure
What is batch closure?
Batch closure is the process by which the system finalizes a group of approved credit card transactions (known as a batch) and submits them to the processor for settlement. Once a batch is closed, those transactions are locked for changes.
Standard Closure Process
Auto-Close (Default Behavior)
- All approved transactions from that day are automatically batched and closed at the designated time (e.g., 4:00 AM UTC).
Manual Close (Optional)
- If auto-close is disabled, merchants must use the dashboard or API to manually close the batch.
- If not closed, transactions remain unsettled and are not funded until closed.
When is a new batch opened?
- A new batch is automatically initiated upon the next approved transaction after the previous batch is closed.
Impact on Transactions
What happens after batch closure?
Once a batch is closed:
Voids:
- You can no longer void a transaction from a closed batch.
- Voids are only possible before the batch is closed.
Refunds:
- You can issue a refund for a closed transaction, but this will be a new transaction that is added to the next open batch.
- Refunds take longer to process than voids (usually 3–5 business days).
Important Notes:
- Only finalized actions (e.g., sales, refunds) are included in a batch.
- A batch will never include pending or incomplete transactions.
- Once closed, a batch is read-only and cannot be modified.
Batch Statuses
Batches have two statuses:
Open – This is the current batch actively collecting approved transactions. It remains open until:
- It is auto-closed at the scheduled time, or
- It is manually closed by the merchant
Closed – This batch has been finalized and submitted for settlement.
- No further changes can be made.
- The next batch is automatically started upon the next successful transaction.
There is no “pending” status for batches; transactions may be pending, but batches are either open or closed.
Batch Creation by Payment Source
Does the source of the payment affect batching?
Not directly.
Transactions from sources such as API, Payment Links, Invoices, Recurring Contracts, and Virtual Terminal are grouped into the same batch, as long as they fall within the current batch window and share the same Merchant ID.
However, Terminal Auto-Close can allow terminal transactions to be batched separately if:
- The Device ID is transmitted, and
- The source is defined as “terminal.”
This is typically used for merchants who want to separate their in-person (terminal) transactions from online or keyed-in ones.
API Operations
List Batches for a Merchant
Retrieve all batches created for a merchant within a given time frame. Useful for merchants who want to view their daily/weekly settlement cycles.
Common use cases:
- Monitoring all batches over a period.
- Checking batch IDs before drilling into details.
Call: GET /checkout/v3/batch
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
merchantid | query | string | Yes | Merchant identifier. |
startDate | query | string (ISO 8601 UTC) | Conditional* | Start of date range (use when dateRange is Custom). |
endDate | query | string (ISO 8601 UTC) | Conditional* | End of date range (use when dateRange is Custom). |
limit | query | integer | No | Page size. |
offset | query | integer | No | Offset for pagination. |
dateRange | query | string | No | Date filter preset (e.g., Custom). |
status | query | string | No | Filter by batch status (Open or Closed). |
*Conditional means required when a custom date range is used.
Retrieve a Batch Details
Fetch detailed information for a specific batch, including totals, status, and key timestamps.
Common use cases:
- Reviewing a batch before reconciliation.
- Confirming settlement readiness.
Call: GET /checkout/v3/batch?batchId={batchId}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
batchId | query | integer | Yes | The batch identifier to retrieve. |
Close a Batch
Manually close an open batch to initiate settlement. If not manually closed, the system may auto-close at the end of the cycle.
Common use cases:
- Merchants who want early closure (e.g., end of shift).
- Ensuring same-day settlement.
Call: PUT /checkout/v3/batch/{batchId}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
batchId | path | integer | Yes | The open batch to close. |
Retrieve Transactions within a Batch
Get a list of all transactions grouped in a particular batch.
Common use cases:
- Investigating discrepancies or failed transactions.
- Downloading all transactions for reconciliation.
Call: GET /checkout/v3/batchpayment?id={batchId}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | query | integer | Yes | The batchId to list transactions for. |
Updated 10 days ago