Defines Remote API account authentication, transaction behavior, and processing control parameters.

Account Authentication and Transaction Control

Variable Requirement Type Max Size Possible Values / Example Description Notes
publisher-name Mandatory string N/A your_gateway_username Gateway account username issued to your account. Required for all Remote API requests.
publisher-password Mandatory string N/A — Remote Client Password associated with the account. This is different from the administrative login password. Generated in the Security Administration area.
publisher-email Optional string N/A person@place.com Merchant email address for order confirmation messages. Also used as the return address for customer emails. Defaults to address set in Email Management
cc-mail Optional string 100 person@place.com Secondary email address for merchant order confirmations. Used as an additional recipient for transaction notifications.
mode Optional string N/A auth Defines the Remote API transaction mode or operation type. Required for administrative functions. Defaults to auth if omitted.
paymethod Optional string 11 credit, onlinecheck Specifies the payment method used for the transaction. onlinecheck = ACH/eCheck processing, credit or blank = credit card transaction.
authtype Optional string 39 authpostauth, authonly Defines transaction settlement behavior. authpostauth automatically marks transactions for settlement. Defaults to authonly if omitted.
required Optional string N/A card-address|card-city|card-zip|email Pipe-delimited list of variables that should be enforced as required fields. Used to validate incoming transaction requests.
app-level Optional integer 1 1, 2, 3, 4, 5, 6 AVS approval level required for transaction approval. Transactions failing the specified AVS level are automatically voided. AVS verification is primarily available for U.S.-issued cards.
dontsndmail Optional string 3 yes Prevents the system from sending confirmation emails to the customer. Useful when merchant systems handle customer notifications separately.
client Optional string N/A coldfusion, softcart, cart32 Identifies the originating client software or integration platform. Used to modify system behavior for compatibility purposes.
convert Optional string N/A underscores Converts hyphens in variable names to underscores. Primarily used for integrations that cannot process hyphenated variable names.
transflags Optional string N/A recurring, debt, multicurrency, moto, retail, avsonly, fleet, cit, mit, init Defines special transaction processing behaviors and flags. recurring = recurring billing transaction, debt = Visa debt repayment, multicurrency = multi-currency processing, moto = mail/telephone order, retail = retail environment transaction, avsonly = address verification only with 0.00 amount allowed, fleet = petroleum fleet card transaction. Card on File combinations (cit, mit, init) may be comma-joined; see Card On File Requirements.
origorderid Optional string N/A Example: 1234567890 Original Cardholder Initiated transaction orderID used for subsequent Card on File charges. Required for subsequent CIT/MIT Card on File transactions. See Card On File Requirements.

Notes

The fields above apply to the Plug’n Pay Remote API authorization interface and are used to authenticate requests, define transaction behavior, and customize integration handling.

When storing card credentials on an initial authorization (mode defaults to auth), or when processing subsequent stored-credential transactions, send the appropriate Card on File transflags and origorderid values. See Card On File Requirements.