Request used for transaction batch request
Request used for Authorization and Purchase Transactions
Request used for Settlement and Credit Transactions
Request used for cancelling Payment Transactions only
Instant Response returned for batch or api request
Response returned for batch request
Response returned for all requests
Request used for Authorization status change
Request used to lookup a previous transaction.
Electronic Commerce Indicator
Cardholder Authentication Verification Value
returned in the Authentication Response
Passed Fraud / Signature Check result status. Y = All transaction and signature checks satisfied. N = At least one transaction or signature check failed
Transaction Identifier returned in the
Authentication Response
I (Initial Recurring), R (Subsequent Recurring)
The confirmation number of the initial transaction related to this recurring transaction
The confirmation number of the recurring transaction that directly preceded this one. This may be the initial or a recurring transaction
[DEPRECATED] The method used to make the payment. Possible values are:
WEB = Card Number Provided Online,
TEL = Card Number Provided by Phone,
P = Card present,
PD = Card present deferred,
D = Deferred
First name
Last name
Street information line 1
Street information line 2
City
Use Region for geographical regions outside US and Canada
State in US or Province in Canada
The 2 letter ISO Country Code
Postal code
Phone number
Email address
The card number against which the Purchase is made
For Card Present (CP) transactions merchants can provide the track 1 data instead of the first and last name.
For Card Present (CP) transactions merchants can provide the track 2 data instead of the card number and expiry.
The expiry date for the card
The type of card against which the Purchase is made. Possible values are: AM = American Express, DC = Diners Club, DI = Discover, FP = FirePay, MC = MasterCard, SF = Swiff, SO = Solo, SW = Switch, VI = Visa, JC = JCB, MD = Maestro, VD = Visa Debit, VE = Visa Electron, N = Novus (now Discover), CB = Carte Blanche. NOTE: If you need to use other card types, please contact technical support
The 1- or 2-digit number located on the front of the card, following the card number. NOTE: The issueNumber parameter can be used only when the cardType is SO (Solo) or SW (Switch)
The status of CVD value information. Possible values are: 0 = The customer did not provide a value. 1 = The customer provided a value. 2 = The value is illegible. 3 = The value is not on the card
The 3- or 4-digit security code that appears on the back of a card following the card number. This code does not appear on imprints. NOTE: The cvd parameter is mandatory when the cvdIndicator parameter value = 1
A unique ID number associated with each request. The value is created by the merchant and submitted as part of the request
A unique ID number associated with each request. The value is created by the merchant and submitted as part of the request
Generated token that represents the buyer
Amount in dollars
Creditcard information
Indicates whether the authorization is to be an estimated pre authorization or not
The 3DSecure authentication information (ex Verfied by Visa)
An authorization code that has already been previously provided
Indicates whether the customer has previously shopped online with this merchant
I (Initial Recurring), R (Subsequent Recurring)
Recurring billing information
Holds details of Stored Credential as required by implementation of VISA compliance 2.11 + 9.2.2
Customer's IP address
The type of product ordered. Possible values are: P = Physical Goods, D = Digital Goods (e.g. software), C = Digital Content (e.g. images and/or text), G = Gift Certificate/Digital Cash, S = Shareware
, M = Both Digital and Physical (e.g. software downloaded followed by media shipment), R = Account Replenish (subscription renewal)
The virtual or wallet account that this transaction is to affect. In most cases, this will be a firepay personal account
Indicates that a risk check should be done when processing the transaction
Validates that this request is not a duplicate. A request is considered a duplicate if the card number, amount and merchantRefNum are the same
Meta data about the sdk used to send the transaction request
Additional data
Dynamic descriptor used in credit card statement
Dynamic descriptor line 2; contact for exact details
Amount before applying any taxes in dollars
Additional fields for pre-arranged financing transactions
Transaction description
[DEPRECATED] The mode used to capture card number information
GPS location of the transaction
wallet transaction Id
This is how the transaction has been initiated and will affect the way it will be processed.
Possible values are:
MOTO = Mail Order/Telephone Order
In the case of a settlement this should be the response Id (or transactionId from DP) of the original authorization transaction. In the case of a credit this is the response Id (or transactionId from DP) of the original purchase, settlement, or authorization transaction
A unique ID number associated with each request. The value is created by the merchant and submitted as part of the request
Amount in dollars
For backwards compatibility only. Applicable to credit requests where the original settlement was processed through the DP protocol. The merchantTxn from DP from the settlement request that is to be credited
Validates that this request is not a duplicate. A request is considered a duplicate if the card number, amount and merchantRefNum are the same
Additional data
GPS location of the transaction
Additional fields for pre-arranged financing transactions
Request used to credit the card holder's card (OCT)
A unique ID number associated with each request. The value is created by the merchant and submitted as part of the request
Generated token that represents the buyer
Amount in dollars
Creditcard information
Meta data about the sdk used to send the transaction request
An authorization code that has already been previously provided
The confirmation number of a previously accepted and captured authorization. Required for some gaming payments.
MasterCard gaming payments further require the referenced authorization to be fully authenticated.
Contact merchant services to see if you require this field.
Additional data
In the case of a settlement, this should be the response Id of the original authorization transaction. In the case of a credit this is the response Id of the original Purchase or Settlement transaction. In case of a payment this is the response Id of the original Payment transaction
Additional data
GPS location of the transaction
A unique ID number associated with each request. The value is created by the merchant and submitted as part of the request
UNKNOWN, RECEIVED, ACCEPTED, CANCELLED, ERROR, HELD
A unique numeric code classifying this detail (e.g. "32" might mean "missing parameter"). This is included to simplify "switch" construct processing by the client
A human readable description of the tag
Any additional details
A unique ID number associated with each request. The value is created by the merchant and submitted as part of the request
Index of the payment instruction from the Request
Confirmation number that is returned by the system for a request
A unique ID number associated with each request. The value is created by the merchant and submitted as part of the request
The merchant account against which the
transaction is made
UNKNOWN, RECEIVED, ACCEPTED, CANCELLED, ERROR, HELD
A unique numeric code classifying this detail (e.g. "32" might mean "missing parameter"). This is included to simplify "switch" construct processing by the client
R (Retry), M (Merchant Parameter Error), C (Consumer Parameter Error), D (Do not retry)
A human readable description of the tag
The Authorization code assigned by the issuing bank and returned by the transaction processor
X Exact. Nine-digit zip code and address match. Y Yes. Five-digit zip code and address match. A Address matches, but zip code does not. W Nine-digit zip code matches, but address does not. Z Five-digit zip code matches, but address does not. N No part of the address matches. U Address information is unavailable. R Retry. System unable to process. S AVS not supported. E AVS not supported for this industry. B AVS not performed. Q Unknown response from issuer/banknet switch
The response to the CVD value submitted with the CCAuthRequest. Possible values are: M (Match) = The CVD value provided matches the CVD value associated with the card. N (No Match) = The CVD value provided does not match the CVD value associated with the card. P (Not Processed) = The CVD value was not processed. S = Merchant indicated that CVD value was not present on the card. U = Issuer is not certified and/or has not provided Visa encryption keys
Any additional details
Transaction Time
Indicates if this transaction is a duplicate transaction, if a duplicate check was requested
If a duplicate record was found, this element contains the details of that record
If the cardholder enrolled in the authentication program, this response will contain a URL for the Merchant to redirect the cardholder's browser to the corresponding Issuing Bank ACS
The number of times the Load Balancer engine retried this transaction
The original response code returned by the system that caused the Load Balancer engine to retry the transaction
Additional gateway/service response values
Amount before applying any taxes in dollars
Amount in dollars
Risk Response Error Codes
The transaction type of the record found. Returned on Lookup only.
A - Authorize
P - Purchase
S - Settlement
CR - Credit
PY - Credit Card Payment
N - Independent Credit
The last 4 digits of the card associated with this transaction. Returned on Lookup only.
The expiry date for the card. associated with this transaction. Returned on Lookup only.
Unique identifier of the txn in Netbanx. Returned on Lookup only.
Transaction response of the record(s) found. Returned on Lookup only.
Holds details of Stored Credential as required by implementation of VISA compliance 2.11 + 9.2.2
Purchase return authorization response.
Classification of the detail element
Description of the detail
Type of tax to be charged
tax rate (percentage)
tax rate (percentage)
Amount in dollars
Type of tax applied to
The merchant account against which the request is made
The account transaction processing id
The account transaction processing password
Version number of the sdk being used
The integration language of the sdk (e.g. java, dotnet, cpp, perl, php, cf). The values are not enforced via an enumeration. See integration documentation for list of valid platform elements
Indicates the author of the sdk. All SDK's provided by Optimal Payments will set the provider to "op"
The shipment carrier. Possible values are: APC = APC Overnight, APS = AnPost, CAD = Canada Postal Service, DHL, FEX = Fedex, RML = Royal Mail, UPS = United Parcel Service, USPS = United States Postal Service, CLK = CityLink, EMS = EMS (US Postal Service), NEX = nexworldwide, OTHER
The method of shipment. Possible values are: N = Next Day/Overnight, T = Two-Day Service, C = Lowest Cost, O = Other
First name
Last name
Street information line 1
Street information line 2
City
Use Region for geographical regions outside US and Canada
State in US or Province in Canada
The 2 letter ISO Country Code
Postal code
Phone number
Email address
A positive number (including 0)
The type of card against which the Purchase is made. Possible values are: AM = American Express, DC = Diners Club, DI = Discover, FP = FirePay, MC = MasterCard, SF = Swiff, SO = Solo, SW = Switch, VI = Visa, JC = JCB, MD = Maestro, VD = Visa Debit, VE = Visa Electron, N = Novus (now Discover), CB = Carte Blanche. NOTE: If you need to use other card types, please contact technical support
The shipment carrier. Possible values are: APC = APC Overnight, APS = AnPost, CAD = Canada Postal Service, DHL, FEX = Fedex, RML = Royal Mail, UPS = United Parcel Service, USPS = United States Postal Service, CLK = CityLink, EMS = EMS (US Postal Service), NEX = nexworldwide, OTHER
3D Secure lookup response message
A fully qualified URL to redirect the consumer to complete the payer authentication transaction
An encoded payment request generated by MAPS
Request used for 3D Secure Authentication
Payload value representing the payer authentication
A merchant reference number for TDS authenticate request
Generated token that represents the buyer
Request used for Stored Data Authorization and Purchase Transactions
A unique ID number associated with each request. The value is created by the merchant and submitted as part of the request
A confirmation number from a previous successful transaction
Amount in dollars
The 3- or 4-digit security code that appears on the back of a card following
the card number. This code does not appear on imprints. NOTE: The cvd parameter is mandatory when the cvdIndicator parameter value = 1.
Holds details of Stored Credential as required by implementation of VISA compliance 2.11 + 9.2.2
Dynamic descriptor used in credit card statement
Dynamic descriptor line 2; contact for exact details
Additional data
Cardholder authentication availability.
Y = Cardholder authentication available.
N = Cardholder not enrolled in authentication.
U = Cardholder authentication unavailable.
E = Error
Generated token that represents the buyer
Request for TDS enrollment lookup
Identifies the authentication outcome
Authentication value. Indicates that the transaction has been authenticated. This value will be encoded according to the Merchant's Centinel profile in either Base64 encoding or Hex encoding
Passed Fraud / Signature Check result status. Y = All transaction and signature checks satisfied. N = At least one transaction or signature check failed
Transaction Identifier. Some gateways may or may not require this value to be appended to the authorization message. This value will only be returned on payer authentication transactions
E-Commerce Indicator (ECI). This value will only be returned on payer authentication transactions.
Visa / JCB
05 = Identifies a successfully authenticated transaction.
06 = Identifies an attempted authenticated transaction.
07 = Identifies a non-authenticated transaction.
MasterCard
00 = Identifies that authentication was unavailable at the issuing bank.
01 = Identifies a non-authenticated transaction.
02 = Identifies a successfully authenticated transaction
Identifies the authentication outcome. Y = Successful authentication. Cardholder successfully authenticated with their Card Issuer. A = Attempted authentication. Cardholder authentication was attempted. N = Failed authentication. Cardholder failed to successfully authenticate with their Card Issuer. U = Authentication unavailable. Authentication with the Card Issuerwas unavailable. E = Error. R = Indication from the issuing bank that the transaction should be rejected
Request used for Authorization Reversal Transactions
A transaction request type for authorization reversal
Merchant account information
The confirmation number of the authorization
A unique transaction identifier provided by the merchant
The amount to reverse. If this value is empty, the full amount of the authorization will be reversed
Additional data
GPS location of the transaction
A code that represent the service provide who provides the values
The financing plan type associated with this transaction
The plan number for this financing transaction
The grace period associated with deferred payment transactions
The number of payments in months for equal payment transations
Financing type of this transaction
D - Deferred Payment Financing
E - Equal Payment Financing
How card data was entered
SWIPED - card reader was used
MANUAL - Card number manually entered
GPS latitude value
GPS longitude value
Risk Error Codes
Only allowed if transaction is already in a held state
In the case of a settlement this should be the response Id (or transactionId from DP) of the original authorization transaction. In the case of a credit this is the response Id (or transactionId from DP) of the original purchase, settlement, or authorization transaction
A unique ID number associated with each request. The value is created by the merchant and submitted as part of the request
Additional data
Request used to lookup previous transactions
Account validation information
Confirmation number that is returned by the system for a request
Unique identifier of the txn in Netbanx.
A unique ID associated with each request. The value is created by the merchant and submitted as part of the request.
Starting date/time for the search (inclusive)
Ending date/time for the search (inclusive)
The recipient postal code
The recipient last name (surname)
The recipient account number.
The Wallet Indicator is returned by the wallet platform
Enumeration: MERCHANT_ONLY, 3DS
Enumeration: MANUAL, DIRECT_PROVISIONED, 3DS_MANUAL, NFC_TAP
The value assigned by MasterCard that represents the programs associated directly with Maestro cards.
Enumeration: ADHOC, TOPUP, RECURRING
Enumeration: INITIAL, SUBSEQUENT
The confirmation number of the initial transaction related to this recurring transaction
The external reference to the initial transaction related to this recurring transaction
Enumeration: ADHOC, TOPUP, RECURRING
Enumeration: INITIAL, SUBSEQUENT
The confirmation number of the initial transaction related to this recurring transaction
The external reference to the initial transaction related to this recurring transaction
Payment Facilitator Name
Sub-Merchant Identifer
Sub-Merchant Name
Confirmation number that is returned by the system for the request
A unique ID number associated with each request. The value is created by the merchant and submitted as part of the request
Transaction Time
The Authorization code assigned by the issuing bank and returned by the transaction processor
The amount in the currency of the account.
This is how the transaction has been initiated and will affect the way it will be processed.
Possible values are:
MOTO = Mail Order/Telephone Order
CARD_PRESENT = Card Present
3DS strong customers authentication's exemption indicator.
Possible values are:
LOW_VALUE_EXEMPTION = For transactions under 30 EUR.