Home > Field Mapping


Field Mapping

Field Names in JSON Response

The Transaction Search and Transaction Detail REST APIs return JSON responses. The table below shows the new REST field names and the old servlet field names.

Table 3Servlet to REST Field Mapping

Servlet Field Name

REST Field Name

ApplicationReplies.ApplicationReply.Name

applicationInformation.applications[].name

ApplicationReplies.ApplicationReply.Rcode

applicationInformation.applications[].rCode

ApplicationReplies.ApplicationReply.Rflag

applicationInformation.applications[].rFlag

ApplicationReplies.ApplicationReply.RMsg

HTTP 201: errorInformation.message

HTTP 400/502: message

Applications.application

applicationInformation.applications[].name

Applications.reasonCode

applicationInformation.applications[].reasonCode

Applications.status

applicationInformation.applications[].status

BillTo.Address1

orderInformation.billTo.address1

BillTo.Address2

orderInformation.billTo.address2

BillTo.City

orderInformation.billTo.locality

BillTo.CompanyName

orderInformation.billTo.company

BillTo.Country

orderInformation.billTo.country

BillTo.CustomerID

buyerInformation.merchantCustomerId

BillTo.Email

orderInformation.billTo.email

BillTo.FirstName

orderInformation.billTo.firstName

BillTo.Hostname

deviceInformation.hostName

BillTo.IPAddress

deviceInformation.ipAddress

BillTo.LastName

orderInformation.billTo.lastName

BillTo.MiddleName

orderInformation.billTo.middleName

BillTo.NameSuffix

orderInformation.billTo.suffix

BillTo.Phone

orderInformation.billTo.phoneNumber

BillTo.State

orderInformation.billTo.administrativeArea

BillTo.Title

orderInformtion.billTo.title

BillTo.UserName

buyerInformation.merchantCustomerId

BillTo.Zip

orderInformation.billTo.postalCode

Comments

clientReferenceInformation.applicationUser

LineItems.lineItem.FulfillmentType

orderInformation.lineItems[].fulfillmentType

LineItems.lineItem.MerchantProductSKU

orderInformation.lineItems[].productSku

LineItems.lineItem.Number

Not required to return as API response but it should be used to reconstruct the line item array.

LineItems.lineItem.ProductCode

orderInformation.lineItems[].productCode

LineItems.lineItem.ProductName

orderInformation.lineItems[].productName

LineItems.lineItem.Quantity

orderInformation.lineItems[].quantity

LineItems.lineItem.TaxAmount

orderInformation.lineItems[].taxAmount

LineItems.lineItem.UnitPrice

orderInformation.lineItems[].unitPrice

MerchantDefinedData.field1

merchantDefinedInformation[].key = "field1"
merchantDefinedInformation[].value

MerchantDefinedData.field2

merchantDefinedInformation[].key = "field2"
merchantDefinedInformation[].value

MerchantDefinedData.field3

merchantDefinedInformation[].key = "field3"
merchantDefinedInformation[].value

MerchantDefinedData.field4

merchantDefinedInformation[].key = "field4"
merchantDefinedInformation[].value

MerchantDefinedData.field5

merchantDefinedInformation[].key = "field5"
merchantDefinedInformation[].value

MerchantDefinedData.field6

merchantDefinedInformation[].key = "field6"
merchantDefinedInformation[].value

MerchantDefinedData.field7

merchantDefinedInformation[].key = "field7"
merchantDefinedInformation[].value

MerchantDefinedData.field8

merchantDefinedInformation[].key = "field8"
merchantDefinedInformation[].value

MerchantDefinedData.field9

merchantDefinedInformation[].key = "field9"
merchantDefinedInformation[].value

MerchantDefinedData.field10

merchantDefinedInformation[].key = "field10"
merchantDefinedInformation[].value

MerchantDefinedData.field11

merchantDefinedInformation[].key = "field11”
merchantDefinedInformation[].value

MerchantDefinedData.field12

merchantDefinedInformation[].key = "field12"
merchantDefinedInformation[].value

MerchantDefinedData.field13

merchantDefinedInformation[].key = "field13"
merchantDefinedInformation[].value

MerchantDefinedData.field14

merchantDefinedInformation[].key = "field14"
merchantDefinedInformation[].value

MerchantDefinedData.field15

merchantDefinedInformation[].key = "field15"
merchantDefinedInformation[].value

MerchantDefinedData.field16

