On This Page

Recent Revisions to This Document

25.05.01

May 2025:
This revision of the guide contains updated or new field information.
Updated these fields:
  • clientReferenceInformation.transactionId
  • processingInformation.walletType
Added these new fields:
  • completeMandate.decisionManager
  • completeMandate.type
  • processingInformation.fundingOptions.initiator.originatorInitiatedTransaction.originalTransactionId
  • processingInformation.validationLevel

25.04.02

April 2025:
This revision of the guide contains updated or new field information.
Updated these fields:
  • pointOfSaleInformation.catLevel
  • pointOfSaleInformation.pinEntrySolution
  • processingInformation.businessApplicationId
  • processingInformation.merchantVerificationValue
  • recipientInformation.accountType
  • senderInformation.account.number
  • senderInformation.locality
  • travelInformation.transit.airline.passengerName
Added these new fields:
  • captureOptions.dateToCapture
  • processingInformation.foreignRetailIndicator
  • processorInformation.enhancedDataEnabled

25.04.01

March 2025:
This revision of the guide contains updated or new field information.
Updated this field:
  • merchantInformation.merchantDescriptor.county
Added these new fields:
  • paymentCredentialType
  • transactionType

25.04

March 2025:
 This revision of the guide contains updated or new field information.
Added these new fields:
  • transientTokenResponseOptions.includeCardPrefix
  • travelInformation.autoRental.adjustedAmount
  • travelInformation.autoRental.adjustedAmountIndicator
  • travelInformation.autoRental.affiliateName
  • travelInformation.autoRental.agreementNumber
  • travelInformation.autoRental.commodityCode
  • travelInformation.autoRental.companyId
  • travelInformation.autoRental.corporateClientCode
  • travelInformation.autoRental.customerName
  • travelInformation.autoRental.customerServicePhoneNumber
  • travelInformation.autoRental.dailyRentalRate
  • travelInformation.autoRental.distanceTraveled
  • travelInformation.autoRental.distanceUnit
  • travelInformation.autoRental.driverAge
  • travelInformation.autoRental.extraCharge
  • travelInformation.autoRental.extraMileageCharge
  • travelInformation.autoRental.fuelCharges
  • travelInformation.autoRental.gpsCharge
  • travelInformation.autoRental.insuranceAmount
  • travelInformation.autoRental.insuranceIndicator
  • travelInformation.autoRental.lateFeeAmount
  • travelInformation.autoRental.maxFreeDistance
  • travelInformation.autoRental.mileageCharge
  • travelInformation.autoRental.noShowIndicator
  • travelInformation.autoRental.numberOfAdditionalDrivers
  • travelInformation.autoRental.odometerReading
  • travelInformation.autoRental.oneWayDropOffAmount
  • travelInformation.autoRental.otherCharges
  • travelInformation.autoRental.parkingViolationCharge
  • travelInformation.autoRental.phoneCharge
  • travelInformation.autoRental.programCode
  • travelInformation.autoRental.promotion.additionalCouponCode
  • travelInformation.autoRental.promotion.couponCode
  • travelInformation.autoRental.ratePerMile
  • travelInformation.autoRental.rentalAddress.address1
  • travelInformation.autoRental.rentalAddress.address2
  • travelInformation.autoRental.rentalAddress.city
  • travelInformation.autoRental.rentalAddress.country
  • travelInformation.autoRental.rentalAddress.location
  • travelInformation.autoRental.rentalAddress.locationId
  • travelInformation.autoRental.rentalAddress.postalCode
  • travelInformation.autoRental.rentalAddress.state
  • travelInformation.autoRental.rentalDateTime
  • travelInformation.autoRental.returnAddress.address1
  • travelInformation.autoRental.returnAddress.city
  • travelInformation.autoRental.returnAddress.country
  • travelInformation.autoRental.returnAddress.location
  • travelInformation.autoRental.returnAddress.locationId
  • travelInformation.autoRental.returnAddress.postalCode
  • travelInformation.autoRental.returnAddress.state
  • travelInformation.autoRental.returnDateTime
  • travelInformation.autoRental.specialProgramCode
  • travelInformation.autoRental.taxDetails.amount
  • travelInformation.autoRental.taxDetails.applied
  • travelInformation.autoRental.taxDetails.exemptionCode
  • travelInformation.autoRental.taxDetails.rate
  • travelInformation.autoRental.taxDetails.taxSummary
  • travelInformation.autoRental.taxDetails.taxType
  • travelInformation.autoRental.timePeriod
  • travelInformation.autoRental.towingCharge
  • travelInformation.autoRental.vehicleClass
  • travelInformation.autoRental.vehicleIdentificationNumber
  • travelInformation.autoRental.vehicleMake
  • travelInformation.autoRental.vehicleModel
  • travelInformation.autoRental.weeklyRate

