Transaction Administration - Credit


Credits funds to card info provided. (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 ’newreturn'
orderID Optional 20 Unique numeric identifier for transaction. Must be a unique number. If not submitted one will be generated using a date/time string. This number is required to perform any future activity for an order, including but not limited to voids and returns.
card-amount Mandatory 10 Amount to credit to customer. No currency symbols or commas.
card-name Mandatory 39 Name as it appears on Credit Card.
card-address1 Optional 39 Billing Street Address Line 1.
card-address2 Optional 39 Billing Street Address Line 2.
card-city Optional 39 Billing City Address.
card-state Optional 2 Billing State Address - 2 Char. State Code
card-zip Optional 10 Billing Zip Address.
card-country Optional 3 Billing 2 Character Country Code
card-number Mandatory 16 Credit Card # - Numeric characters only.Format: 4111111111111111
card-exp Mandatory 5 Credit Card Expiration Date.Format: MM/YY
notify-email Optional NA Email address to send alert notice for transacton problems.
currency Optional/Mandatory 3 3 Char. ISO Currency Code. Defaults to USD. Mandatory for multicurrency accounts.

1. Usage Notes:

  • Credits are not associated with any prior authorization; a new orderID will be associated to each credit submitted.

  • Credits can issued for any amount and can be used as often as needed.

  • Use this mode for returning funds on transactions over 1 year old.

  • Use this mode when returning funds to a different card, then what was originally used by the customer.

2. These variables are required if your merchant bank processor is either Pago or Wirecard. For other processors, they are optional but highly recommended.

Response Values - Credit

Variable Value Notes
FinalStatus success/problem/pending Will return ‘success’ or ‘pending’ (processor dependent) upon success. Will return ‘probelm’ 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. No records found. 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.
user-agent Browser or Identifier of posting system.
ipaddress IP address of posting system.