merchantDefinedInformation[].key = "field16"
merchantDefinedInformation[].value

MerchantDefinedData.field17

merchantDefinedInformation[].key = "field17"
merchantDefinedInformation[].value

MerchantDefinedData.field18

merchantDefinedInformation[].key = "field18"
merchantDefinedInformation[].value

MerchantDefinedData.field19

merchantDefinedInformation[].key = "field19"
merchantDefinedInformation[].value

MerchantDefinedData.field20

merchantDefinedInformation[].key = "field20"
merchantDefinedInformation[].value

MerchantReferenceNumber

clientReferenceInformation.code

PaymentData.ACHVerificationResult

processorInformation.achVerification.resultCodeRaw

PaymentData.ACHVerificationResult
Mapped

processorInformation.achVerification.resultCode

PaymentData.Amount

orderInformation.amountDetails.totalAmount

PaymentData.AuthorizationCode

processorInformation.approvalCode

PaymentData.AVSResult

processorInformation.avs.codeRaw

PaymentData.AVSResultMapped

processorInformation.avs.code

PaymentData.BalanceAmount

paymentInformation.accountFeatures.balanceAmount

PaymentData.BalanceCurrencyCode

paymentInformation.accountFeatures.currency

PaymentData.CurrencyCode

orderInformation.amountDetails.currency

PaymentData.CVResult

processorInformation.cardVerification.resultCode

PaymentData.EVEmail

processorInformation.electronicVerification
Results.email

PaymentData.EVEmailRaw

processorInformation.electronicVerification
Results.emailRaw

PaymentData.EventType

NA

PaymentData.EVName

processorInformation.electronicVerification
Results.name

PaymentData.EVNameRaw

processorInformation.electronicVerification
Results.nameRaw

PaymentData.EVPhoneNumber

processorInformation.electronicVerification
Results.phoneNumber

PaymentData.EVPhoneNumberRaw

processorInformation.electronicVerification
Results.phoneNumberRaw

PaymentData.EVPostalCode

processorInformation.electronicVerification
Results.postalCode

PaymentData.EVPostalCodeRaw

processorInformation.electronicVerification
Results.postalCodeRaw

PaymentData.EVStreet

processorInformation.electronicVerification
Results.street

PaymentData.EVStreetRaw

processorInformation.electronicVerification
Results.streetRaw

PaymentData.NumberOfInstallments

installmentInformation.numberOfInstallments

PaymentData.payerAuthenticationInfo.AAV_CAVV

consumerAuthenticationInformation.cavv

PaymentData.payerAuthenticationInfo.ECI

consumerAuthenticationInformation.eciRaw

PaymentData.payerAuthenticationInfo.XID

consumerAuthenticationInformation.xid

PaymentData.PaymentProcessor

processorInformation.processor.name

PaymentData.PaymentRequestID

Not supported

PaymentData.ProcessorResponseCode

processorInformation.responseCode

PaymentData.RequestedAmount

orderInformation.amountDetails.totalAmount

PaymentData.RequestedAmountCurrencyCode

orderInformation.amountDetails.currency

PaymentData.TotalTaxAmount

orderInformation.amountDetails.taxAmount

PaymentMethod.Card.AccountSuffix

paymentInformation.card.suffix

PaymentMethod.Card.BoletoNumber

paymentInformation.invoice.number

PaymentMethod.Card.CardType

paymentInformation.card.type

PaymentMethod.Card.ExpirationMonth

paymentInformation.card.expirationMonth

PaymentMethod.Card.ExpirationYear

paymentInformation.card.expirationYear

PaymentMethod.Card.IssueNumber

paymentInformation.card.issueNumber

PaymentMethod.Card.StartMonth

paymentInformation.card.startMonth

PaymentMethod.Card.StartYear

paymentInformation.card.startYear

PaymentMethod.Check.AccountSuffix

paymentInformation.bank.account.suffix

PaymentMethod.Check.CheckNumber

paymentInformation.bank.account.checkNumber

PaymentMethod.WalletType

processingInformation.paymentSolution

PredecessorRequestID

rootId

Profilelist.Profile.Name

riskInformation.profile.name

Profilelist.Profile.Name

riskInformation.passiveProfile.name

Profilelist.Profile.ProfileDecision

riskInformation.profile.decision

Profilelist.Profile.ProfileDecision

riskInformation.passiveProfile.decision

Profilelist.Profile.ProfileMode