25.03

February 2025:
 This revision of the guide contains updated or new field information.
Added these new fields:
  • captureMandate.requestSaveCard
  • processingInformation.japanPaymentOptions.bonusAmount
  • processingInformation.japanPaymentOptions.bonuses
  • processingInformation.japanPaymentOptions.bonusMonth
  • processingInformation.japanPaymentOptions.preapprovalType
  • processingInformation.japanPaymentOptions.secondBonusAmount
  • processingInformation.japanPaymentOptions.secondBonusMonth
Updated this field:
  • recipientInformation.nationality

25.02

January 2025:
 This revision of the guide contains updated or new field information.
Updated these fields:
  • deviceInformation.hostName
  • orderInformation.amountDetails.gratuityAmount
  • processingInformation.authorizationOptions.billPaymentType

25.01

January 2025:
 This revision of the guide contains updated or new field information.
Added this new field:
  • createInstrumentIdentifier
Updated these fields:
  • orderInformation.amountDetails.taxDetails[].type
  • orderInformation.lineItems[].productSku
  • processingInformation.authorizationOptions.billPaymentType
  • processingInformation.authorizationOptions.initiator.merchantInitiatedTransaction.reason
  • processingInformation.businessApplicationId
  • processingInformation.purposeOfPayment
  • recipientInformation.accountId
  • recipientInformation.accountType
  • recipientInformation.address1
  • recipientInformation.administrativeArea
  • recipientInformation.country
  • recipientInformation.firstName
  • recipientInformation.lastName
  • recipientInformation.locality
  • recipientInformation.middleName
  • recipientInformation.postalCode
  • senderInformation.account.fundsSource
  • senderInformation.account.number
  • senderInformation.account.type
  • senderInformation.address1
  • senderInformation.administrativeArea
  • senderInformation.countryCode
  • senderInformation.firstName
  • senderInformation.identificationNumber
  • senderInformation.lastName
  • senderInformation.middleName
  • senderInformation.name
  • senderInformation.personalIdType
  • senderInformation.locality
  • senderInformation.phoneNumber
  • senderInformation.referenceNumber

24.24

December 2024:
 This revision of the guide contains updated or new field information.
Added this new field:
  • paymentInformation.card.productSubtype
Updated these fields:
  • allowedCardNetworks
  • allowedPaymentTypes

24.23

November 2024:
 This revision of the guide contains updated or new field information.
Updated these fields:
  • processingInformation.authorizationOptions.aftIndicator
  • processingInformation.businessApplicationId
  • processingInformation.commerceIndicator
  • recipientInformation.accountId
  • recipientInformation.accountType
  • recipientInformation.address1
  • recipientInformation.country
  • recipientInformation.firstName
  • recipientInformation.lastName
  • recipientInformation.middleName
  • senderInformation.address1
  • senderInformation.firstName
  • senderInformation.lastName
  • senderInformation.locality
  • senderInformation.middleName

24.22

October 2024:
 This revision of the guide contains updated or new field information.
Added these new fields:
  • productInformation.selectedProducts.commerceSolutions.tokenManagement. configurationInformation.configurations.networkTokenServices. synchronousProvisioning.enabled
  • senderInfomation.accounttype
