The Payment operation functions similarly to a credit transaction and is used to issue funds back to a cardholder. This mode is restricted to specific processors and card types.

Transaction Administration - Payment

Overview

The Payment operation functions similarly to a credit transaction and is used to issue funds back to a cardholder. This mode is restricted to specific processors and card types.

Do not use this mode unless advised by our Plug’n Pay staff This is available only for PAGO merchant accounts with VISA cards. For standard transaction processing, use normal authorization (mode=auth) instead — see Section 1. Remote Authorization.

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 payment Specifies payment processing mode. Must be set to payment.
orderID Optional string 20 Example: 1234567890 Unique transaction identifier. If omitted, a system-generated ID based on timestamp is used. Required for future operations such as voids or returns.
card-amount Mandatory decimal 10 1234.56 Amount to be credited to the customer. 1 Must not include currency symbols or commas.
currency Optional / Mandatory string 3 USD ISO 3-character currency code. Used with card-amount. Defaults to USD; required for multicurrency accounts.
card-name Mandatory string 39 John Doe Cardholder name as shown on the card.
card-address1 Mandatory string 39 123 Main St Billing address line 1. Required for this mode.
card-address2 Optional string 39 Apt 2B Billing address line 2.
card-city Mandatory string 39 New York Billing city. Required for this mode.
card-state Mandatory string 2 NY Billing state code. Must be 2-character state abbreviation.
card-zip Mandatory string 10 11788 Billing postal code.
card-country Mandatory string 2 US Billing country code. Must be 2-character ISO country code.
card-number Mandatory string 16 4111111111111111 Credit card number. Numeric characters only; see Credit Card Storage Validation Policy.
card-exp Mandatory string 5 MM/YY Card expiration date. Must follow MM/YY format.
notify-email Optional string 39 user@example.com Email address for transaction alerts. Used for failure notifications.

Response Parameters

Variable Value Description Notes
FinalStatus success, problem, pending Overall transaction result. 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. May include settlement or refund restrictions.
user-agent string Identifier of the submitting system or browser. Used for audit tracking.
ipaddress string IP address of the submitting system. Logged for security purposes.
Duplicate yes, no Indicates duplicate submission of orderID. If yes, original transaction data is returned unchanged.

Notes

  • Restricted to PAGO merchant accounts and VISA cards.
  • If this mode does not apply to your account or card type, use Credit (newreturn) instead.

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