Retrieve Order
Request to retrieve the details of an order and all transactions associated with this order.
URL | https://evopaymentsmexico.gateway.mastercard.com/api/rest/version/34/merchant/{merchantId}/order/{orderid} |
HTTP Method | GET |
Authentication |
This operation requires authentication via one of the following methods:
|
Request Parameters
correlationId String = OPTIONAL
responseControls = OPTIONAL
responseControls.sensitiveData String = OPTIONAL
{merchantId} Alphanumeric + additional characters COMPULSORY
{orderid} String COMPULSORY
Response Parameters
amount Decimal = Always Provided
creationTime DateTime = Always Provided
currency Upper case alphabetic text = Always Provided
id String = Always Provided
merchant Alphanumeric + additional characters = Always Provided
result Enumeration = Always Provided
totalAuthorizedAmount Decimal = Always Provided
totalCapturedAmount Decimal = Always Provided
totalRefundedAmount Decimal = Always Provided
acceptPartialAmount Boolean = CONDITIONAL
Unless you have been advised by your payment service provider that the gateway supports partial approvals for your acquirer, you can ignore this field.
If the gateway supports partial approvals for your acquirer you must set this field to TRUE else the transaction is rejected by the gateway.
amount Decimal = Always Provided
billing = CONDITIONAL
billing.address = CONDITIONAL
billing.address.city String = CONDITIONAL
billing.address.company String = CONDITIONAL
billing.address.country Upper case alphabetic text = CONDITIONAL
billing.address.postcodeZip Alphanumeric + additional characters = CONDITIONAL
billing.address.stateProvince String = CONDITIONAL
billing.address.street String = CONDITIONAL
billing.address.street2 String = CONDITIONAL
correlationId String = CONDITIONAL
creationTime DateTime = Always Provided
currency Upper case alphabetic text = Always Provided
currencyConversion = CONDITIONAL
You can only provide DCC information on the initial transaction for an order. If provided on subsequent transactions or an order, DCC information will be ignored.
currencyConversion.exchangeRateTime DateTime = CONDITIONAL
currencyConversion.marginPercentage Decimal = CONDITIONAL
currencyConversion.payerAmount Decimal = CONDITIONAL
currencyConversion.payerCurrency Upper case alphabetic text = CONDITIONAL
currencyConversion.payerExchangeRate Decimal = CONDITIONAL
currencyConversion.payerReceiptText String = CONDITIONAL
currencyConversion.provider Enumeration = CONDITIONAL
currencyConversion.providerReceipt String = CONDITIONAL
currencyConversion.uptake Enumeration = Always Provided
custom String = CONDITIONAL
customer = CONDITIONAL
customer.email Email = CONDITIONAL
customer.firstName String = CONDITIONAL
customer.lastName String = CONDITIONAL
customer.mobilePhone String = CONDITIONAL
customer.phone String = CONDITIONAL
customerNote String = CONDITIONAL
customerOrderDate Date = CONDITIONAL
customerReference ASCII Text = CONDITIONAL
description String = CONDITIONAL
device = CONDITIONAL
device.ani String = CONDITIONAL
device.aniCallType String = CONDITIONAL
device.browser String = CONDITIONAL
device.hostname String = CONDITIONAL
device.ipAddress String = CONDITIONAL
discount = CONDITIONAL
discount.amount Decimal = CONDITIONAL
discount.code String = CONDITIONAL
discount.description String = CONDITIONAL
id String = Always Provided
item[n] = CONDITIONAL
item[n].brand String = CONDITIONAL
item[n].category String = CONDITIONAL
item[n].description String = CONDITIONAL
item[n].name String = Always Provided
item[n].quantity Integer = Always Provided
item[n].sku String = CONDITIONAL
item[n].unitPrice Decimal = Always Provided
item[n].unitTaxAmount Decimal = CONDITIONAL
itemAmount Decimal = CONDITIONAL
merchant Alphanumeric + additional characters = Always Provided
notificationUrl Url = CONDITIONAL
productSKU String = CONDITIONAL
recurringPaymentAgreement Alphanumeric = CONDITIONAL
reference String = CONDITIONAL
requestorName String = CONDITIONAL
result Enumeration = Always Provided
risk = CONDITIONAL
risk.custom String = CONDITIONAL
Field: risk.custom.headOfficeLocation
Value: London UK
risk.response = CONDITIONAL
risk.response.gatewayCode Enumeration = CONDITIONAL
risk.response.reversalResult Enumeration = CONDITIONAL
risk.response.review = CONDITIONAL
risk.response.review.decision Enumeration = CONDITIONAL
risk.response.review.decisionReason String = CONDITIONAL
risk.response.review.note String = CONDITIONAL
risk.response.review.timeOfDecision DateTime = CONDITIONAL
risk.response.review.userId String = CONDITIONAL
risk.response.rule[n] = CONDITIONAL
risk.response.rule[n].data String = CONDITIONAL
risk.response.rule[n].id String = CONDITIONAL
risk.response.rule[n].name String = CONDITIONAL
risk.response.rule[n].recommendation Enumeration = CONDITIONAL
risk.response.rule[n].score Integer = CONDITIONAL
risk.response.rule[n].type Enumeration = CONDITIONAL
risk.response.totalScore Integer = CONDITIONAL
shipping = CONDITIONAL
shipping.address = CONDITIONAL
shipping.address.city String = CONDITIONAL
shipping.address.company String = CONDITIONAL
shipping.address.country Upper case alphabetic text = CONDITIONAL
shipping.address.postcodeZip Alphanumeric + additional characters = CONDITIONAL
shipping.address.stateProvince String = CONDITIONAL
shipping.address.street String = CONDITIONAL
shipping.address.street2 String = CONDITIONAL
shipping.contact = CONDITIONAL
shipping.contact.email Email = CONDITIONAL
shipping.contact.firstName String = CONDITIONAL
shipping.contact.lastName String = CONDITIONAL
shipping.contact.mobilePhone String = CONDITIONAL
shipping.contact.phone String = CONDITIONAL
shipping.method Enumeration = CONDITIONAL
shippingAndHandlingAmount Decimal = CONDITIONAL
sourceOfFunds = CONDITIONAL
sourceOfFunds.provided = CONDITIONAL
sourceOfFunds.provided.ach = CONDITIONAL
sourceOfFunds.provided.ach.accountType Enumeration = CONDITIONAL
- Consumer (checking or savings), or
- Business
For pre-arranged payments (sourceOfFunds.provided.ach.secCode=PPD) retrieve this information from the payer.
If payments were telephone-initiated (sourceOfFunds.provided.ach.secCode=TEL) or internet-initiated (sourceOfFunds.provided.ach.secCode=WEB) you may choose to limit the payer's options (e.g. only support consumer checking accounts), depending on your type of business (e.g. B2C online webshop).
sourceOfFunds.provided.ach.bankAccountHolder String = CONDITIONAL
sourceOfFunds.provided.ach.bankAccountNumber Alphanumeric + additional characters = CONDITIONAL
sourceOfFunds.provided.ach.routingNumber Digits = CONDITIONAL
- Routing number,
- Transit number, or
- ABA number
Retrieve this information from the payer.
See also http://en.wikipedia.org/wiki/Routing_transit_number.
sourceOfFunds.provided.ach.secCode Enumeration = CONDITIONAL
sourceOfFunds.provided.card = CONDITIONAL
sourceOfFunds.provided.card.accountType Enumeration = CONDITIONAL
sourceOfFunds.provided.card.brand Enumeration = Always Provided
You may use this information to support surcharging decisions. This information is gathered from 3rd party sources and may not be accurate in all circumstances.
sourceOfFunds.provided.card.expiry = CONDITIONAL
sourceOfFunds.provided.card.expiry.month Digits = Always Provided
sourceOfFunds.provided.card.expiry.year Digits = Always Provided
sourceOfFunds.provided.card.fundingMethod Enumeration = Always Provided
sourceOfFunds.provided.card.issuer String = CONDITIONAL
sourceOfFunds.provided.card.localBrand String = CONDITIONAL
You may use this information to support surcharging decisions. This information is gathered from 3rd party sources and may not be accurate in all circumstances.
sourceOfFunds.provided.card.nameOnCard String = CONDITIONAL
sourceOfFunds.provided.card.number Masked digits = Always Provided
sourceOfFunds.provided.card.scheme Enumeration = Always Provided
sourceOfFunds.provided.card.securityCodePresence Alphanumeric = CONDITIONAL
sourceOfFunds.provided.card.sequenceNumber Digits = CONDITIONAL
sourceOfFunds.provided.card.trackDataProvided Boolean = CONDITIONAL
sourceOfFunds.provided.giftCard = CONDITIONAL
sourceOfFunds.provided.giftCard.brand Enumeration = Always Provided
sourceOfFunds.provided.giftCard.localBrand String = Always Provided
sourceOfFunds.provided.giftCard.number Masked digits = Always Provided
sourceOfFunds.provided.giftCard.pin Masked digits = CONDITIONAL
sourceOfFunds.provided.giftCard.scheme Enumeration = Always Provided
sourceOfFunds.provided.giropay = CONDITIONAL
sourceOfFunds.provided.giropay.bankIdentifier Digits = Always Provided
sourceOfFunds.provided.paypal = CONDITIONAL
sourceOfFunds.provided.paypal.accountEmail Email = CONDITIONAL
sourceOfFunds.provided.paypal.accountHolder String = CONDITIONAL
sourceOfFunds.provided.sofort = CONDITIONAL
sourceOfFunds.provided.sofort.bankAccountHolder String = CONDITIONAL
sourceOfFunds.provided.sofort.bankAccountNumber String = CONDITIONAL
sourceOfFunds.provided.sofort.bankIdentifier String = CONDITIONAL
sourceOfFunds.provided.sofort.bic String = CONDITIONAL
sourceOfFunds.provided.sofort.country Upper case alphabetic text = CONDITIONAL
sourceOfFunds.provided.sofort.iban String = CONDITIONAL
sourceOfFunds.token Alphanumeric = CONDITIONAL
sourceOfFunds.type Enumeration = CONDITIONAL
status Enumeration = CONDITIONAL
subMerchant = CONDITIONAL
subMerchant.address = CONDITIONAL
subMerchant.address.city String = CONDITIONAL
subMerchant.address.company String = CONDITIONAL
subMerchant.address.country Upper case alphabetic text = CONDITIONAL
subMerchant.address.postcodeZip Alphanumeric + additional characters = CONDITIONAL
subMerchant.address.stateProvince String = CONDITIONAL
subMerchant.address.street String = CONDITIONAL
subMerchant.address.street2 String = CONDITIONAL
subMerchant.bankIndustryCode Digits = CONDITIONAL
subMerchant.email Email = CONDITIONAL
subMerchant.identifier String = CONDITIONAL
subMerchant.phone String = CONDITIONAL
subMerchant.registeredName String = CONDITIONAL
subMerchant.tradingName String = CONDITIONAL
tax[n] = CONDITIONAL
tax[n].amount Decimal = CONDITIONAL
tax[n].type String = CONDITIONAL
taxAmount Decimal = CONDITIONAL
taxRegistrationId String = CONDITIONAL
totalAuthorizedAmount Decimal = Always Provided
totalCapturedAmount Decimal = Always Provided
totalRefundedAmount Decimal = Always Provided
transaction[n] = CONDITIONAL
transaction[n].3DSecure = CONDITIONAL
transaction[n].3DSecure.acsEci Digits = CONDITIONAL
transaction[n].3DSecure.authenticationStatus Enumeration = CONDITIONAL
The PARes message is the response received from the card Issuer's Access Control Server (ACS) after the cardholder has completed the authentication process.
transaction[n].3DSecure.authenticationToken Base64 = CONDITIONAL
This field corresponds to the Cardholder Authentication Verification Value (CAVV) for Visa, the Accountholder Authentication Value (AAV) for MasterCard and JCB, or the American Express Verification Value (AEVV) for American Express.
transaction[n].3DSecure.enrollmentStatus Enumeration = Always Provided
transaction[n].3DSecure.xid Base64 = CONDITIONAL
transaction[n].3DSecureId ASCII Text = CONDITIONAL
It is not used when the authentication is performed externally.
transaction[n].airline = CONDITIONAL
transaction[n].airline.bookingReference Alphanumeric = CONDITIONAL
transaction[n].airline.documentType Enumeration = CONDITIONAL
transaction[n].airline.itinerary = CONDITIONAL
transaction[n].airline.itinerary.leg[n] = CONDITIONAL
transaction[n].airline.itinerary.leg[n].carrierCode Regex = CONDITIONAL
transaction[n].airline.itinerary.leg[n].conjunctionTicketNumber Alphanumeric = CONDITIONAL
transaction[n].airline.itinerary.leg[n].couponNumber Alphanumeric = CONDITIONAL
transaction[n].airline.itinerary.leg[n].departureAirport Upper case alphabetic text = CONDITIONAL
transaction[n].airline.itinerary.leg[n].departureDate Date = CONDITIONAL
transaction[n].airline.itinerary.leg[n].departureTax Decimal = CONDITIONAL
transaction[n].airline.itinerary.leg[n].departureTime Time = CONDITIONAL
transaction[n].airline.itinerary.leg[n].destinationAirport Upper case alphabetic text = CONDITIONAL
transaction[n].airline.itinerary.leg[n].destinationArrivalDate Date = CONDITIONAL
transaction[n].airline.itinerary.leg[n].destinationArrivalTime Time = CONDITIONAL
transaction[n].airline.itinerary.leg[n].endorsementsRestrictions Alphanumeric = CONDITIONAL
transaction[n].airline.itinerary.leg[n].exchangeTicketNumber Alphanumeric = CONDITIONAL
transaction[n].airline.itinerary.leg[n].fare Decimal = CONDITIONAL
transaction[n].airline.itinerary.leg[n].fareBasis Alphanumeric = CONDITIONAL
transaction[n].airline.itinerary.leg[n].fees Decimal = CONDITIONAL
transaction[n].airline.itinerary.leg[n].flightNumber Alphanumeric = CONDITIONAL
transaction[n].airline.itinerary.leg[n].stopoverPermitted Boolean = CONDITIONAL
transaction[n].airline.itinerary.leg[n].taxes Decimal = CONDITIONAL
transaction[n].airline.itinerary.leg[n].travelClass Alphanumeric = CONDITIONAL
transaction[n].airline.itinerary.numberInParty Digits = CONDITIONAL
transaction[n].airline.itinerary.originCountry Upper case alphabetic text = CONDITIONAL
transaction[n].airline.passenger[n] = CONDITIONAL
transaction[n].airline.passenger[n].firstName String = CONDITIONAL
transaction[n].airline.passenger[n].frequentFlyerNumber String = CONDITIONAL
transaction[n].airline.passenger[n].lastName String = CONDITIONAL
transaction[n].airline.passenger[n].middleName String = CONDITIONAL
transaction[n].airline.passenger[n].specificInformation Alphanumeric = CONDITIONAL
transaction[n].airline.passenger[n].title String = CONDITIONAL
transaction[n].airline.planNumber Alphanumeric = CONDITIONAL
transaction[n].airline.ticket = CONDITIONAL
transaction[n].airline.ticket.conjunctionTicketIndicator Boolean = CONDITIONAL
transaction[n].airline.ticket.eTicket Boolean = CONDITIONAL
transaction[n].airline.ticket.exchangedTicketNumber Alphanumeric = CONDITIONAL
transaction[n].airline.ticket.issue = CONDITIONAL
transaction[n].airline.ticket.issue.address String = CONDITIONAL
transaction[n].airline.ticket.issue.carrierCode Regex = CONDITIONAL
transaction[n].airline.ticket.issue.carrierName Alphanumeric = CONDITIONAL
transaction[n].airline.ticket.issue.city Alphanumeric = CONDITIONAL
transaction[n].airline.ticket.issue.country Upper case alphabetic text = CONDITIONAL
transaction[n].airline.ticket.issue.date Date = CONDITIONAL
transaction[n].airline.ticket.issue.travelAgentCode Alphanumeric = CONDITIONAL
transaction[n].airline.ticket.issue.travelAgentName Alphanumeric = CONDITIONAL
transaction[n].airline.ticket.restricted Boolean = CONDITIONAL
transaction[n].airline.ticket.ticketNumber Alphanumeric = CONDITIONAL
transaction[n].airline.ticket.totalFare Decimal = CONDITIONAL
transaction[n].airline.ticket.totalFees Decimal = CONDITIONAL
transaction[n].airline.ticket.totalTaxes Decimal = CONDITIONAL
transaction[n].airline.transactionType Enumeration = CONDITIONAL
transaction[n].billing = CONDITIONAL
transaction[n].billing.address = CONDITIONAL
transaction[n].billing.address.city String = CONDITIONAL
transaction[n].billing.address.company String = CONDITIONAL
transaction[n].billing.address.country Upper case alphabetic text = CONDITIONAL
transaction[n].billing.address.postcodeZip Alphanumeric + additional characters = CONDITIONAL
transaction[n].billing.address.stateProvince String = CONDITIONAL
transaction[n].billing.address.street String = CONDITIONAL
transaction[n].billing.address.street2 String = CONDITIONAL
transaction[n].browserPayment = CONDITIONAL
transaction[n].browserPayment.interaction = CONDITIONAL
transaction[n].browserPayment.interaction.status Enumeration = Always Provided
transaction[n].browserPayment.interaction.timeCompleted ASCII Text = CONDITIONAL
transaction[n].browserPayment.interaction.timeInitiated ASCII Text = CONDITIONAL
transaction[n].browserPayment.interaction.timeRedirected ASCII Text = CONDITIONAL
transaction[n].browserPayment.interaction.timeReturned ASCII Text = CONDITIONAL
transaction[n].browserPayment.operation Enumeration = CONDITIONAL
transaction[n].browserPayment.paypal = CONDITIONAL
transaction[n].browserPayment.paypal.displayShippingAddress Boolean = CONDITIONAL
transaction[n].browserPayment.paypal.overrideShippingAddress Boolean = CONDITIONAL
transaction[n].browserPayment.paypal.paymentConfirmation Enumeration = CONDITIONAL
transaction[n].browserPayment.redirectUrl Url = CONDITIONAL
transaction[n].browserPayment.returnUrl Url = CONDITIONAL
transaction[n].constraints = CONDITIONAL
transaction[n].constraints.paymentPlans = CONDITIONAL
transaction[n].constraints.paymentPlans.numberOfDeferrals Integer = CONDITIONAL
transaction[n].constraints.paymentPlans.numberOfPayments Integer = CONDITIONAL
transaction[n].constraints.paymentPlans.supported[n] String = CONDITIONAL
See Payment Plans for the supported payment plans and their identifiers.
transaction[n].currencyConversion = CONDITIONAL
You can only provide DCC information on the initial transaction for an order. If provided on subsequent transactions or an order, DCC information will be ignored.
transaction[n].currencyConversion.exchangeRateTime DateTime = CONDITIONAL
transaction[n].currencyConversion.marginPercentage Decimal = CONDITIONAL
transaction[n].currencyConversion.payerAmount Decimal = CONDITIONAL
transaction[n].currencyConversion.payerCurrency Upper case alphabetic text = CONDITIONAL
transaction[n].currencyConversion.payerExchangeRate Decimal = CONDITIONAL
transaction[n].currencyConversion.payerReceiptText String = CONDITIONAL
transaction[n].currencyConversion.provider Enumeration = CONDITIONAL
transaction[n].currencyConversion.providerReceipt String = CONDITIONAL
transaction[n].currencyConversion.uptake Enumeration = Always Provided
transaction[n].customer = CONDITIONAL
transaction[n].customer.email Email = CONDITIONAL
transaction[n].customer.firstName String = CONDITIONAL
transaction[n].customer.lastName String = CONDITIONAL
transaction[n].customer.mobilePhone String = CONDITIONAL
transaction[n].customer.phone String = CONDITIONAL
transaction[n].device = CONDITIONAL
transaction[n].device.ani String = CONDITIONAL
transaction[n].device.aniCallType String = CONDITIONAL
transaction[n].device.browser String = CONDITIONAL
transaction[n].device.hostname String = CONDITIONAL
transaction[n].device.ipAddress String = CONDITIONAL
transaction[n].gatewayEntryPoint Enumeration = CONDITIONAL
transaction[n].giftCard = CONDITIONAL
transaction[n].giftCard.availableBalance = CONDITIONAL
transaction[n].giftCard.availableBalance.amount Decimal = CONDITIONAL
transaction[n].giftCard.availableBalance.currency Upper case alphabetic text = CONDITIONAL
transaction[n].merchant Alphanumeric + additional characters = Always Provided
transaction[n].order = Always Provided
transaction[n].order.acceptPartialAmount Boolean = CONDITIONAL
Unless you have been advised by your payment service provider that the gateway supports partial approvals for your acquirer, you can ignore this field.
If the gateway supports partial approvals for your acquirer you must set this field to TRUE else the transaction is rejected by the gateway.
transaction[n].order.amount Decimal = Always Provided
transaction[n].order.creationTime DateTime = Always Provided
transaction[n].order.currency Upper case alphabetic text = Always Provided
transaction[n].order.custom String = CONDITIONAL
transaction[n].order.customerNote String = CONDITIONAL
transaction[n].order.customerOrderDate Date = CONDITIONAL
transaction[n].order.customerReference ASCII Text = CONDITIONAL
transaction[n].order.description String = CONDITIONAL
transaction[n].order.discount = CONDITIONAL
transaction[n].order.discount.amount Decimal = CONDITIONAL
transaction[n].order.discount.code String = CONDITIONAL
transaction[n].order.discount.description String = CONDITIONAL
transaction[n].order.id String = Always Provided
transaction[n].order.item[n] = CONDITIONAL
transaction[n].order.item[n].brand String = CONDITIONAL
transaction[n].order.item[n].category String = CONDITIONAL
transaction[n].order.item[n].description String = CONDITIONAL
transaction[n].order.item[n].name String = Always Provided
transaction[n].order.item[n].quantity Integer = Always Provided
transaction[n].order.item[n].sku String = CONDITIONAL
transaction[n].order.item[n].unitPrice Decimal = Always Provided
transaction[n].order.item[n].unitTaxAmount Decimal = CONDITIONAL
transaction[n].order.itemAmount Decimal = CONDITIONAL
transaction[n].order.notificationUrl Url = CONDITIONAL
transaction[n].order.productSKU String = CONDITIONAL
transaction[n].order.recurringPaymentAgreement Alphanumeric = CONDITIONAL
transaction[n].order.reference String = CONDITIONAL
transaction[n].order.requestorName String = CONDITIONAL
transaction[n].order.shippingAndHandlingAmount Decimal = CONDITIONAL
transaction[n].order.status Enumeration = CONDITIONAL
transaction[n].order.subMerchant = CONDITIONAL
transaction[n].order.subMerchant.address = CONDITIONAL
transaction[n].order.subMerchant.address.city String = CONDITIONAL
transaction[n].order.subMerchant.address.company String = CONDITIONAL
transaction[n].order.subMerchant.address.country Upper case alphabetic text = CONDITIONAL
transaction[n].order.subMerchant.address.postcodeZip Alphanumeric + additional characters = CONDITIONAL
transaction[n].order.subMerchant.address.stateProvince String = CONDITIONAL
transaction[n].order.subMerchant.address.street String = CONDITIONAL
transaction[n].order.subMerchant.address.street2 String = CONDITIONAL
transaction[n].order.subMerchant.bankIndustryCode Digits = CONDITIONAL
transaction[n].order.subMerchant.email Email = CONDITIONAL
transaction[n].order.subMerchant.identifier String = CONDITIONAL
transaction[n].order.subMerchant.phone String = CONDITIONAL
transaction[n].order.subMerchant.registeredName String = CONDITIONAL
transaction[n].order.subMerchant.tradingName String = CONDITIONAL
transaction[n].order.tax[n] = CONDITIONAL
transaction[n].order.tax[n].amount Decimal = CONDITIONAL
transaction[n].order.tax[n].type String = CONDITIONAL
transaction[n].order.taxAmount Decimal = CONDITIONAL
transaction[n].order.taxRegistrationId String = CONDITIONAL
transaction[n].order.totalAuthorizedAmount Decimal = Always Provided
transaction[n].order.totalCapturedAmount Decimal = Always Provided
transaction[n].order.totalRefundedAmount Decimal = Always Provided
transaction[n].order.wallet.visaCheckout.callId String = CONDITIONAL
transaction[n].order.walletIndicator String = CONDITIONAL
transaction[n].order.walletProvider Enumeration = CONDITIONAL
transaction[n].partnerSolutionId String = CONDITIONAL
transaction[n].paymentPlan = CONDITIONAL
transaction[n].paymentPlan.finalAmount Decimal = Always Provided
transaction[n].paymentPlan.interestRate Decimal = Always Provided
transaction[n].paymentPlan.numberOfDeferrals Integer = Always Provided
transaction[n].paymentPlan.numberOfPayments Integer = Always Provided
transaction[n].paymentPlan.paymentAmount Decimal = Always Provided
transaction[n].paymentPlan.planId String = Always Provided
transaction[n].posTerminal = CONDITIONAL
transaction[n].posTerminal.attended Enumeration = CONDITIONAL
transaction[n].posTerminal.cardholderActivated Enumeration = CONDITIONAL
transaction[n].posTerminal.entryMode Digits = CONDITIONAL
PAN ENTRY Mode
01 - Manual Entry
02 - Magnetic stripe read, but full unaltered contents not provided
04 - OCR/MICR coding read
05 - PAN auto entry via chip
07 - Auto-entry via contactless magnetic chip
79 - Chip card at chip-capable terminal was unable to process transaction using data on the chip or magnetic stripe on the card-therefore, PAN entry via manual entry
80 - Chip card at chip-capable terminal was unable to process transaction using data on the chip therefore; the terminal defaulted to the magnetic stripe read for the PAN. This is referred to as fallback.
90 - Magnetic stripe read and full, unaltered contents provided
91 - Auto-entry via contactless magnetic strip
PIN Entry Mode
0 - Unspecified or unknown
1 - Terminal has PIN entry capability
2 - Terminal does not have PIN entry capability (default)
8 - Terminal has PIN entry capability but PIN pad is not currently operative
transaction[n].posTerminal.inputCapability Enumeration = CONDITIONAL
transaction[n].posTerminal.location Enumeration = CONDITIONAL
transaction[n].posTerminal.name String = Always Provided
transaction[n].response = Always Provided
transaction[n].response.acquirerCode ASCII Text = CONDITIONAL
transaction[n].response.acquirerMessage ASCII Text = CONDITIONAL
transaction[n].response.cardSecurityCode = CONDITIONAL
transaction[n].response.cardSecurityCode.acquirerCode ASCII Text = CONDITIONAL
transaction[n].response.cardSecurityCode.gatewayCode Enumeration = CONDITIONAL
transaction[n].response.cardholderVerification = CONDITIONAL
transaction[n].response.cardholderVerification.avs = CONDITIONAL
transaction[n].response.cardholderVerification.avs.acquirerCode ASCII Text = CONDITIONAL
transaction[n].response.cardholderVerification.avs.gatewayCode Enumeration = CONDITIONAL
transaction[n].response.cardholderVerification.detailedVerification[n] = CONDITIONAL
transaction[n].response.cardholderVerification.detailedVerification[n].gatewayCode Enumeration = CONDITIONAL
transaction[n].response.cardholderVerification.detailedVerification[n].type Enumeration = CONDITIONAL
transaction[n].response.debugInformation String = CONDITIONAL
transaction[n].response.gatewayCode Enumeration = Always Provided
transaction[n].response.recurringPaymentAdvice = CONDITIONAL
transaction[n].response.recurringPaymentAdvice.acquirerCode Digits = CONDITIONAL
transaction[n].result Enumeration = Always Provided
transaction[n].risk = CONDITIONAL
transaction[n].risk.custom String = CONDITIONAL
Field: risk.custom.headOfficeLocation
Value: London UK
transaction[n].risk.response = CONDITIONAL
transaction[n].risk.response.gatewayCode Enumeration = CONDITIONAL
transaction[n].risk.response.reversalResult Enumeration = CONDITIONAL
transaction[n].risk.response.review = CONDITIONAL
transaction[n].risk.response.review.decision Enumeration = CONDITIONAL
transaction[n].risk.response.review.decisionReason String = CONDITIONAL
transaction[n].risk.response.review.note String = CONDITIONAL
transaction[n].risk.response.review.timeOfDecision DateTime = CONDITIONAL
transaction[n].risk.response.review.userId String = CONDITIONAL
transaction[n].risk.response.rule[n] = CONDITIONAL
transaction[n].risk.response.rule[n].data String = CONDITIONAL
transaction[n].risk.response.rule[n].id String = CONDITIONAL
transaction[n].risk.response.rule[n].name String = CONDITIONAL
transaction[n].risk.response.rule[n].recommendation Enumeration = CONDITIONAL
transaction[n].risk.response.rule[n].score Integer = CONDITIONAL
transaction[n].risk.response.rule[n].type Enumeration = CONDITIONAL
transaction[n].risk.response.totalScore Integer = CONDITIONAL
transaction[n].shipping = CONDITIONAL
transaction[n].shipping.address = CONDITIONAL
transaction[n].shipping.address.city String = CONDITIONAL
transaction[n].shipping.address.company String = CONDITIONAL
transaction[n].shipping.address.country Upper case alphabetic text = CONDITIONAL
transaction[n].shipping.address.postcodeZip Alphanumeric + additional characters = CONDITIONAL
transaction[n].shipping.address.stateProvince String = CONDITIONAL
transaction[n].shipping.address.street String = CONDITIONAL
transaction[n].shipping.address.street2 String = CONDITIONAL
transaction[n].shipping.contact = CONDITIONAL
transaction[n].shipping.contact.email Email = CONDITIONAL
transaction[n].shipping.contact.firstName String = CONDITIONAL
transaction[n].shipping.contact.lastName String = CONDITIONAL
transaction[n].shipping.contact.mobilePhone String = CONDITIONAL
transaction[n].shipping.contact.phone String = CONDITIONAL
transaction[n].shipping.method Enumeration = CONDITIONAL
transaction[n].sourceOfFunds = CONDITIONAL
For card payments the source of funds information may be represented by combining one or more of the following: explicitly provided card details, a session identifier which the gateway will use to look up the card details and/or a card token. Precedence rules will be applied in that explicitly provided card details will override session card details which will override card token details. Each of these may represent partial card details, however the combination must result in a full and complete set of card details. See Using Multiple Sources of Card Details for examples.
transaction[n].sourceOfFunds.provided = CONDITIONAL
transaction[n].sourceOfFunds.provided.ach = CONDITIONAL
transaction[n].sourceOfFunds.provided.ach.accountType Enumeration = CONDITIONAL
- Consumer (checking or savings), or
- Business
For pre-arranged payments (sourceOfFunds.provided.ach.secCode=PPD) retrieve this information from the payer.
If payments were telephone-initiated (sourceOfFunds.provided.ach.secCode=TEL) or internet-initiated (sourceOfFunds.provided.ach.secCode=WEB) you may choose to limit the payer's options (e.g. only support consumer checking accounts), depending on your type of business (e.g. B2C online webshop).
transaction[n].sourceOfFunds.provided.ach.bankAccountHolder String = CONDITIONAL
transaction[n].sourceOfFunds.provided.ach.bankAccountNumber Alphanumeric + additional characters = CONDITIONAL
transaction[n].sourceOfFunds.provided.ach.routingNumber Digits = CONDITIONAL
- Routing number,
- Transit number, or
- ABA number
Retrieve this information from the payer.
See also http://en.wikipedia.org/wiki/Routing_transit_number.
transaction[n].sourceOfFunds.provided.ach.secCode Enumeration = CONDITIONAL
transaction[n].sourceOfFunds.provided.card = CONDITIONAL
transaction[n].sourceOfFunds.provided.card.accountType Enumeration = CONDITIONAL
transaction[n].sourceOfFunds.provided.card.brand Enumeration = Always Provided
You may use this information to support surcharging decisions. This information is gathered from 3rd party sources and may not be accurate in all circumstances.
transaction[n].sourceOfFunds.provided.card.expiry = CONDITIONAL
transaction[n].sourceOfFunds.provided.card.expiry.month Digits = Always Provided
transaction[n].sourceOfFunds.provided.card.expiry.year Digits = Always Provided
transaction[n].sourceOfFunds.provided.card.fundingMethod Enumeration = Always Provided
transaction[n].sourceOfFunds.provided.card.issuer String = CONDITIONAL
transaction[n].sourceOfFunds.provided.card.localBrand String = CONDITIONAL
You may use this information to support surcharging decisions. This information is gathered from 3rd party sources and may not be accurate in all circumstances.