Updated these fields:
  • merchantInformation.merchantDescriptor.name
  • processingInformation.authorizationOptions.aftIndicator
  • processingInformation.businessApplicationId
  • productInformation.selectedProducts.commerceSolutions.tokenManagement. configurationInformation.configurations.networkTokenEnrollment. businessInformation.acquirer.acquirerId
  • recipientInformation.accountId
  • recipientInformation.accounttype
  • recipientInformation.address1
  • recipientInformation.administrativeArea
  • recipientInformation.country
  • recipientInformation.firstName
  • recipientInformation.lastName
  • recipientInformation.locality
  • recipientInformation.middleName
  • recipientInformation.phoneNumber
  • recipientInformation.postalCode
  • senderInformation.account.number
  • senderInformation.address1
  • senderInformation.administrativeArea
  • senderInformation.account.fundsSource
  • senderInformation.countryCode
  • senderInformation.firstName
  • senderInformation.lastName
  • senderInformation.locality
  • senderInformation.phoneNumber
  • senderInformation.referenceNumber

24.21

October 2024:
 This revision of the guide contains updated or new field information.
Added these new fields:
  • consumerAuthenticationInformation.dataQualityIndicator
  • processorInformation.merchantRiskPrediction
  • recipientInformation.countryOfBirth
  • recipientInformation.email
  • recipientInformation.nationality
  • recipientInformation.occupation
  • serviceProcessing_serviceType
Updated these fields:
  • consumerAuthenticationInformation. strongAuthentication.authenticationOutageExemptionIndicator
  • installmentInformation.identifier
  • processingInformation.authorizationOptions.aftIndicator
  • processingInformation.businessApplicationId
  • processingInformation.purposeOfPayment
  • recipientInformation.dateOfBirth

24.20

September 2024:
 This revision of the guide contains updated or new field information.
Updated this field:
  • merchantInformation.serviceLocation.postalCode
Added these new fields:
  • aggregatorInformation.city
  • aggregatorInformation.country
  • aggregatorInformation.postalCode
  • aggregatorInformation.state
  • aggregatorInformation.streetAddress
  • paymentInformation.accountFeatures.accountHolderType

24.19

September 2024:
 This revision of the guide contains updated or new field information.
Updated fields in this object:
  • productInformation.selectedProducts.payments.payerAuthentication.configurationInformation
  • productInformation.selectedProducts.commerceSolutions.tokenManagement.configurationInformation
Updated these fields:
  • consumerAuthenticationInformation.acsReferenceNumber
  • consumerAuthenticationInformation.authenticationBrand
Added these new fields:
  • retrieveBinDetails
  • source
  • consumerAuthenticationInformation.authenticationBrand

24.18

August 2024:
 This revision of the guide contains updated or new field information.
Updated this field:
  • deviceInformation.userAgentBrowserValue

24.17

August 2024:
 This revision of the guide contains updated or new field information.
Updated this field:
  • travelInformation.lodging.additionalDiscountAmount
  • paymentInsightsInformation.responseInsights.categoryCode

24.16

July 2024:
 This revision of the guide contains updated or new field information.
Added these new fields:
  • customerInformation.company.name
  • customerInformation.email
  • customerInformation.merchantCustomerId
  • customerInformation.name
  • invoiceInformation.allowPartialPayments
  • invoiceInformation.deliveryMode
  • invoiceInformation.description
  • invoiceInformation.dueDate
  • invoiceInformation.invoiceNumber
  • invoiceInformation.sendImmediately
  • orderInformation.amountDetails.discountPercent
  • orderInformation.amountDetails.freight.taxable
  • orderInformation.amountDetails.freight.taxRate
  • orderInformation.amountDetails.minimumPartialAmount
  • orderInformation.amountDetails.subAmount
  • orderInformation.amountDetails.taxDetails.type

24.15

July 2024:
 This revision of the guide contains updated or new field information.
Added these new fields:
  • acquirerInformation.acquirerMerchantId
  • buyerInformation.notToSeller
  • buyerInformation.walletId
  • processingInformation.authorizationOptions.initiator.merchantInitiatedTransaction.agreementId
  • processingInformation.captureOptions.isFinal
  • clientReferenceInformation.applicationName
  • clientReferenceInformation.applicationUser
  • clientReferenceInformation.applicationVersion
  • clientReferenceInformation.returnReconciliationId

24.14

July 2024:
 This revision of the guide contains updated or new field information.
Updated these fields:
  • paymentInformation.card.sourceAccountType
  • paymentInformation.card.useAs

24.13

June 2024:
 This revision of the guide contains updated or new field information.
