Marking a transaction, recorded in the system as a postauth, is a request to settle the transaction. Transactions that are postauthed are swept to the bank for transfer of funds. A transaction can be settled for an amount up to but not greater than the amount of the original authorization. For a transaction to settle for an amount less than the original sale amount it needs to have an auth reversal or reauth performed. If a mark request for an amount less than the original sale is received, the system will automatically converted the transaction request to a reauth transaction and then mark it for settlement.

Transaction Administration - Mark


Overview

The Mark operation is used to settle a specific previously authorized transaction. It finalizes the transaction amount and submits it for 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 administrative login password.
mode Mandatory string N/A mark Specifies the settlement operation type. Must be set to mark.
orderID Mandatory string 20 Example: 1234567890 Original transaction identifier to be settled. Required for transaction lookup and settlement.
card-amount Mandatory decimal 10 1234.56 Amount to be submitted for settlement. 1 Must not include currency symbols.
currency Optional / Mandatory string 3 USD ISO 3-character currency code. Used with card-amount. Defaults to USD; required for multicurrency accounts.
gratuity Optional decimal 10 10.00 Tip amount added to the settlement total. Only applicable for restaurant-configured accounts.
notify-email Optional string 39 user@example.com Email address used for transaction alerts. Used for error or settlement notifications.

Response Parameters

Variable Value Description Notes
FinalStatus success, problem, pending Overall result of the settlement request. May return pending depending on processor behavior.
success yes, no Indicates whether the request succeeded.
Mstatus success, problem, pending Legacy status field. Deprecated in favor of FinalStatus.
aux-msg string Informational message returned on success. Example: order marked for settlement.
MErrMsg string Error message returned on failure. Indicates why settlement failed.
Duplicate yes, blank Indicates duplicate submission of orderID. 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. ↩︎