A Commit Batch request is a way to perform multiple postauth’s with one request to the server.

Transaction Administration - Batch Commit

Overview

The Batch Commit operation allows multiple transactions to be post-authorized (committed) in a single server request. Each transaction is referenced individually using a numeric suffix, enabling bulk settlement processing.

Request Parameters

Variable Requirement Type Max Size Possible Values / Example Description Notes
publisher-name Mandatory string N/A Example: gatewayuser Gateway account username issued to you.
publisher-password Mandatory string N/A Example: securepassword Remote Client Password used for API authentication. This differs from the login password for the administrative interface.
mode Mandatory string N/A batchcommit Specifies the batch commit operation. Must be set to batchcommit.
orderID-X Mandatory string 20 Example: 1234567890 Original transaction ID for post-authorization. X is a sequential index from 1 to 99.
card-amount-X Mandatory decimal 10 1234.56 Amount to be captured for transaction X. 1 Cannot exceed original authorization amount.
currency-X Optional / Mandatory string 3 USD ISO 3-character currency code for transaction X. Used with card-amount-X. Defaults to USD; required for multicurrency accounts.
num-txns Mandatory integer N/A 3 Number of transactions included in the batch commit request. Must be between 1 and 99.
notify-email Optional string 39 user@example.com Email address for transaction error or alert notifications.

Response Parameters

Variable Value Description Notes
FinalStatus success, problem Overall batch commit result. Returns success on completion; problem on failure.
Duplicate yes, blank Indicates whether a transaction was previously submitted. If yes, original transaction values are echoed back.
success yes, no Indicates whether the request succeeded.
Mstatus success, problem Legacy status field. Deprecated in favor of FinalStatus.
aux-msg string Informational message returned upon success. May be empty depending on processor response.
MErrMsg string Error message returned on failure. May contain batch-level failure details.

Per-Transaction Response Parameters

Each transaction within the batch is returned with indexed fields.

Variable Value Description Notes
FinalStatus-X success, problem, pending Status of transaction X. X ranges from 1 to 99.
MErrMsg-X string Error message for transaction X. Only populated if transaction X fails.
Mstatus-X success, problem Legacy per-transaction status field. Deprecated in favor of FinalStatus-X.
Duplicate-X yes, blank Indicates duplicate submission for transaction X. If yes, original transaction data is returned unchanged.

⚠️ Formatting Rule (Applies to All Amount Fields)

  1. All monetary values must be numeric only in the format 1234.56. Do not include currency symbols, commas, or formatting. Exactly two decimal places are required. ↩︎