Added these new fields:
  • Lodging data fields, which begin with
    travelInformation.lodging
    .
Updated these fields:
  • processorInformation.responseCode

24.12

June 2024:
 This revision of the guide contains updated or new field information.
Updated these fields:
  • aggregatorInformation.subMerchant.country
  • issuerInformation.transactionInformation
  • merchantInformation.merchantDescriptor.country
  • paymentInformation.card.cardType
  • processingInformation.captureOptions.totalCaptureCount

24.11

May 2024:
 This revision of the guide contains updated or new field information.
Added these new fields:
  • merchantInformation.merchantDescriptor.phone
  • processingInformation.authorizationOptions.extendAuthIndicator
  • processingInformation.fundingOptions.initiator.type
  • processingInformation.merchantVerificationValue
  • processingInformation.paymentFlowMode
  • productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configuration.cardTypes.amexsafekey.currencies[].acquirerId
  • productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configuration.cardTypes.amexsafekey.currencies[].currencyCodes
  • productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configuration.cardTypes.amexsafekey.currencies[].processorMerchantId
  • productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configuration.cardTypes.amexsafekey.enabled
  • productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configuration.cardTypes.cb.currencies[].acquirerId
  • productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configuration.cardTypes.cb.currencies[].currencyCodes
  • productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configuration.cardTypes.cb.currencies[].processorMerchantId
  • productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configuration.cardTypes.cb.enabled
  • productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configuration.cardTypes.cb.requestorId
  • productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configuration.cardTypes. dinersclubinternationalprotectbuy.currencies[].acquirerId
  • productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configuration.cardTypes. dinersclubinternationalprotectbuy.currencies[].currencyCodes
  • productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configuration.cardTypes. dinersclubinternationalprotectbuy.currencies[].processorMerchantId
  • productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configuration.cardTypes. dinersclubinternationalprotectbuy.enabled
  • productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configuration.cardTypes.elo.currencies[].acquirerId
  • productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configuration.cardTypes.elo.currencies[].currencyCodes
  • productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configuration.cardTypes.elo.currencies[].processorMerchantId
  • productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configuration.cardTypes.elo.enabled
  • productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configuration.cardTypes.jcbjsecure.currencies[].acquirerId
  • productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configuration.cardTypes.jcbjsecure.currencies[].currencyCodes
  • productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configuration.cardTypes.jcbjsecure.currencies[].processorMerchantId
  • productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configuration.cardTypes.jcbjsecure.enabled
  • productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configuration.cardTypes.jcbjsecure.securePasswordForJCB
  • productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configuration.cardTypes.mastercardsecurecode.currencies[].acquirerId
  • productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configuration.cardTypes.mastercardsecurecode.currencies[].currencyCodes
  • productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configuration.cardTypes.mastercardsecurecode.currencies[].processorMerchantId
  • productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configuration.cardTypes.mastercardsecurecode.enabled
  • productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configuration.cardTypes.upi.currencies[].acquirerId
  • productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configuration.cardTypes.upi.currencies[].currencyCodes
  • productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configuration.cardTypes.upi.currencies[].processorMerchantId
  • productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configuration.cardTypes.upi.enabled
  • productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configuration.cardTypes.verifiedbyvisa.currencies[].acquirerId
  • productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configuration.cardTypes.verifiedbyvisa.currencies[].currencyCodes
  • productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configuration.cardTypes.verifiedbyvisa.currencies[].processorMerchantId
  • productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configuration.cardTypes.verifiedbyvisa.enabled
  • recipientInformation.accountType
  • recipientInformation.address2
  • recipientInformation.buildingNumber
  • recipientInformation.streetName
Updated these fields:
  • aggregatorInformation.aggregatorId

24.10

April 2024:
 This revision of the guide contains updated or new field information.