riskInformation.profiles.mode

Profilelist.Profile.RuleList.Rule.ruleDecision

riskInformation.rules[].decision

Profilelist.Profile.RuleList.Rule.ruleDecision

riskInformation.passiveRules[].decision

Profilelist.Profile.RuleList.Rule.ruleName

riskInformation.rules[].name

Profilelist.Profile.RuleList.Rule.ruleName

riskInformation.passiveRules[].name

reasonCode

applicationInformation.reasonCode

RequestDate

submitTimeUTC

RequestID

id

RiskData.AppliedAVS

processorInformation.avs.code

RiskData.AppliedCategoryGift

Not supported

RiskData.AppliedCategoryTime

Not supported

RiskData.AppliedCV

processorInformation.cardVerification.resultCode

RiskData.AppliedHostHedge

Not supported

RiskData.AppliedThreshold

Not supported

RiskData.AppliedTimeHedge

Not supported

RiskData.AppliedVelocityHedge

Not supported

RiskData.ConsumerLoyalty

Not supported

RiskData.ConsumerPasswordProvided

buyerInformation.hashedPassword

RiskData.ConsumerPromotions

Not supported

RiskData.CookiesAccepted

deviceInformation.cookiesAccepted

RiskData.Factors

riskInformation.score.factorCodes[]

RiskData.GiftWrap

orderInformation.shippingDetails.giftWrap

RiskData.HostSeverity

Not supported

RiskData.LostPassword

Not supported

RiskData.ProductRisk

Not supported

RiskData.RepeatCustomer

Not supported

RiskData.ReturnsAccepted

Not supported

RiskData.Score

riskInformation.score.result

RiskData.TimeLocal

riskInformation.localTime

shipping.Carrier

Not supported

shipping.Method

orderInformation.shippingDetails.shippingMethod

ShipTo.Address1

orderInformation.shipTo.address1

ShipTo.Address2

orderInformation.shipTo.address2

ShipTo.City

orderInformation.shipTo.locality

ShipTo.CompanyName

orderInformation.shipTo.company

ShipTo.Country

orderInformation.shipTo.country

ShipTo.FirstName

orderInformation.shipTo.firstName

ShipTo.LastName

orderInformation.shipTo.lastName

ShipTo.Phone

orderInformation.shipTo.phoneNumber

ShipTo.State

orderInformation.shipTo.administrativeArea

ShipTo.ZipShipTo

orderInformation.shipTo.postalCode

Source

clientReferenceInformation.applicationName

status

applicationInformation.status

SubscriptionID

paymentInformation.customer.customerId

TransactionReferenceNumber

reconciliationID

User

clientReferenceInformation.applicationUser

NA

paymentInformation.card.prefix

NA

paymentInformation.invoice.barcodeNumber

NA

paymentInformation.invoice.expirationDate

NA

paymentInformation.accountFeatures.previousBalanceAmount

NA

consumerAuthenticationInformation.transactionId

pay_req_id

Not supported

order_number

Not supported

request_key

Not supported

auth_type

processingInformation.authorizationOptions.authType

auth_amount

OrderInformation.amountDetails.authorized
Amount

payment_service_data

Not supported

payment_service_data_2

Not supported

response_code

processorInformation.responseCode

type_code

Not supported

acct_enc

Not supported

acct_key

Not supported

NA

paymentInformation.paymentType.name

type

paymentInformation.paymentType.type

subType

paymentInformation.paymentType.method

NA

paymentInformation.paymentType.funding
Source

NA

paymentInformation.paymentType.funding
SourceAffiliation

NA

paymentInformation.paymentType.credential

merchant_name

merchantId

order_total_amount

orderInformation.amountDetails.totalAmount

eci

processingInformation.commerceIndicator

objFxQuoteId

Not supported

accountEncoderID

paymentInformation.card.accountEncoderId
paymentInformation.bank.account.encoderId

posEntryMode

pointOfSaleInformation.entryMode

terminalCapability

pointOfSaleInformation.terminalCapability

processor_trans_id

processorInformation.transactionId

override_payment_method

paymentInformation.card.useAs

payment_network_transaction_id

processorInformation.networkTransactionId

sender_reference_number

senderInformation.referenceNumber

aft_indicator

Not supported

processor_response_id

processorInformation.responseId

provider_transaction_id

processorInformation.providerTransactionId

NA

fraudMarkingInformation.reason