A return is a credit transaction associated with a prior auth. A return can be made for an amount less than or equal to the amount of the original auth. Only one return may be performed per transaction even if the amount of the return is less than the amount of the original auth.

Transaction Administration - Return

Overview

The Return operation issues a refund back to a prior authorization. This action is tied directly to an existing transaction and cannot be used independently.

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 return Specifies the return/refund operation. Must be set to return.
orderID Mandatory string 20 Example: 1234567890 Original transaction identifier. Required for linking the return to the prior authorization.
card-amount Mandatory decimal 10 1234.56 Amount to be refunded. 1 Cannot exceed the original authorization amount.
currency Optional / Mandatory string 3 USD ISO 3-character currency code. Defaults to USD; required for multicurrency accounts.

Response Parameters

Variable Value Description Notes
FinalStatus success, problem, pending Overall return request status. 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 success message. Example: order marked for settlement.
MErrMsg string Error message returned on failure. Includes issues such as invalid orderID or already returned transactions.
Duplicate yes, blank Indicates duplicate submission of orderID. If yes, original transaction data is returned unchanged.

Usage Notes

  • Returns are directly linked to the original transaction record.
  • This operation cannot be used for transactions older than 6 months.
  • Only one return is allowed per orderID.
  • Refund amount must not exceed the original authorized amount.
  • This mode should only be used when refunding to the same transaction source.
  • If a return is issued against an unsettled authorization, the gateway voids the transaction instead of issuing a refund.

⚠️ 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. ↩︎