Added these new fields:
  • agreementInformation.dateSigned
  • agreementInformation.eSignIndicator
  • buyerInformation.gender
  • deviceInformation.deviceType
  • merchantDefinedInformation[].value
  • merchantInformation.transactionLocalDateTime
  • orderInformation.billTo.county
  • orderInformation.billTo.title
  • paymentInformation.bank.account.iban
  • paymentInformation.bank.scheme
  • paymentInformation.directDebit.mandate.clearingDate
  • paymentInformation.directDebit.mandate.id
  • paymentInformation.legacyToken.id
  • paymentOptions.limit
  • paymentOptions.offset
  • processingInformation.paymentFlowMode
  • processingInformation.transactionTimeout
  • productInformation.selectedProducts.payments.cardProcessing. configurationInformation.configurations. common.processors.[processorName].paymentTypes[paymentType].currencies.[currency].enabled
  • productInformation.selectedProducts.payments.payerAuthentication. subscriptionInformation.enabled
  • productInformation.selectedProducts.payments.payerAuthentication. subscriptionInformation.selfServiceability
  • productInformation.selectedProducts.payments.paymentOrchestration. subscriptionInformation.enabled
  • productInformation.selectedProducts.payments.paymentOrchestration. subscriptionInformation.selfServiceability
  • travelInformation.transit.airline.clearingCount
  • travelInformation.transit.airline.clearingSequence
  • travelInformation.transit.airline.creditReasonIndicator
  • travelInformation.transit.airline.electronicTicketIndicator
  • travelInformation.transit.airline.purchaseType
  • travelInformation.transit.airline.reservationSystemCode
  • travelInformation.transit.airline.restrictedTicketDescription
  • travelInformation.transit.airline.ticketIssuer.locality
  • travelInformation.transit.airline.ticketNumber
  • travelInformation.transit.airline.totalClearingAmount
Updated these fields:
  • processingInformation.authorizationOptions.balanceInquiry
  • processingInformation.purchaseLevel
  • processingInformation.authorizationOptions.declineAvsFlags
  • processingInformation.authorizationOptions.ignoreCvResult
  • processorInformation.merchantAdvice.code
  • processorInformation.merchantAdvice.codeRaw

24.09

April 2024:
 This revision of the guide contains updated or new field information.
Added these new fields:
  • paymentInsightsInformation.orchestration.infoCodes[]
Updated these fields:
  • orderInformation.lineItems[].amountIncludesTax
Updated these field groups:
  • productInformation.selectedProducts.payments.cardProcessing. configurationInformation.configurations. common.processors.[processorName]
  • productInformation.selectedProducts.payments.cardProcessing. configurationInformation.configurations. features.cardNotPresent.processors.[processorName]
  • productInformation.selectedProducts.payments.cardProcessing. configurationInformation. configurations.features.cardNotPresent.processors.[processorName]
  • productInformation.selectedProducts.payments.cardProcessing. configurationInformation. configurations.features.cardPresent.processors.[processorName]
  • productInformation.selectedProducts.payments.echeck.configurationInformation. configurations.common.processors.[processorName]
  • productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configuration.cardTypes
