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.

Key Highlights:

• Transactions are grouped into a batch through Batch Closure. Only settled batches are eligible for funding.
• Automatically or manually group transactions into daily settlement batches.
• Monitor batch statuses — Open or Closed.
• Control batch timing through merchant-level or terminal-specific settings.
• Retrieve and review batch and transaction details via API.

Benefits:

• Clear visibility into daily sales and settlement activity.
• Simplified reconciliation with processor and funding reports.
• Faster identification of any discrepancies or missing transactions.

---

How It Works

• Transactions are approved throughout the day.
• Batches automatically close at the configured auto-close time (default: 4:00 AM UTC).
• Settled batches are submitted to the processor for fund transfer.
• A new batch is automatically created upon the next approved transaction.

📘

Best Practice: Close batches daily to ensure timely settlements and prevent funding delays.

---

Batch Configuration

The rules and configurations 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.

Merchants can configure batching behavior based on their operational needs.

---

Batch Management Operations

Below are the API endpoints used for managing batches.

1. Retrieve Batches for a Merchant

Retrieve a list of all batches for a merchant using either of the following endpoints:

• Basic Request: Use the GET /checkout/v3/batch?merchantid={{merchantId}} endpoint to retrieve all batches associated with the merchant.
• Filtered Request: Use the GET /checkout/v3/batch?merchantid={{merchantId}}&startDate={{startDate}}&endDate={{endDate}}&limit={{limit}}&offset={{offset}}&dateRange={{dateRange}}&status={{status}} endpoint to retrieve batches filtered by date range, status, and pagination parameters.

2. Close an Open Batch

Use the PUT /checkout/v3/batch/{batchId} API endpoint to close a specific batch to initiate settlement.

3. Get Batch by ID

Use the GET /checkout/v3/batch?batchId={batchId} to Retrieve complete details for a specific batch using its ID.

Key Response Fields:

4. Retrieve Batch Transactions

Use the GET /checkout/v3/batchpayment?id={batchId} to fetch detailed transaction information for a batch.

Key Response Fields:

---

Batch Lifecycle

The batch lifecycle outlines how transactions move from authorization to settlement, helping merchants track the status of their daily payment batches.

---

Troubleshooting

---

See Also

• Retrieve Payment API
• Cancel Payment API
• Refund Payment API
• Payments lifecycle

---

Pending Items

• Questions raised : https://prioritycommerce.atlassian.net/browse/APIHELP-10382
• Need to update links for all API endpoints mentioned above