Transaction Administration - Return

Return funds back to a prior authorization.
Variable Required Max Size Notes
publisher-name Mandatory NA Gateway account username issued to you.
publisher-password Mandatory NA Remote Client Password - This is different then the password used to login.
mode Mandatory NA Value needs to be set to ‘return’
card-amount Mandatory NA Format: 1234.56 - Total amount to be charged.
orderID Mandatory 20 Original transaction’s transaction ID.
currency Optional/Mandatory 3 3 Char. ISO Currency Code. Defaults to USD. Mandatory for multicurrency accounts.

Notes:

1. Usage Notes:

  • The type of return is linked to the previous transaction’s records.

  • This cannot be used on transactions over 1 year old.

  • This type of return is limited to one use per orderID.

  • Amount returned cannot exceed that of the original auth.

  • Use this mode when returning funds back to the same transaction.

Response Values - Return
Variable Value Notes
FinalStatus success/problem/pending Will return either ‘success’ or ‘prending’ (processor dependent) upon success. Will return ‘failure’ on failure.
success yes/no Will return either ‘yes’ upon success or ’no’ upon failure.
Mstatus success/problem/pending Deprecated in favor of FinalStatus
Aux-msg Aux message if applicable on success. orderid has been successfully makred for settlement.
MErrMsg Error message if applicable on failure. Transaction already voided. It may not be returned. Order ID does not exist as a previous order. It may not be marked for return. Transaction not yet settled. It may not be returned. Transaction already returned.
Duplicate yes/blank yes - If the orderID of the transaction has previously been submitted, then the value of ‘Duplicate’ will be set to ‘yes’ and the values of the other fields will be the same as the original transaction.