Added these new fields:
  • productInformation.selectedProducts.payments.cardProcessing. configurationInformation.configurations.common.features. cardNotPresent.amexTransactionAdviceAddendum1
  • productInformation.selectedProducts.payments.cardProcessing. configurationInformation.configurations.common.processors. [processorName].acquirer.institutionId
  • productInformation.selectedProducts.payments.cardProcessing. configurationInformation.configurations.common.processors. [processorName].acquirerMerchantId
  • productInformation.selectedProducts.payments.cardProcessing. configurationInformation.configurations.common.processors. [processorName]. amexTransactionAdviceAddendum1
  • productInformation.selectedProducts.payments.cardProcessing. configurationInformation.configurations.common.processors. [processorName].enhancedData
  • productInformation.selectedProducts.payments.cardProcessing. configurationInformation.configurations.common.processors. [processorName].merchantTier
  • productInformation.selectedProducts.payments.cardProcessing. configurationInformation.configurations.common.processors. [processorName].paymentTypes.[paymentType].currencies.[currency].merchantId
  • productInformation.selectedProducts.payments.cardProcessing. configurationInformation.configurations.common.processors. [processorName].paymentTypes.[paymentType].currencies.[currency].terminalId
  • productInformation.selectedProducts.payments.cardProcessing. configurationInformation.configurations.common.processors. [processorName].paymentTypes.[paymentType].currencies.[currency].terminalIds
  • productInformation.selectedProducts.payments.cardProcessing. configurationInformation.configurations.common.processors. [processorName].terminalId
  • productInformation.selectedProducts.payments.cardProcessing. configurationInformation.configurations.common. subMerchantBusinessName
  • productInformation.selectedProducts.payments.cardProcessing. configurationInformation.configurations.common.subMerchantId
  • productInformation.selectedProducts.payments.secureAcceptance. subscriptionInformation.enabled
  • productInformation.selectedProducts.payments.secureAcceptance. subscriptionInformation.selfServiceability
  • productInformation.selectedProducts.payments.tax. subscriptionInformation.enabled
  • productInformation.selectedProducts.payments.tax. subscriptionInformation.selfServiceability
  • productInformation.selectedProducts.payments.unifiedCheckout. subscriptionInformation.enabled
  • productInformation.selectedProducts.payments.unifiedCheckout. subscriptionInformation.selfServiceability
  • productInformation.selectedProducts.payments.virtualTerminal. configurationInformation.configurations.cardNotPresent. globalPaymentInformation.basicInformation.defaultPaymentType
  • productInformation.selectedProducts.payments.virtualTerminal. configurationInformation.configurations.cardNotPresent. globalPaymentInformation.basicInformation.defaultTransactionType
  • productInformation.selectedProducts.payments.virtualTerminal. configurationInformation.configurations.cardNotPresent. globalPaymentInformation.basicInformation.displayInternet
  • productInformation.selectedProducts.payments.virtualTerminal. configurationInformation.configurations.cardNotPresent. globalPaymentInformation.basicInformation.displayMoto
  • productInformation.selectedProducts.payments.virtualTerminal. configurationInformation.configurations.cardNotPresent. globalPaymentInformation.basicInformation.displayRetail
  • productInformation.selectedProducts.payments.virtualTerminal. configurationInformation.configurations.cardNotPresent. globalPaymentInformation.merchantDefinedDataFields.displayMerchantDefinedData1
  • productInformation.selectedProducts.payments.virtualTerminal. configurationInformation.configurations.cardNotPresent. globalPaymentInformation.merchantDefinedDataFields.displayMerchantDefinedData2
  • productInformation.selectedProducts.payments.virtualTerminal. configurationInformation.configurations.cardNotPresent. globalPaymentInformation.merchantDefinedDataFields.displayMerchantDefinedData3
  • productInformation.selectedProducts.payments.virtualTerminal. configurationInformation.configurations.cardNotPresent. globalPaymentInformation.merchantDefinedDataFields.displayMerchantDefinedData4
  • productInformation.selectedProducts.payments.virtualTerminal. configurationInformation.configurations.cardNotPresent. globalPaymentInformation.merchantDefinedDataFields.displayMerchantDefinedData5
  • productInformation.selectedProducts.payments.virtualTerminal. configurationInformation.configurations.cardNotPresent. globalPaymentInformation.merchantDefinedDataFields.merchantDefinedData1DisplayOnReceipt
  • productInformation.selectedProducts.payments.virtualTerminal. configurationInformation.configurations.cardNotPresent. globalPaymentInformation.merchantDefinedDataFields.merchantDefinedData2DisplayOnReceipt
  • productInformation.selectedProducts.payments.virtualTerminal. configurationInformation.configurations.cardNotPresent. globalPaymentInformation.merchantDefinedDataFields.merchantDefinedData3DisplayOnReceipt
  • productInformation.selectedProducts.payments.virtualTerminal. configurationInformation.configurations.cardNotPresent. globalPaymentInformation.merchantDefinedDataFields.merchantDefinedData4DisplayOnReceipt
  • productInformation.selectedProducts.payments.virtualTerminal. configurationInformation.configurations.cardNotPresent. globalPaymentInformation.merchantDefinedDataFields.merchantDefinedData5DisplayOnReceipt
  • productInformation.selectedProducts.payments.virtualTerminal. configurationInformation.configurations.cardNotPresent. globalPaymentInformation.merchantDefinedDataFields.requireMerchantDefinedData1
  • productInformation.selectedProducts.payments.virtualTerminal. configurationInformation.configurations.cardNotPresent. globalPaymentInformation.merchantDefinedDataFields.requireMerchantDefinedData2
  • productInformation.selectedProducts.payments.virtualTerminal. configurationInformation.configurations.cardNotPresent. globalPaymentInformation.merchantDefinedDataFields.requireMerchantDefinedData3
  • productInformation.selectedProducts.payments.virtualTerminal. configurationInformation.configurations.cardNotPresent. globalPaymentInformation.merchantDefinedDataFields.requireMerchantDefinedData4
  • productInformation.selectedProducts.payments.virtualTerminal. configurationInformation.configurations.cardNotPresent. globalPaymentInformation.merchantDefinedDataFields.requireMerchantDefinedData5
  • productInformation.selectedProducts.payments.virtualTerminal. configurationInformation.configurations.cardNotPresent. globalPaymentInformation.paymentInformation.acceptedCardTypes
  • productInformation.selectedProducts.payments.virtualTerminal. configurationInformation.configurations.cardNotPresent. globalPaymentInformation.paymentInformation.displayBillPayment
  • productInformation.selectedProducts.payments.virtualTerminal. configurationInformation.configurations.cardNotPresent. globalPaymentInformation.paymentInformation.displayCardVerificationValue
  • productInformation.selectedProducts.payments.virtualTerminal. configurationInformation.configurations.cardNotPresent. globalPaymentInformation.paymentInformation.displayCreditCards
  • productInformation.selectedProducts.payments.virtualTerminal. configurationInformation.configurations.cardNotPresent. globalPaymentInformation.paymentInformation.displayDebtIndicator
  • productInformation.selectedProducts.payments.virtualTerminal. configurationInformation.configurations.cardNotPresent. globalPaymentInformation.paymentInformation.displayEchecks
  • productInformation.selectedProducts.payments.virtualTerminal. configurationInformation.configurations.cardNotPresent. globalPaymentInformation.paymentInformation.displayFirstName
  • productInformation.selectedProducts.payments.virtualTerminal. configurationInformation.configurations.cardNotPresent. globalPaymentInformation.paymentInformation.displayIgnoreECheckAvsCheckbox
  • productInformation.selectedProducts.payments.virtualTerminal. configurationInformation.configurations.cardNotPresent. globalPaymentInformation.paymentInformation.displayLastName
  • productInformation.selectedProducts.payments.virtualTerminal. configurationInformation.configurations.cardNotPresent. globalPaymentInformation.paymentInformation.enableEchecks
  • productInformation.selectedProducts.payments.virtualTerminal. configurationInformation.configurations.cardNotPresent. globalPaymentInformation.paymentInformation.firstNameRequired
  • productInformation.selectedProducts.payments.virtualTerminal. configurationInformation.configurations.cardNotPresent. globalPaymentInformation.paymentInformation.lastNameRequired
  • productInformation.selectedProducts.payments.virtualTerminal. configurationInformation.configurations.cardNotPresent. globalPaymentInformation.paymentInformation.requireCardVerificationValue

