Transaction Administration - Return Previous

Credits funds, using card info file from a previous transaction. (see note 1)
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 ‘returnprev’
prevorderid Mandatory 20 Original transaction’s transaction ID.Billing data only valid for 1 year from original transaction.Please update the stored orderID so only the most recent one is used.
card-amount Mandatory NA Format: 1234.56 - Total amount to be charged.
orderID Optional 20 Must be unique. If not submitted, one will be generated using a date/time string. This number will be required to perform any future activity for an order, including but not limited to, voids and returns. Note capitalization of the ‘I’ and ‘D’.

1. Usage Notes:

  • This type of return is NOT linked to the previous transaction’s records; instead a new orderID will be associated to each return submitted.

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

  • This type of return can be issued for any amount and can be used as often as needed.

  • Use this mode when amount returned exceeds that of the original auth and/or when you want to issue the return to a card already on file.

  • Use this mode when issuing additional returns on a particular transaction. (i.e. use ‘return’ mode for 1st return, then use ‘returnprev’ for 2nd, 3rd, 4th, Nth return)

  • Please update the stored orderID so only the most recent one is used.

Response Values - Return Previous
Variable Value Notes
FinalStatus success/problem/pending Will return either ‘success’ or ‘pending’ (processor dependent) upon success. Will return ‘problem’ on failure.
Duplicate yes/blank yes - If the orderID of the transaction has previously been submitted the value will be ‘yes’ and the values of the other fields will echo the values of the original transaction.
success yes/no Will return ‘yes’ upon success or ’no’ on failure.
Mstatus success/problem/pending Deprecated in favor of FinalStatus
aux-msg Aux message if applicable on success. orderID has been successfully marked 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 has already been returned.
Duplicate yes/blank yes - If the orderID of the transaction has previously been submitted the value will be ‘yes’ and the values of the other fields will echo the values of the original transaction.