A credit transfers funds from a merchant’s account and is a not associated with any prior auth. A credit can be made for any amount. For security reasons an account can be flagged to prevent credits from being issued. Turning off the ability for an account to allow credits can be done via the Security Administration Area.

Transaction Administration - Credit

Overview

The Credit operation issues funds back to a cardholder. It is used to return money independently of any prior authorization and generates a new transaction record.

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 newreturn Specifies credit/return transaction type. Must be set to newreturn.
orderID Optional string 20 Example: 1234567890 Unique identifier for the credit transaction. If omitted, a system-generated ID is assigned. Must be unique if provided.
card-amount Mandatory decimal 10 1234.56 Amount to be credited to the customer. 1 Must not include currency symbols or commas.
card-name Mandatory string 39 John Doe Cardholder name as displayed on the card.
card-address1 Optional string 39 123 Main St Billing address line 1. Recommended for AVS support.
card-address2 Optional string 39 Apt 2B Billing address line 2.
card-city Optional string 39 New York Billing city.
card-state Optional string 2 NY Billing state code. Must be 2-character state abbreviation.
card-zip Optional string 10 11788 Billing postal code.
card-country Optional string 2 US Billing country code. 2-character ISO country code.
card-number Mandatory string 16 4111111111111111 Credit card number. Numeric characters only; no formatting.
card-exp Mandatory string 5 MM/YY Card expiration date. Must follow MM/YY format.
notify-email Optional string 39 user@example.com Email for transaction alerts. Used for error notifications.
currency Optional / Mandatory string 3 USD Transaction currency code. Defaults to USD; required for multicurrency setups.

Response Parameters

Variable Value Description Notes
FinalStatus success, problem, pending Overall result of the credit request. May return pending depending on processor behavior.
Duplicate yes, blank Indicates whether the transaction was previously submitted. If yes, original transaction data is echoed.
success yes, no Indicates request success or failure.
Mstatus success, problem, pending Legacy status field. Deprecated in favor of FinalStatus.
aux-msg string Informational message on success. Example: order marked for settlement.
MErrMsg string Error message returned on failure. May include settlement or duplication errors.
user-agent string Identifier of the client system submitting the request. Captured for auditing purposes.
ipaddress string IP address of the submitting system. Used for security and tracking.

Usage Notes

  • Credits are not linked to a prior authorization and always generate a new orderID.
  • Credits may be issued for any amount and reused as needed.
  • Recommended for transactions older than 1 year.
  • Used when refunding to a different card than the original transaction.
  • Some processors (e.g., Pago, Wirecard) require additional fields; others may treat them as optional but recommended.

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