24.08

April 2024:
 This revision of the guide contains updated or new field information.
Updated these fields:
  • processorInformation.responseCode
Added these new fields:
  • clientReferenceInformation.partner.developerId
  • processingInformation.authorizationOptions.paymentTypeIndicator
  • tokenInformation.additionalInformation

24.07

April 2024:
 This revision of the guide contains updated or new field information.
Added these new fields:
  • paymentAccountInformation.features.healthCard
  • paymentInformation.shippingAddress.id
  • processingInformation.enablerId
Updated these fields:
  • aggregatorInformation.aggregatorId
  • aggregatorInformation.subMerchant.id
  • consumerAuthenticationInformation.paSpecificationVersion
  • issuerInformation.transactionInformation
  • merchantInformation.salesOrganizationId
  • paymentInsightInformation.responseInsights.category
  • pointOfSaleInformation.emv.tags
  • pointOfSaleInformation.encryptedPin
  • processingInformation.authorizationOptions.authType
  • processingInformation.networkPartnerId
  • processorInformation.merchantAdvice.code
  • processorInformation.merchantAdvice.codeRaw

24.06

March 2024:
 This revision of the guide contains updated or new field information.
Added these new fields:
  • allowedCardNetworks
  • allowedPaymentNetworks
  • captureMandate.billingType
  • captureMandate.requestEmail
  • captureMandate.requestPhone
  • captureMandate.requestShipping
  • captureMandate.shipToCountries
  • captureMandate.showAcceptedNetworkIcons
  • clientVersion
  • consumerAuthenticationInformation.dsReferenceNumber
  • country
  • locale
  • processingInformation.transactionTypeIndicator
  • targetOrigins

24.05

February 2024:
 This revision of the guide contains updated or new field information.
Added this new field:
  • watchlistScreeningInformation.proceedOnMatch

24.04

February 2024:
 This revision of the guide contains updated or new field information.
Updated the field length for
installmentInformation.identifier

24.03

January 2024:
 This revision of the guide contains updated or new field information.
Added these new fields:
  • orderInformation.billTo.company.phoneNumber
  • orderInformation.billTo.middleName
  • orderInformation.billTo.namePrefix
  • orderInformation.billTo.nameSuffix
  • orderInformation.billTo.company.phoneNumber
  • paymentInformation.bank.account.checkTransactionCode
  • validationInformation.accountType
  • validationInformation.authorizationLevel
  • validationInformation.bank.accountOwner.customerDataConditionCode
  • validationInformation.bank.accountOwner.matchAddress
  • validationInformation.bank.accountOwner.matchAdministrativeArea
  • validationInformation.bank.accountOwner.matchCompanyName
  • validationInformation.bank.accountOwner.matchCompanyPhoneNumber
  • validationInformation.bank.accountOwner.matchDateOfBirth
  • validationInformation.bank.accountOwner.matchFirstName
  • validationInformation.bank.accountOwner.matchFullName
  • validationInformation.bank.accountOwner.matchLastName
  • validationInformation.bank.accountOwner.matchLocality
  • validationInformation.bank.accountOwner.matchMiddleName
  • validationInformation.bank.accountOwner.matchNamePrefix
  • validationInformation.bank.accountOwner.matchNameSuffix
  • validationInformation.bank.accountOwner.matchPersonalIdentificationID
  • validationInformation.bank.accountOwner.matchPersonalIdentificationIssuedBy
  • validationInformation.bank.accountOwner.matchPersonalIdentificationType
  • validationInformation.bank.accountOwner.matchPhoneNumber
  • validationInformation.bank.accountOwner.matchSocialSecurityNumber
  • validationInformation.bank.accountOwner.matchTaxId
  • validationInformation.bank.accountOwner.matchPostalCode
  • validationInformation.bank.accountOwner.overallMatchScore
  • validationInformation.bank.accountStatus.addedOrClosedDate
  • validationInformation.bank.accountStatus.additionalStatusCode
  • validationInformation.bank.accountStatus.fcraDisputeCode
  • validationInformation.bank.accountStatus.lastUpdateDate
  • validationInformation.bank.accountStatus.previousStatusCode
  • validationInformation.bank.accountStatus.primaryStatusCode
  • validationInformation.bank.accountStatus.scoredAccountProcessorResponse1
  • validationInformation.bank.accountStatus.scoredAccountProcessorResponse2
  • validationInformation.bank.accountStatus.scoredAccountProcessorResponse3
  • validationInformation.bank.accountStatus.scoredAccountProcessorResponse5
  • validationInformation.bank.accountStatus.secondaryStatusCode
  • validationInformation.calculatedResponse
  • validationInformation.resultCode
  • validationInformation.referenceID
  • validationInformation.transactionReason
  • validationInformation.validationType
Updated the processors that support these fields:
  • buyerInformation.merchantCustomerID
  • consumerAuthenticationInformation.cavvAlgorithm
  • orderInformation.billTo.company.name
  • orderInformation.shipTo.address1
  • orderInformation.shipTo.address2
  • orderInformation.shipTo.firstName
  • orderInformation.shipTo.lastName
  • orderInformation.shipTo.locality
  • paymentInformation.card.cardType
  • paymentInformation.card.securityCode
  • paymentInformation.card.type
  • paymentInformation.tokenizedCard.securityCode
  • paymentInformation.tokenizedCard.type
  • processingInformation.commerceIndicator
  • processorInformation.retrievalReferenceNumber

24.02

January 2024:
 This revision of the guide contains updated or new field information.
Added clarifying information for
FDC Nashville Global
 about the uses of this field:
  • processorInformation.merchantAdvice.code