`REST API` Field Reference
(Pilot Release)

This section provides you with information about the REST API field reference.

Audience and Purpose: This guide is written for application developers who want to use the REST API to integrate Visa Acceptance Solutions services into an order management system. Implementing Visa Acceptance Solutions services requires software development skills. You must write code that uses the REST API request and reply fields.
Conventions: These special statements are used in this document:
IMPORTANT

An Important
statement contains information essential to successfully completing a task or learning a concept.

WARNING

A Warning
contains information or instructions, which, if not heeded, can result in a security risk, irreversible loss of data, or significant cost in time or revenue or both.

Recent Revisions to This Document

25.10.02

October 2025:
This revision of the guide contains updated or new field information.

Added this field:

paymentInformation.paymentAccountReference.id

25.10.01

October 2025:
This revision of the guide contains updated or new field information.

Updated this field:

consumerAuthenticationInformation.overrideCountryCode

Deprecated these fields:

consumerAuthenticationInformation.veresEnrolled

processorInformation.customer.personalIDResult

25.09.02

September 2025:
This revision of the guide contains updated or new field information.

Updated these fields:

paymentInformation.card.sourceAccountType

paymentInformation.card.useAs

pointOfSaleInformation.catLevel

pointOfSaleInformation.terminalCapability

25.09.01

September 2025:
This revision of the guide contains updated or new field information.

Added these new fields:

orderInformation.amountDetails.refundBalance

paymentInfomation.eWallet.fundingSource

paymentInfomation.eWallet.name

processorInformation.issuerInformation.code

processorInformation.issuerInformation.name

processorInformation.rawResponse

processorInformation.rawResponseLocal

Updated these fields:

consumerAuthenticationInformation.alternateAuthenticationMethod

consumerAuthenticationInformation.fido.fidoFlowType

consumerAuthenticationInformation.fido.reasonCode

consumerAuthenticationInformation.fido.reasonDescription

consumerAuthenticationInformation.languagePreference

consumerAuthenticationInformation.methodUrlPresent

processorInformation.merchantAdvice.code

processorInformation.merchantAdvice.codeRaw

25.08.01

August 2025: Added these new fields:; authenticatedIdentities.relyingPartyId
authenticatorRenderMethod
paymentInstrument.bankAccount.type
paymentInstrument.instrumentIdentifier.bankAccount.number
paymentInstrument.instrumentIdentifier.bankAccount.routingNumber

25.07.01

July 2025
: This revision of the guide contains updated or new field information.

Updated this field:

installmentInformation.paymentType

25.06.02

June 2025
: This revision of the guide contains updated or new field information.

Added these new fields:

card.type

consumerAuthenticationInformation.fido.fidoFlowType

consumerAuthenticationInformation.fido.reasonCode

consumerAuthenticationInformation.fido.reasonDescription

consumerAuthenticationInformation.languagePreference

consumerAuthenticationInformation.methodUrlPresent

Updated these fields:

consumerAuthenticationInformation. alternateAuthenticationMethod

25.06.01

June 2025:
This revision of the guide contains updated or new field information.

Added these new fields:

clientReferenceInformation.transactionId

authenticatedIdentities.data

authenticatedIdentities.id

authenticatedIdentities.provider

clientCorrelationId

deviceInformation.platformType

issuerAuthCode

otp

paymentAccountInformation.card.type

paymentInformation.card.cardType

paymentInformation.card.type

paymentInformation.tokenizedCard.type

sessionInformation.secureToken

stepUpOptions.id

stepUpOptions.method

stepUpOptions.platformType

stepUpOptions.requestPayload

stepUpOptions.source

stepUpOptions.subMethod

stepUpOptions.value

25.05.02

May 2025
: This revision of the guide contains updated or new field information.

Updated these fields:

Updated the data length of the

merchantInformation.merchantDescriptor.name

field for the Visa Platform Connect processor.

installmentInformation.paymentType

recurringPayment.informationType

processingInformation.commerceIndicator

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

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

VISA Platform Connect: Specifications and Conditions for Resellers/Partners

The following are specifications and conditions that apply to a Reseller/Partner enabling its merchants through

Visa Acceptance platform

. Failure to meet any of the specifications and conditions below is subject to the liability provisions and indemnification obligations under Reseller/Partner’s contract with Visa/Cybersource.

Before boarding merchants for payment processing on a VPC acquirer’s connection, Reseller/Partner and the VPC acquirer must have a contract or other legal agreement that permits Reseller/Partner to enable its merchants to process payments with the acquirer through the dedicated VPC connection and/or traditional connection with such VPC acquirer.

Reseller/Partner is responsible for boarding and enabling its merchants in accordance with the terms of the contract or other legal agreement with the relevant VPC acquirer.

Reseller/Partner acknowledges and agrees that all considerations and fees associated with chargebacks, interchange downgrades, settlement issues, funding delays, and other processing related activities are strictly between Reseller and the relevant VPC acquirer.

Reseller/Partner acknowledges and agrees that the relevant VPC acquirer is responsible for payment processing issues, including but not limited to, transaction declines by network/issuer, decline rates, and interchange qualification, as may be agreed to or outlined in the contract or other legal agreement between Reseller/Partner and such VPC acquirer.

DISCLAIMER: NEITHER VISA NOR CYBERSOURCE WILL BE RESPONSIBLE OR LIABLE FOR ANY ERRORS OR OMISSIONS BY THE

Visa Platform Connect

ACQUIRER IN PROCESSING TRANSACTIONS. NEITHER VISA NOR CYBERSOURCE WILL BE RESPONSIBLE OR LIABLE FOR RESELLER/PARTNER BOARDING MERCHANTS OR ENABLING MERCHANT PROCESSING IN VIOLATION OF THE TERMS AND CONDITIONS IMPOSED BY THE RELEVANT

Visa Platform Connect

ACQUIRER.

Introduction to the REST API Fields

REST, or (REpresentational State Transfer), is an architecture for developing web services. It enables communication between a client and server using HTTP protocols.

REST-compliant machines communicate with each other using stateless messaging. Stateless messaging is a loosely coupled connection between a client and server, where each message is self-contained. This connection enables the client and server to communicate without first establishing a communication channel and without managing the state between systems.

This guide provides an alphabetical list of the REST fields available through the Cybersource platform.

acquirerInformation

These fields are related to acquirer information. Use these links to view the specifications for these fields, or when you are viewing this content in a browser, enter

Ctrl + F

(Windows) or

Command + F

(Mac) to search for a field.

acquirerInformation.acquirerMerchantId

acquirerInformation.acquirerBin

acquirerInformation.country

acquirerInformation.merchantId

acquirerInformation.password

acquirerInformation. acquirerMerchantId

An aquirer assigned merchant ID.

Specifications

Data Type:
String

Data Length:
15 or 23. The length depends upon the number assigned by acquiring bank.

Mapping Information

REST API Field:

acquirerInformation.acquirerMerchantId

SCMP API Field:

acquirer_merchant_ID

Simple Order API Field:

ccAuthService_acquirerMerchantId

acquirerInformation. acquirerBin

pa_ds_login_id

Simple Order API Field:

payerAuthEnrollService_merchantId

acquirerInformation. password

Registered password for the Visa directory server.

For Mastercard, this value is always 12345678.

Specifications

Data Type:
String

Data Length:
8

Mapping Information

REST API Field:

acquirerInformation.password

SCMP API Field:

pa_ds_password

Simple Order API Field:

payerAuthEnrollService_password

addressVerificationInformation

These fields are related to address verification.

addressVerificationInformation.addressType

addressVerificationInformation.applicableRegion

addressVerificationInformation.barCode.checkDigit

addressVerificationInformation.barCode.value

addressVerificationInformation.careOf

addressVerificationInformation.errorCode

addressVerificationInformation.matchScore

addressVerificationInformation.standardAddress.address1. withApartment

addressVerificationInformation.standardAddress.address1.withoutApartment

addressVerificationInformation.standardAddress.address2

addressVerificationInformation.standardAddress.address3

addressVerificationInformation.standardAddress.address4

addressVerificationInformation.standardAddress.administrativeArea

addressVerificationInformation.standardAddress.country

addressVerificationInformation.standardAddress.county

addressVerificationInformation.standardAddress.csz

addressVerificationInformation.standardAddress.iso.Country

addressVerificationInformation.standardAddress.locality

addressVerificationInformation.standardAddress.postalCode

addressVerificationInformation.statusCode

addressVerificationInformation. addressType

Contains the record type of the postal code to which the address was matched.

U.S. Addresses
: Depending on the quantity and quality of the address information provided, this field contains one or two characters:

One character: Sufficient correct information was provided to result in accurate matching.

Two characters: Standardization would provide a better address if more or better input address information was available. The second character is

D

(default).

Blank fields are unassigned. When an address cannot be standardized, the parsing of the input data determines the address type. In this case, standardization can indicate a street, rural route, highway contract, general delivery, or PO box.

These address type codes are returned:

Address Type Codes
Code	Description
F	Firm.
G	General delivery.
H	High-rise apartment or office building.
M	Military.
P	Post office box.
R	Rural route or highway contract.
S	Street (usually one side of one city block).
FD	Firm default. The standardization process could not assign a firm extended ZIP code.
GD	General delivery default. Assigned when general delivery is the only primary name listed for the ZIP code.
HD	High-rise default. The standardization process assigned the extended ZIP code for the entire building. Assignment at the unit, floor, or wing level is possible. A suite or apartment number could be out of range.
RD	Rural route or highway contract default. The standardization process assigned the extended ZIP code for the entire route, but it was unable to assign the box number.
SD	Street default. The standardization process assigned the extended ZIP code for the block because there was no extended ZIP code for the building.
SR	Street served by route.
UD	Unique default. The owner of the ZIP code did not assign extended ZIP codes, or the address was not matched.

All Other Countries
: This field contains one of these values:

P

: Post

S

: Street

X

: Unknown

Specifications

Data Type:
String

Data Length:
255

Mapping Information

REST API Field:

addressVerificationInformation.addressType

SCMP API Field:

dav_address_type

Simple Order API Field:

davReply_addressType

addressVerificationInformation. applicableRegion

The regional location of the delivery address.

Possible values include:

Canada

International

US

The values of the error codes and status codes mean different things depending on the applicable region.

Specifications

Data Type:
String

REST API Field:

addressVerificationInformation.errorCode

SCMP API Fields:

dav_ca_error_info

(Canadian)

dav_intl_error_info

(international)

dav_us_error_info

(US)

Simple Order API Fields:

davReply_caErrorInfo

(Canadian)

davReply_intlErrorInfo

(international)

davReply_usErrorInfo

(US)

addressVerificationInformation. matchScore

Indicates the probable correctness of the address match.

Returned for U.S. and Canadian addresses. Returns a value from

0-9

, where

0

is most likely to be correct and

9

is least likely to be correct, or

-1

if there is no address match.

Specifications

Data Type:
Integer

Data Length:
1

Mapping Information

REST API Field:

addressVerificationInformation.matchScore

SCMP API Field:

dav_match_score

Simple Order API Field:

davReply_matchScore

addressVerificationInformation. standardAddress.address1. withApartment

First line of the standardized address, including apartment information.

Specifications

Data Type:
String

Data Length:
255

Mapping Information

REST API Field:

addressVerificationInformation.standardAddress.address1.withApartment

SCMP API Field:

dav_standard_address

Simple Order API Field:

davReply_standardizedAddress1

addressVerificationInformation. standardAddress.address1. withoutApartment

Simple Order API Fields:

davReply_caInfo

davReply_intlInfo

davReply_usInfo

aggregatorInformation

These fields are related to aggregators.

aggregatorInformation.aggregatorId

aggregatorInformation.city

aggregatorInformation.country

aggregatorInformation.name

aggregatorInformation.postalCode

aggregatorInformation.serviceProvidername

aggregatorInformation.state

aggregatorInformation.streetAddress

aggregatorInformation.subMerchant.address1

aggregatorInformation.subMerchant.administrativeArea

aggregatorInformation.subMerchant.cardAcceptorId

aggregatorInformation.subMerchant.country

aggregatorInformation.subMerchant.email

aggregatorInformation.subMerchant.id

aggregatorInformation.subMerchant.locality

aggregatorInformation.subMerchant.name

aggregatorInformation.subMerchant.phoneNumber

aggregatorInformation.subMerchant.postalCode

aggregatorInformation.subMerchant.region

aggregatorInformation. aggregatorId

Value that identifies you as a payment aggregator.

Get this value from the processor.

FDC Compass: This value must consist of uppercase letters.
Chase Paymentech Solutions: This field is available only for Payouts transactions. It is not available for standard credit card transactions.; This field is optional in a request for an AFT with aggregator support an OCT with aggregator support.
Visa Platform Connect: This field is required for Payouts transactions making OCT requests from merchants that are payment facilitators using Visa Platform Connect.

The value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCR6
Position: 95-105
Field: Market Identifier / Payment Facilitator ID
Visa Platform Connect: This field is required in an authorization request message for Visa, Mastercard, and Discover transactions.

Specifications

Data Type:
String

Data Length:

Chase Paymentech Solutions:
204

Cielo:
11

FDC Nashville Global:
15

Getnet:
11

Rede:
11

Payment aggregator business name.

Chase Paymentech Solutions: This field is available only for Payouts transactions only. It is not available for standard credit card transactions. It is optional for Mastercard and Visa transactions.
FDC Compass: This value must consist of uppercase letters.
Getnet: This value must consist of uppercase letters. Special characters are not allowed.
Visa Platform Connect: The value for this field does not map to the TC 33 capture file.
Payouts OCT
:: Required in OCT requests from merchants that are payment facilitators using the Visa Platform Connect processor.

Specifications

Data Type:
String

Data Length

American Express Direct: Maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 37 characters.

Chase Paymentech Solutions: 22 for Mastercard, 25 for Visa

FDC Compass: Maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 37 characters.

FDC Nashville Global: 12

Getnet: 7

: 25

Visa Platform Connect: 25

Mapping Information

REST API Field:

aggregatorInformation.name

SCMP API Field:

aggregator_name

Simple Order API Fields:

ccAuthService_aggregatorName

ccCaptureService_aggregatorName

ccCreditService_aggregatorName

octService_aggregatorName

aggregatorInformation. postalCode

The postal code of the payment facilitator.

This field is applicable to the Visa card type.

Specifications

Data Type:
String

Data Length:
10

Mapping Information

REST API Field:

aggregatorInformation.postalCode

SCMP API Field:

aggregator_postalCode

Simple Order API Fields:

ccAuthService_aggregatorPostalcode

octService_aggregatorPostalcode

aggregatorInformation. serviceProvidername

Name of the transfer service provider.

This field is available only on the Visa Platform Connect processor.

With Mastercard payment cards, the value for this field corresponds to this data in the TC 33 capture file:

Records: CP12 TCR2, TCR3, TCR4

Field: Gateway Data

This field is required for Payouts original credit transaction (OCT) service requests from these types of merchants:

Merchants who are payment facilitators.

Merchants who want OCT processing to be deferred to a specified date and time.

To support Visa Direct transactions in Original Credit Transactions destined to issuers in Australia or Canada, you must include additional merchant address data in the authorization request:

Field 43—Card Acceptor Name/Location

Field 59—National Point-of-Service Geographical Data

Field 104, Usage 2—Transaction-Specific Data in TLV format, Dataset ID 56—Additional Acceptance Information, Tag 81—Acceptor Legal Business Name

To process Faster Refund Original Credit Transactions (OCTs) in AP and the EU, include these fields in the request:

Transaction Type

Record: Field 3

Positions: 1-2

Transaction Amount

Record: Field 4

Card Acceptor Name or Location

Record: Field 43

Transaction Identifier

Record: Field 62.2 (in bitmap format)

Message Reason Code

Record: Field 63.3

Acceptor Legal Business Name

Record: 104, Usage 2—Transaction-Specific Data (in TLV format)

Dataset ID: 56

Tag: 81

Business Application Identifier (BAI)

Record: 104, Usage 2—Transaction-Specific Data (in TLV format)

Dataset ID: 57

Tag: 01

Visa Merchant Identifier

Record: 126.5

Specifications

Data Type:
String

Data Length:
25

Mapping Information

REST API Field:

aggregatorInformation.serviceProvidername

SCMP API Field:

service_provider_name

Simple Order API Field:

octService_serviceProviderName

aggregatorInformation. state

The state or providence of the payment facilitator.

This field is applicable to the Visa card type.

Specifications

Data Type:
String

Data Length:
3

Mapping Information

REST API Field:

aggregatorInformation.state

SCMP API Field:

aggregator_state

Simple Order API Fields:

ccAuthService_aggregatorState

octService_aggregatorState

aggregatorInformation. streetAddress

The street address of the payment facilitator.

This field is applicable to the Visa card type.

Specifications

Data Type:
String

Data Length:
99

Mapping Information

REST API Field:

aggregatorInformation.streetAddress

SCMP API Field:

aggregator_streetAddress

Simple Order API Fields:

ccAuthService_aggregatorStreetAddress

octService_aggregatorStreetAddress

aggregatorInformation. subMerchant.address1

The first line of the street address of the submerchant associated with the aggregator.

Chase Paymentech Solutions: This field is available only for Payouts transactions. It is not supported for standard credit card transactions.
FDC Compass: This value must consist of uppercase letters.
Getnet: Allowable characters are letters, numbers, and spaces. Special characters are not allowed.
Visa Platform Connect: The value for this field does not map to the TC 33 capture file.

Specifications

Data Type:
String

Data Length:

American Express Direct:
29

Chase Paymentech Solutions:
38

Cielo:
22

FDC Compass:
38

FDC Nashville Global:
25

Getnet:
40—When length is greater than 40, characters to the right of the 40th character are discarded.

:
29

Rede:
48

Visa Platform Connect:
29

Mapping Information

REST API Field:

aggregatorInformation.subMerchant.address1

SCMP API Field:

submerchant_street

Simple Order API Field:

invoiceHeader_submerchantStreet

aggregatorInformation. subMerchant.administrativeArea

Sub-merchant’s state or province.

Use a state, province, or territory code.

Chase Paymentech Solutions: This field is available only for Payouts transactions. It is not supported for standard credit card transactions.
FDC Compass: This value must consist of uppercase characters.
Getnet: All characters must be uppercase letters. Special characters are not allowed.
Visa Platform Connect: The value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCR4
Position: 164-166
Field: Region Code

Specifications

Data Type:
String

Data Length:

Getnet:
2—When length is greater than 2, characters to the right of the 2nd character are discarded.

All other processors:
3

Mapping Information

REST API Field:

aggregatorInformation.subMerchant.administrativeArea

SCMP API Field:

submerchant_state

Simple Order API Field:

invoiceHeader_submerchantState

aggregatorInformation. subMerchant.cardAcceptorId

Unique identifier assigned by the payment card company to the sub-merchant.

FDC Nashville Global: This field is available only for aggregator authorizations with American Express.

Specifications

Data Type:
String

Data Length:
15

Mapping Information

REST API Field:

aggregatorInformation.subMerchant.cardAcceptorId

SCMP API Field:

submerchant_merchant_id

Simple Order API Field:

invoiceHeader_submerchantMerchantID

aggregatorInformation. subMerchant.country

Sub-merchant’s country.

Use the two-character ISO country code.

Barclays: For marketplace transactions, include this field and the
merchantInformation.merchantDescriptor.country
field in the transaction request. The marketplace is the merchant, and the retailer is the sub‑merchant. When the field values do not match, the transaction is identified as a foreign retail transaction to the acquirer and the merchant can verify them in the Business Center on the transactions details page.

Chase Paymentech Solutions: This field is available only for Payouts transactions. It is not supported for standard credit card transactions.
FDC Compass: This value must consist of only uppercase letters.
: The value for this field does not map to the TC 33 capture file.

Specifications

Data Type:
String

Data Length:
3

Mapping Information

REST API Field:

aggregatorInformation.subMerchant.country

SCMP API Field:

submerchant_country

Simple Order API Field:

invoiceHeader_submerchantCountry

aggregatorInformation. subMerchant.email

Sub-merchant's email address.

Chase Paymentech Solutions: This field is available only for Payouts transactions. It is not supported for standard credit card transactions.
Visa Platform Connect: With American Express, the value of this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCRB
Position: 25-64
Field: American Express Seller Email Address

Specifications

Data Type:
String

Data Length:

FDC Nashville Global:
19

All other processors:
40

Mapping Information

REST API Field:

aggregatorInformation.subMerchant.email

SCMP API Field:

submerchant_email

Simple Order API Field:

invoiceHeader_submerchantEmail

aggregatorInformation. subMerchant.id

ID that you assigned to the sub-merchant.

FDC Compass: This value must consist of uppercase letters.
Chase Paymentech Solutions: This field is available only for Payouts transactions. It is not supported for standard credit card transactions.
Visa Platform Connect: This field is required for the Payouts OCT service requests from merchants that are payment facilitators using Visa Platform Connect.; With American Express, the value of this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCRB
Position: 65-84
Field: American Express Seller ID

With Mastercard and Visa, the value of this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCR6
Position: 117-131
Field: Sub-Merchant ID
Visa Platform Connect: This field is required in an authorization request message for Discover transactions.

Specifications

Data Type:
String

Data Length:

Cielo: 15

FDC Nashville Global: 14

Getnet: 15

Rede: 15

Visa Platform Connect: American Express: 20, Mastercard and Visa: 15

All other processors: 20

Mapping Information

REST API Field:

aggregatorInformation.subMerchant.id

SCMP API Field:

submerchant_id

Simple Order API Field:

invoiceHeader_submerchantID

aggregatorInformation. subMerchant.locality

Sub-merchant’s city.

Chase Paymentech Solutions: This field is available only for Payouts transactions. It is not supported for standard credit card transactions.
FDC Compass: This value must consist of uppercase characters.
Getnet: Allowable characters are letters, numbers, and spaces. Special characters are not allowed.
Visa Platform Connect: The value for this field does not map to the TC 33 capture file.

Specifications

Data Type
: String

Data Length:

Chase Paymentech Solutions:
21 for Mastercard, 13 for Visa

Cielo:
13

FDC Compass:
21

FDC Nashville Global:
11

Getnet:
13—When length is greater than 13, characters to the right of the 13th character are discarded.

Rede:
13

All other processors:
14

Mapping Information

REST API Field:

aggregatorInformation.subMerchant.locality

SCMP API Field:

submerchant_city

Simple Order API Field:

invoiceHeader_submerchantCity

aggregatorInformation. subMerchant.name

Sub-merchant’s business name.

Chase Paymentech Solutions: This field is available only for Payouts transactions. It is not supported for standard credit card transactions.
FDC Compass: This value must consist of uppercase characters.
: The value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCRB
Position: 109-146
Field: American Express Seller Name

Specifications

Data Type:
String

Data Length:

American Express Direct: Maximum length of the sub-merchant name depends on the length of the aggregator name. The combined length for both values must not exceed 37 characters.

Chase Paymentech Solutions: Mastercard: 22, Visa: 25.

FDC Compass: American Express: 19. Mastercard: maximum length of the sub-merchant name depends on the length of the aggregator name. The combined length for both values must not exceed 37 characters.

FDC Nashville Global: American Express: 12. Mastercard: maximum length of the sub-merchant name depends on the length of the aggregator name: if aggregator name length is 1 through 3, maximum sub-merchant name length is 21; if aggregator name length is 4 through 7, maximum sub-merchant name length is 17; if aggregator name length is 8 through 12, maximum sub-merchant name length is 12.

Visa Platform Connect: American Express: maximum length of the sub-merchant name depends on the length of the aggregator name. The combined length for both values must not exceed 36 characters. Not used with other card types.

Mapping Information

REST API Field:

aggregatorInformation.subMerchant.name

SCMP API Field:

submerchant_name

Simple Order API Field:

invoiceHeader_submerchantName

aggregatorInformation. subMerchant.phoneNumber

Sub-merchant’s telephone number.

Chase Paymentech Solutions: This field is available only for Payouts transactions. It is not supported for standard credit card transactions.
FDC Compass: This value must consist of numbers or a combinations of numbers and uppercase letters.

Formats:

NNN-NNN-NNNN
NNN-AAAAAAA
Visa Platform Connect: The value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCRB
Position: 5-24
Field: American Express Seller Telephone Number

Specifications

Data Type:
String

Data Length:

Cielo:
13

FDC Compass:
13

FDC Nashville Global:
10

All other processors
: 20

Mapping Information

REST API Field:

aggregatorInformation.subMerchant.phoneNumber

SCMP API Field:

submerchant_telephone_number

Simple Order API Field:

invoiceHeader_submerchantTelephoneNumber

aggregatorInformation. subMerchant.postalCode

Partial postal code for the sub-merchant’s address.

Chase Paymentech Solutions: This field is available only for Payouts transactions. It is not supported for standard credit card transactions.
FDC Compass: This value must consist of uppercase letters.
Getnet: All characters must be numbers. Special characters are not allowed.
Visa Platform Connect: The value for this field does not map to the TC 33 capture file.

Specifications

Data Type:
String

Data Length:

American Express Direct:
10

Chase Paymentech Solutions:
15

FDC Compass:
15

Visa Platform Connect:
10

All other processors:
9

Mapping Information

REST API Field:

aggregatorInformation.subMerchant.postalCode

SCMP API Field:

submerchant_postal_code

Simple Order API Field:

invoiceHeader_submerchantPostalCode

aggregatorInformation. subMerchant.region

Sub-merchant’s region.

FDC Nashville Global: This field is available only for aggregator authorizations.

Example
:
NE
indicates that the sub-merchant is in the northeast region.

Specifications

Data Type:
String

Data Length:
3

Mapping Information

REST API Field:

aggregatorInformation.subMerchant.region

SCMP API Field:

submerchant_region

Simple Order API Field:

invoiceHeader_submerchantRegion

agreementInformation

These fields are related to agreements.

agreementInformation.agreementId

agreementInformation.dateSigned

agreementInformation.eSignIndicator

agreementInformation. agreementId

Identifier for the billing agreement.

This API field is required when checking the status of a billing agreement.

Specifications

Data Type:
String

Data Length:
50

Mapping Information

REST API Field:

agreementInformation.agreementId

SCMP API Field:

ap_billing_agreement_id

Simple Order API Field:

ap_billingAgreementID

agreementInformation. dateSigned

The date the mandate was signed.

Format:

YYYYMMDD

Only numerical values are supported.

Specifications

Data Type:
String

Data Length:
8

Mapping

REST Field Name:

agreementInformation.dateSigned

Simple Order Field Name:

apImportMandateService_dateSigned

agreementInformation. eSignIndicator

The indicator that the customer signed the electronic mandate.

Possible values:

N

: False

Y

: True

Specifications

Data Type:
String

Data Length:
1

Mapping

REST Field Name:

agreementInformation.eSignIndicator

Simple Order Field Name:

apUpdateMandateService_esign

allowedCardNetworks

The card networks that are allowed for the merchant.

Possible values:

Microform Integration: AMEX
CARNET
CARTESBANCAIRES
CUP
DINERSCLUB
DISCOVER
EFTPOS
ELO
JCB
JCREW
MADA
MAESTRO
MASTERCARD
MEEZA
VISA
Unified Checkout: AMEX
CARNET
CARTESBANCAIRES
CUP
DINERSCLUB
DISCOVER
EFTPOS
ELO
JCB
JCREW
MADA
MAESTRO
MASTERCARD
MEEZA
VISA

Specifications

Data Type:
Enum

Mapping Information

REST API Field:

allowedCardNetworks

Simple Order API Field:
No corresponding field.

allowedPaymentTypes

The payment types that are allowed for the merchant.

Possible values:

Click to Pay Drop-In UI: CLICKTOPAY
Microform Integration: CARD
CHECK
Unified Checkout: APPLEPAY
CHECK
CLICKTOPAY
GOOGLEPAY
PANENTRY

IMPORTANT

Click to Pay supports American Express, Mastercard, and Visa for saved cards. Visa and Mastercard tokenize payment credentials using network tokenization for all Click to Pay requests. Click to Pay uses Click to Pay Token Requester IDs (TRIDs) rather than your existing TRIDs.

Specifications

Data Type:
Enum

Mapping Information

REST API Field:

allowedPaymentTypes

Simple Order API Field:
No corresponding field.

authenticatedIdentities

These fields are related to authenticated identities.

authenticatedIdentities.data

authenticatedIdentities.id

authenticatedIdentities.provider

authenticatedIdentities.relyingPartyId

authenticatedIdentities. data

The data from the authenticated identity, for FIDO this could be the Attestation.Base64URL encoded string (RFC4648).The encoding is the same as Base64, but uses '-' characters instead of '+' and '_' characters instead of '/'.

Specifications

Data Type:
String

Data Length:
17000

Mapping Information

REST API Field:

authenticatedIdentities.data

Simple Order API Field:
No corresponding field.

authenticatedIdentities. id

The id from the authenticated identity, for FIDO this could be the Relying Party Identifier.Base64URL encoded string (RFC4648).The encoding is the same as Base64, but uses '-' characters instead of '+' and '_' characters instead of '/'.

Specifications

Data Type:
String

Data Length:
2000

Mapping Information

REST API Field:

authenticatedIdentities.id

Simple Order API Field:
No corresponding field.

authenticatedIdentities. provider

The provider of the authenticated identity.

Possible value:

VISA_PAYMENT_PASSKEY

Specifications

Data Type:
Enum

Mapping Information

REST API Field:

authenticatedIdentities.provider

Simple Order API Field:
No corresponding field.

authenticatedIdentities. relyingPartyId

The Base64URL-encoded value of auth.visa.com or vts.auth.visa.com.

Specifications

Data Type:
Enum

Mapping Information

REST API Field:

authenticatedIdentities.relyingPartyId

Simple Order API Field:
No corresponding field.

authorizationInformation

These fields are related to authorizations.

authorizationInformation.approvalCode

authorizationInformation.reasonCode

authorizationInformation.reversalSubmitted

authorizationInformation. approvalCode

Authorization code.

This field is returned only when the value is sent by the processor.

Specifications

Data Type:
String

Data Length:
6

Mapping Information

REST API Field:

authorizationInformation.approvalCode

SCMP API Field:

auth_reversal_auth_code

Simple Order API Field:

ccAuthReversalReply_authorizationCode

authorizationInformation. reasonCode

Response flag for the original transaction.

Specifications

Type:
String

Length:
50

Mapping Information

REST API Field:

authorizationInformation.reasonCode

SCMP API Field:

original_transaction_rflag

Simple Order API Field:
No corresponding field

authorizationInformation. reversalSubmitted

Flag that indicates whether a full authorization reversal was successfully submitted.

This field is available only on the FDC Nashville Global processor.

Possible values:

Y

: Authorization reversal was successfully submitted.

N

: Authorization reversal was not successfully submitted. You must send a credit request for a refund.

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

authorizationInformation.reversalSubmitted

SCMP API Field:

reversal_submitted

Simple Order API Field:

voidReply_reversalSubmitted

buyerInformation

These fields are related to buyers.

buyerInformation.companyTaxId

buyerInformation.dateOfBirth

buyerInformation.gender

buyerInformation.hashedPassword

buyerInformation.language

buyerInformation.merchantCustomerId

buyerInformation.mobilePhone

buyerInformation.noteToSeller

buyerInformation.personalIdentification[].id

buyerInformation.personalIdentification.issuedBy

buyerInformation.personalIdentification[].type

buyerInformation.personalIdentification[]. verificationResults

buyerInformation.vatRegistrationNumber

buyerInformation.walletId

buyerInformation.workPhone

buyerInformation. companyTaxId

Tax identifier for the customer’s company.

This field is supported only for these kinds of payments on :

BNDES transactions

Installment payments with Mastercard

Set the value for this field to the Cadastro Nacional da Pessoa Jurídica (CNPJ). The request must include this field or

buyerInformation.personalIdentification[].id

and

buyerInformation.personalIdentification[].type

. When a request includes both fields, the value for the

buyerInformation.personalIdentification[].id

and

buyerInformation.personalIdentification[].type

field

s

is

are

sent to the processor and the

buyerInformation.companyTaxId

field is ignored.

REST API Field:

buyerInformation.hashedPassword

SCMP API Field:

customer_password

Simple Order API Field:

billTo_customerPassword

buyerInformation. language

The language indicator for payment services.

For the Korea Cyber Payment (KCP) service, the default value is

Korean

.

Possible values:

EN

: English

Korean

: Korean

Specifications

Data Type:
String

Data Length:
6

Mapping Information

REST API Field:

buyerInformation.language

SCMP API Field:

ap_initiate_language_interface

Simple Order API Field:

apInitiateService_languageInterface

buyerInformation. merchantCustomerId

Customer identifier.

This field is available only on the Banque de France et Tresor Public, Barclays, BNP Paribas France, Credit Mutuel-CIC, FDC Compass, Prosa, and Worldpay VAP processors.

These processors have specific requirements:

Credit Mutuel-CIC: For recurring payments in Mexico, the value for this field is the customer’s contract number.; Before you request the authorization, you must inform the issuer about the customer contract numbers that will be used for recurring transactions.
Prosa: For recurring payments in Mexico, the value for this field is the customer’s contract number.
Worldpay VAP: For a follow-on credit, Visa Acceptance Solutions verifies these fields in the order given for a customer account ID value, and it uses d the first value it finds:
The
buyerInformation.merchantCustomerId
field value in the follow-on credit request.
The
buyerInformation.merchantCustomerId
field value that was used for the capture that is being credited.
The
buyerInformation.merchantCustomerId
field value that was used for the original authorization.

Specifications

Data Type:
String

Data Length

Banque de France et Tresor Public: 20

Barclays: 17

BNP Paribas France: 20

Credit Mutuel-CIC: 20

FDC Compass: 100

Prosa: 20

Mapping Information

REST API Field:

buyerInformation.merchantCustomerId

SCMP API Fields:

customer_account_id

purchaser_code

Simple Order API Fields:

billTo_customerID

invoiceHeader_purchaserCode

This field is available only on the Barclaysprocessor.

buyerInformation. mobilePhone

Cardholder’s mobile phone number.

Specifications

Data Type:
Integer

Data Length:
25

Mapping Information

REST API Field:

buyerInformation.mobilePhone

SCMP API Field:

pa_mobile_phone

Simple Order API Field:

payerAuthEnrollService_mobilePhone

buyerInformation. noteToSeller

Note to the recipient of the funds.

Specifications

Data Type:
String

Data Length:
255

Mapping Information

REST API Field:

buyerInformation.noteToSeller

buyerInformation. personalIdentification[].id

Personal ID value, based on the personal ID type.

For example, if the personal ID type is Passport, the passport holder’s passport number would be the value of this field.

Syntax

"buyerInformation": {
    "personalIdentification": [
      {
        "type": "TAX_ID",
        "id": "A30328567",
        "issuedBy": "US"
      }
      ]

Specifications

Data Type:
String

Data Length:
26

Mapping Information

REST API Field:

buyerInformation.personalIdentification.id

SCMP API Fields:

verification_results_passport_number

verification_results_personal_id

verification_results_driver_license_no

verification_results_buyer_registration

SO API Fields:

verificationResults_passportNumber

verificationResults_personalID

verificationResults_driversLicenseNumber

verificationResults_buyerRegistration

buyerInformation. personalIdentification. issuedBy

A two or three character code that indicates the identity of the issuing authority usually a state or country code.

Use the two-character ISO state or country code.

Syntax

"buyerInformation": {
    "personalIdentification": [
      {
        "type": "TAX_ID",
        "id": "A30328567",
        "issuedBy": "US"
      }
      ]

Specifications

Data Type:
String

Data Length:
2-6

Mapping Information

REST API Fields:

buyerInformation.personalIdentification.issuedBy

SCMP API Field:

personal_id_issued_by

Simple Order API Field:

personalID_issuedBy

buyerInformation. personalIdentification[]. type

The type of document issued that identifies the account owner/authorized signer.

Valid values:

• 0 – Driver’s License (USA)

• 1 – Military (USA)

• 2 – Passport

• 3 – Resident Alien ID

• 4 – State Identification

• 5 – Student Identification

• 6 – Driver’s License (Foreign)

• 7 – Driver’s License (Canada)

• 8 – Driver’s License (Mexico)

• 9 – Other Primary ID (Foreign)

• A – Matricula Consular Card

• B – South America Cedula No.

Type of the personal identification.

Possible values include:

NATIONAL

: National ID

CPF

: Cadastro de Pessoas Fisicas (CPF)

CNPJ

: Cadastro Nacional da Pessoa Juridica (CNPJ)

CURP

: Clave Única de Registro de Población (CURP)

DRIVER_LICENSE

: Drivers License

MATRICULA_CONSULAR_CARD:

MILITARY:

OTHER:

PASSPORT_NUMBER

: Passport

PERSONAL_ID

: Other Personal ID

RESIDENT_ALIEN:

SOUTH_AMERICA_CEDULA_NO:

SSN

: Social Security Number

STATE:

STUDENT:

TAX_ID

: Tax ID

Comercio Latino: Set this field to the Cadastro de Pessoas Fisicas (CFP). The CFP number is required for AVS for Redecard in Brazil.

Syntax

"buyerInformation": {
    "personalIdentification": [
      {
        "type": "TAX_ID",
        "id": "A30328567",
        "issuedBy": "US"
      }
      ]

Specifications

Data Type:
String

Data Length:
Fixed, based on above list.

Mapping Information

REST API Field:

buyerInformation.personalIdentification.type

SCMP API Fields:

personal_id_number

personal_id_type

verification_results_merchant_tax_id

verification_results_passport_number

verification_results_personal_id

verification_results_driver_license_no

verification_results_buyer_registration

Simple Order API Fields:

personalID_number

personalID_type

verificationResults_merchantTaxID

verificationResults_passportNumber

verificationResults_personalID

verificationResults_driversLicenseNumber

verificationResults_buyerRegistration

buyerInformation. personalIdentification[]. verificationResults

Verification results for Issuer or Card Network for verification transactions.

Possible values:

1

: Verified.

2

: Failed.

3

: Verification was not performed.

4

: Issuer does not support verification.

Syntax

"buyerInformation": {
    "personalIdentification": [
      {
        "type": "TAX_ID",
        "id": "A30328567",
        "issuedBy": "US",
        "verificationResults": "INVALID_DATA"
      }
      ]

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

buyerInformation.personalIdentification.verificationResults

SCMP API Fields:

customer_passport_number

(request)

drivers_license_no

(request)

personal_id

(request)

verification_results_passport_number

(return)

verification_results_personal_id

(return)

verification_results_driver_license_no

(return)

verification_results_buyer_registration

(return)

Simple Order API Fields:

billTo_driversLicenseNumber

(request)

billTo_passportCountry

(request)

billTo_passportNumber

(request)

billTo_personalId

(request)

verificationResults_passportNumber

(return)

verificationResults_personalID

(return)

verificationResults_driversLicenseNumber

(return)

verificationResults_buyerRegistration

(return)

buyerInformation. vatRegistrationNumber

Buyer’s VAT registration number.

This field is available on the Barclays, Elavon Americas, FDC Nashville Global, GPN, OmniPay Direct, , TSYS Acquiring Solutions, and Visa Platform Connect processors.

Specifications

Data Type:
String

Data Length:
25

Mapping Information

REST API Field:

buyerInformation.vatRegistrationNumber

SCMP API Fields:

buyer_registration

purchaser_vat_registration_number

Simple Order API Fields:

invoiceHeader_purchaserVATRegistrationNumber

This field is available only for authorizations on the Barclays processor.

item_#_buyerRegistration

taxService_buyerRegistration

Processor Field Names

This list provides the Level II/Level III processor field name for each processor that supports Level II or Level III data:

Elavon Americas: Customer VAT Registration Number

FDC Nashville Global: Customer VAT Registration Number

GPN: Customer VAT Number

OmniPay Direct: Customer VAT Registration Number

: Customer VAT Number

TSYS Acquiring Solutions: Customer VAT Registration Number

Visa Platform Connect: purchaseVATRegistrationNumber

buyerInformation. walletId

One-time identification code.

Used only for Alipay transactions, this field includes the number scanned from the barcode that is provided in the mobile application.

Specifications

Data Type:
String

Data Length:
150

Mapping Information

REST API Field:

buyerInformation.walletId

buyerInformation. workPhone

Cardholder's work phone number.

Specifications

Data Type:
Integer

Data Length:
25

Mapping Information

REST API Field:

buyerInformation.workPhone

SCMP API Field:

pa_work_phone

Simple Order API Field:

payerAuthEnrollService_workPhone

captureMandate

These fields are related to capture mandates.

captureMandate.billingType

captureMandate.comboCard

captureMandate.requestEmail

captureMandate.requestPhone

captureMandate.requestSaveCard

captureMandate.requestShipping

captureMandate.shipToCountries

captureMandate.showAcceptedNetworkIcons

captureMandate. billingType

Configure Unified Checkout to capture billing address information.

Possible values:

FULL

NONE

PARTIAL

Specifications

Data Type:
Enum

Mapping Information

REST API Field:

captureMandate.billingType

Simple Order API Field:
No corresponding field.

captureMandate. comboCard

Indicates whether you want to offer the Combo Card feature for digital payment methods enabled on Click to Pay or Unified Checkout.

This field is supported when the

allowedPaymentTypes

field is set to

CLICKTOPAY

,

PANENTRY

, or both.

REST API Field:

captureMandate.requestPhone

Simple Order API Field:
No corresponding field.

captureMandate. requestSaveCard

Indicates whether you want to enable the Save Card feature for digital payment methods enabled on Unified Checkout.

This field is supported when the

allowedPaymentTypes

field is set to

CLICKTOPAY

,

PANENTRY

, or both.

Possible values:

true

: Enable the Save Card feature.

false

: Do not enable the Save Card feature.

By default, the value of the field is

false

and the Save Card feature is disabled.

Specifications

Data Type:
Boolean

Mapping Information

REST API Field:

captureMandate.requestSaveCard

Simple Order API Field:
No corresponding field.

captureMandate. requestShipping

Configure Unified Checkout to capture shipping information.

Possible values:

true

false

Specifications

Data Type:
Boolean

Mapping Information

REST API Field:

captureMandate.requestShipping

Simple Order API Field:
No corresponding field.

captureMandate. shipToCountries

List of countries available to ship to in Unified Checkout. Use a two-character ISO country code.

Specifications

Data Type:
String

Data Length:
2

Mapping Information

REST API Field:

captureMandate.shipToCountries

Simple Order API Field:
No corresponding field.

captureMandate. showAcceptedNetworkIcons

Configure Unified Checkout to display the list of accepted card networks beneath the payment button.

Possible values:

true

false

Specifications

Data Type:
Boolean

Mapping Information

REST API Field:

captureMandate.showAcceptedNetworkIcons

Simple Order API Field:
No corresponding field.

captureOptions. dateToCapture

Date on which you want the capture to occur.

This field is supported only on Visa Platform Connect.

Format:
MMDD

Specifications

Data Type:
String

Data Length:
4

Mapping Information

REST API Field:

captureOptions.dateToCapture

SCMP API Field:
No corresponding field.

Simple Order API Field:
No corresponding field.

card

cardEncryptionKsi

SCMP API Field:
No corresponding field

Simple Order API Field:
No corresponding field

clientCorrelationId

Used to correlate authentication and payment credential requests.

Specifications

Data Type:
String

Data Length:
36

Mapping Information

REST API Field:

clientCorrelationId

Simple Order API Field:
No corresponding field.

clientReferenceInformation

These fields provide client reference information.

clientReferenceInformation.apiKey

clientReferenceInformation.applicationName

clientReferenceInformation.applicationUser

clientReferenceInformation.applicationVersion

clientReferenceInformation.code

clientReferenceInformation.comments

clientReferenceInformation.ownerMerchantId

clientReferenceInformation.partner.developerId

clientReferenceInformation.partner. originalTransactionId

clientReferenceInformation.partner.solutionId

clientReferenceInformation.partner. thirdPartyCertificationNumber

clientReferenceInformation.pausedRequestID

clientReferenceInformation.reconciliationId

clientReferenceInformation.returnReconciliationId

clientReferenceInformation.submitLocalDateTime

clientReferenceInformation.transactionId

clientReferenceInformation. apiKey

PSP merchant API key.

Specifications

Data Type:
String

Data Length:
255

Mapping Information

REST API Field:

clientReferenceInformation.apiKey

SCMP API Field:

ap_api_key

Simple Order API Field:

ap_apiKey

clientReferenceInformation. applicationName

Client used to send the transaction request.

Specifications

Data Type:
String

Maximum Data Length:
50

Mapping Information

REST API Field:

clientReferenceInformation.applicationName

clientReferenceInformation. applicationUser

Entity responsible for submitting a processing request through the client.

This value may be a person, system, or connection method.

Specifications

Data Type:
String

Maximum Data Length:
60

Mapping Information

REST API Field:

clientReferenceInformation.applicationUser

clientReferenceInformation. applicationVersion

Version number of the client used to send the transaction request.

Specifications

Data Type:
String

Maximum Data Length:
50

Mapping Information

REST API Field:

clientReferenceInformation.applicationVersion

clientReferenceInformation. code

Order reference or tracking number.

Provide a unique value for each transaction so that you can perform meaningful searches for the transaction. Refer to the Getting Started with Visa Acceptance Solutions Advanced
guide.

IMPORTANT

Depending on the values in your Visa Acceptance Solutions account, there might be a requirement for this field's value to be unique within a 15-minute period. Contact customer support to find out whether this requirement applies to your Visa Acceptance Solutions account.

PIN Debit Transactions: Requests for PIN debit reversals must include the same merchant reference number that was used in the transaction that is being reversed.
FDC Nashville Global: During card-not-present transactions, certain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.
FDC Nashville Global: During card-present transactions, when you do not send a valid value, one is created for you. However, the value is not returned, so you cannot use it to track the order.
SIX: When a card-present request does not include a merchant reference number, this value is provided by the client software that is installed on the POS terminal.

Specifications

Data Type:
String

Data Length:
50

Data Length
:

China UnionPay Data Length:
40

Elavon Americas Data Length:
39

FDC Nashville Global Data Length:
8

RuPay Data Length:
24 (Credit Services)

RuPay Data Length:
50 (Other services)

All Other Processor's Data Length:
8

Mapping Information

REST API Field:

clientReferenceInformation.code

SCMP API Field:

merchant_ref_number

Simple Order API Field:

merchantReferenceCode

clientReferenceInformation. comments

Comments about the transaction.

Mass Transit Transactions: Requests for Mass Transit transactions must include this field set to the value that corresponds to the type of transaction. The value that you send in this field appears in transaction details in the Business Center. For possible values, see the
Card Present Connect | Mass Transit Developer Guide
.

Specifications

Data Type:
String

Data Length:
256

Mapping Information

REST API Field:

clientReferenceInformation.comments

SCMP API Field:
No corresponding field

Simple Order API Field:
No corresponding field

clientReferenceInformation. ownerMerchantId

Merchant ID used to create the subscription or token.

Specifications

Data Type:
String

Data Length:
30

Mapping Information

REST API Field:

clientReferenceInformation.ownerMerchantId

SCMP API Fields:

ecp_credit_owner_merchant_id

ecp_debit_owner_merchant_id

Simple Order API Fields:

ecCreditReply_ownerMerchantID

ecDebitReply_ownerMerchantID

clientReferenceInformation. partner. developerId

Identifier for the developer that integrated a partner solution to Visa Acceptance Solutions.

Send this value in all requests that are sent through the partner solutions built but that developer. Visa Acceptance Solutions assigns this ID to the developer.

IMPORTANT

When you see a developer ID of

999

in reports, the submitted developer ID is incorrect.

Specifications

Data Type:
String

Data Length:
8

Mapping Information

REST API Field:

clientReferenceInformation.partner.developerId

SCMP API Field:

developer_id

Simple Order API Field:

developerID

clientReferenceInformation. partner. originalTransactionId

Value that links the previous transaction to the current follow-on request.

This field is available only for Visa Acceptance Solutions integrations.

This value is assigned by the client software that is installed on the POS terminal, which makes it available to the terminal’s software and to Visa Acceptance Solutions. Therefore, you can use this value to reconcile transactions between Visa Acceptance Solutions and the terminal’s software.

This value is not sent to the processor. Instead, the value is forwarded to the Visa Acceptance Solutions reporting software.

Specifications

Data Type:
String

Data Length:
32

Mapping Information

REST API Field:

clientReferenceInformation.partner.originalTransactionId

SCMP API Field:

partner_original_transaction_id

Simple Order API Field:

partnerOriginalTransactionID

clientReferenceInformation. partner. solutionId

Identifier for pre-built partner solution that is integrated to Visa Acceptance Solutions.

Send this value in all requests that are sent through the partner solution. Visa Acceptance Solutions assigns this ID to the partner.

Specifications

Data Type:
String

Data Length:
8

Mapping Information

REST API Field:

clientReferenceInformation.partner.solutionId

SCMP API Field:

partner_solution_id

Simple Order API Field:

partnerSolutionID

clientReferenceInformation. partner. thirdPartyCertificationNumber

Value that identifies the application vendor and application version for a third-party gateway.

You are provided with this value during testing and validation.

This field is supported only on Visa Platform Connect.

Specifications

Data Type:
String

Data Length:
12

Mapping Information

REST API Field:

clientReferenceInformation.partner.thirdPartyCertificationNumber

SCMP API Field:

third_party_certification_number

Simple Order API Field:

thirdPartyCertificationNumber

clientReferenceInformation. pausedRequestID

Used to resume a transaction that was paused for an order modification rule to allow for payer authentication to complete.

To resume and continue with the authorization/decision service flow, call the services and include the request ID from the prior decision call.

Specifications

Data Type:
String

Data Length:
26

Mapping Information

REST API Field:

clientReferenceInformation.pausedRequestID

SCMP API Field:

paused_request_id

Simple Order API Field:

decisionManager_pausedRequestID

clientReferenceInformation. reconciliationId

Reference number for the transaction.

IMPORTANT

For most Visa Acceptance Solutions services, the response message includes a unique reconciliation ID that is assigned by Visa Acceptance Solutions. For most payment processors, you can use this value to reconcile the transactions in your Visa Acceptance Solutions reports with the transactions in your processor reports.

For details, such as specific field names and information about processors that do not support reconciliation, see the implementation guide or developer guide for the payment method you are using.

Specifications

Data Type:
String

Data Length:
25

Mapping Information

REST API Field:

clientReferenceInformation.reconciliationId

SCMP API Field:

ap_initiate_trans_ref_no

Simple Order API Fields:

apInitiateReply_reconciliationID

apInitiateService_reconciliationID

clientReferenceInformation. returnReconciliationId

Reference number for for a transaction refund.

Specifications

Data Type:
String

Mapping Information

REST API Field:

clientReferenceInformation.returnReconciliationId

clientReferenceInformation. submitLocalDateTime

Local date and time at your physical location.

Format:

yyyyMMDDhhmmss

MM

= month

yyyy

= year

DD

= day

hh

= hour

mm

= minutes

ss

= seconds

Specifications

Data Type:
String

Data Length:
14

Mapping Information

REST API Field:

clientReferenceInformation.submitLocalDateTime

SCMP API Field:

transaction_local_date_time

Simple Order API Field:

transactionLocalDateTime

clientReferenceInformation. transactionId

Unique identifier that the client system assigns, which will restrict transaction processing duplication. Required field for an authorization, sale, credit, refund, PIN debit purchase, and PIN debit credit requests. The identifier can be used to locate and identify these requests in the event of a time-out, in order to be used in a subsequent reversal or void request.

The suggested format for this value is:

Positions 1-4:
Last four characters or your merchant ID.

Positions 5-7:
Julian date. Format: ddd

Positions 8-13:
Time stamp. Format: hhmmss

Positions 14-15:
Two arbitrary characters. One way to generate two arbitrary characters is to use a counter from 01-99.

This response is sent when a duplicate request is detected:

"INVALID_REQUEST"
        "reason": "DUPLICATE_REQUEST"
        "message": "Declined - The transaction identifier sent with this request has already been used in the last 60 days"

This field is available only on the Visa Platform Connect processor.

Specifications

Data Type:
String

Data Length:

PIN Debit Transactions: 15

Other Transactions: 30

Mapping Information

REST API Field:

clientReferenceInformation.transactionId

SCMP API Fields:

merchant_transaction_identifier

pin_debit_credit_transaction_id

pin_debit_purchase_transaction_id

Simple Order API Fields:

merchantTransactionIdentifier

pinDebitCreditReply_transactionID

pinDebitPurchaseReply_transactionID

clientVersion

Version number that is being used by the application.

Specifications

Data Type:
String

Data Length:
4

Mapping Information

REST API Field:

clientVersion

Simple Order API Field:
No corresponding field.

comment

Additional comments about the state of the terminal.

Specifications

Data Type:
String

Data Length:
256

Mapping Information

REST API Field:

comment

SCMP API Field:
No corresponding field

REST API Field:

configVersion

SCMP API Field:
No corresponding field

Simple Order API Field:
No corresponding field

consumerAuthenticationInformation

These fields provide consumer authentification information.

consumerAuthenticationInformation.accessToken

consumerAuthenticationInformation.acsOperatorID

consumerAuthenticationInformation.acsReferenceNumber

consumerAuthenticationInformation.acsRenderingType

consumerAuthenticationInformation.acsTransactionId

consumerAuthenticationInformation.acsUrl

consumerAuthenticationInformation.acsWindowSize

consumerAuthenticationInformation.alternateAuthenticationData

consumerAuthenticationInformation.alternateAuthenticationDate

consumerAuthenticationInformation.alternateAuthenticationMethod

consumerAuthenticationInformation. authenticationBrand

consumerAuthenticationInformation. authenticationDate

consumerAuthenticationInformation.authenticationPath

consumerAuthenticationInformation.authenticationResult

consumerAuthenticationInformation.authenticationStatusMsg

consumerAuthenticationInformation.authenticationTransactionContextId

consumerAuthenticationInformation. authenticationTransactionContext

consumerAuthenticationInformation.authenticationTransactionId

consumerAuthenticationInformation.authenticationType

consumerAuthenticationInformation.authenticationValue

consumerAuthenticationInformation.authorizationPayload

consumerAuthenticationInformation.cardholderMessage

consumerAuthenticationInformation.cavv

consumerAuthenticationInformation.cavvAlgorithm

consumerAuthenticationInformation.challengeCancelCode

consumerAuthenticationInformation.challengeCode

consumerAuthenticationInformation.challengeRequired

consumerAuthenticationInformation.credentialEncrypted

consumerAuthenticationInformation.customerCardAlias

consumerAuthenticationInformation.dataQualityIndicator

consumerAuthenticationInformation. decoupledAuthenticationIndicator

consumerAuthenticationInformation. decoupledAuthenticationMaxTime

consumerAuthenticationInformation.defaultCard

consumerAuthenticationInformation.deviceChannel

consumerAuthenticationInformation.deviceDataCollectionURL

consumerAuthenticationInformation. directoryServerErrorCode

consumerAuthenticationInformation.directoryServerErrorDescription

consumerAuthenticationInformation.directoryServerTransactionId

consumerAuthenticationInformation.dsReferenceNumber

consumerAuthenticationInformation.eci

consumerAuthenticationInformation.eciRaw

consumerAuthenticationInformation.ecommerceIndicator

consumerAuthenticationInformation.effectiveAuthenticationType

consumerAuthenticationInformation.exemptionDataRaw

consumerAuthenticationInformation.fido.fidoFlowType

consumerAuthenticationInformation.fido.reasonCode

consumerAuthenticationInformation. fido.reasonDescription

consumerAuthenticationInformation.idciDecision

consumerAuthenticationInformation.idciReasonCode1

consumerAuthenticationInformation.idciReasonCode2

consumerAuthenticationInformation.idciScore

consumerAuthenticationInformation.interactionCounter

consumerAuthenticationInformation. languagePreference

consumerAuthenticationInformation.marketingOptIn

consumerAuthenticationInformation.marketingSource

consumerAuthenticationInformation.mcc

consumerAuthenticationInformation.merchantFraudRate

consumerAuthenticationInformation.merchantScore

consumerAuthenticationInformation.messageCategory

consumerAuthenticationInformation. methodUrlPresent

consumerAuthenticationInformation.networkScore

consumerAuthenticationInformation.otpToken

consumerAuthenticationInformation.overrideCountryCode

consumerAuthenticationInformation. overridePaymentMethod

consumerAuthenticationInformation.paSpecificationVersion

consumerAuthenticationInformation.pareq

consumerAuthenticationInformation[].paresStatus

consumerAuthenticationInformation. signedParesStatusReason

consumerAuthenticationInformation.priorAuthenticationData

consumerAuthenticationInformation.priorAuthenticationMethod

consumerAuthenticationInformation. priorAuthenticationReferenceId

consumerAuthenticationInformation.priorAuthenticationTime

consumerAuthenticationInformation.productCode

consumerAuthenticationInformation.proofXml

consumerAuthenticationInformation.proxyPan

consumerAuthenticationInformation.referenceId

consumerAuthenticationInformation. requestorInitiatedAuthenticationIndicator

consumerAuthenticationInformation.requestorName

consumerAuthenticationInformation.responseAccessToken

consumerAuthenticationInformation.returnUrl

consumerAuthenticationInformation.scoreRequest

consumerAuthenticationInformation.sdkFlowType

consumerAuthenticationInformation.sdkMaxTimeout

consumerAuthenticationInformation.sdkTransactionId

consumerAuthenticationInformation.signedParesStatusReason

consumerAuthenticationInformation.signedPares

consumerAuthenticationInformation.specificationVersion

consumerAuthenticationInformation.stepUpUrl

consumerAuthenticationInformation.strongAuthentication. authenticationIndicator

consumerAuthenticationInformation.strongAuthentication. authenticationOutageExemptionIndicator

consumerAuthenticationInformation.strongAuthentication. delegatedAuthenticationExemptionIndicator

consumerAuthenticationInformation.strongAuthentication. issuerInformation.trustedMerchantExemptionResult

consumerAuthenticationInformation.strongAuthentication. issuerInformation.delegatedAuthenticationResult

consumerAuthenticationInformation.strongAuthentication. issuerInformation.exemptionDataRaw

consumerAuthenticationInformation.strongAuthentication. issuerInformation.lowValueExemptionResult

consumerAuthenticationInformation.strongAuthentication. issuerInformation.riskAnalysisExemptionResult

consumerAuthenticationInformation.strongAuthentication. issuerInformation.secureCorporatePaymentResult

consumerAuthenticationInformation.strongAuthentication. issuerInformation.transactionRiskAnalysisExemptionResult

consumerAuthenticationInformation.strongAuthentication. issuerInformation.trustedMerchantExemptionResult

consumerAuthenticationInformation.strongAuthentication.lowValueExemptionIndicator

consumerAuthenticationInformation.strongAuthentication. riskAnalysisExemptionIndicator

consumerAuthenticationInformation.strongAuthentication. secureCorporatePaymentIndicator

consumerAuthenticationInformation.strongAuthentication. trustedMerchantExemptionIndicator

consumerAuthenticationInformation. strongAuthentication.transactionMode

consumerAuthenticationInformation. threeDSServerOperatorId

consumerAuthenticationInformation.threeDSServerTransactionId

consumerAuthenticationInformation.transactionFlowIndicator

consumerAuthenticationInformation.transactionToken

consumerAuthenticationInformation. ucafAuthenticationData

consumerAuthenticationInformation. ucafCollectionIndicator

consumerAuthenticationInformation.validityPeriod

consumerAuthenticationInformation.whiteListStatus

consumerAuthenticationInformation.whiteListStatusSource

consumerAuthenticationInformation.xid

consumerAuthenticationInformation. accessToken

JSON Web Token (JWT) used to authenticate the customer with the authentication provider (for example, CardinalCommerce or RuPay).

Specifications

Data Type:
String

Data Length:
2048

Mapping Information

REST API Field:

consumerAuthenticationInformation. accessToken

SCMP API Field:

pa_access_token

Simple Order API Fields:

payerAuthEnrollReply_accessToken

payerAuthSetupReply_accessToken

consumerAuthenticationInformation. acsOperatorID

Access Control Server (ACS) identifier assigned by the directory service.

Each directory service can assign a unique ID to each ACS. This field is used with 3-D Secure 2.0. Required in mada transaction responses.

Specifications

Data Type:
String

Data Length:
32

Mapping Information

REST API Field:

consumerAuthenticationInformation. acsOperatorID

SCMP API Field:

pa_acs_operator_id

Simple Order API Field:

payerAuthEnrollReply_acsOperatorId

consumerAuthenticationInformation. acsReferenceNumber

Unique identifier assigned by EMVCo upon testing and approval.

This field is used with 3-D Secure 2.0.

Specifications

Data Type:
String

Data Length:
32

Mapping Information

REST API Field:

consumerAuthenticationInformation.acsReferenceNumber

SCMP API Fields:

acs_reference_number

pa_acs_reference_number

Simple Order API Fields:

ccAuthService_acsReferenceNumber

payerAuthEnrollReply_acsReferenceNumber

consumerAuthenticationInformation. acsRenderingType

Identifies the UI type that the ACS will use to complete the challenge.

Available only for mobile application transactions using the Cardinal Mobile SDK.

This field is a JSON object that comprises the following two fields, each two characters long.

ACS Interface Field Name:

acsInterface

is the ACS interface the challenge presents to the cardholder. Possible values:

01

: Native UI.

02

: HTML UI.

ACS UI Template Field Name:

acsUiTemplate

identifies the UI template format that the ACS first presents to the consumer. Possible values:

01

: Text.

02

: Single select.

03

: Multi select.

04

: OOB (Out of Band).

05

: HTML other.

Valid values for each interface:

Native UI:

01-04

.

HTML UI:

01-05

.

HTML other is valid only when combined with HTML UI. If HTML other is used with Native UI, it results in error=203.

JSON Object Example:

{ "acsRenderingType":{ "acsInterface";"02", "acsUiTemplate":03" } }

Specifications

Data Type:
String

Data Length:
See description.

Mapping Information

REST API Field:

consumerAuthenticationInformation. acsRenderingType

SCMP API Field:

pa_acs_rendering_type

Simple Order API Fields:

payerAuthEnrollReply_acsRenderingType

payerAuthValidateReply_acsRenderingType

consumerAuthenticationInformation. acsTransactionId

Unique transaction identifier assigned by the access control server (ACS) to identify a single transaction.

When you request the payer authentication and authorization services separately, get the value for this field from the

consumerAuthenticationInformation. acsTransactionId

response field.

Specifications

Data Type:
String

Data Length:
36

Mapping Information

REST API Field:

consumerAuthenticationInformation. acsTransactionId

SCMP API Fields:

acs_server_transaction_id

pa_acs_transaction_id

Simple Order API Fields:

ccAuthService_acsServerTransactionID

payerAuthEnrollReply_acsTransactionID

payerAuthValidateReply_acsTransactionID

consumerAuthenticationInformation. acsUrl

URL for the card-issuing bank’s authentication form that you receive when the card is enrolled.

The value can be very large.

Specifications

Data Type:
String

Data Length:
2048

Mapping Information

REST API Field:

consumerAuthenticationInformation. acsUrl

SCMP API Field:

pa_enroll_acs_url

Simple Order API Field:

payerAuthEnrollReply_acsURL

consumerAuthenticationInformation. acsWindowSize

You can send this override field to set the challenge window size to display to the cardholder. The Access Control Server (ACS) replies with content that is formatted appropriately for this window size to allow for the best user experience.

The sizes are width x height in pixels of the window displayed in the cardholder browser. Possible values:

01

: 250x400

02

: 390x400

03

: 500x600

04

: 600x400

05

: Full page

Specifications

Data Type:
String

Data Length:
2

Mapping Information

REST API Field:

consumerAuthenticationInformation. acsWindowSize

SCMP API Field:

pa_acs_window_size

Simple Order API Field:

payerAuthEnrollService_acsWindowSize

consumerAuthenticationInformation. alternateAuthenticationData

Data that documents and supports a specific authentication process.

Specifications

Data Type:
String

Data Length:
2048

Mapping Information

REST API Field:

consumerAuthenticationInformation. alternateAuthenticationData

SCMP API Field:

pa_alternate_authentication_data

Simple Order API Field:

payerAuthEnrollService_alternateAuthenticationData

consumerAuthenticationInformation. alternateAuthenticationDate

Date and time in UTC of the cardholder authentication.

Format:

yyyyMMDDHHMM

Specifications

Data Type:
String

Data Length:
14

Mapping Information

REST API Field:

consumerAuthenticationInformation. alternateAuthenticationDate

SCMP API Field:

pa_alternate_authentication_date

Simple Order API Fields:

payerAuthEnrollReply_alternateAuthenticationDate

payerAuthEnrollService_alternateAuthenticationDate

consumerAuthenticationInformation. alternateAuthenticationMethod

Mechanism used by the cardholder to authenticate to the 3-D Secure requestor.

Possible values:

01

: No authentication occurred.

02

: Logged in using merchant system credentials.

03

: Logged in using federated ID.

04

: Logged in using issuer credentials.

05

: Logged in using third-party authenticator.

06

: Logged in using Fast Identity Online (FIDO) Authenticator.

80

: Merchant is initiating a FIDO authentication to register a Visa Payment Passkey (VPP).

Specifications

Data Type:
String

Data Length:
2

Mapping Information

REST API Field:

consumerAuthenticationInformation. alternateAuthenticationMethod

SCMP API Field:

pa_alternate_authentication_method

Simple Order API Fields:

payerAuthEnrollReply_alternateAuthenticationMethod

payerAuthEnrollService_alternateAuthenticationMethod

consumerAuthenticationInformation. authenticationBrand

This response field indicates which directory server was used during the authentication process. This field is returned for the mada card scheme when fallback occurs.

This data is useful when the domestic scheme directory server is not present and authentication falls back to the global scheme directory server.

This field is implemented only for the Saudi Arabia region.

Possible values:

1

: Visa—Returned for mada VISA co-badged cards, when authentication falls back to the VISA directory server.

2

: Mastercard—Returned for mada Mastercard co-badged cards, when authentication falls back to the Mastercard directory server.

3

: Unknown—Returned for mada-only cards, when the mada directory server returns an error code.

Specifications

Data Type:
String

Data Length:
16

Mapping Information

REST API Field:

consumerAuthenticationInformation.authenticationBrand

SCMP API Field:

pa_enroll_pa_authentication_brand

pa_validate_pa_authentication_brand

Simple Order API Fields:

payerAuthEnrollReply_authenticationBrand

payerAuthValidateReply_authenticationBrand

consumerAuthenticationInformation. authenticationDate

Date and time that the 3D Secure server authenticated the cardholder.

This field is available only for secure transactions in France on the Banque de France et Tresor Public, BNP Paribas France, and Credit Mutuel-CIC processors.

Format:
yyyyMMDDHHMMSS

Specifications

Data Type:
String

Data Length:
14

Mapping Information

REST API Field:

consumerAuthenticationInformation.authenticationDate

SCMP API Field:

pa_authentication_date

Simple Order API Field:

ccAuthService_paAuthenticationDate

consumerAuthenticationInformation. authenticationPath

Indicates what displays to the customer during the authentication process.

This field can contain one of these values:

ADS

: Card not enrolled. Customer prompted to activate the card during the checkout process.

ATTEMPTS

: Attempts processing.

Processing...

briefly appears before the checkout process is completed.

ENROLLED

: Card enrolled. The card issuer’s authentication window opens.

UNKNOWN

: Card enrollment status cannot be determined.

NOREDIRECT

: Card not enrolled, authentication unavailable, or error occurred. Nothing displays to the customer.

The following values can be returned if you are using rules-based payer authentication:

RIBA

: The card-issuing bank supports risk-based authentication, but whether the cardholder is likely to be challenged cannot be determined.

RIBA_PASS

: The card-issuing bank supports risk-based authentication, and it is likely that the cardholder will not be challenged to provide credentials, also known as silent authentication
.

Specifications

Data Type:
String

Data Length:
255

Mapping Information

REST API Field:

consumerAuthenticationInformation. authenticationPath

SCMP API Field:

pa_enroll_authentication_path

Simple Order API Field:

payerAuthEnrollReply_authenticationPath

consumerAuthenticationInformation. authenticationResult

Raw authentication data that comes from the card-issuing bank.

Primary authentication field that indicates whether authentication was successful and the liability shift occurred. Examine the result of this field first.

This field contains one of these values:

-1

: Invalid PARes.

0

: Successful validation.

1

: Cardholder is not participating, but the attempt to authenticate was recorded.

6

: Issuer unable to perform authentication.

9

: Cardholder did not complete authentication.

Specifications

Data Type:
String with numbers only

Data Length:
255

Mapping Information

REST API Field:

consumerAuthenticationInformation. authenticationResult

SCMP API Field:

pa_validate_authentication_result

Simple Order API Fields:

payerAuthEnrollReply_authenticationResult

payerAuthValidateReply_authenticationResult

consumerAuthenticationInformation. authenticationStatusMsg

Message that explains the

consumerAuthenticationInformation. authenticationResult

response field.

Specifications

Data Type:
String

Data Length:
255

Mapping Information

REST API Field:

consumerAuthenticationInformation. authenticationStatusMsg

SCMP API Field:

pa_validate_authentication_status_msg

Simple Order API Fields:

payerAuthEnrollReply_authenticationStatusMessage

payerAuthValidateReply_authenticationStatusMessage

consumerAuthenticationInformation. authenticationTransactionContext

Payer authentication transaction context identifier.

It links the check enrollment authentication and the validate authentication transactions.

This field is supported only for RuPay for the payer authentication seamless flow.

Get the value for this field from the

consumerAuthenticationInformation. authenticationTransactionContext

field in the check enrollment response.

Specifications

Data Type:
String

Data Length:
256

Mapping Information

REST API Field:

consumerAuthenticationInformation. authenticationTransactionContext

SCMP API Field:
No corresponding field.

Simple Order API Field:
No corresponding field.

consumerAuthenticationInformation. authenticationTransactionContextId

Payer authentication transaction context identifier. It links the validate authentication transaction and payment authorization transaction.

This field is supported only for RuPay for the payer authentication seamless flow.

Specifications

Data Type:
String

Data Length:
256

Mapping Information

REST API Field:

consumerAuthenticationInformation. authenticationTransactionContextId

SCMP API Field:
No corresponding field.

Simple Order API Field:
No corresponding field.

consumerAuthenticationInformation. authenticationTransactionId

Payer authentication transaction identifier that links the check enrollment and validates authentication transactions.

Use this field to resend the one-time password.

This field is available only for the RuPay processor for the payer authentication seamless flow.

Get the value for this field from the

consumerAuthenticationInformation. authenticationTransactionId

field in the check enrollment response.

Specifications

Data Type:
String

Data Length:
26

Mapping Information

REST API Field:

consumerAuthenticationInformation.authenticationTransactionId

SCMP API Fields:

pa_authentication_transaction_id

pa_enroll_authentication_transaction_id

Simple Order API Fields:

payerAuthEnrollReply_authenticationTransactionID

payerAuthEnrollService_authenticationTransactionID

payerAuthValidateService_authenticationTransactionID

consumerAuthenticationInformation. authenticationType

Indicates the type of authentication that is used to challenge the cardholder.

This field is available only on the RuPay processor.

Possible Values:

01

: Static.

02

: Dynamic.

03

: OOB (Out of Band).

20

: Merchant hosted. RuPay:
For payer authentication seamless flow.

IMPORTANT

EMV 3-D Secure 2.1.0 supports values

01-03

. Version 2.2.0 supports values

01-03

.

Specifications

Data Type:
Integer

Data Length:
2

Mapping Information

REST API Field:

consumerAuthenticationInformation.authenticationType

SCMP API Field:

pa_authentication_type

Simple Order API Fields:

payerAuthEnrollReply_authenticationType

payerAuthValidateReply_authenticationType

consumerAuthenticationInformation. authenticationValue

Authentication transaction token.

This field is supported only for RuPay. Include this field in authorizations that do not use a payment network token for the payer authentication seamless flow.

Get the value for this field from the

consumerAuthenticationInformation. transactionToken

field in the validate authentication response.

Specifications

Data Type:
String

Data Length:
256

Mapping Information

REST API Field:

consumerAuthenticationInformation. authenticationValue

SCMP API Field:
No corresponding field.

Simple Order API Field:
No corresponding field.

consumerAuthenticationInformation. authorizationPayload

The Base64-encoded JSON payload of authorization values returned in the challenge flow.

Specifications

Data Type:
String

Data Length:
255

Mapping Information

REST API Field:

consumerAuthenticationInformation. authorizationPayload

SCMP API Field:

authorization_payload

Simple Order API Fields:

payerAuthEnrollReply_authorizationPayload

payerAuthValidateReply_authorizationPayload

consumerAuthenticationInformation. cardholderMessage

Text provided by the AC or issuer or both to the cardholder during a frictionless or decoupled transaction.

The issuer can provide information to the cardholder. For example, “Additional authentication is needed for this transaction. Please contact (Issuer Name) at xxx-xxx-xxxx.” The issuing bank can choose to support this value.

Specifications

Data Type:
String

Data Length:
128

Mapping Information

REST API Field:

consumerAuthenticationInformation. cardholderMessage

SCMP API Field:

pa_cardholder_message

Simple Order API Field:

payerAuthEnrollReply_cardholderMessage

consumerAuthenticationInformation. cavv

Cardholder authentication verification value (CAVV).

This value is a transaction identifier generated by the issuing bank during payer authentication.

This value must be 28-character Base64 or 40-character hex binary.

When you request the payer authentication and authorization services separately, get the value for this field from the

consumerAuthenticationInformation. cavv

response field.

Apple Pay and Samsung Pay Transactions

American Express: for a 20-byte cryptogram, set this field to the cryptogram for authorizations with payment network tokens. For a 40-byte cryptogram, set this field to block A of the cryptogram for authorizations with payment network tokens.

Discover: the value for this field can be a 20 or 40-character hex binary. All cryptograms use one of these formats.

Visa: the value for this field must be 28-character base 64 or 40-character hex binary. All cryptograms use one of these formats.

China UnionPay: This field and
processingInformation.commerceIndicator
field are required for authorizations for China UnionPay domestic debit cards.
FDC Nashville Global: For Visa Secure, this field is set to the value for the transaction identifier (XID) when the XID is present in the authorization request and the CAVV is not present.
Visa Platform Connect: The value for this field corresponds to this data in the TC 33 capture file:
Record: CP01 TCR8
Position: 77-78
Field: CAVV version and authentication action

Specifications

Data Type:
String

Data Length (request):
40

Data Length (response):
255

Mapping Information

REST API Field:

consumerAuthenticationInformation.cavv

SCMP API Fields:

cavv

pa_enroll_cavv

pa_validate_cavv

Simple Order API Fields:

ccAuthService_cavv

payerAuthEnrollReply_cavv

payerAuthValidateReply_cavv

consumerAuthenticationInformation. cavvAlgorithm

Algorithm for generating a cardholder authentication verification value (CAVV) or universal cardholder authentication field (UCAF) data.

This field is available only on Credit Mutuel-CIC for Visa Secure.

Possible values:

0

: Hash-based message authentication code (HMAC)

1

: Card verification value (CVV)

2

: CVV with authentication transaction number (ATN)

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

consumerAuthenticationInformation.cavvAlgorithm

SCMP API Fields:

cavv_algorithm

pa_enroll_cavv_algorithm

pa_validate_cavv_algorithm

Simple Order API Fields:

ccAuthService_cavvAlgorithm

payerAuthEnrollReply_cavvAlgorithm

payerAuthValidateReply_cavvAlgorithm

consumerAuthenticationInformation. challengeCancelCode

Indicates why a transaction was canceled.

Possible values:

01

: Cardholder selected Cancel.

02

: Reserved for future EMVCo use (values invalid until defined by EMVCo).

03

: Transaction timed out—Decoupled Authentication.

04

: Transaction timed out at ACS—other timeouts.

05

: Transaction timed out at ACS—First CReq not received by ACS.

06

: Transaction Error.

07

: Unknown.

08

: Transaction timed out at SDK.

France Country Specific Information: In France, this field is available only for secure transactions.

The transaction was not cancelled. It was sent to the payment card company and the issuer who can reject it with a soft decline by requesting additional cardholder authentication.

Possible values:

01
: Cardholder selected Cancel
.
03
: Decoupled authentication caused the transaction to time out.
04
: Transaction timed out at the access control server (ACS), which is a server on the issuer side of the 3-D Secure protocol. This value includes all ACS timeouts not covered by the value
05
.
05
: Transaction timed out at the ACS because the first challenge request was not received by the ACS.
06
: Transaction error as determined by the 3-D Secure server.
07
: Unknown.
08
: Visa Acceptance Solutions software timed out.

When you request the payer authentication and authorization services separately, get the value for this field from the
consumerAuthenticationInformation. challengeCancelCode
response field.

Specifications

Data Type:
String

Data Length:
2

Mapping Information

REST API Field:

consumerAuthenticationInformation.challengeCancelCode

SCMP API Field:

challenge_cancel_code

Simple Order API Fields:

ccAuthService_challengeCancelCode

challenge_cancel_code

(France only)

payerAuthEnrollReply_challengeCancelCode

payerAuthValidateReply_challengeCancelCode

consumerAuthenticationInformation. challengeCode

Authentication type or challenge presented to the cardholder at checkout.

This field is available only for the Banque de France et Tresor Public, BNP Paribas France, and Credit Mutuel-CIC processors.

The challenge is issued after requesting secure transactions through the Visa Acceptance Solutions payer authentication services.

A challenge
means that strong customer authentication is required. The challenge status does the following:

Informs the issuer about the alternative authentication methods that the cardholder used.

Enables you to override default values for one transaction at a time and increase the authorization acceptance rate at the risk of accepting a liability shift for the transaction.

Possible values:

01

: No preference.

02

: No challenge requested, but the reason is unknown.

03

: You requested the challenge. You can default to this value for every transaction when you see an increase in fraud rates.

04

: Challenge mandated. Strong customer authentication is required when one of the following is true:

Transaction amount exceeds 30 EUR and there have been at least five transactions on the payment card during the preceding week.

Cumulative amount for the payment card during the preceding week exceeds 100 EUR.

05

: No challenge requested because transactional risk analysis has already been performed.

06

: No challenge requested because the purpose of this transaction is to share data, not to move money.

07

: No challenge requested because strong consumer authentication has already been performed.

08

: No challenge requested because the cardholder is on a white list of exempt cardholders.

09

: Challenge requested by issuer. Determine whether the cardholder is on a white list of exempt cardholders.

This field defaults to

01

on merchant configuration and can be overridden by the merchant. EMV 3-D Secure version 2.1.0 supports values

01

-

04

. Version 2.2.0 supports values

01

-

09

.

Specifications

Data Type:
Integer

Data Length:
2

Mapping Information

REST API Field:

consumerAuthenticationInformation. challengeCode

SCMP API Field:

pa_challenge_code

Simple Order API Fields:

ccAuthService_paChallengeCode

payerAuthEnrollService_challengeCode

consumerAuthenticationInformation. challengeRequired

SCMP API Field:

pa_customer_cc_alias

Simple Order API Field:

payerAuthEnrollService_customerCCAlias

consumerAuthenticationInformation. dataQualityIndicator

This value indicates whether a payment authorization request or capture authorization request meets the Visa Secure data quality requirements.

The authorization response returns the authentication indicator in Field 34 (acceptance environment data in TLV format), Dataset ID 01 (authentication data), Tag C1.

IMPORTANT

This indicator does not appear in responses to authorization follow-on transactions.

Possible values for tag C1:

0

: The authorization request meets the Visa Secure data quality requirements.

1

: The authorization request does not meet the Visa Secure data quality requirements.

Specifications

Data Type: String

Data Length 10

Mapping Information

REST API Field:

consumerAuthenticationInformation.dataQualityIndicator

SCMP API Field:

authentication_data_quality_indicator

Simple Order API Field:

authenticationData_qualityIndicator

consumerAuthenticationInformation. decoupledAuthenticationIndicator

Indicates whether the 3-D Secure requester agrees to use decoupled authentication if the ACS confirms its use.

Possible Values:

Y

: Decoupled Authentication is supported and preferred if a challenge is necessary.

N

: Do not use Decoupled Authentication (default).

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

consumerAuthenticationInformation. decoupledAuthenticationIndicator

SCMP API Field:

pa_decoupled_authentication_indicator

Simple Order API Field:

payerAuthEnrollService_decoupledAuthenticationIndicator

consumerAuthenticationInformation. decoupledAuthenticationMaxTime

The maximum interval of time (in minutes) that the 3-D Secure requester waits for an Active Control Server (ACS) to return the result of a decoupled authentication transaction.

Possible Values: Numeric values between

1

and

10080

are accepted.

Specifications

Data Type:
String

Data Length:
5

Mapping Information

REST API Field:

consumerAuthenticationInformation. decoupledAuthenticationMaxTime

SCMP API Field:

pa_decoupled_authentication_max_time

Simple Order API Field:

payerAuthEnrollService_decoupled_AuthenticationMaxTime

consumerAuthenticationInformation. defaultCard

Indicates that the card being used is the one designated as the primary payment card for purchase.

This field can contain one of these values:

true

false

Recommended for Discover ProtectBuy.

Specifications

Data Type:
Boolean

Data Length:
1

Mapping Information

REST API Field:

consumerAuthenticationInformation. defaultCard

SCMP API Field:

pa_default_card

Simple Order API Field:

payerAuthEnrollService_defaultCard

consumerAuthenticationInformation. deviceChannel

Indicates the channel used for the transaction.

Required for SDK integration. Possible Values:

SDK

Browser

3RI (3-D Secure Integrator Request)

IMPORTANT

If you use the SDK integration, this field is dynamically set to

REST API Field:

consumerAuthenticationInformation.directoryServerErrorCode

SCMP API Field:

pa_directory_server_error_code

Simple Order API Fields:

payerAuthEnrollReply_directoryServerErrorCode

payerAuthValidateReply_directoryServerErrorCode

consumerAuthenticationInformation. directoryServerErrorDescription

Directory server text and additional detail about the error for the transaction.

Specifications

Data Type:
String

Data Length:
4096

Mapping Information

REST API Field:

consumerAuthenticationInformation. directoryServerErrorDescription

SCMP API Field:

pa_directory_server_error_description

Simple Order API Fields:

payerAuthEnrollReply_directoryServerErrorDescription

payerAuthValidateReply_directoryServerErrorDescription

consumerAuthenticationInformation. directoryServerTransactionId

Transaction ID that the directory server generates during authentication.

When you request the payer authentication and authorization services separately, get the value for this field from the

consumerAuthenticationInformation. threeDSServerTransactionId

response field.

Mastercard Identity Check on Visa Platform Connect

The value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCR7

Position: 114-149

Field: MC AVV Verification—Directory Server Transaction ID

The TC 33 capture file contains information about the payments and credits that a merchant submits to Visa Acceptance Solutions. The processor creates the TC 33 capture file at the end of the day and sends it to the merchant’s acquirer. The acquirer uses this information to facilitate end-of-day clearing processing with payment networks.

Specifications

Data Type:
String

Data Length:
36

Mapping Information

REST API Field:

consumerAuthenticationInformation.directoryServerTransactionId

SCMP API Fields:

directory_server_transaction_id

pa_enroll_directory_server_transaction_id

pa_validate_directory_server_transaction_id

Simple Order API Fields:

ccAuthService_directoryServerTransactionID

payerAuthEnrollReply_directoryServerTransactionID

payerAuthValidateReply_directoryServerTransactionID

consumerAuthenticationInformation. dsReferenceNumber

Unique identifier assigned by the EMVCo.

This field is required in cardholder-initiated 3-D Secure fully-authenticated mada card transactions.

When you request the payer authentication and authorization services separately, get the value for this field from the response messages.

Specifications

Data Type:
String

Data Length:
23

Mapping Information

REST API Field:

consumerAuthenticationInformation. dsReferenceNumber

SCMP API Field:

ds_reference_number

Simple Order API Field:

ccAuthService_dsReferenceNumber

consumerAuthenticationInformation. eci

Numeric electronic commerce indicator (ECI) returned only for Visa, American Express, JCB, Diners Club, Discover, China UnionPay, and Elo transactions when the card is not enrolled.

IMPORTANT

This field applies only to cards that are not issued in the U.S.

If you are not using Visa Acceptance Solutions payment services, you must send this value to your payment processor in the next request for card authorization.

This field contains one of these values:

06

: The card can be enrolled. Liability shift.

07

: The card cannot be enrolled. No liability shift.

Specifications

Data Type:
String

Data Length:
255

Mapping Information

REST API Field:

consumerAuthenticationInformation. eci

SCMP API Fields:

pa_enroll_eci

pa_validate_eci

Simple Order API Fields:

payerAuthEnrollReply_eci

payerAuthValidateReply_eci

consumerAuthenticationInformation. eciRaw

Raw electronic commerce indicator (ECI).

The field is absent if authentication fails.

This field can contain one of these values:

01

: Authentication attempted (Mastercard).

02

: Successful authentication (Mastercard).

05

: Successful authentication (Visa, American Express, JCB, Diners Club, Discover, China UnionPay, and Elo).

06

: Authentication attempted (Visa, American Express, JCB, Diners Club, Discover, China UnionPay, and Elo).

Specifications

Data Type:
String

Data Length:
255

Mapping Information

REST API Field:

consumerAuthenticationInformation.eciRaw

SCMP API Fields:

eci_raw

pa_enroll_eci_raw

pa_validate_eci_raw

Simple Order API Fields:

ccAuthService_eciRaw

payerAuthEnrollReply_eciRaw

payerAuthValidateReply_eciRaw

consumerAuthenticationInformation. ecommerceIndicator

Indicator used to distinguish types of transactions.

This field contains one of these values:

aesk

: American Express SafeKey authentication verified successfully.

aesk_attempted

: Card not enrolled in American Express SafeKey, but the attempt to authenticate is recorded.

cs

: Elo Compra Segura authentication verified successfully.

cs_attempted

: Elo Compra Segura card not enrolled, but the attempt to authenticate is recorded.

dipb

: Discover ProtectBuy authentication verified successfully.

dipb_attempted

: Card not enrolled in Discover ProtectBuy, but the attempt to authenticate is recorded.

internet

: Card not enrolled, or card type not supported by payer authentication. No liability shift.

js

: J/Secure authentication verified successfully.

js_attempted

: Card not enrolled, but the attempt to authenticate is recorded. Liability shift.

js_failure

: J/Secure directory service is not available. No liability shift.

pb

: Diners Club ProtectBuy authentication verified successfully.

pb_attempted

: Card not enrolled in Diners Club ProtectBuy, but the attempt to authenticate is recorded.

spa

: Mastercard Identity Check authentication verified successfully.

spa_failure

: Mastercard Identity Check failed authentication.

up3ds

: China UnionPay authentication verified successfully.

up3ds_attempted

: China UnionPay card not enrolled, but the attempt to authenticate is recorded.

up3ds_failure

: China UnionPay authentication unavailable.

vbv

: Visa Secure authentication verified successfully.

vbv_attempted

: Visa card not enrolled, but the attempt to authenticate is recorded. Liability shift.

vbv_failure

: For the payment processors Barclays, Streamline, AIBMS, or FDC Germany, you receive this result if Visa’s directory service is not available. No liability shift.

Specifications

Data Type:
String

Data Length:
255

Mapping Information

REST API Field:

consumerAuthenticationInformation. ecommerceIndicator

SCMP API Fields:

pa_enroll_e_commerce_indicator

pa_validate_e_commerce_indicator

Simple Order API Fields:

payerAuthEnrollReply_commerceIndicator

payerAuthValidateReply_commerceIndicator

consumerAuthenticationInformation. effectiveAuthenticationType

The type of 3-D Secure transaction flow.

When you request the payer authentication and authorization services separately, get the value for this field from the

consumerAuthenticationInformation. effectiveAuthenticationType

response field.

Possible Values:

CH

: Challenge.

Strong customer authentication is required. The cardholder must prove that they are present and enter the payment details by providing two of the following elements:

Something on the cardholder's body. Example: fingerprint.

Something the cardholder has. Examples: plastic card, mobile device, token generator.

Something the cardholder knows. Examples: PIN, password.

FR

: Frictionless.

The transaction can proceed without cardholder authentication.

FD

: Frictionless with delegation (challenge not generated by the issuer but by the scheme on behalf of the issuer).

The issuer does not require cardholder authentication, but the payment card company might require it.

Specifications

Data Type:
String

Data Length:
2

Mapping Information

REST API Field:

consumerAuthenticationInformation. effectiveAuthenticationType

SCMP API Field:

effective_authentication_type

Simple Order API Fields:

ccAuthService_effectiveAuthenticationType

payerAuthEnrollReply_effectiveAuthenticationType

payerAuthValidateReply_effectiveAuthenticationType

consumerAuthenticationInformation. exemptionDataRaw

Payer authentication exemption data field.

Raw exemption data field that is used for Carte Bancaire exemptions. For example,"low fraud merchant program." Used with payer authentication service response.

Specifications

Data Type:
String

Data Length:
4

Mapping Information

REST API Field:

consumerAuthenticationInformation.exemptionDataRaw

Simple Order API Field:

payerAuthEnrollReply_exemptionDataRaw

consumerAuthenticationInformation.fido.fidoFlowType

The type of flow used in the Fast Identity Online (FIDO) process.

Possible values:

ENROLLMENT

: Continue the enrollment flow using 3-D Secure authentication.

CHALLENGE

: Continue using the FIDO Challenge.

ERROR

: Continue using 3-D Secure authentication without FIDO.

Specifications

Data Type:
String

Data Length:
10

Mapping Information

REST API Field:

consumerAuthenticationInformation.fido.fidoFlowType

Simple Order API Field:

fidoFlowType

consumerAuthenticationInformation.fido.reasonCode

This is the value returned when Fast Identity Online (FIDO) fails.

A value of

0

indicates success.

Specifications

Data Type:
Number

Data Length:
5

Mapping Information

REST API Field:

consumerAuthenticationInformation.fido.reasonCode

Simple Order API Field:

fidoReasonCode

consumerAuthenticationInformation. fido.reasonDescription

This is a description of the error that occurs when Fast Identity Online (FIDO) fails.

Specifications

Data Type:
String

Data Length:
100

Mapping Information

REST API Field:

consumerAuthenticationInformation.fido.reasonDescription

Simple Order API Field:

fidoReasonDescription

consumerAuthenticationInformation. idciDecision

Decision on the risk assessment from Mastercard.

This field is used only with Mastercard. It is required when the merchant requests the Identity Check Insights (IDCI) score.

Specifications

Data Type:
String

Data Length:
12

Mapping Information

REST API Field:

consumerAuthenticationInformation. idciDecision

SCMP API Field:

pa_idci_decision

Simple Order API Field:

payerAuthEnrollReply_idciDecision

consumerAuthenticationInformation. idciReasonCode1

Reason code from Mastercard.

This field is only used with Mastercard. It is required when the merchant requests the Identity Check Insights (IDCI) score. The reason code values range from

A

through

Z

. For a description of the reason codes values, see the appendix of the Mastercard Identity Check Program Guide.

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

consumerAuthenticationInformation. idciReasonCode1

SCMP API Field:

pa_idci_reason_code1

Simple Order API Field:

payerAuthEnrollReply_idciReasonCode1

consumerAuthenticationInformation. idciReasonCode2

Reason code from Mastercard.

This field is only used with Mastercard. It is required when the merchant requests the Identity Check Insights (IDCI) score. The reason code values range from

A

through

Z

. For a description of the reason codes values, see the appendix of the Mastercard Identity Check Program Guide.

Specifications

Data Type:
String

Data Length:
2

Mapping Information

REST API Field:

consumerAuthenticationInformation. idciReasonCode2

SCMP API Field:

pa_idci_reason_code2

Simple Order API Field:

payerAuthEnrollReply_idciReasonCode2

consumerAuthenticationInformation. idciScore

Risk assessment from Mastercard.

Only for Mastercard. Required when the merchant requests the Identity Check Insights (IDCI) score. The risk score values range from

0

-

9

(low to high). Refer to the Appendix C in the Mastercard Identity Check Program Guide for additional information about the score values.

Specifications

Data Type:
Integer

Data Length:
1

Mapping Information

REST API Field:

consumerAuthenticationInformation.idciScore

SCMP API Field:

pa_idci_score

Simple Order API Field:

payerAuthEnrollReply_idciScore

consumerAuthenticationInformation. interactionCounter

pa_marketing_optin

Simple Order API Field:

payerAuthEnrollService_marketingOptIn

consumerAuthenticationInformation. marketingSource

Indicates origin of the marketing offer.

Recommended for Discover ProtectBuy.

Specifications

Data Type:
String

Data Length:
40

Mapping Information

REST API Field:

consumerAuthenticationInformation. marketingSource

SCMP API Field:

pa_marketing_source

Simple Order API Field:

payerAuthEnrollService_marketingSource

consumerAuthenticationInformation. mcc

Merchant category code.

Specifications

Data Length:
4

Mapping Information

REST API Field:

consumerAuthenticationInformation. mcc

SCMP API Field:

pa_mcc

Simple Order API Field:

payerAuthEnrollService_MCC

consumerAuthenticationInformation. merchantFraudRate

Calculated by merchants according to Payment Service Directive 2 (PSD2) and Regulatory Technical Standards (RTS). European Economic Area (EEA) card fraud divided by all EEA card volumes.

Possible Values:

1

: Represents fraud rate <=1.

2

: Represents fraud rate >1 and <=6.

3

: Represents fraud rate >6 and <=13.

4

: Represents fraud rate >13 and <=25.

5

: Represents fraud rate >25.

Specifications

Data Type:
String

Data Length:
2

Mapping Information

REST API Field:

consumerAuthenticationInformation.merchantFraudRate

SCMP API Field:

pa_merchant_fraud_rate

Simple Order API Field:

payerAuthEnrollService_merchantFraudRate

consumerAuthenticationInformation. merchantScore

Risk score provided by merchants.

Specifications

Data Type:
Integer

Data Length:
2

Mapping Information

REST API Field:

consumerAuthenticationInformation. merchantScore

SCMP API Field:

pa_merchant_score

Simple Order API Field:

payerAuthEnrollService_merchantScore

consumerAuthenticationInformation. messageCategory

Category of the message for a specific use case.

Possible values:

01

: PA (payment authentication).

02

: NPA (nonpayment authentication).

03-79

: Reserved for EMVCo future use (values invalid until defined by EMVCo).

80-99

: Reserved for directory server use.

Specifications

Data Type:
String

Data Length:
2

Mapping Information

REST API Field:

consumerAuthenticationInformation.messageCategory

SCMP API Field:

pa_message_category

Simple Order API Field:

payerAuthEnrollService_messageCategory

consumerAuthenticationInformation. methodUrlPresent

This value indicates whether the issuer provided a device data collection URL.

Possible values:

True

False

Specifications

Data Type:
String

Data Length:
5

Mapping Information

REST API Field:

consumerAuthenticationInformation.methodUrlPresent

Simple Order API Field:

methodUrlPresent

consumerAuthenticationInformation. networkScore

The global score calculated by the 3-D Secure scoring platform and returned to the merchant.

This field is available only for secure transactions in France on the Banque de France et Tresor Public, BNP Paribas France, and Credit Mutuel-CIC processors.

Possible values:

00

-

99

.

When you request the payer authentication and authorization services separately, get the value for this field from the

consumerAuthenticationInformation. networkScore

response field.

Specifications

Data Type:
String

Data Length:
2

Mapping Information

REST API Field:

consumerAuthenticationInformation. networkScore

SCMP API Field:

pa_network_score

Simple Order API Fields:

ccAuthService_paNetworkScore

payerAuthEnrollReply_networkScore

consumerAuthenticationInformation. otpToken

One-time password that the cardholder entered.

RuPay:
This field is supported only for the payer authentication seamless flow.

Specifications

Data Type:
String

Data Length:
255

Mapping Information

REST API Field:

consumerAuthenticationInformation. otpToken

SCMP API Field:

pa_otp_token

Simple Order API Field:

pa_otpToken

consumerAuthenticationInformation. overrideCountryCode

Two-character ISO standard country code.

Specifications

Data Type:
String

Data Length:
2

Mapping Information

REST API Field:

consumerAuthenticationInformation.overrideCountryCode

SCMP API Field:

pa_merchant_country_code

Simple Order API Field:

payerAuthEnrollService_countrycode

consumerAuthenticationInformation. overridePaymentMethod

Specifies the payment account type used for the transaction.

This field overrides other payment types that might be specified in the request. Use one of the following values for this field:

NA

: Does not apply. Do not override other payment types that are specified in the request.

CR

: Credit card.

DB

: Debit card.

VSAVR

: Visa Vale Refeicao.

VSAVA

: Visa Vale Alimentacao.

Specifications

Data Type:
String

Data Length:
10

Mapping Information

REST API Field:

consumerAuthenticationInformation. overridePaymentMethod

SCMP API Field:

pa_override_payment_method

Simple Order API Field:

payerAuthEnrollService_overridePaymentMethod

consumerAuthenticationInformation. pareq

Payer authentication request (PAReq) message that you must forward to the ACS.

The value can be very large. The value is encoded in Base64.

Specifications

Data Type:
String

Data Length:
No length limit.

Mapping Information

REST API Field:

consumerAuthenticationInformation. pareq

SCMP API Field:

pa_enroll_pareq

Simple Order API Field:

payerAuthEnrollReply_paReq

consumerAuthenticationInformation[]. paresStatus

Raw result of the authentication check.

This field can contain one of these values:

A

: Proof of authentication attempt was generated.

C

: Card challenged. This status is a temporary status for an in-flight transaction and can result in other authentication statuses after transaction is completed.

N

: Customer failed or canceled authentication. Transaction denied.

R

: Authentication rejected (used for 3-D Secure 2.x transactions only).

U

: Authentication not completed regardless of the reason.

Y

: Customer was successfully authenticated.

Specifications

Data Type:
String

Data Length:
255

Mapping Information

REST API Field:

consumerAuthenticationInformation[].paresStatus

SCMP API Fields:

pares_status

pa_enroll_pares_status

pa_validate_pares_status

Simple Order API Fields:

ccAuthService_paresStatus

payerAuthEnrollReply_paresStatus

payerAuthValidateReply_paresStatus

consumerAuthenticationInformation. signedParesStatusReason

Provides additional information about the PARes status value.

Specifications

Data Type:
String

Data Length:
2

Mapping Information

REST API Field:

consumerAuthenticationInformation. signedParesStatusReason

SCMP API Field:

pares_status_reason

Simple Order API Fields:

payerAuthEnrollReply_authenticationStatusReason

payerAuthValidateReply_authenticationStatusReason

consumerAuthenticationInformation. paSpecificationVersion

The EMV 3-D Secure version that was used to process the transaction.

Example
: 2.3.1

This field is available only for the FDC Compass and Visa Platform Connect processors.

Visa Platform Connect: The value for this field corresponds to this data in the TC 33 capture file:

Record: CP01 TCR7
Position: 113
Field: MC AVV Verification—Program Protocol

Mastercard Identity Check on Visa Platform ConnectVisa Platform Connect: Mastercard Identity Check might return one of these values during the authentication process.

Possible values:

2.1.0
: EMV 3-D Secure 2.1.0 (This value cannot be used after September 25, 2024, when EMV 3-D Secure 2.1 is no longer supported. All merchants must begin using EMV 3-D Secure 2.2 or later before that date to avoid any disruption in service.)
2.2.0
: EMV 3-D Secure 2.2.0
2.3.0
: EMV 3-D Secure 2.3.0
2.4.0
: EMV 3-D Secure 2.4.0
2.5.0
: EMV 3-D Secure 2.5.0
2.6.0
: EMV 3-D Secure 2.6.0
2.7.0
: EMV 3-D Secure 2.7.0
2.8.0
: EMV 3-D Secure 2.8.0
2.9.0
: EMV 3-D Secure 2.9.0

Specifications

Data Type:
String

Data Length:
20

Mapping Information

REST API Field:

consumerAuthenticationInformation.paSpecificationVersion

SCMP API Field:

pa_specification_version

Simple Order API Field:

ccAuthService_paSpecificationVersion

consumerAuthenticationInformation. priorAuthenticationData

This field contains data that the ACS can use to verify the authentication process.

Specifications

Data Type:
String

Data Length:
2048

Mapping Information

REST API Field:

consumerAuthenticationInformation. priorAuthenticationData

SCMP API Field:

pa_prior_authentication_data

Simple Order API Field:

payerAuthEnrollService_priorAuthenticationData

consumerAuthenticationInformation. priorAuthenticationMethod

Method the cardholder used previously to authenticate to the 3-D Secure requester.

Possible values:

01

: Frictionless authentication occurred by ACS.

02

: Cardholder challenge occurred by ACS.

03

: AVS verified.

04

: Other issuer methods.

05-79

: Reserved for EMVCo future use (values invalid until defined by EMVCo).

80-99

: Reserved for directory server use.

Specifications

Data Type:
String

Data Length:
2

Mapping Information

REST API Field:

consumerAuthenticationInformation. priorAuthenticationMethod

SCMP API Field:

pa_prior_authentication_method

Simple Order API Field:

payerAuthEnrollService_priorAuthenticationMethod

consumerAuthenticationInformation. priorAuthenticationReferenceId

This field contains the ACS transaction ID for a prior authenticated transaction.

For example, the first recurring transaction that was authenticated with the cardholder.

Specifications

Data Type:
String

Data Length:
36

Mapping Information

REST API Field:

consumerAuthenticationInformation. priorAuthenticationReferenceId

SCMP API Field:

pa_prior_authentication_reference_id

Simple Order API Field:

payerAuthEnrollService_priorAuthenticationReferenceID

consumerAuthenticationInformation. priorAuthenticationTime

Date and time in UTC of the prior cardholder authentication.

Format:

yyyyMMDDHHMM

Specifications

Data Type:
String

Data Length:
12

Mapping Information

REST API Field:

consumerAuthenticationInformation. priorAuthenticationTime

SCMP API Field:

pa_prior_authentication_time

Simple Order API Field:

payerAuthEnrollService_priorAuthenticationTime

consumerAuthenticationInformation. productCode

Specifies the product code, which designates the type of transaction.

Specify one of the following values for this field:

AIR

: Airline purchase.

ACC

: Accommodation rental.

ACF

: Account funding.

CHA

: Check acceptance.

DIG

: Digital goods.

DSP

: Cash dispensing.

GAS

: Fuel.

GEN

: General retail.

LUX

: Luxury retail.

PAL

: Prepaid activation and load.

PHY

: Goods or services purchase.

QCT

: Quasi-cash transaction.

REN

: Car rental.

RES

: Restaurant.

SVC

: Services.

TBD

: Other.

TRA

: Travel.

Specifications

Data Type:
String

Data Length:
3

Mapping Information

REST API Field:

consumerAuthenticationInformation. productCode

SCMP API Field:

pa_product_code

Simple Order API Field:

payerAuthEnrollService_productCode

consumerAuthenticationInformation. proofXml

Date and time of the enrollment check combined with the VEReq and VERes elements.

If you ever need to show proof of enrollment checking, you might need to parse the string for the information required by the payment card company. The value can be very large.

For cards issued in the US or Canada, Visa might require this data for specific merchant category codes.

For cards not issued in the US or Canada, your bank might require this data as proof of enrollment checking for any payer authentication transaction that you re-present because of a chargeback.

Specifications

Data Type:
String

Data Length:
No length limit.

Mapping Information

REST API Field:

consumerAuthenticationInformation. proofXml

SCMP API Field:

pa_enroll_proofxml

Simple Order API Field:

payerAuthEnrollReply_proofXML

consumerAuthenticationInformation. proxyPan

Encrypted version of the card number that is used in the payer authentication request message.

Specifications

Data Type:
String

Data Length:
255

Mapping Information

REST API Field:

consumerAuthenticationInformation. proxyPan

SCMP API Field:

pa_enroll_proxypan

Simple Order API Field:

payerAuthEnrollReply_proxyPAN

consumerAuthenticationInformation. referenceId

Reference ID that corresponds to the device fingerprinting data that was collected previously.

Specifications

Data Type:
String

Data Length:
50

Mapping Information

REST API Field:

consumerAuthenticationInformation.referenceId

SCMP API Fields:

pa_reference_id

pa_setup_pa_reference_id

Simple Order API Fields:

payerAuthEnrollService_referenceID

payerAuthSetupReply_referenceID

consumerAuthenticationInformation. requestorInitiatedAuthenticationIndicator

Indicates the type of 3-D Secure Integrator Request (3RI Request).

Possible Values:

01

: Recurring transaction.

02

: Installment transaction.

03

: Add card.

04

: Maintain card.

05

: Account verification.

06

: Split/delayed shipment.

07

: Top-up.

08

: Mail order.

09

: Telephone order.

10

: Whitelist status check.

11

: Other payment.

EMV 3-D Secure version 2.1.0 supports values

REST API Field:

consumerAuthenticationInformation.responseAccessToken

SCMP API Field:

pa_response_access_token

Simple Order API Field:

payerAuthValidateService_responseAccessToken

consumerAuthenticationInformation. returnUrl

URL of your return page.

This return URL is added to the step-up JWT and returned in the response of the Payer Authentication enrollment call. Your return URL page serves as a listening URL. Cardinal sends a POST response to your return URL when the bank session completes that contains the completed bank session’s transaction ID. Your return page should capture the transaction ID and send it in the Payer Authentication validation call.

Specifications

Data Type:
String

Data Length:
2048

Mapping Information

REST API Field:

consumerAuthenticationInformation. returnUrl

SCMP API Field:

pa_return_url

Simple Order API Field:

payerAuthEnrollService_returnURL

consumerAuthenticationInformation. scoreRequest

Indicates that you are requesting the Identity Check Insights (IDCI) score details of a transaction.

Possible values:

Yes

No

If set to

yes

, you receive the values of these fields in the response:

consumerAuthenticationInformation. idciScore

consumerAuthenticationInformation. idciDecision

consumerAuthenticationInformation. idciReasonCode1

consumerAuthenticationInformation. idciReasonCode2

This field is used only with Mastercard transactions.

Specifications

Data Type:

Boolean

Data Length:
1

Mapping Information

REST API Field:

consumerAuthenticationInformation. scoreRequest

SCMP API Field:

pa_score_request

Simple Order API Field:

payerAuthEnrollService_scoreRequest

consumerAuthenticationInformation. sdkFlowType

Type of SDK flow used for the transaction.

Possible values:

Virtual SDK

Cardinal

Specifications

Data Type:
String

Data Length:
100

Mapping Information

REST API Field:

consumerAuthenticationInformation. sdkFlowType

SCMP API Field:

pa_sdk_flow_type

Simple Order API Field:

payerAuthEnrollService_sdkFlowType

consumerAuthenticationInformation. sdkMaxTimeout

This field indicates the maximum amount of time for all 3-D Secure 2.x messages to be communicated between all components (in minutes).

Possible Values:

Greater than or equal to

05

(05 is the minimum timeout to set)

Default is set to

15

Specifications

Data Type:
String

Data Length:
2

Mapping Information

REST API Field:

consumerAuthenticationInformation. sdkMaxTimeout

SCMP API Field:

pa_sdk_max_timeout

Simple Order API Field:

payerAuthEnrollService_sdkMaxTimeout

consumerAuthenticationInformation. sdkTransactionId

SDK unique transaction identifier that is generated on each new transaction.

Specifications

Data Type:
String

Data Length:
36

Mapping Information

REST API Field:

consumerAuthenticationInformation. sdkTransactionId

SCMP API Field:

pa_sdk_transaction_id

Simple Order API Fields:

payerAuthEnrollReply_sdkTransactionID

payerAuthEnrollService_sdkTransactionID

payerAuthValidateReply_sdkTransactionID

consumerAuthenticationInformation. signedPares

Payer authentication result (PARes) message returned by the card-issuing bank.

If you need to show proof of enrollment checking, you might need to decrypt and parse the string for the information required by the payment card company.

IMPORTANT

The value is in Base64. You must remove all carriage returns and line feeds before adding the PARes to the request.

Specifications

Data Type:
String

Mapping Information

REST API Field:

consumerAuthenticationInformation.signedPares

SCMP API Field:

pa_signedpares

Simple Order API Field:

payerAuthValidateService_signedPARes

consumerAuthenticationInformation. signedParesStatusReason

Reason for payer authentication response status.

This field is available only for the Banque de France et Tresor Public, BNP Paribas France, and Credit Mutuel-CIC processors and is used to process secure transactions in France.

Possible values:

01

: Card authentication failed.

02

: Unknown device. Example: Device fingerprint not recognised because the device is an old mobile phone.

03

: Unsupported device.

04

: Exceeds authentication frequency limit. Strong customer authentication is required every six transactions or when the cumulative amount for the payment card during the preceding week exceeds 100 EUR.

05

: Expired card.

06

: Invalid card number.

07

: Invalid transaction.

08

: No card record. The card was not found in the 3-D Secure server database.

09

: Security failure as determined by 3-D Secure server.

10

: Stolen card.

11

: Suspected fraud.

12

: Cardholder is not permitted to perform this transaction.

13

: Cardholder is not enrolled in 3-D Secure service.

14

: Transaction timed out at the access control server (ACS), which is a server on the issuer side of the 3-D Secure protocol.

15

: Low confidence as determined by 3-D Secure server.

16

: Medium confidence.

17

: High confidence.

18

: Very high confidence.

19

: Exceeds the maximum number of challenges permitted by the ACS.

20

: Non-payment transaction is not supported.

21

: 3-D Secure request for information, such as BIN lookup, is not supported.

22

: ACS technical problem.

23

: Decoupled authentication is required by the ACS but you did not request it.

24

: Your maximum expiration time was exceeded.

25

: There was not enough time for decoupled authentication to authenticate the cardholder.

26

: Authentication was attempted but the cardholder was not authenticated.

When you request the payer authentication and authorization services separately, get the value for this field from the

consumerAuthenticationInformation. signedParesStatusReason

response field.

Specifications

Data Type:
Integer

Data Length:
2

Mapping Information

REST API Field:

consumerAuthenticationInformation. signedParesStatusReason

SCMP API Field:

pares_status_reason

Simple Order API Field:

ccAuthService_paresStatusReason

consumerAuthenticationInformation. specificationVersion

This field contains the 3-D Secure version that was used to process the transaction. For example, 1.0.2 or 2.0.0.

Specifications

Data Type:
String

Data Length:
8

Mapping Information

REST API Field:

consumerAuthenticationInformation. specificationVersion

SCMP API Fields:

pa_enroll_specification_version

pa_validate_specification_version

Simple Order API Fields:

payerAuthEnrollReply_specificationVersion

payerAuthValidateReply_specificationVersion

consumerAuthenticationInformation. stepUpUrl

The fully qualified URL that the merchant uses to post a form to the cardholder in order to complete the consumer authentication transaction for the Cardinal Cruise Direct Connection API integration.

Specifications

Data Type:
String

Data Length:
2048

Mapping Information

REST API Field:

consumerAuthenticationInformation. stepUpUrl

SCMP API Field:

pa_step_up_url

Simple Order API Field:

payerAuthEnrollReply_stepUpURL

consumerAuthenticationInformation. strongAuthentication. authenticationIndicator

Indicates the type of authentication request.

Possible values:

01

: Payment transaction.

02

: Recurring transaction.

03

: Installment transaction.

04

: Add card.

05

: Maintain card.

06

: Cardholder verification as part of EMV token ID&V (identity and verification).

Specifications

Data Type:
String

Data Length:
2

Mapping Information

REST API Field:

consumerAuthenticationInformation. strongAuthentication. authenticationIndicator

SCMP API Field:

pa_authentication_indicator

Simple Order API Field:

payerAuthEnrollService_authenticationIndicator

consumerAuthenticationInformation. strongAuthentication. authenticationOutageExemptionIndicator

This field is an exemption indicator for payer authentication outage.

This flag indicates whether the transaction is exempt from strong customer authentication (SCA) requirements in Europe because Payer Authentication is not available.

Possible values:

0

(default): Not exempt.

1

: Exempt from SCA requirements because payer authentication is not available.

This field is supported on these payment gateways: Barclays, Streamline, HSBC, Omnipay Direct Platform (opdfde, opdcardnet, omnipaydirect), Credit Mutuel CIC, BNP Paribas France, Banque de France et Tresor Public, Lloyds TSB Cardnet, HBoS Visa Platform Connect, and GPX.

Countries in CEMEA must now support Field 34 DSID 02 Tag 87 in the authorization request and response for Visa transactions. The response does not include an Economic Commerce Indicator (ECI) value or the Field F34 DSID 02 Tag 87.

These countries in CEMEA are affected by this requirement:

Albania

Armenia

Azerbaijan

Bahrain

Belarus

Bosnia and Herzegovina

Georgia

Kazakhstan

Kenya

Kosovo

Kuwait

Kyrgyzstan

Moldova

Montenegro

Nigeria

North Macedonia

Oman

Pakistan

Qatar

Republic of Serbia

Saudi Arabia

South Africa

Tajikistan

Turkmenistan

United Arab Emeriates (UAE)

Ukraine

Uzbekistan

For Mastercard transactions, the value for this field corresponds to this data in the TC 33 capture file:

Record: CP01 TCR6

Position: 145-146

Field: Mastercard Low-Risk Merchant Indicator

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

consumerAuthenticationInformation.strongAuthentication. authenticationOutageExemptionIndicator

SCMP API Field:

authentication_outage_exemption_indicator

Simple Order API Field:

ccAuthService_authenticationOutageExemptionIndicator

consumerAuthenticationInformation. strongAuthentication. delegatedAuthenticationExemptionIndicator

Exemption indicator for delegated authentication.

This flag specifies whether the transaction is exempt from strong customer authentication (SCA) requirements in Europe because the authentication was delegated to a different provider, such as an acquirer or payment technology provider (PTP).

Possible values:

0

(default): Not exempt.

1

: Exempt from SCA requirements because the authentication was delegated to a different provider

Visa Platform Connect

For Mastercard transactions, the value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCR6

Position: 145-146

Field: Mastercard Low-Risk Merchant Indicator

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

consumerAuthenticationInformation. strongAuthentication.delegatedAuthenticationExemptionIndicator

SCMP API Field:

delegated_authentication_exemption_indicator

Simple Order API Field:

ccAuthService_delegatedAuthenticationExemptionIndicator

consumerAuthenticationInformation. strongAuthentication. issuerInformation. trustedMerchantExemptionResult

Code that indicates whether the issuer honored or denied the customer's request for trusted merchant exemption.

This field is supported only on Visa Platform Connect.

Possible values:

1

: Trusted merchant exemption validated.

2

: Trusted merchant exemption failed validation.

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

consumerAuthenticationInformation. strongAuthentication.issuerInformation.trustedMerchantExemptionResult

SCMP API Field:

trusted_merchant_exemption_response_indicator

Simple Order API Field:

issuer_trustedMerchantExemptionResult

consumerAuthenticationInformation. strongAuthentication. issuerInformation.delegatedAuthenticationResult

Code that indicates whether the issuer validated your request for a delegated authentication exemption.

This field is available only on the Visa Platform Connect processor.

Possible values:

2

: Request for a delegated authentication exemption was validated.

3

: Request for a delegated authentication exemption was not validated.

When this field returns a value of

3

, the reason is returned in the

consumerAuthenticationInformation. strongAuthentication.issuerInformation.riskAnalysisExemptionResult

response field.

Specifications

Data Type:
String

Length:
1

Mapping Information

REST API Field:

consumerAuthenticationInformation. strongAuthentication.issuerInformation.delegatedAuthenticationResult

SCMP API Field:

delegated_authentication_result

Simple Order API Field:

ccAuthService_delegatedAuthenticationResult

consumerAuthenticationInformation. strongAuthentication. issuerInformation. exemptionDataRaw

Payer authentication exemption indicator for delegated authentication.

Raw payer authentication exemption data field that is used for Carte Bancaire exemptions. For example, "low fraud merchant program." Used with authorization service requests.

Specifications

Data Type:
String

Data Length:
4

Mapping Information

REST API Field:

consumerAuthenticationInformation. strongAuthentication.issuerInformation. exemptionDataRaw

SCMP API Field:

exemption_data

Simple Order API Field:

ccAuthService_exemptionDataRaw

consumerAuthenticationInformation. strongAuthentication. issuerInformation. lowValueExemptionResult

Code that indicates whether the issuer validated your request for a low-value amount exemption.

This field is available only on the Visa Platform Connect processor.

Possible values:

0

: Low value exemption does not apply to the transaction.

1

: Transaction exempt from SCA as the merchant/acquirer has determined it to be a low value payment.

Specifications

Data Type:
String

Length:
1

Mapping Information

REST API Field:

consumerAuthenticationInformation. strongAuthentication.issuerInformation.lowValueExemptionResult

SCMP API Field:

issuer_low_value_exemption_result

Simple Order API Field:

issuer_lowValueExemptionResult

consumerAuthenticationInformation. strongAuthentication. issuerInformation. riskAnalysisExemptionResult

Reason that the issuer declined your request for a strong customer authentication exemption.

This field is avaukabke only on the Visa Platform Connect processor.

This value is a series of a maximum of 20 four-digit codes and no delimiters. Possible codes:

8401

: You are not participating in the Visa Trusted Listing program.

8402

: Issuer is not participating in the Visa Trusted Listing program.

8403

: Your business is not included on the cardholder's list of trusted merchants.

8404

: Issuer response is unclear or invalid.

8473

: Your business is not included on the cardholder's list of trusted merchants.

8474

: Transaction information does not meet the exemption criteria.

8904

: Issuer response is unclear or invalid (Visa).

8905

: No entry found in the supplemental database (Visa).

8906

: Did not meet exemption criteria (Visa).

8A01

: Merchant not participating in Visa Delegated Authentication Program.

8A02

: Issuer not participating in Visa Delegated Authentication Program.

8A04

: Issuer response is unclear or invalid.

8A06

: Did not meet the exemption criteria (Visa).

8A07

: Visa merchant ID invalid for service.

8A08

: CAVV invalid value.

8A76

: Did not meet the exemption criteria (Issuer).

Visa Platform Connect

The value for this field corresponds to the following data in the TC 33 capture file:

Record: CP07 TCR9

Position: 61-140

Field: Reasons for Not Honoring SCA Exemptions

Specifications

Data Type:
String

Data Length:
80

Mapping Information

REST API Field:

consumerAuthenticationInformation. strongAuthentication.issuerInformation.riskAnalysisExemptionResult

SCMP API Field:

issuer_risk_analysis_exemption_result

Simple Order API Field:

issuer_riskAnalysisExemptionResult

consumerAuthenticationInformation. strongAuthentication. issuerInformation. secureCorporatePaymentResult

Code that indicates whether the issuer validated your request for a secure corporate payment exemption.

This field is available only on the Visa Platform Connect processor.

Possible values:

2

: Request for a secure corporate payment exemption was validated.

3

: Request for a secure corporate payment exemption was not validated.

Specifications

Data Type:
String

Length:
1

Mapping Information

REST API Field:

consumerAuthenticationInformation. strongAuthentication.issuerInformation.secureCorporatePaymentResult

SCMP API Field:

issuer_secure_corporate_payment_result

Simple Order API Field:

issuer_secureCorporatePaymentResult

consumerAuthenticationInformation. strongAuthentication. issuerInformation. transactionRiskAnalysisExemptionResult

Code that indicates whether the issuer validated your request for a transaction risk analysis exemption.

This field is available only on the Visa Platform Connect processor.

Possible values:

2

: Request for a transaction risk analysis exemption was validated.

3

: Request for a transaction risk analysis exemption was not validated.

Specifications

Data Type:
String

Length:
1

Mapping Information

REST API Field:

consumerAuthenticationInformation. strongAuthentication.issuerInformation.transactionRiskAnalysisExemptionResult

SCMP API Field:

issuer_transaction_risk_analysis_exemption_result

Simple Order API Field:

issuer_transactionRiskAnalysisExemptionResult

consumerAuthenticationInformation. strongAuthentication. issuerInformation. trustedMerchantExemptionResult

Code that indicates whether the issuer validated your request for a trusted merchant exemption.

This field is available only on the Visa Platform Connect processor.

Possible values:

2

: Request for a trusted merchant exemption was validated.

3

: Request for a trusted merchant exemption was not validated.

Specifications

Data Type:
String

Length:
1

Mapping Information

REST API Field:

consumerAuthenticationInformation. strongAuthentication.issuerInformation.trustedMerchantExemptionResult

SCMP API Field:

issuer_trusted_merchant_exemption_result

Simple Order API Field:

issuer_trustedMerchantExemptionResult

consumerAuthenticationInformation. strongAuthentication. lowValueExemptionIndicator

Exemption indicator for a low payment amount.

This flag specifies whether the transaction is exempt from strong customer authentication (SCA) requirements in Europe because the payment amount is low.

Possible values:

0

(default): Not exempt.

1

: Exempt from SCA requirements because the payment amount is low.

Visa Platform Connect: For Mastercard transactions, the value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCR6
Position: 145-146
Field: Mastercard Low-Risk Merchant Indicator

For transactions with other card types, the value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCR8
Position: 126
Field: Low Value Exemption Indicator

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

consumerAuthenticationInformation. strongAuthentication.lowValueExemptionIndicator

SCMP API Field:

low_value_exemption_indicator

Simple Order API Fields:

ccAuthService_lowValueExemptionIndicator

consumerAuthenticationInformation. strongAuthentication. riskAnalysisExemptionIndicator

Exemption indicator for a low-risk transaction.

This flag specifies whether the transaction is exempt from strong customer authentication (SCA) requirements in Europe because it is a low-risk transaction.

Low-risk transactions are described by the Payments Service Directive 2/Regulatory Technical Standards (PSD2/RTS) regulations.

Possible values:

0

(default): Not exempt.

1

: Exempt from SCA requirements because the transaction is low risk.

Visa Platform Connect: To set the default for this field, contact customer support.
For Mastercard transactions, the value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCR6
Position: 145-146
Field: Mastercard Low-Risk Merchant Indicator

For transactions with other card types, the value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCR8
Position: 127
Field: Transaction Risk Analysis Exemption Indicator

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

consumerAuthenticationInformation. strongAuthentication.riskAnalysisExemptionIndicator

SCMP API Field:

risk_analysis_exemption_indicator

Simple Order API Field:

ccAuthService_riskAnalysisExemptionIndicator

consumerAuthenticationInformation. strongAuthentication. secureCorporatePaymentIndicator

Exemption indicator for a secure corporate payment.

This field is available only for the FDC Compass and Visa Platform Connect processors.

This flag specifies whether the transaction is exempt from strong customer authentication (SCA) requirements in Europe because the payment is a secure corporate payment. Indicates that dedicated payment processes and procedures were used.

Possible values:

0

(default): Not exempt.

1

: Exempt from SCA requirements because the payment is a secure corporate payment.

Visa Platform Connect:
For Mastercard transactions, the value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCR6

Position: 145-146

Field: Mastercard Low-Risk Merchant Indicator

For transactions with other card types, the value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCR8

Position: 129

Field: Secure Corporate Payment Indicator

Specifications

Data Type:
String

Dats Length:
1

Mapping Information

REST API Field:

consumerAuthenticationInformation. strongAuthentication. secureCorporatePaymentIndicator

SCMP API Field:

secure_corporate_payment_indicator

Simple Order API Fields:

ccAuthService_secureCorporatePaymentIndicator

payerAuthEnrollService_secureCorporatePaymentIndicator

consumerAuthenticationInformation. strongAuthentication. trustedMerchantExemptionIndicator

Exemption indicator for a trusted merchant.

This flag specifies whether the transaction is exempt from strong customer authentication (SCA) requirements in Europe because the customer trusts you.

This field is available only for the FDC Compass and Visa Platform Connect processors.

Possible values:

0

(default): Not exempt.

1

: Exempt from SCA requirements because the customer trusts the merchant.

Visa Platform Connect: For Mastercard transactions, the value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCR6
Position: 145-146
Field: Mastercard Low-Risk Merchant Indicator

For transactions with other card types, the value for this field corresponds to the following data in the TC 33 capture file:

Record: CP07 TCR9
Position: 8
Field: Trusted Merchant Exemption Indicator

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

consumerAuthenticationInformation. strongAuthentication.trustedMerchantExemptionIndicator

SCMP API Field:

trusted_merchant_exemption_indicator

Simple Order API Field:

ccAuthService_trustedMerchantExemptionIndicator

consumerAuthenticationInformation. strongAuthentication.transactionMode

Transaction mode identifier. Identifies the channel from which the transaction originates.

Possible values:

REST API Field:

consumerAuthenticationInformation. threeDSServerTransactionId

SCMP API Field:

pa_three_ds_server_transaction_id

Simple Order API Fields:

ccAuthService_threeDSServerTransactionID

payerAuthEnrollReply_threeDSServerTransactionID

payerAuthValidateReply_threeDSServerTransactionID

consumerAuthenticationInformation. transactionFlowIndicator

This field indicates which type of RuPay seamless flow is used.

This field is supported only for RuPay.

Possible Values:

01

: Transaction performed by domestic merchant for authentication and authorization or authorization only.

02

: Transaction performed by domestic merchant with token provisioning.

03

: Transaction performed by international merchant.

04

: Authentication transaction.

05

: Authentication transaction for provisioning.

06

: Domestic in-app transaction.

07

: International in-app transaction.

08

: Transaction performed at domestic merchant along with Guest Check out.

09

: Standing Instruction authentication transaction only.

10

: Standing Instruction authorization with token provisioning.

Specifications

Data Type:
String

Data Length:
2

Mapping Information

REST API Field:

consumerAuthenticationInformation. transactionFlowIndicator

SCMP API Field:
No corresponding field.

Simple Order API Field:
No corresponding field.

consumerAuthenticationInformation. transactionToken

Token used to authenticate the customer.

This field is supported only on RuPay for the payer authentication seamless flow.

Specifications

Data Type:
String

Data Length:
256

Mapping Information

REST API Field:

consumerAuthenticationInformation. transactionToken

SCMP API Field:
No corresponding field.

Simple Order API Field:
No corresponding field.

consumerAuthenticationInformation. ucafAuthenticationData

Universal cardholder authentication field (UCAF) data.

This field is available only on the FDC Compass and Visa Platform Connect processors.

IMPORTANT

Mastercard has indicated that an issuing bank can downgrade an authorization request to a non-secure transaction when the UCAF collection indicator is

1

and UCAF authentication data is not present. An issuing bank can choose not to settle a downgraded Mastercard Identity Check transaction. When UCAF authentication data is not present, set the UCAF collection indicator to

0

.

The value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCR8

Position: 126-157

Field: Mastercard UCAF Data

Specifications

Data Type:
String

Data Length (request):
32

Data Length (response):
255

Mapping Information

REST API Field:

consumerAuthenticationInformation.ucafAuthenticationData

SCMP API Fields:

pa_enroll_ucaf_authentication_data

pa_validate_ucaf_authentication_data

ucaf_authentication_data

Simple Order API Fields:

payerAuthEnrollReply_ucafAuthenticationData

payerAuthValidateReply_ucafAuthenticationData

ucaf_authenticationData

consumerAuthenticationInformation. ucafCollectionIndicator

Universal cardholder authentication field (UCAF) collection indicator used for Mastercard Identity Check.

Cielo, Getnet, and Rede: For data only authorizations in Brazil, set this field to
4
.

When you request the payer authentication and authorization services separately, get the value for this field from the

consumerAuthenticationInformation.ucafCollectionIndicator

response field.

Possible values:

0

: UCAF collection is not supported on your web site.

1

: UCAF collection is supported on your web site, and the UCAF was populated.

2

: UCAF collection is supported on your web site and the UCAF was populated. This value indicates a successful Mastercard Identity Check transaction. Use this value for Apple Pay and Samsung Pay transactions.

5

: UCAF collection is supported at your web site, and the UCAF was populated based on the risk assessment that the issuer performed. This value is supported only for Masterpass transactions.

6

: UCAF collection is supported at your web site, and the UCAF was populated based on the risk assessment that you performed. This value is supported only for Masterpass transactions.

When this value is returned, the field value indicates transaction was downgraded.

Possible values:

0

: The transaction was downgraded.

1

: The transaction was not downgraded.

IMPORTANT

A value of

0

for the UCAF collection indicator response field for a Mastercard transaction indicates that Mastercard downgraded the transaction. When Mastercard approves an authorization and downgrades the transaction, you are responsible for the transaction. To confirm the downgrade, look at the e-commerce indicator for the transaction in the Business Center. You can proceed with the transaction if you want to accept responsibility. If you do not want to accept responsibility, reverse the authorization, attempt to authenticate the customer again, and request another authorization.

Visa Platform Connect

The value for this field corresponds to the following data in the TC 33 capture file.

Record: CP01 TCR7

Position: 5

Field: Mastercard Electronic Commerce Indicators—UCAF Collection Indicator

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

consumerAuthenticationInformation.ucafCollectionIndicator

SCMP API Fields:

pa_enroll_ucaf_collection_indicator

pa_validate_ucaf_collection_indicator

ucaf_collection_indicator

Simple Order API Fields:

payerAuthEnrollReply_ucafCollectionIndicator

payerAuthValidateReply_ucafCollectionIndicator

ucaf_collectionIndicator

consumerAuthenticationInformation. validityPeriod

Number of minutes that the one-time password is valid for the incoming transaction.

This field is supported only for RuPay payer authentication seamless flow.

Possible values:

00

-

30

.

Specifications

Data Type:
Integer

Data Length:
5

Mapping Information

REST API Field:

consumerAuthenticationInformation. validityPeriod

SCMP API Field:
No corresponding field.

Simple Order API Field:
No corresponding field.

consumerAuthenticationInformation. veresEnrolled

Verification response enrollment status.

This field is available only on the Asia, Middle East, and Africa Gateway processor.

Possible values:

Y

: Authentication available.

N

: Customer not participating.

U

: Unable to authenticate regardless of the reason.

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

consumerAuthenticationInformation. veresEnrolled

SCMP API Field:

veres_enrolled

Simple Order API Field:

ccAuthService_veresEnrolled

consumerAuthenticationInformation. whiteListStatus

Enables the communication of trusted beneficiary and whitelist status among the ACS, the directory server, and the 3-D Secure requester.

Possible values:

Y

: 3-D Secure requester is whitelisted by cardholder.

N

: 3-D Secure requester is not whitelisted by cardholder.

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

consumerAuthenticationInformation. whiteListStatus

SCMP API Field:

pa_white_list_status

Simple Order API Fields:

payerAuthEnrollReply_whiteListStatus

payerAuthValidateReply_whiteListStatus

consumerAuthenticationInformation. whiteListStatusSource

This field is populated by the system setting Whitelist Status.

Possible values:

1

: 3-D Secure server.

2

: Directory server.

3

: ACS.

Specifications

Data Type:
String

Data Length:
2

Mapping Information

REST API Field:

consumerAuthenticationInformation. whiteListStatusSource

SCMP API Field:

pa_white_list_status_source

Simple Order API Fields:

payerAuthEnrollReply_whiteListStatusSource

payerAuthValidateReply_whiteListStatusSource

consumerAuthenticationInformation. xid

Transaction identifier.

This value must be 28-character Base64 or 40-character hex binary.

For Visa Secure on FDC Nashville Global, the value for this field is set to the XID value when the XID is present in the authorization request and the CAVV is not present.

Apple Pay and Samsung Pay Transactions: American Express: For a 20-byte cryptogram, set this field to the cryptogram for authorizations with payment network tokens. For a 40-byte cryptogram, set this field to block A of the cryptogram for authorizations with payment network tokens. All cryptograms use one of these formats.
Visa: The value for this field must be 28-character base64 or 40-character hex binary. All cryptograms use one of these formats.

Specifications

Data Type:
String

Data Length (request):
40

Data Length (response):
255

Mapping Information

REST API Field:

consumerAuthenticationInformation.xid

SCMP API Fields:

pa_enroll_xid

pa_validate_xid

xid

Simple Order API Fields:

ccAuthService_xid

payerAuthEnrollReply_xid

payerAuthValidateReply_xid

consumerId

The identifier of the consumer within the wallet.

Visa Token Service (VTS) supports

consumerId

values that are 24 characters in length. If you send a request with a

consumerId

value that is longer than 24 characters, only the first 24 characters are sent to VTS.

Specifications

Data Type:
String

Maximum Data Length:
36

Mapping Information

REST API Field:

consumerId

SCMP API Field:
No corresponding field

Simple Order API Field:
No corresponding field

country

Country where Unified Checkout is being used. Use a two-character ISO country code.

Possible values:

AD-CV	CY-ID	IE-MM	MN-SG	SI-ZW
AD	CY	IE	MN	SI
AE	DE	IL	MO	SK
AF	DJ	IM	MR	SL
AG	DK	IN	MT	SM
AL	DK	IQ	MU	SN
AM	DM	IS	MV	SO
AO	DO	IT	MW	SR
AR	DZ	JE	MX	SS
AT	EC	JM	MY	ST
AU	EE	JO	MZ	SV
AZ	EG	JP	NA	SZ
BA	ER	KE	NE	TD
BB	ES	KG	NG	TG
BD	ET	KH	NI	TH
BE	FI	KI	NL	TJ
BF	FJ	KM	NO	TL
BG	FM	KN	NP	TM
BH	FO	KR	NR	TN
BI	FR	KW	NZ	TO
BJ	GA	KZ	OM	TR
BN	GB	LA	PA	TT
BO	GD	LB	PE	TV
BR	GE	LC	PG	TW
BS	GG	LI	PH	TZ
BT	GH	LK	PK	UA
BW	GI	LR	PL	UG
BY	GL	LS	PS	US
BZ	GM	LT	PT	UY
CA	GN	LU	PW	UZ
CD	GQ	LV	PY	VA
CF	GR	LY	QA	VC
CG	GT	MA	RO	VE
CH	GW	MC	RS	VN
CI	GY	MD	RW	VU
CL	HK	ME	SA	WS
CM	HN	MG	SB	YE
CN	HR	MH	SC	ZA
CO	HT	MK	SD	ZM
CR	HU	ML	SE	ZW
CV	ID	MM	SG

Specifications

Data Type:
Enum

Mapping Information

REST API Field:

country

Simple Order API Field:
No corresponding field.

createInstrumentIdentifier

Indicates if a Token Management Service instrument identifier token should be created when you are provisioning a network tokenized card. When this field is set to true, an instrument identifier should be created.

Possible values:

true

false

Specifications

Data Type:
Boolean

Mapping Information

REST API Field:

createInstrumentIdentifier

SCMP API Field:
No corresponding field.

Simple Order API Field:
No corresponding field

creditAmountDetails

These fields provide credit information.

creditAmountDetails.creditAmount

creditAmountDetails.currency

creditAmountDetails. creditAmount

Amount credited to the cardholder.

Specifications

Data Type:
String

Data Length:
15

Mapping Information

REST API Field:

creditAmountDetails.creditAmount

and

refundAmountDetails.refundAmount

SCMP API Fields:

credit_credit_amount

pin_debit_credit_auth_amount

Simple Order API Fields:

ccCreditReply_amount

pinDebitCreditReply_amount

creditAmountDetails. currency

Currency used in the transaction.

Use a three-character ISO currency code. For a list of ISO currency codes, see: ISO Currency Codes.

For authorization reversal or capture services, you must use the same currency that was used for the authorization.

For the PIN debit reversal service, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.

When using Dynamic Currency Conversion (DCC) with a Third-Party Provider:, use the customer’s billing currency.

Visa Platform Connect: For Mastercard installment payments in Peru, the value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCR5
Position: 108-110
Field: Financing Currency

Specifications

Data Type:
String

Data Length:
3

Mapping Information

REST API Fields:

orderInformation.amountDetails.currency

creditAmountDetails.currency

refundAmountDetails.currency

reversalAmountDetails.currency

SCMP API Field:

currency

Simple Order API Field:

purchaseTotals_currency

currencyConversion

These fields provide currency conversion data.

currencyConversion.reconciliationId

currencyConversion.indicator

currencyConversion. indicator

Flag indicating whether Dynamic Currency Conversion is used for the order.

1
: Converted; Value was converted using DCC.

2
: Not Convertable; Cannot use DCC for this transaction.

3
: Declined; Customer declined to use DCC.

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

currencyConversion.indicator

SCMP API Field:

dcc_indicator

Simple Order API Field:

dcc_dccIndicator

currencyConversion. reconciliationId

Optional description or label for the point-of-sale terminal.

Specifications

Data Type:
String

Data Length:
128

Mapping Information

REST API Field:

currencyConversion.reconciliationId

SCMP API Field:

exchange_rate_timestamp

Simple Order API Field:
No corresponding field

customerInformation

These fields are related to customer information.

customerInformation.company.name

customerInformation.email

customerInformation.merchantCustomerId

customerInformation.name

customerInformation. company. name

The name of the customer's company.

Specifications

Data Type:
String

Data Length:
60

Mapping

REST Field Name:

customerInformation.company.name

Simple Order Field Name:
No corresponding field.

customerInformation. email

The customer's email address, including the full domain name.

Specifications

Data Type:
String

Data Length:
255

Mapping

REST Field Name:

customerInformation.email

Simple Order Field Name:
No corresponding field.

customerInformation. merchantCustomerId

Simple Order API Field:
No corresponding field

deviceExternalId

Identifier from the partner's system that is used to set up the point-of-sale (POS) terminal firmware, software, and configurations.

To get this value, contact Visa Acceptance Solutions customer support.

Specifications

Data Type:
String

Data Length:
64

Mapping Information

REST API Field:

deviceExternalId

SCMP API Field:
No corresponding field

Simple Order API Field:
No corresponding field

deviceInformation

These fields provide device information.

deviceInformation.appUrl

deviceInformation.cookiesAccepted

deviceInformation.deviceType

deviceInformation.hostName

deviceInformation.httpAcceptBrowserValue

deviceInformation.httpAcceptContent

deviceInformation.httpBrowserColorDepth

deviceInformation.httpBrowserEmail

deviceInformation.httpBrowserJavaEnabled

deviceInformation.httpBrowserJavaScriptEnabled

deviceInformation.httpBrowserLanguage

deviceInformation.httpBrowserScreenHeight

deviceInformation.httpBrowserScreenWidth

deviceInformation.httpBrowserTimeDifference

deviceInformation.userAgentBrowserValue

deviceInformation.ipAddress

deviceInformation.platformType

deviceInformation.userAgent

deviceInformation. appUrl

App URL used by Korea Cyber Payment (KCP) to wake up the merchant app after payment processing.

Only alphanumeric characters are accepted.

Format:

{a-z}://

Specifications

Data Type:
String

Data Length:
512

Mapping Information

REST API Field:

deviceInformation.appUrl

SCMP API Field:
No corresponding field

Simple Order API Field:

ap_appUrl

deviceInformation. cookiesAccepted

Whether the customer's browser accepts cookies.

This field can contain one of these values:

yes

: The customer's browser accepts cookies.

no

: The customer's browser does not accept cookies.

Specifications

Data Type:
String

Data Length:
3

Mapping Information

REST API Field:

deviceInformation.cookiesAccepted

SCMP API Field:

customer_cookies_accepted

Simple Order API Field:

billTo_httpBrowserCookiesAccepted

deviceInformation. deviceType

The type of device the customer is using to access the service.

Possible values:

MB

: Mobile device

PC

: Desktop computer

Specifications

Data Type:
String

Data Length:
2

Mapping

REST Field Name:

deviceInformation.deviceType

Simple Order Field Name:

ap_device_type

deviceInformation. hostName

Hostname for the IP address.

Specifications

Data Type:
String

Data Length:
60

Mapping Information

REST API Field:

deviceInformation.hostName

SCMP API Field:

customer_hostname

Simple Order API Field:

billTo_hostname

deviceInformation. httpAcceptBrowserValue

Value of the HTTP accept header sent by the customer’s web browser.

IMPORTANT

If the customer’s browser provides a value, you must include it in your request.

Specifications

Data Type:
String

Data Length:
255

Mapping Information

REST API Field:

deviceInformation.httpAcceptBrowserValue

SCMP API Field:

pa_http_accept

Simple Order API Field:

Indicates the ability of the cardholder browser to execute Java.

The value is returned from the navigator.javaEnabled property. This field can contain one of these values:

true

: cardholder's browser can execute Java.

false

: cardholder's browser cannot execute Java.

Specifications

Data Type:
Boolean

Data Length:
1

Mapping Information

REST API Field:

deviceInformation.httpBrowserJavaEnabled

SCMP API Field:

http_browser_java_enabled

Simple Order API Field:

billTo_httpBrowserJavaEnabled

deviceInformation. httpBrowserJavaScriptEnabled

Simple Order API Field:

payerAuthEnrollService_httpUserAgent

deviceInformation. ipAddress

Customer’s IP address.

Specifications

Data Type:
String

Data Length:
45

Mapping Information

REST API Field:

deviceInformation.ipAddress

SCMP API Field:

customer_ipaddress

Simple Order API Field:

billTo_ipAddress

deviceInformation. platformType

The device platform type.

Possible values:

iOS

: iOS application

ANDROID

: Android application

WINDOWS

: Windows application

WEB

: Browser-based application

Specifications

Data Type:
Enum

Mapping

REST Field Name:

deviceInformation.platformType

Simple Order Field Name:

deviceInformation. userAgent

Customer’s browser as identified from the HTTP header data.

Example:

Mozilla

is the value that identifies the Firefox browser.

Chrome

is the value that identifies the Google Chrome browser.

Specifications

Data Type:
String

Data Length:
40

Mapping Information

REST API Field:

deviceInformation.userAgent

SCMP API Field:

http_browser_type

Simple Order API Field:

billTo_httpBrowserType

documentInformation

These fields provide information about the document.

documentInformation.signedDocuments.documentId

documentInformation. signedDocuments. documentId

Document identifier of the boarded merchant's signed document.

Syntax

{
  "documentInformation": {
    "signedDocuments": [
      "documentId": "TCProcessing"
    ]
  }
}

Specifications

Data Type:
String

Maximum Data Length:
200

Mapping Information

No corresponding fields.

errorInformation

These fields provide error information.

errorInformation.reason

errorInformation. reason

Reason for the status.

Possible values are:

CUSTOMER_WATCHLIST_MATCH

ADDRESS_COUNTRY_WATCHLIST_MATCH

EMAIL_COUNTRY_WATCHLIST_MATCH

IP_COUNTRY_WATCHLIST_MATCH

INVALID_MERCHANT_CONFIGURATION

Specifications

Data Type:
String

Data Length:
31

Mapping Information

REST API Field:

errorInformation.reason

SCMP API Field:
No corresponding field

Simple Order API Field:
No corresponding field

firmwareVersion

Version number of terminal firmware.

To get this value, contact Visa Acceptance Solutions customer support.

Specifications

Data Type:
String

Data Length:
64

Mapping Information

REST API Field:

firmwareVersion

SCMP API Field:
No corresponding field

Simple Order API Field:
No corresponding field

hardwareRevision

Revison number of terminal hardware.

To get this value, contact Visa Acceptance Solutions customer support.

Specifications

Data Type:
String

Data Length:
64

Mapping Information

REST API Field:

hardwareRevision

SCMP API Field:
No corresponding field

Simple Order API Field:
No corresponding field

healthcareInformation

These fields provide healthcare information.

healthCareInformation.amountDetails.amount

healthCareInformation.amountDetails.amountType

healthCareInformation. amountDetails.amount

Amount of the healthcare payment.

Send this field with a corresponding

healthCareInformation.amountDetails.amountType

field.

Example:

"healthCareInformation":{
  "amountDetails":[
    {
      "amountType": "clinic",
      "amount": "20.00"
    },
    {
      "amountType":"vision",
      "amount":"60.00"
    }
  ]
}

Specifications

Data Type:
String

Data Length:
13

healthCareInformation. amountDetails.amountType

Type of healthcare payment.

Mastercard possible values:

eligible-total

: total amount of healthcare.

prescription

Visa possible values:

clinic

dental

healthcare

: total amount of healthcare.

healthcare-transit

prescription

vision

Send this field with a corresponding

healthCareInformation.amountDetails.amount

field.

Example:

"healthCareInformation":{
  "amountDetails":[{
    "amountType":"vision",
    "amount":"60.00"
},

Specifications

Data Type:
String

Data Length:
35

id

For transaction processing, this field contains the processor transaction identifier (TID) that isused to identify and track a transaction throughout its lifecycle.

For plans and subscriptions, the identifier is assigned by Visa Acceptance Solutions to identify the submitted plan or subscription request.

Not all processors provide this value for transaction processing.

American Express Direct: American Express generates this value. To comply with the American Express Card Acceptance Processing Network (CAPN) requirements, this value must be included in all subsequent follow-on requests, such as captures and follow-on credits.

When you perform authorizations, captures, and credits through Visa Acceptance Solutions, Visa Acceptance Solutions passes this value from the authorization service to the subsequent services for you. However, when you perform authorizations through Visa Acceptance Solutions and perform subsequent services through other financial institutions, you must ensure that requests for captures and credits include this value.
Cielo: This value is the non-sequential unit (NSU) and is returned for all transactions. Cielo or the issuing bank generates the value.
Comercio Latino: This value is the proof of sale or non-sequential unit (NSU) number. The Cielo acquirer, Rede acquirer, or issuing bank generates the value.
Moneris: This value identifies the transaction on a host system. You must store this value. If you give the customer a receipt, display this value on the receipt.

The value contains the following information:

Terminal used to process the transaction
Shift during which the transaction took place
Batch number
Transaction number within the batch

Example:
For the value
66012345001069003
:

Terminal ID = 66012345
Shift number = 001
Batch number = 069
Transaction number = 003
GPN: The value is generated for each card type:
American Express: The payment card company generates this value. This value is saved and sent to the processor in all subsequent capture requests.
Discover: The payment card company generates this value. This value is saved and sent to the processor in all subsequent requests for full authorization reversals and captures.
Mastercard: The payment card company generates this value. This value is saved and sent to the processor in all subsequent requests for full authorization reversals and captures. Format:
Positions 1-9: Mastercard Banknet reference number.
Positions 10-13: Date.
Positions 14-15: Spaces.
Visa: The payment card company generates this value. This value is saved and sent to the processor in all subsequent requests for full authorization reversals and captures.
Other Card Types: Not used.
Visa Platform Connect: The value is generated for each card type:
American Express: American Express generates this value. It is included in all replies from the American Express Global Network (AEGN).
Mastercard: This value is the qualification information for the Mastercard Interchange Compliance (MIC) program. It is used for all Mastercard responses coming from Mastercard Banknet through Visa to certified acquirers. Format:
Positions 1–4: Date in MMDD format.
Positions 5–7: Product code or financial network code. Mastercard can introduce new values for this subfield without advance notice.
Positions 8–13: First six digits of Mastercard Banknet reference number.
Positions 14–15: Spaces.
Visa and other card types: The payment card company generates this value. It is unique for each original authorization and identifies a transaction throughout its life cycle.

The value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCR7
Position: 81-95
Field: Gateway Transaction Identifier

Specifications

Data Type:
String

Data Length for Transaction Processing:
26

Data Length for Transaction Processing:

Cielo:
50

Elavon:
22

Comercio Latino:
20

Cybersource Latin American Processing:
50

Moneris:
18

All other processors:
26

Data Length for Plans and Subscriptions:
26

Mapping Information

REST API Field:

id

SCMP API Fields:

auth_payment_network_transaction_id

auth_processor_trans_id

auth_request_id

auth_reversal_processor_trans_id

ecp_debit_request_id

Simple Order API Fields:

ccAuthReply_paymentNetworkTransactionID

ccAuthReply_processorTransactionID

ccAuthReversalReply_processorTransactionID

ccAuthReversalService_authRequestID

ccCaptureService_authRequestID

ccCheckStatusService_authRequestID

ccIncrementalAuthService_authRequestID

ecDebitService_debitRequestID

Information

These fields provide miscellaneous information.

Information.feeProgramIndicator

Information. feeProgramIndicator

Interchange reimbursement fee program indicator (FPI), which is used when assessing the fee applied to a cross-border or domestic Asia Pacific financial transaction.

Acquirers and issues retain and return the FPI value in chargeback and representments.

Specifications

Data Type:
String

Data Length:
3

Mapping Information

REST API Field:

Information.feeProgramIndicator

SCMP API Field:

fee_program_indicator

Simple Order API Field:

feeProgramIndicator

installmentInformation

These fields provide installment information.

installmentInformation.additionalCosts

installmentInformation.additionalCostsPercentage

installmentInformation.amount

installmentInformation.amountFunded

installmentInformation.amountRequestedPercentage

installmentInformation.annualFinancingCost

installmentInformation.annualInterestRate

installmentInformation.downPayment

installmentInformation.eligibilityInquiry

installmentInformation.expenses

installmentInformation.expensesPercentage

installmentInformation.fees

installmentInformation.feesPercentage

installmentInformation.firstInstallmentAmount

installmentInformation.firstInstallmentDate

installmentInformation.frequency

installmentInformation.gracePeriodDuration

installmentInformation.gracePeriodDurationType

installmentInformation.identifier

installmentInformation.insurance

installmentInformation.insurancePercentage

installmentInformation.invoiceData

installmentInformation.maximumTotalCount

installmentInformation.minimumTotalCount

installmentInformation.monthlyInterestRate

installmentInformation.paymentType

installmentInformation.planId

installmentInformation.planType

installmentInformation.sequence

installmentInformation.taxes

installmentInformation.taxesPercentage

installmentInformation.totalAmount

installmentInformation.totalCount

installmentInformation.validationIndicator

installmentInformation. additionalCosts

Additional costs charged by the issuer to fund the installment payments.

This field is available only for Crediario installment payments in Brazil on the Visa Platform Connect processor.

Obtain the value for this field from the authorization response for a Crediario eligibility request.

The value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCR9

Position: 128-139

Field: Total Other Costs

Specifications

Data Type:
String

Data Length:
12

Mapping Information

REST API Field:

installmentInformation.additionalCosts

SCMP API Field:

installment_additional_costs

Simple Order API Field:

installment_additionalCosts

installmentInformation. additionalCostsPercentage

Additional costs divided by the amount funded.

This field is available only for Crediario installment payments in Brazil on the Visa Platform Connect processor.

Example
: A value of

1.0

specifies 1%.

Example
: A value of

4.0

specifies 4%.

Obtain the value for this field from the authorization response for a Crediario eligibility request.

The value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCR9

Position: 140-143

Field: Percent of Total Other Costs

Specifications

Data Type:
String

Data Length:
4

Mapping Information

REST API Field:

installmentInformation.additionalCostsPercentage

SCMP API Field:

installment_additional_costs_percentage

Simple Order API Field:

installment_additionalCostsPercentage

installmentInformation. amount

Amount of the current installment payment.

This field is available only for Mastercard installment payments on the Visa Platform Connect processor in all countries except Croatia and Georgia.

Argentina: The value for this field corresponds to the following data in the TC 33 capture file:
Record: CP01 TCR9
Position: 26-37
Field: Installment Amount
Brazil: In Brazil, this field is available only for Crediario installment payments.

When you do not include this field in a request for a Crediario installment payment, a value of
0
is sent to the processor.

The value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCR9
Position: 26-37
Field: Amount of Each Installment
Chile: The value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCR9
Position: 24-35
Field: Installment Amount
Georgia (Sakartvelo): The value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCR5
Position: 63-74
Mastercard Subsequent Installment Amount
Greece: The value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCR5
Position: 23-34
Field: Amount of Each Installment
Mexico: Visa Acceptance Solutions does not validate the combination of values for this field.

Format:
Positions 1-2: Grace period in months
Positions 3-4: Total number of installments
Positions 5-6: Plan type:
03
: Without interest for the cardholder
05
: With interest for the cardholder
07
: Skip payment

Example:
030007

Example:
000603
Peru: The value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCR5
Position: 23-34
Field: Amount of Each Installment
Other Countries: The value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCR5
Position: 63-74
Field: Mastercard Subsequent Installment Amount

Specifications

Data Type:
String

Data Length:

Standing-instruction MIT with Diners Club or Mastercard in India or with an India-issued card: 10 excluding decimal

Installment payment in Mexico: 6

Other kinds of installment payments: 12

Mapping Information

REST API Field:

installmentInformation.amount

SCMP API Fields:

auth_installment_amount

installment_amount

Simple Order API Field:

installment_amount

installmentInformation. amountFunded

Amount funded.

This field is available only for Crediario installment payments in Brazil on the Visa Platform Connect processor.

Obtain the value for this field from the authorization response for a Crediario eligibility request.

The value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCR9

Position: 48-59 Field: Total Amount Funded

Specifications

Data Type:
String

Data Length:
12

Mapping Information

REST API Field:

installmentInformation.amountFunded

SCMP API Fields:

auth_installment_amount_funded

installment_amount_funded

Simple Order API Field:

installment_amountFunded

installmentInformation. amountRequestedPercentage

Amount requested divided by the amount funded.

This field is available only for two kinds of installment payments in Brazil on the Visa Platform Connect processor:

Crediario with Visa: this field is included in the authorization response for the Crediario eligibility request when the issuer approves the customer's request for Crediario installment payments.

Mastercard.

Example:
A value of

90.0

specifies 90%.

Example:
A value of

93.7

specifies 93.7%.

The value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCR9

Position: 60-63

Field: Percent of Amount Requested

Specifications

Data Type:
String

Data Length:
4

Mapping Information

REST API Field:

installmentInformation.amountRequestedPercentage

SCMP API Field:

auth_installment_amount_requested_percentage

Simple Order API Field:

installment_amountRequestedPercentage

installmentInformation. annualFinancingCost

Annual cost of financing the installment payments.

This field is available only for Crediario installment payments in Brazil on the Visa Platform Connect processor.

This field is included in the authorization response for the Crediario eligibility request when the issuer approves the customer's request for Crediario installment payments in Brazil.

The value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCR9

Position: 158-164

Field: Annual Total Cost of Financing

Specifications

Data Type:
String

Data Length:
7

Mapping Information

REST API Field:

installmentInformation.annualFinancingCost

SCMP API Fields:

auth_installment_annual_financing_cost

installment_annual_financing_cost

Simple Order API Field:

installment_annualFinancingCost

installmentInformation. annualInterestRate

Annual interest rate.

This field is available only for two kinds of installment payments on the Visa Platform Connect processor:

Crediario with Visa in Brazil: this field is included in the authorization response for the Crediario eligibility request when the issuer approves the customer's request for Crediario installment payments.

Mastercard in all countries except Brazil, Croatia, Georgia, and Greece.

Example:
A value of

1.0

specifies 1%.

Example:
A value of

4.0

specifies 4%.

Brazil: The value for this field corresponds to the following data in the TC 33 capture file:
Record: CP01 TCR9
Position: 151-157
Field: Annual Interest Rate
Other Countries: The value for this field corresponds to the following data in the TC 33 capture file:
Record: CP01 TCR5
Position: 58-62
Field: Mastercard Annual Percentage Rate

Specifications

Data Type:
String

Data Length:
7

Mapping Information

REST API Field:

installmentInformation.annualInterestRate

SCMP API Fields:

auth_installment_annual_interest_rate

installment_annual_interest_rate

Simple Order API Field:

installment_annualInterestRate

installmentInformation. downPayment

Down payment.

This field is available only for airline transactions on the Getnet processor.

Specifications

Data Type:
String

Data Length:
12

Mapping Information

REST API Field:

installmentInformation.downPayment

SCMP API Field:

installment_down_payment

Simple Order API Field:

installment_downPayment

installmentInformation. eligibilityInquiry

Flag that specifies whether the authorization request is a Crediario eligibility inquiry.

This field is available only for Crediario installment payments in Brazil on the Visa Platform Connect processor.

Set the value for this field to

Crediario

.

Specifications

Type:
String

Length:
9

Mapping Information

REST API Field:

installmentInformation.eligibilityInquiry

SCMP API Field:

eligibility_inquiry

Simple Order API Field:

eligibilityInquiry

installmentInformation. expenses

Expenses charged by the issuer to fund the installment payments.

This field is available only for two kinds of installment payments in Brazil on the Visa Platform Connect processor:

Crediario with Visa: this field is included in the authorization response for the Crediario eligibility request when the issuer approves the customer's request for Crediario installment payments.

Mastercard.

The value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCR9

Position: 64-75

Field: Total Expenses

Specifications

Data Type:
String

Data Length:
12

Mapping Information

REST API Field:

installmentInformation.expenses

SCMP API Field:

auth_installment_expenses

Simple Order API Field:

installment_expenses

installmentInformation. expensesPercentage

Expenses divided by the amount funded.

This field is available only for two kinds of installment payments in Brazil on the Visa Platform Connect processor:

Crediario with Visa: this field is included in the authorization response for the Crediario eligibility request when the issuer approves the customer's request for Crediario installment payments.

Mastercard.

Example:
A value of

1.0

specifies 1%.

Example:
A value of

4.0

specifies 4%.

The value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCR9

Position: 76-79

Field: Percent of Total Expenses

Specifications

Data Type:
String

Data Length:
4

Mapping Information

REST API Field:

installmentInformation.expensesPercentage

SCMP API Field:

auth_installment_expenses_percentage

Simple Order API Field:

installment_expensesPercentage

installmentInformation. fees

Fees charged by the issuer to fund the installment payments.

This field is available only for two kinds of installment payments on the Visa Platform Connect processor:

Crediario with Visa in Brazil: This field is included in the authorization response for the Crediario eligibility request when the issuer approves the customer's request for Crediario installment payments.
Mastercard: This field is included in all countries except Croatia, Georgia, and Greece.

Brazil: The value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCR9
Position: 80-91
Field: Total Fees
Other Countries: The value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCR5
Position: 46-57
Field: Mastercard Installment Fee

Specifications

Data Type:
String

Data Length:
12

Mapping Information

REST API Field:

installmentInformation.fees

SCMP API Fields:

auth_installment_fees

installment_fees

Simple Order API Field:

installment_fees

installmentInformation. feesPercentage

Fees divided by the amount funded.

This field is available only for two kinds of installment payments in Brazil on the Visa Platform Connect processor:

Crediario with Visa: this field is included in the authorization response for the Crediario eligibility request when the issuer approves the customer's request for Crediario installment payments.

Mastercard.

Example:
A value of

1.0

specifies 1%.

Example:
A value of

4.0

specifies 4%.

The value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCR9

Position: 92-95

Field: Percent of Total Fees

Specifications

Data Type:
String

Data Length:
4

Mapping Information

REST API Field:

installmentInformation.feesPercentage

SCMP API Field:

auth_installment_fees_percentage

Simple Order API Field:

installment_feesPercentage

installmentInformation. firstInstallmentAmount

Amount of the first installment payment.

This field is available only for Mastercard installment payments on the Visa Platform Connect processor in all countries except Brazil, Croatia, and Greece.

The issuer provides this value when the first installment payment is successful.

The value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCR5

Position: 23-34

Field: Amount of Each Installment

Specifications

Data Type:
String

Data Length:
12

Mapping Information

REST API Field:

installmentInformation.firstInstallmentAmount

SCMP API Fields

Georgia (Sakartvelo)
: installment_first_installment_amount

Other Countries
:

auth_installment_first_installment_amount

Simple Order API Field:

installment_firstInstallmentAmount

installmentInformation. firstInstallmentDate

Date of the first installment payment.

This field is available only on the Visa Platform Connect processor.

Argentina: When you do not include this field, a string of six zeros (
000000
) is sent to the processor.

In Argentina, the value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCR9
Position: 38-43
Field: Consumer Deferred Sale
Brazil: Crediario installment payments.

When you do not include this field, a string of six zeros (
000000
) is sent to the processor.
For Crediario installment payments in Brazil, the value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCR9
Position: 42-47
Field: Date of First Installment
Greece: Mastercard only.; For Mastercard installment payments in Greece, the value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCR5
Position: 102-107
Field: Mastercard Greece First Installment Due Date
Peru: Mastercard only.

For Mastercard installment payments in Peru, the value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCR5
Position: 102-107
Field: Mastercard Peru First Installment Due Date

Specifications

Data Type:
String

Data Length:
6

Format:
YYMMDD

Mapping Information

REST API Field:

installmentInformation.firstInstallmentDate

SCMP API Field:

installment_first_installment_date

Simple Order API Field:

installment_firstInstallmentDate

installmentInformation. frequency

The frequency of the installment payments.

This field is available only on the Visa Platform Connect processor.

Possible values for standing-instruction MITs with Diners Club or Mastercard in India or with an India-issued card:

1

: Daily (for an installment payment or recurring payment).

2

: Weekly (for an installment payment or recurring payment).

3

: Every two weeks (for an installment payment or recurring payment).

4

: Monthly (for an installment payment or recurring payment).

5

: Quarterly (for an installment payment or recurring payment).

6

: Half-yearly (for an installment payment or recurring payment).

7

: Annually (for an installment payment or recurring payment).

8

: As needed (for an unscheduled COF transaction).

Possible values for other kinds of installment payments:

B

: Biweekly.

M

: Monthly.

W

: Weekly.

Crediario Installment Payments

When you do not include this field in a request for a Credario installment payment, a space character is sent to the processor.

The value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCR9

Position: 41

Field: Installment Frequency

The TC 33 capture file contains information about the payments and credits that a merchant submits to Visa Acceptance Solutions. The processor creates the TC 33 capture file at the end of the day and sends it to the merchant’s acquirer. The acquirer uses this information to facilitate end-of-day clearing processing with payment networks.

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

installmentInformation.frequency

SCMP API Field:

installment_frequency

Simple Order API Field:

installment_frequency

installmentInformation. gracePeriodDuration

Grace period requested by the customer before the first installment payment is due.

This field is available only on the Prosa and Visa Platform Connect processors.

Prosa: Length of grace period in months.

Valid values:
00
through
99
.

When the value for the installment plan type field is
07
, the installment grace period duration must be greater than
00
.
Visa Platform Connect: This field is available only for Mastercard installment payments in Brazil, Greece, and Peru.

When you include this field in a request, you must also include the grace period duration type field.

The value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCR5
Position: 99-101
Field: Mastercard Grace Period Details

Specifications

Data Type:
String

Data Length:
2

Mapping Information

REST API Field:

installmentInformation.gracePeriodDuration

SCMP API Field:

installment_grace_period_duration

Simple Order API Field:

installment_gracePeriodDuration

installmentInformation. gracePeriodDurationType

Unit for the requested grace period duration.

This field is available only for Mastercard installment payments in Brazil and Greece on the Visa Platform Connect processor.

Possible values:

D

: Days.

W

: Weeks.

M

: Months.

The value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCR5

Position: 99

Field: Mastercard Grace Period Details

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

installmentInformation.gracePeriodDurationType

SCMP API Field:

installment_grace_period_duration_type

Simple Order API Field:

installment_gracePeriodDurationType

installmentInformation. identifier

Identifier for an installment payment transaction.

This field is to be used only for the following card types and transactions on the Visa Platform Connect processor:

Diners Club:
standing instruction (SI) merchant-initiated transaction (MIT) in India or with an India-issued card. You must register with the SI hub in India to obtain this value.

Mastercard:
standing instruction (SI) merchant-initiated transaction (MIT) in India or with an India-issued card. You must register with the SI hub in India to obtain this value.

Visa:
MIT installment scenario in India.

Visa installments in Australia, Hong Kong, Japan, Malaysia, Philippines, Singapore, and Vietnam: For Visa installments in these countries in the AP region, include the plan registration system identifier in authorization requests and authorization reversal requests.

The value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCR5

Position: 121-155

Field: Plan Registration System Identifier

The TC 33 capture file contains information about the payments and credits that a merchant submits to Visa Acceptance Solutions. The processor creates the TC 33 capture file at the end of the day and sends it to the merchant’s acquirer. The acquirer uses this information to facilitate end-of-day clearing processing with payment networks.

Specifications

Data Type:
String

Data Length:
35

Mapping Information

REST API Field:

installmentInformation.identifier

SCMP API Field:

installment_identifier

Simple Order API Field:

installment_identifier

installmentInformation. insurance

Insurance charged by the issuer to fund the installment payments.

This field is available only for two kinds of installment payments in Brazil on the Visa Platform Connect processor:

Crediario with Visa: this field is included in the authorization response for the Crediario eligibility request when the issuer approves the customer's request for Crediario installment payments.

Mastercard.

The value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCR9

Position: 112-123

Field: Total Insurance

Specifications

Data Type:
String

Data Length:
12

Mapping Information

REST API Field:

installmentInformation.insurance

SCMP API Fields:

auth_installment_insurance

installment_insurance

Simple Order API Field:

installment_insurance

installmentInformation. insurancePercentage

Insurance costs divided by the amount funded.

This field is available only for two kinds of installment payments in Brazil on the Visa Platform Connect processor:

Crediario with Visa: this field is included in the authorization response for the Crediario eligibility request when the issuer approves the customer's request for Crediario installment payments.

Mastercard.

Example:
A value of

1.0

specifies 1%.

Example:
A value of

4.0

specifies 4%.

The value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCR9

Position: 124-127

Field: Percent of Total Insurance

Specifications

Data Type:
String

Data Length:
4

Mapping Information

REST API Field:

installmentInformation.insurancePercentage

SCMP API Field:

auth_installment_insurance_percentage

installment_insurance_percentage

Simple Order API Field:

installment_insurancePercentage

installmentInformation. invoiceData

Invoice information that you want to provide to the issuer.

This field is available only for installment payments with Mastercard in Brazil on the Visa Platform Connect processor.

This value is similar to a tracking number and is the same for all installment payments for one purchase.

The value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCR4

Position: 51-70

Field: Purchase Identification

Specifications

Data Type:
String

Data Length:
20

Mapping Information

REST API Field:

installmentInformation.invoiceData

SCMP API Field:

installment_invoice_data

Simple Order API Field:

installment_invoiceData

installmentInformation. maximumTotalCount

Maximum number of installments offered by the issuer for this purchase.

This field is available only for installment payments with Mastercard in all countries except Brazil, Croatia, Georgia, and Greece on the Visa Platform Connect processor.

The issuer provides this value when the first installment payment is successful.

The value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCR5

Position: 77-78

Field: Mastercard Maximum Number Of Installments

Specifications

Data Type:
String

Data Length:
2

Mapping Information

REST API Field:

installmentInformation.maximumTotalCount

SCMP API Field:

auth_installment_maximum_total_count

Simple Order API Field:

installment_maximumTotalCount

installmentInformation. minimumTotalCount

Minimum number of installments offered by the issuer for this purchase.

This field is available only for installment payments with Mastercard in all countries except Brazil, Croatia, Georgia, and Greece on the Visa Platform Connect processor.

The issuer provides this value when the first installment payment is successful.

The value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCR5

Position: 75-76

Field: Mastercard Minimum Number Of Installments

Specifications

Data Type:
String

Data Length:
2

Mapping Information

REST API Field:

installmentInformation.minimumTotalCount

SCMP API Field:

auth_installment_minimum_total_count

Simple Order API Field:

installment_minimumTotalCount

installmentInformation. monthlyInterestRate

Monthly interest rate.

This field is available only for two kinds of installment payments on the Visa Platform Connect processor:

Crediario with Visa in Brazil: this field is included in the authorization response for the Crediario eligibility request when the issuer approves the customer's request for Crediario installment payments.

Mastercard in all countries except Croatia, Georgia, and Greece.

Example:
A value of

1.0

specifies 1%.

Example:
A value of

4.0

specifies 4%.

Brazil

The value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCR9

Position: 144-150

Field: Monthly Interest Rate

Other Countries

The value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCR5

Position: 41-45

Field: Mastercard Interest Rate

Specifications

Data Type:
String

Data Length:
7

Mapping Information

REST API Field:

installmentInformation.monthlyInterestRate

SCMP API Field:

auth_installment_monthly_interest_rate

installment_monthly_interest_rate

Simple Order API Field:

installment_monthlyInterestRate

installmentInformation. paymentType

Payment plan for installments.

This field is available only for installment payments on the Visa Platform Connectprocessor.

This field is available for RuPay seamless flow.

Possible values for a standing-instruction (SI) merchant-initiated transaction (MIT) with Diners Club or Mastercard in India or with an India-issued card:

1

: SI with a fixed amount.

2

: SI with a maximum amount.

3

: Other kind of SI.

Possible values for other kinds of installment payments:

0

(default): Regular installment. This value is not allowed for airline transactions.

1

: Installment payment with down payment.

2

: Installment payment without down payment. This value is supported only for airline transactions.

3

: Installment payment. Down payment and boarding fee will follow. This value is supported only for airline transactions.

4

: Down payment only. Regular installment payment will follow.

5

: Boarding fee only. This value is supported only for airline transactions.

6

: SI de-registration on RuPay for the payer authentication seamless flow.

Australia

In Australia, this field is used by eftpos for installment transactions.

Possible values:

1

= Registration/first payment

2

= Subsequent payments

Brazil

In Brazil, this field is available only for installment payments with Visa.

The value for this field corresponds to the following data in the TC 33 capture file:

Record: CP07 TCR1

Position: 9

Field: Merchant Installment Supporting Information

The TC 33 capture file contains information about the payments and credits that a merchant submits to Visa Acceptance Solutions. The processor creates the TC 33 capture file at the end of the day and sends it to the merchant’s acquirer. The acquirer uses this information to facilitate end-of-day clearing processing with payment networks.

India

In India, this field is available only for standing-instruction MITs.

Rest of World

In all countries except Brazil, Croatia, Georgia, and Greece, this field is available only for installment payments with Mastercard.

The value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCR5

Position: 35-37

Field: Installment Payment Number

The TC 33 capture file contains information about the payments and credits that a merchant submits to Visa Acceptance Solutions. The processor creates the TC 33 capture file at the end of the day and sends it to the merchant’s acquirer. The acquirer uses this information to facilitate end-of-day clearing processing with payment networks.

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

installmentInformation.paymentType

SCMP API Field:

installment_payment_type

Simple Order API Field:

installment_paymentType

installmentInformation. planId

Identifier for the issuer-funded installment plan.

This field is available only for Chile on the Visa Platform Connect processor.

Possible values:

0

: No deferred period.

1

: Deferred period 1.

2

: Deferred period 2.

3

: Deferred period 3.

The value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCR9

Position: 40

Field: Deferred Period

Specifications

Data Type:
String

Data Length:
50

Mapping Information

REST API Field:

installmentInformation.planId

SCMP API Field:

installment_plan_id

Simple Order API Field:

installment_planID

installmentInformation. planType

Type of installment plan.

This field is available only on the American Express Direct, Cielo, Prosa, and Visa Platform Connect processors.

American Express Direct and Cielo: Possible values:

1
: Merchant-funded installment plan.
2
: Issuer-funded installment plan.

When you do not include this field in the request, the value in your account is used. To change the value in your account, contact customer service.

is the name of a specific processing connection.
does not refer to the general topic of processing in Latin America. The information in this field description, or in this section of the field description, is for the specific processing connection called . It is not for any other Latin American processors.
Prosa: Possible values:

00
: Not a promotion.
03
: Interest is not charged to the customer.
05
: Interest is charged to the customer.
07
: Skip payment: buy now and pay the full amount later in one payment.
Visa Platform Connect with American Express: American Express-defined code that specifies the type of installment plan. Contact American Express for:

Information about the kinds of installment plans that American Express provides.
Values for this field.; For installment payments with American Express in Brazil, the value for this field corresponds to the following data in the TC 33 capture file:

Record: CP07 TCR3
Position: 5-6
Field: Plan Type
Visa Platform Connect with Visa or Mastercard: Possible values:

0
or
00
: Non-installment plan—only with Visa in Paraguay.
1
or
01
: Merchant-funded installment plan.
2
or
02
: Issuer-funded installment plan.
3
or
03
: Co-branded merchant financed—only with Mastercard in Brazil.
4
or
04
: Issuer merchant co-financed—only with Mastercard in Brazil.
5
or
05
: Deferred issuer-funded installment plan—only with Visa in Paraguay.
6
or
06
: Acquirer-funded installment plan—only with Mastercard in Paraguay.
7
or
07
: Merchant-funded government plan—only with Visa in Argentina.
8
or
08
: Average payment financing installments—only with Mastercard in Paraguay.
43
: Crediario installment plan—only with Visa in Brazil.

For installment payments in Argentina, the value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCR9
Position: 22-23
Field: Installment Type

For installment payments in Chile, the value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCR9
Position: 23
Field: Installment Type

For installment payments with Visa in Brazil, the value for this field corresponds to the following data in the TC 33 capture file:

Record: CP07 TCR1
Position: 5-6
Field: Installment Type

For installment payments in Paraguay, the value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCR5
Position: 39-40
Field: Installment Plan Type

For installment payments with Mastercard in Peru, the value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCR5
Position: 39-40
Field: Installment Plan Type

For all other kinds of installment payments, the value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCR5
Position: 39-40
Field: Installment Plan Type

Specifications

Prosa and Visa Platform Connect:

Data Type:
String

Data Length:
2

All Other Processors:

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

installmentInformation.planType

SCMP API Field:

installment_plan_type

Simple Order API Field:

installment_planType

installmentInformation. sequence

Installment payment number.

This field is used along with

installmentInformation.totalCount

to track which payment is being processed.

Example:
These are the values for the second of five payments:

installmentInformation.sequence=2
installmentInformation.totalCount=5

Visa Platform Connect

When you do not include this field in a request for a Crediario installment payment, a value of

0

is sent to the processor.

For Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCR9

Position: 38-40

Field: Installment Payment Number

For installment payments in Paraguay, the value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCR5

Position: 35-37

Field: Installment Payment Number

Specifications

Data Type:
Integer

Data Length:
2

Mapping Information

REST API Field:

installmentInformation.sequence

SCMP API Field:

installment_sequence

Simple Order API Field:

installment_sequence

installmentInformation. taxes

Taxes collected by the issuer to fund the installment payments.

This field is included in the authorization response for a Crediario eligibility request when the issuer approves the customer's request for Crediario installment payments in Brazil.

This field is available only for Crediario installment payments in Brazil on the Visa Platform Connect processor.

The value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCR9

Position: 96-107

Field: Total Taxes

Specifications

Type:
String

Length:
12

Mapping Information

REST API Field:

installmentInformation.taxes

SCMP API Field:

installment_taxes

Simple Order API Field:

installment_taxes

installmentInformation. taxesPercentage

Taxes divided by the amount funded.

This field is available only for two kinds of installment payments in Brazil on the Visa Platform Connect processor.

Crediario with Visa: this field is included in the authorization response for the Crediario eligibility request when the issuer approves the customer's request for Crediario installment payments.

Mastercard.

Example:
A value of

1.0

specifies 1%.

Example:
A value of

4.0

specifies 4%.

The value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCR9

Position: 108-111

Field: Percent of Total Taxes

Specifications

Data Type:
String

Data Length:
4

Mapping Information

REST API Field:

installmentInformation.taxesPercentage

SCMP API Fields:

auth_installment_taxes_percentage

installment_taxes_percentage

Simple Order API Field:

installment_taxesPercentage

installmentInformation. totalAmount

Total amount of the loan that is being paid in installments.

This field is available only for installment payments with Mastercard in all countries except Croatia, Georgia, and Greece on the Visa Platform Connect processor.

Brazil

The value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCR9

Position: 8-19

Field: Installment Total Amount

Other Countries

The value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCR5

Position: 5-16

Field: Installment Payment Total Amount

Specifications

Data Type:
String

Data Length:
12

Mapping Information

REST API Field:

installmentInformation.totalAmount

SCMP API Field:

auth_installment_total_amount

installment_total_amount

Simple Order API Field:

installment_totalAmount

installmentInformation. totalCount

Total number of installment payments.

This field is available only for installment payments with Mastercard in all countries except Brazil, Croatia, Georgia, and Greece on the Visa Platform Connect processor.

This field is used along with

installmentInformation.sequence

to track which payment is being processed.

Example:
These are the values for the second of five payments:

installmentInformation.sequence=2
installmentInformation.totalCount=5

American Express Direct, Cielo, and Credit Mutuel-CIC: This value is the total number of installments that you approved.
Prosa: Valid values:
00
through
99
. When the value for the installment plan type field is
07
, the installment total count is set to
00
.
Visa Platform Connect in Argentina: Valid values with Mastercard:
02
through
99
.

Valid values with Visa:
00
through
99
.

The value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCR9
Position: 24-25
Field: Number of Installments
Visa Platform Connect in Brazil: For Mastercard installments and for Crediario installment payments with Visa, the value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCR9
Position: 23-25
Field: Number of Installments
Visa Platform Connect in Chile: Valid values:
02
through
48
.

The value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCR9
Position: 20-22
Field: Number of Installments
Visa Platform Connect in Paraguay: Valid values with Visa:
0
through
99
.

The value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCR5
Position: 20-22
Field: Number of Installments
Visa Platform Connect in Peru: Valid values with Mastercard:
0
through
99
.

The value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCR5
Position: 20-22
Field: Number of Installments
Visa Platform Connect in All Countries Except Argentina, Brazil, Chile, Paraguay, and Peru: The value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCR5
Position: 20-22
Field: Number of Installments

For installment payments with American Express or with Visa, the value for this field corresponds to the following data in the TC 33 capture file:

Record: CP07 TCR3
Position: 7-8
Field: Number of Installments

Specifications

Data Type:
Integer

Data Length:
2

Mapping Information

REST API Field:

installmentInformation.totalCount

SCMP API Field:

auth_installment_total_count

Simple Order API Field:

installment_totalCount

installmentInformation. validationIndicator

Validation indicator for an installment payment.

This field is available only for a standing instruction (SI) merchant-initiated transaction (MIT) with Diners Club or Mastercard in India or with an India-issued card on the Visa Platform Connect processor.

Possible values:

0

: Not validated.

1

: Validated. The customer provided consent for the payment.

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

installmentInformation.validationIndicator

SCMP API Field:

installment_validation_indicator

Simple Order API Field:

installment_validationIndicator

integrationInformation

These fields provide information about the integration.

integrationInformation.oauth2.clientId

integrationInformation.tenantConfigurations[]. solutionId

integrationInformation.tenantConfigurations[]. tenantConfigurationId

integrationInformation.tenantConfigurations[]. tenantInformation.tenantId

integrationInformation. oauth2. clientId

Client identifier that is registered with OAuth 2.0.

Syntax

 {
  "integrationInformation": {
    "oauth2": [
      "clientId": "client123"
    ]
  }
}

Specifications

Data Type:
String

Maximum Data Length:
32

Mapping Information

No corresponding fields.

integrationInformation. tenantConfigurations[]. solutionId

The unique identifier of the solution to be associated with the merchant. This ID is assigned to the solution during tech partner and solution onboarding.

Syntax

 {
  "integrationInformation": {
    "tenantConfigurations": [
      "solutionId": "12345678"
    ]
  }
}

The syntax must conform to this regular expression:

^[0-9a-zA-Z_]+$

Specifications

Data Type:
String

Data Length:
8

Mapping Information

No corresponding fields.

integrationInformation. tenantConfigurations[]. tenantConfigurationId

Unique identifier for the tenant that contains the associated solution ID and merchant ID. This identifier is used to retrieve tenant details and manage the tenant status.

This field is assigned to the tenant during the boarding process and is returned in a response.

Syntax

 {
  "integrationInformation": {
    "tenantConfigurations": [
      "tenantConfigurationId": "id1234"
    ]
  }
}

Specifications

Data Type:
String

Minimum Data Length:
6

Maximum Data Length:
30

Mapping Information

No corresponding fields.

integrationInformation. tenantConfigurations[]. tenantInformation. tenantId

The optional external identifier that is included in tenant information. This ID is provided by technology partners.

Syntax

 {
  "integrationInformation": {
    "tenantConfigurations": [
      "tenantInformation": {
        "tenantId": "tenant123"
      }
    ]
  }
}

Specifications

Data Type:
String

Minimum Data Length:
1

Maximum Data Length:
50

Mapping Information

No corresponding fields.

invoiceDetails

These fields provide invoice information.

invoiceDetails.salesSlipNumber

invoiceDetails. salesSlipNumber

In requests, this field is the transaction identifier that you generate. In responses, this field identifies the transaction identifier.

This field is available only on the JCN Gateway and Visa Platform Connect processors.

The difference between this field and the

processorInformation.systemTraceAuditNumber

field is that Visa Acceptance Solutions generates the receipt number for the

processorInformation.systemTraceAuditNumber

field, and you must print the receipt number on the receipt. However, for this field, you can generate the sales slip number, and you can choose to print the sales slip number on the receipt.

Visa Platform Connect

Required in Argentina and Japan.

In Argentina, the value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCR9

Position: 8-15

Field: Field Purchase Receipt Number

In Japan, the value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCR9

Position: 143-147

Field: Sales Slip Number

The TC 33 capture file contains information about the payments and credits that a merchant submits to Visa Acceptance Solutions. The processor creates the TC 33 capture file at the end of the day and sends it to the merchant’s acquirer. The acquirer uses this information to facilitate end-of-day clearing processing with payment networks.

Specifications

Data Type:
Integer

Data Length in Argentina:
8

Data Length in Japan:
5

Mapping Information

REST API Field:

invoiceDetails.salesSlipNumber

SCMP API Field:

sales_slip_number

Simple Order API Field:

salesSlipNumber

invoiceInformation

These fields are related to invoicing information.

invoiceInformation.allowPartialPayments

invoiceInformation.deliveryMode

invoiceInformation.description

invoiceInformation.dueDate

invoiceInformation.invoiceNumber

invoiceInformation.sendImmediately

invoiceInformation. allowPartialPayments

The indicator for whether or not the customer can pay a partial amount of the total owed invoice amount.

This is also known as making a partial payment.

Possible values:

false

: The customer cannot make a partial payment.

true

: The customer can make a partial payment.

Specifications

Data Type:
Boolean

Data Length:
5

Mapping

REST Field Name:

invoiceInformation.allowPartialPayments

Simple Order Field Name:
No corresponding field.

invoiceInformation. deliveryMode

The indicator for whether or not the customer will be sent an email message notifying them of a new invoice.

Possible values:

Email

: An email message will be sent to the customer when a new invoice is created.

None

: An email message will not be sent to the customer when a new invoice is created.

Specifications

Data Type:
String

Data Length:
5

Mapping

REST Field Name:

invoiceInformation.deliveryMode

Simple Order Field Name:
No corresponding field.

invoiceInformation. description

The description included in the invoice.

Specifications

Data Type:
String

Data Length:
2000

Mapping

REST Field Name:

invoiceInformation.description

Simple Order Field Name:
No corresponding field.

invoiceInformation. dueDate

The due date of the billed invoice.

Format:

YYYY-MM-DD

Specifications

Data Type:
String

Data Length:
10

Mapping

REST Field Name:

invoiceInformation.dueDate

Simple Order Field Name:
No corresponding field.

invoiceInformation. invoiceNumber

The unique identifier for an invoice, also known as the invoice number.

Specifications

Data Type:
String

Data Length:
248

Mapping

REST Field Name:

invoiceInformation.invoiceNumber

Simple Order Field Name:
No corresponding field.

invoiceInformation. sendImmediately

The indicator for whether an invoice is either published as a payable invoice or remains as a draft.

Possible values:

false

: the invoice is created as a draft.

true

: the invoice is published as a payable invoice.

Specifications

Data Type:
Boolean

Data Length:
5

Mapping

REST Field Name:

invoiceInformation.sendImmediately

Simple Order Field Name:
No corresponding field.

issuerAuthCode

Issuer authentication code that the issuer receives through redirect from the mobile payment application when the

stepUpOption.method

field is set to

APP_TO_APP

.

Specifications

Data Type:
String

Data Length:
4096

Mapping Information

REST API Field:

issuerAuthCode

Simple Order API Field:
No corresponding field.

issuerInformation

These fields provide issuer information.

issuerInformation.accountPrefix

issuerInformation.binLength

issuerInformation.country

issuerInformation.discretionaryData

issuerInformation.name

issuerInformation.phoneNumber

issuerInformation.responseCode

issuerInformation.serviceProcessingType

issuerInformation.transactionInformation

issuerInformation.verificationType

issuerInformation. accountPrefix

First six or eight digits of the payment account number (PAN).

The length of the field is determined by PCI-DSS standards for truncation. For more information about formats for PAN truncation, see What-are-acceptable-formats-for-truncation-of-primary-account-numbers.

If you have questions about receiving this field, contact customer support.

Specifications

Data Type:
String

Data Length:
8

Mapping Information

No corresponding fields.

issuerInformation. binLength

Length of the card prefix or bank identification number (BIN).

Specifications

Data Type:
String

Data Length:
2

Mapping Information

No corresponding fields.

issuerInformation. country

Country where the card was issued.

This information enables you to determine whether the card was issued domestically or internationally.

Specifications

Data Type:
String

Data Length:
2

Mapping Information

REST API Field:

issuerInformation.country

SCMP API Field:

auth_card_issuer_country

Simple Order API Field:

ccAuthReply_cardIssuerCountry

issuerInformation. discretionaryData

Data defined by the issuer.

This field is available only for Visa and Mastercard on the Visa Platform Connect processor.

The value for this field corresponds to the following data in the TC 33 capture file:

Record: CP08 TCR1

Position: 5-168

Field: Free Form Text

The tables provide examples of the formats for discretionary data specific to acquirers for issuer-funded installment payments. The issuers and acquirers work together to develop and reach consensus on the formats. You must contact your acquirer for information about the formats to use.

IMPORTANT

Review the issuer data when issuer additional data is part of the response. To ensure the transaction is fully supported by the issuer, it's important to closely inspect the issuer data to ensure it follows the format provided with the issuer’s specification. Should you find any discrepancies in the data, please initiate the required follow-on transactions.

Example:
Discretionary Data Format for Issuer-Funded Installment Payments with Visa Guatemala

VC10000000050000

Discretionary Data Format for Issuer-Funded Installment Payments with Visa Guatemala
Position (Character or Digit #)	Number of Characters or Digits	Description
1-2	2	Prefix. Set this value to VC .
3-4	2	Total number of installments.
5-16	12	Total amount.

Example:
Discretionary Data Format for Issuer-Funded Installment Payments with Visa Uruguay

00612012345678910000000008160003359

Discretionary Data Format for Issuer-Funded Installment Payments with VisaNet Uruguay
Position (Character or Digit #)	Number of Characters or Digits	Description
1-2	2	Plan type. Set this value to 00 . Specifies that the transaction is an e-commerce transaction.
3	1	Grace period. Number of months that the issuer waits before charging customers.
4-5	2	Total number of installments. Possible values: 00 through 99 .
6	1	POS entry mode. Set this value to 0 . Specifies that the transaction is an e-commerce transaction.
7-15	9	Identity document number. Set this value to the number on the customer’s identity document or leave it blank. Format: right justified with 0 (zero) padding on the left.
16	1	Financial inclusion law indicator. Possible values: 1 : Law 17934 2 : Law 18099 3 : Asignaciones familiares (AFAM) (family allowance program) 4 : Real state law 5 : Law 19210
17-28	12	Financial inclusion amount. This value is the amount the bank returns to the customer.
29-35	7	Merchant-generated invoice number.

Example : Discretionary Data Format for Issuer-Funded Installment Payments with Mastercard Taiwan
Field	Position	Length	Description
Filler	1 - 90	90	Spaces
Installment-Tx-Indicator	91	1	Installment Transaction Indicator
Installment-Tranaction Response Code	92 - 93	2	Installment Transaction Response Code
Filler	94 - 120	27	Spaces
Period Number	121 - 122	2	Period Number
Down Payment	123 - 130	8	Down Payment
Installment Payments	131 - 138	8	Installment Payments
Formality Fee	139 - 144	6	Formality Fee

Specifications

Data Type:
String

Data Length:
255

IMPORTANT

For an authorization, the maximum length for this value is 255 characters. In the capture file, the value is truncated at 164 characters.

Mapping Information

REST API Field:

issuerInformation.discretionaryData

and

processingInformation.issuer.discretionaryData

SCMP API Field:

issuer_additional_data

Simple Order API Field:

issuer_additionalData

issuerInformation. name

Issuer's name.

Specifications

Data Type:
String

Data Length:
1000

Mapping Information

No corresponding fields.

issuerInformation. phoneNumber

Issuer's customer service phone number.

Specifications

Data Type:
String

Data Length:
20

Mapping Information

No corresponding fields.

issuerInformation. responseCode

For FDC Nashville Global card-not-present transactions, the raw decline code received from the card association.

For card-present transactions, the additional authorization code that must be printed on the receipt when returned by the processor. This field can be used to identify when to retry authorization for a declined transaction and increase successful transaction volumes.

This value is generated by the processor.

This field is available for card-present and card-not-present transactions for all card brands on .

These processors are supported for card-not-present transactions:

FDC Nashville Global

HSBC

These processors are supported for card-present transactions:

FDC Nashville Global

SIX

IMPORTANT

For FDC Nashville Global, this field is used in conjunction with

processorInformation.merchantAdvice.code

for Visa and Mastercard. See processorInformation. merchantAdvice.code to determine whether to retry a declined transaction. Retrying on a transaction with a value in this field which prohibits retries can incur a penalty from card companies.

IMPORTANT

SIX is currently not receiving Association/Issuer response codes. It receives an additional authorization code printed on the receipt when returned by the processor.

Possible Values

Association response codes are returned for the following card types.

FDC Nashville Global and HSBC: Visa:
000
: Successful approval/completion or that V.I.P. PIN verification is successful
001
: Refer to card issuer
002
: Refer to card issuer, special condition
003
: Invalid merchant or service provider
004
: Pickup card
005
: Do not honor
006
: Error
007
: Pickup card, special condition (other than lost/stolen card)
010
: Partial approval
011
: V.I.P. approval
012
: Invalid transaction
013
: Invalid amount (currency conversion field overflow); or amount exceeds maximum for card program
014
: Invalid account number (no such number)
015
: No such issuer
019
: Re-enter transaction
021
: No action taken (unable to back out prior transaction)
025
: Unable to locate record in file, or account number is missing from the inquiry
028
: File is temporarily unavailable
039
: No credit account
041
: Pickup card (lost card)
043
: Pickup card (stolen card)
046
: Closed account
051
: Insufficient funds
052
: No checking account
053
: No savings account
054
: Expired card
055
: Incorrect PIN
057
: Transaction not permitted to cardholder
058
: Transaction not allowed at terminal
059
: Suspected fraud
061
: Exceeds approval amount limit
062
: Restricted card (for example, in Country Exclusion table)
063
: Security violation
064
: Transaction does not fulfill AML requirement
065
: Exceeds withdrawal frequency limit
070
: PIN data required
075
: Allowable number of PIN-entry tries exceeded
076
: Unable to locate previous message (no match on retrieval reference number)
077
: Previous message located for a repeat or reversal, but repeat or reversal data inconsistent with original message
078
: “Blocked, first used”—Transaction from new cardholder, and card not properly unblocked
079
: Transaction reversed
080
: Visa transactions: credit issuer unavailable. Private label: invalid date
081
: PIN cryptographic error found (error found by VIC security module during PIN decryption)
082
: Negative Online CAM, dCVV, iCVV, or CVV results Or Offline PIN authentication interrupted
06P
: Verification data failed
085
: No reason to decline request for account number verification, address verification, CVV2 verification, or credit voucher or merchandise return
086
: Cannot verify
091
: Issuer unavailable or switch inoperative (STIP not applicable or available for this transaction). Issuers can respond with this code, which V.I.P. passes to the acquirer without invoking stand-in processing (STIP). Issuer processors use the code to indicate they cannot perform authorization on issuers’ behalf. Code causes decline at POS.
092
: Financial institution or intermediate network facility cannot be found for routing
093
: Transaction cannot be completed; violation of law
094
: Duplicate transaction. Transaction submitted containing values in tracing data fields that duplicate values in a previous transaction.
096
: System malfunction; System malfunction or certain field error conditions
01A
: Additional customer authentication required
0B1
: Surcharge amount not permitted on Visa cards (U.S. acquirers only)
0N0
: Force STIP
0N3
: Cash service not available
0N4
: Cashback request exceeds issuer limit
0N7
: Decline for CVV2 failure
0N8
: Transaction amount exceeds pre-authorized approval amount
0P2
: Invalid biller information
0P5
: PIN Change/Unblock request declined
0P6
: Unsafe PIN
0Q1
: Card authentication failed Or Offline PIN authentication interrupted
0R0
: Stop payment order
0R1
: Revocation of authorization order
0R3
: Revocation of all authorizations order
0Z3
: Unable to go online; declined
0XA
: Forward to issuer
0XD
: Forward to issuer

Mastercard:
000
: Approved or completed successfully
001
: Refer to card issuer
003
: Invalid merchant
004
: Capture card
005
: Do not honor
006
: Error
008
: Honor with ID
010
: Partial approval
012
: Invalid transaction
013
: Invalid amount
014
: Invalid card number
015
: Invalid issuer
017
: Customer cancellation
025
: Unable to locate record on file (no action taken)
026
: Record not in active status
027
: Issuer file update field edit error
028
: Record permanently deleted
029
: Delete request less than 540 days
030
: Format error
032
: Partial reversal
034
: Suspect Fraud
040
: Requested function not supported
041
: Lost card
043
: Stolen card
051
: Insufficient funds/over credit limit
054
: Expired card
055
: Invalid PIN
057
: Transaction not permitted to issuer/cardholder
058
: Transaction not permitted to acquirer/terminal
061
: Exceeds withdrawal amount limit
062
: Restricted card
063
: Security violation
065
: Exceeds withdrawal count limit OR Identity Check Soft-Decline of EMV 3DS Authentication (merchant should resubmit authentication with 3DSv1)
068
: Response received late
070
: Contact card issuer
071
: PIN not changed
075
: Allowable number of PIN tries exceeded
076
: Invalid/nonexistent "To Account" specified
077
: Invalid/nonexistent "From Account" specified
078
: Invalid/nonexistent account specified (general)
079
: Life cycle
080
: Duplicate add, action not performed
081
: Domestic debit transaction not allowed (Regional use only)
082
: Policy
083
: Fraud/Security
084
: Invalid authorization life cycle
085
: Not declined Valid for all zero amount transactions
086
: PIN validation not possible
087
: Purchase amount only, no cash back allowed
088
: Cryptographic failure
089
: Unacceptable PIN - Transaction declined - Retry
091
: Authorization platform or issuer system inoperative
092
: Unable to route transaction
094
: Duplicate transmission detected
096
: System error

American Express

000
: Approved
001
: Approve with ID
002
: Partial Approval (Prepaid Cards only)
100
: Deny
101
: Expired Card/Invalid Expiration Date
106
: Exceeded PIN attempts
107
: Please call issuer
109
: Invalid merchant
110
: Invalid amount
111
: Invalid account/Invalid MICR (Travelers Cheque)
115
: Requested function not supported
116
: Not sufficient funds
117
: Invalid PIN
119
: Card member not enrolled/not permitted
121
: Limit exceeded
122
: Invalid card security code (a.k.a, CID, 4DBC, 4CSC)
125
: Invalid effective date
130
: Additional customer identification required
181
: Format error
183
: Invalid currency code
187
: Deny - New card issued
189
: Deny - Canceled or Closed merchant/SE
193
: Invalid country code
200
: Deny - Pick up card
400
: Reversal accepted
900
: Accepted - ATC Synchronization
909
: System malfunction (Cryptographic error)
912
: Issuer not available

Discover:

000
: Approved or completed successfully
001
: Reserved for future USE
002
: Reserved for future USE
003
: Invalid merchant
004
: Capture card
005
: Do not honor
007
: Pick-up card, special condition
008
: Reserved for future USE
010
: Approved for partial amount
011
: Approved
012
: Invalid transaction
013
: Invalid amount
014
: Invalid card number
015
: Reserved for future USE
019
: Re-enter transaction
030
: Format error
031
: Bank not supported by switch
033
: Reserved for future USE
034
: Reserved for future USE
035
: Reserved for future USE
036
: Reserved for future USE
037
: Reserved for future USE
038
: Allowable PIN tries exceeded
039
: No credit account
040
: Requested function not supported
041
: Lost card
043
: Stolen card
051
: Decline
053
: No savings account
054
: Expired card
055
: Invalid PIN
056
: No card record
057
: Transaction not permitted to issuer/cardholder
058
: Transacton not permitted to acquirer/terminal
059
: Suspected fraud
060
: Card acceptor contact acquirer
061
: Exceeds withdrawal amount limit
062
: Restricted card
063
: Security violation
064
: Original amount incorrect
065
: Exceeds withdrawal count limit
066
: Card acceptor call acquirer's security dept
067
: Hard capture (requires ATM pick-up)
068
: Response received too late
075
: Allowable number of PIN tries exceeded
076
: Invalid/nonexistent "to" account specified
077
: Invalid/nonexistent "from" account specified
078
: Invalid/nonexistent account specified (general)
083
: Domain restriction controls failure
085
: No reason to decline
087
: Network unavailable
091
: Authorization system or Issuer system inoperative
092
: Unable to route transaction
093
: Transaction cannot be completed, violation of law
094
: Duplicate transmission detected
096
: System malfunction
01A
: Customer authentication required (Decline)
0N1
: System-up
0N2
: Soft down
0N3
: System down
0N7
: Decline for AVS or CID mismatch
0P5
: PIN change/unblock failed
0P6
: New PIN not accepted

Specifications

Data Type:
Integer

Data Length:
6

Mapping Information

REST API Field:

issuerInformation.responseCode

SCMP API Field:

issuer_response_code

Simple Order API Field:

issuer_responseCode

issuerInformation. serviceProcessingType

Type of service under which the transaction was processed.

Possible values:

00

: Normal transaction

A0

: Visa Alias Directory Service

Visa Platform Connect:
This field is returned for domestic original credit transactions (OCTs) in Moldova and Uzbekistan.

Specifications

Data Type:
String

Data Length:
2

Mapping Information

REST API Field:

issuerInformation.serviceProcessingType

SCMP API Field:

service_processing_type

Simple Order API Field:

OCTReply_serviceProcessingType

issuerInformation. transactionInformation

Information from the Discover or Mastercard network.

This field is available only on the Visa Platform Connect processor.

This field is used for processing industry-practice merchant-initiated token transactions with Discover, Diners Club, and Mastercard.

Set the value for this field to the value for the

processorInformation.transactionID

field that was in the response message when you obtained the customer's credentials.

When you use this field, you must also include the

processorInformation.cardReferenceData

field.

In a Mastercard response, this field includes the transaction link identifier for the first transaction of a transaction life cycle. You must include this field in linked requests for subsequent authorizations, authorization reversals, and refunds/follow-on credits.

Specifications

Data Type:
String

Data Length:

Discover: 29

Mastercard: 22

Mapping Information

REST API Field:

issuerInformation.transactionInformation

SCMP API Field:

payment_network_transaction_information

Simple Order API Field:

paymentNetworkTransactionInformation

issuerInformation. verificationType

Type of customer verification data you are requesting.

This field is available only for Mastercard installment payments in Poland on the Visa Platform Connect processor.

After receiving the authorization request, the issuer sends you the type of data you requested by means of a communication method or network that does not include Visa Platform Connect. Use the data to verify the customer's identity.

Possible values:

01

: Customer's personal data.

02

: Customer's age.

Specifications

Data Type:
String

Data Length:
2

Mapping Information

REST API Field:

issuerInformation.verificationType

SCMP API Field:

auth_verification_type

Simple Order API Field:

ccAuthService_verificationType

locale

Locale where Unified Checkout is being used. This field controls aspects of the application such as the language it will be rendered in.

Possible values:

ar_AE

ca_ES

cs_CZ

da_DK

de_AT

de_DE

el_GR

en_AU

en_CA

en_GB

en_IE

en_NZ

en_US

es_AR

es_CL

es_CO

es_ES

es_MX

es_PE

es_US

fi_FI

fr_CA

fr_FR

he_IL

hr_HR

hu_HU

id_ID

it_IT

ja_JP

km_KH

ko_KR

lo_LA

ms_MY

nb_NO

nl_NL

pl_PL

pt_BR

ru_RU

sk_SK

sv_SE

th_TH

tl_PH

tr_TR

vi_VN

zh_CN

zh_HK

zh_MO

zh_SG

zh_TW

Specifications

Data Type:
Enum

Mapping Information

REST API Field:

locale

Simple Order API Field:
No corresponding field.

make

Manufacturer of the point-of-sale (POS) terminal.

When sending a request, you must send either the

partName

field or both the

make

and

model

fields.

Valid values:

Ingenico

PAX

Verifone

Specifications

Data Type:
String

Data Length:
Pre-defined values

Mapping Information

REST API Field:

make

SCMP API Field:
No corresponding field

Simple Order API Field:
No corresponding field

merchantDefinedSecureInformation

These fields provide merchant defined secure information.

merchantDefinedSecureInformation[].key

merchantDefinedSecureInformation[].value

merchantDefinedSecureInformation[]. key

Name that you assign as the key for your merchant-defined secure data field.

This field is available only on the Visa Platform Connect processor.

You can pass up to four merchant-defined secure data fields in a single authorization request. To add merchant-defined secure data to a request, include an optional array of up to four name-value pairs. Visa Acceptance Solutions encrypts the data before storing it in the payments repository.

This topic describes the sequence of key fields from

merchantDefinedSecureInformation[1].key

through

merchantDefinedSecureInformation[4].key

.

IMPORTANT

When you include this field in the request, you must also include the corresponding

merchantDefinedSecureInformation[].value

field, which contains the secure value that corresponds to this field.

For each secure data field to be passed in the request, add two REST API fields in the form illustrated in this example:

"merchantDefinedSecureInformation": [
	{
		“key”: “1”,
		“value”: “XXXXXXXXXXXXXXXXXXXXXXXXXXXX5627::|6703611202308240110111111”
	},
	{
		“value”: “XXXXXXXXXXXXXXXXXXXXXXXXXXXX5627::|6703611202308240110222222”,
		“key”: “2” 
	},
	{
		“key”: “3”,
		“value”: “XXXXXXXXXXXXXXXXXXXXXXXXXXXX5627::|6703611202308240110333333”
	},
	{
		“key”: “4”,
		“value”: “XXXXXXXXXXXXXXXXXXXXXXXXXXXX5627::|6703611202308240110444444”
	}
]

Specifications

Data Type:
String

Data Length:
100

Mapping Information

No corresponding fields.

merchantDefinedSecureInformation[]. value

Merchant-defined secure data field to be passed in an authorization request.

This field is available only on the Visa Platform Connect processor.

You can pass up to four merchant-defined secure data fields in a single authorization request. To add merchant-defined secure data to a request, include an optional array of up to four name-value pairs. Visa Acceptance Solutions encrypts the data before storing it in the payments repository.

This topic describes the sequence of data fields from

merchantDefinedSecureInformation[1].value

through

merchantDefinedSecureInformation[4].value

.

IMPORTANT

When you include this field in the request, you must also include the corresponding

merchantDefinedSecureInformation[].key

field, which contains the key that corresponds to this field.

For each secure data field to be passed in the request, add two REST API fields in the form illustrated in this example:

"merchantDefinedSecureInformation": [
	{
		“key”: “1”,
		“value”: “XXXXXXXXXXXXXXXXXXXXXXXXXXXX5627::|6703611202308240110111111”
	},
	{
		“value”: “XXXXXXXXXXXXXXXXXXXXXXXXXXXX5627::|6703611202308240110222222”,
		“key”: “2” 
	},
	{
		“key”: “3”,
		“value”: “XXXXXXXXXXXXXXXXXXXXXXXXXXXX5627::|6703611202308240110333333”
	},
	{
		“key”: “4”,
		“value”: “XXXXXXXXXXXXXXXXXXXXXXXXXXXX5627::|6703611202308240110444444”
	}
]

Specifications

Data Type:
String

Data Length:
2048

Mapping Information

No corresponding fields.

merchantDefinedInformation

These fields provide merchant defined information.

merchantDefinedInformation[].key

merchantDefinedInformation[].value

merchantDefinedInformation[]. key

The number you assign as the key for your merchant-defined data field.

This topic describes the sequence of fields from

merchantDefinedInformation[0].key

through

merchantDefinedInformation[100].key

.

IMPORTANT

When you include this field in a request, you must also include the corresponding

merchantDefinedInformation[].value

field, which contains the value that corresponds to the

merchantDefinedInformation[].key

field.

WARNING

Merchant-defined data fields are not intended to and must not be used to capture personally identifying information. Accordingly, merchants are prohibited from capturing, obtaining, or transmitting any personally identifying information in or through the merchant-defined data fields. Personally identifying information includes, but is not limited to, address, payment card number, social security number, driver's license number, state-issued identification number, passport number, and card verification numbers (CVV, CVC2, CVV2, CID, CVN). In the event Visa Acceptance Solutions discovers that a merchant is capturing or transmitting personally identifying information through the merchant-defined data fields, whether or not intentionally, Visa Acceptance Solutions will immediately suspend the merchant's account, which will result in a rejection of any and all transaction requests submitted by the merchant after the point of suspension.

Payer Authentication

Only fields 1 through 5 are supported in Payer Authentication. The value appears in the Case Management Details window in the Business Center. The first four fields are the same fields that are used by the Secure Data services.

Visa Platform Connect

For installment payments with Mastercard in Brazil, use

merchantDefinedInformation[0].key

and

merchantDefinedData_mddField_2

merchantDefinedInformation[1].key

for data that you want to provide to the issuer to identify the transaction.

For installment payments with Mastercard in Brazil:

The value for

merchantDefinedInformation[0].key

corresponds to the following data in the TC 33 capture file:

Record: CP07 TCR5

Position: 25-44

Field: Reference Field 2

The value for

merchantDefinedInformation[1].key

corresponds to the following data in the TC 33 capture file:

Record: CP07 TCR5

Position: 45-64

Field: Reference Field 3

Specifications

Installment payments with Mastercard on Visa Platform Connect in Brazil:

Data Type:
String

Data Length:
20

All other transactions:

Data Type:
String

Data Length:
50

Mapping Information

REST API Field:

merchantDefinedInformation[].key

SCMP API Field:

merchant_defined_data1

through

merchant_defined_data100

Simple Order API Field:

merchantDefinedData_mddField_1

through

merchantDefinedData_mddField_100

merchantDefinedInformation[]. value

Any processor-specific information.

This field is intended for merchants to send additional information to the processor that is not included in any other API field.

WARNING

Do not include personally identifiable information (PII) in this field. Any merchant account that sends PII in this field will be suspended.

Specifications

Data Type:
String

Data Length:
255

Mapping

REST Field Name:

merchantDefinedInformation[].value

Simple Order Field Name:

merchantDefinedData_mddField_#

merchantInformation

These fields provide merchant information.

merchantInformation.cancelUrl

merchantInformation.cardAcceptorReferenceNumber

merchantInformation.categoryCode

merchantInformation.categoryCodeDomestic

merchantInformation.failureUrl

merchantInformation.merchantDescriptor.address1

merchantInformation.merchantDescriptor.administrativeArea

merchantInformation. merchantDescriptor.alternateName

merchantInformation. merchantDescriptor.contact

merchantInformation.merchantDescriptor.country

merchantInformation.merchantDescriptor.countryOfOrigin

merchantInformation.merchantDescriptor.county

merchantInformation.merchantDescriptor.customerServicePhoneNumber

merchantInformation.merchantDescriptor.locality

merchantInformation.merchantDescriptor.name

merchantInformation.merchantDescriptor.phone

merchantInformation.merchantDescriptor.postalCode

merchantInformation.merchantDescriptor.url

merchantInformation.merchantDomainName

merchantInformation.partnerId

merchantInformation.returnUrl

merchantInformation.salesOrganizationId

merchantInformation.serviceLocation.countryCode

merchantInformation.serviceLocation.countrySubdivisionCode

merchantInformation.serviceLocation.Locality

merchantInformation.serviceLocation.postalCode

merchantInformation.successUrl

merchantInformation.taxId

merchantInformation.transactionLocalDateTime

merchantInformation.vatRegistrationNumber

merchantInformation. cancelUrl

URL the customer is redirected to after cancelling a payment.

Make a GET request to this URL.

Specifications

Data Type:
String

Data Length:
255

Mapping Information

REST API Field:

merchantInformation.cancelUrl

SCMP API Field:

ap_initiate_cancel_url

Simple Order API Field:

apInitiateService_cancelURL

merchantInformation. cardAcceptorReferenceNumber

Reference number that facilitates card acceptor/corporation communication and record keeping.

This field is available only on the Visa Platform Connect
processor.

Specifications

Data Type:
String

Data Length:
25

Mapping Information

REST API Field:

merchantInformation.cardAcceptorReferenceNumber

SCMP API Field:

card_acceptor_ref_number

Simple Order API Field:

invoiceHeader_cardAcceptorRefNumber

Processor Field Names

This list provides the Level II/Level III processor field name for each processor that supports Level II or Level III data:

Visa Platform Connect: cardAcceptorRefNumber

merchantInformation. categoryCode

Four-digit number that the payment card industry uses to classify merchants into market segments.

A payment card company assigned one or more of these values to your business when you started accepting the payment card company’s cards.

When you do not include this field in a request, the value in your account is used.

Chase Paymentech Solutions: This field is optional for Mastercard or Visa card transactions that use the Payouts services. Note:
For a different combination of services, processors, or conditions, this field might be a required field.
Visa Platform Connect: This field is optional for aggregator transactions using Mastercard or Visa cards with the Payouts services.

The value for this field corresponds to the following data in the TC 33 capture file:
Record: CP01 TCR4
Position: 150-153
Field: Merchant Category Code

Specifications

Data Type:
Integer

Data Length:
4

Mapping Information

REST API Field:

merchantInformation.categoryCode

SCMP API Field:

merchant_category_code

Simple Order API Field:

merchantCategoryCode

merchantInformation. categoryCodeDomestic

Merchant category code for domestic transactions.

This field is available only on the Chase Paymentech Solutions, OmniPay Direct, and Visa Platform Connectprocessors.

The value for this field is a four-digit number that the payment card industry uses to classify merchants into market segments. A payment card company assigned one or more of these values to your business when you started accepting the payment card company’s cards. Including this field in a request for a domestic transaction might reduce interchange fees.

Visa Platform Connect: This field is available only for domestic transactions with Visa or Mastercard in Spain. Domestic means that you and the customer are in the same country.

When you include this field in a Visa request, you must also include the
merchantInformation.categoryCode
field.

When you include this field in a Mastercard request, including the
merchantInformation.categoryCode
field is optional.
Chase Paymentech Solutions: This field is available only for Payouts transactions. It is not supported for standard credit card transactions. It is optional for Mastercard and Visa transactions.
OmniPay Direct: Do not include the
merchantInformation.categoryCode
field. The value for this field overrides the value in your account.

This field is available only for:

Domestic transactions with Mastercard in Spain. Domestic means that you and the customer are in the same country.
Merchants enrolled in the OmniPay Direct interchange program.
First Data Merchant Solutions (Europe) on OmniPay Direct.

Specifications

Data Type:
Integer

Length:
4

Mapping Information

REST API Field:

merchantInformation.categoryCodeDomestic

SCMP API Field:

merchant_category_code_domestic

Simple Order API Field:

merchantCategoryCodeDomestic

merchantInformation. failureUrl

URL the customer is redirected to after a payment fails.

Make a GET request to this URL.

Specifications

Data Type:
String

Data Length:
255

Mapping Information

REST API Field:

merchantInformation.failureUrl

SCMP API Field:

ap_initiate_failure_url

Simple Order API Field:

apInitiateService_failureURL

merchantInformation. merchantDescriptor.address1

Street address for your business location.

This field is available on the Barclays and Visa Platform Connect processors.

Specify the value in US English characters. The address might appear on the cardholder’s statement.

IMPORTANT

This field might be ignored by your acquiring bank. Contact your acquiring bank for more information about overriding your default merchant descriptor.

When you include this value in your request, Visa Acceptance Solutions recommends that you also include these fields in the request:

merchantInformation.merchantDescriptor.country

(merchant descriptor country)

merchantInformation.merchantDescriptor.administrativeArea

(merchant descriptor state)

merchantInformation.merchantDescriptor.postalCode

(merchant descriptor postal code)

Visa Platform Connect: With Mastercard payment cards, the value for this field corresponds to this data in the TC 33 capture file:
Record: CP12 TCR2
Position: 35–82
Field: Acceptor Street Address

Specifications

Data Type:
String

Data Length

Barclays: 55

Visa Platform Connect: 29

IMPORTANT

If the value exceeds 29 characters, excess data is truncated before it is sent to Visa.

Mapping Information

REST API Field:

merchantInformation.merchantDescriptor.address1

SCMP API Field:

merchant_descriptor_street

Simple Order API Field:

invoiceHeader_merchantDescriptorStreet

merchantInformation. merchantDescriptor.administrativeArea

State code or region code for your business location.

Use the standard state, province, and territory codes for the US and Canada.

This field is available only for businesses located in the US or Canada.

This value must consist of English characters.

This value might be displayed on the cardholder’s statement.

IMPORTANT

This value might be ignored by your acquiring bank. Contact your acquiring bank for more information about overriding your default merchant descriptor.

When you do not include this value in your PIN debit request, the merchant state or province from your account is used.

Specifications

Data Type:
String

Data Length:
2

Mapping Information

REST API Field:

merchantInformation.merchantDescriptor.administrativeArea

SCMP API Field:

merchant_descriptor_state

Simple Order API Field:

invoiceHeader_merchantDescriptorState

merchantInformation. merchantDescriptor.alternateName

Alternate contact information for your business, such as an email address or URL.

This value might appear on the cardholder's statement.

For authorizations, this value is not sent to the processor. Instead, this value is stored and sent to the processor for captures and follow-on credits.

Specifications

Data Type:
String

Data Length:
13

Mapping Information

REST API Field:

merchantInformation.merchantDescriptor.alternateName

SCMP API Field:

merchant_descriptor_alternate

Simple Order API Field:

invoiceHeader_merchantDescriptorAlternate

merchantInformation. merchantDescriptor.contact

Contact information for your business.

This value must be the name of the city in which your store or outlet is located.

When you include more than one consecutive space, extra spaces are removed.

This value might be displayed on the cardholder’s statement.

IMPORTANT

This value might be ignored by your acquiring bank. Contact your acquiring bank for more information about overriding your default merchant descriptor.

Payouts: For Chase Paymentech Solutions, you must use one of the following formats:
PCCCCCCCCCCCC
NNN-NNN-NNNN
NNN-NNN-NAAA
NNN-NNN-AAAA
NNN-AAAAAAA

Each character in the format represents the following formatting:
A: Alphanumeric (alphabetical or numeric)
C: Character (alphabetical or blank)
N: Numeric
P: Alphabetical
Visa Platform Connect: With Mastercard, the value of this field corresponds to the following data in the TC 33 capture file:; Record: CP12 TCR4; Position: 5–30; Field: Acceptor Phone Number

Specifications

Data Type:
String

Data Length:
13

Mapping Information

REST API Field:

merchantInformation.merchantDescriptor.contact

SCMP API Field:

merchant_descriptor_contact

Simple Order API Field:

invoiceHeader_merchantDescriptorContact

merchantInformation. merchantDescriptor. country

Country code for your business location.

Use the two-character ISO country code. .

When you do not include this value in your request, Visa Acceptance Solutions uses the merchant country from your account.

This value must consist of English characters.

This value might be displayed on the cardholder’s statement.

IMPORTANT

Your acquiring bank might ignore this value. Contact your acquiring bank for more information about overriding your default merchant descriptor.

If your business is located in the US or Canada, and you include this field in a request, you must also include the

merchantInformation.merchantDescriptor.administrativeArea

field.

This field is required for a Payouts original credit transaction (OCT) service request that specifies a deferred OCT processing date and time. See the

processingInformation.payoutOptions.deferredDateTime

field.

To support Visa Direct transactions in OCTs destined for issuers in Australia or Canada, you must include additional merchant address data in the authorization request:

Field 43—Card Acceptor Name/Location

Field 59—National Point-of-Service Geographical Data

Field 104, Usage 2—Transaction-Specific Data in TLV format; Dataset ID 56—Additional Acceptance Information; Tag 81—Acceptor Legal Business Name

To process Faster Refund OCTs in Asia Pacific and Europe, include these fields in the request:

Transaction Type

Record: Field 3

Positions: 1-2

Transaction Amount

Record: Field 4

Card Acceptor Name or Location

Record: Field 43

Transaction Identifier

Record: Field 62.2 (in bitmap format)

Message Reason Code

Record: Field 63.3

Acceptor Legal Business Name

Record: 104, Usage 2—Transaction-Specific Data (in TLV format)

Dataset ID: 56

Tag: 81

Business Application Identifier (BAI)

Record: 104, Usage 2—Transaction-Specific Data (in TLV format)

Dataset ID: 57

Tag: 01

Visa Merchant Identifier

Record: 126.5

Barclays: For marketplace transactions, include this field and the
aggregatorInformation.subMerchant.country
field in the transaction request. The marketplace is the merchant, and the retailer is the sub‑merchant. When the field values do not match, the transaction is identified as a foreign retail transaction to the acquirer and the merchant can verify them in the Business Center on the transactions details page.

Specifications

Data Type:
String

Data Length:
2

Mapping Information

REST API Field:

merchantInformation.merchantDescriptor.country

SCMP API Fields:

merchant_descriptor_country

pa_merchant_country_code

Simple Order API Fields:

invoiceHeader_merchantDescriptorCountry

payerAuthEnrollService_merchantCountrycode

merchantInformation. merchantDescriptor.countryOfOrigin

Country of origin for your business.

Use the two-character ISO country code. .

IMPORTANT

This value must consist of English characters.

This field is available only for Mastercard on the FDC Nashville Global and Visa Platform Connect processors.

If you are a government-controlled merchant, ensure your Visa Acceptance Solutions account is enabled as a government-controlled merchant with the attribute

CFG : <proc>_governmentControlled

. You must include this field in authorization requests or ensure that your Visa Acceptance Solutions account includes the correct two-character ISO country code.

Specifications

Data Type:
String

Data Length:
2

Mapping Information

REST API Field:

merchantInformation.merchantDescriptor.countryOfOrigin

SCMP API Field:

merchant_descriptor_countryoforigin

Simple Order API Field:

invoiceHeader_merchantDescriptorCountryOfOrigin

merchantInformation. merchantDescriptor.county

County for your business location.

This field is available only on the Barclays and Visa Direct processors.

Visa Direct: You must send a three-digit numeric FIPS county code. For more information about FIPS county codes, see State and County Codes and Names.

Specifications

Data Type:
String

Data Length:
35

Visa Direct: 3

Mapping Information

REST API Field:

merchantInformation.merchantDescriptor.county

SCMP API Field: No corresponding field.

Simple Order API Field:

invoiceHeader_merchantDescriptorCounty

merchantInformation. merchantDescriptor.customerServicePhoneNumber

Customer service phone number for merchant.

Visa Platform Connect: With Mastercard, the value of this field corresponds to the following data in the TC 33 capture file:; Record: CP12 TCR2; Position: 92–107; Field: Acceptor Street Address

Specifications

Data Type:
String

Data Length:
27

Mapping Information

REST API Field:

merchantInformation.merchantDescriptor.customerServicePhoneNumber

SCMP API Field:

merchant_descriptor_customer_service_phone_number

Simple Order API Field:

invoiceHeader_merchantDescriptorCustomerServicePhoneNumber

merchantInformation. merchantDescriptor.locality

City for your business location.

This value might be displayed on the cardholder’s statement, and it must consist of US English characters.

IMPORTANT

This value might be ignored by your acquiring bank. Contact your acquiring bank for more information about overriding your default merchant descriptor.

If you do not include this value in your PIN debit request, Visa Acceptance Solutions uses the merchant city from your account.

For an original credit transaction (OCT), the only supported value is

Visa Direct

.

This field is available on the Barclays, FDC Compass, and Visa Platform Connect processors.

Specifications

Data Type:
String

Data Length

Barclays: 35

FDC Compass: 13

: 13

Visa Platform Connect: 13

Mapping Information

REST API Field:

merchantInformation.merchantDescriptor.locality

SCMP API Field:

merchant_descriptor_city

Simple Order API Field:

invoiceHeader_merchantDescriptorCity

merchantInformation. merchantDescriptor.name

Merchant business name.

This field should be the Doing Business As
name or the 1 to 4 digit abbreviation of the merchant name, and be the most recognizable name by the cardholder.

Specify the value in US English characters. The merchant business name is displayed on the cardholder’s statement. When the field contains more than one consecutive space, the extra spaces are removed.

When you use this field with Payer Authentication, the name that is specified in this field overrides the value that is specified by the merchant bank and that appears to the customer in the issuing bank's authentication form.

IMPORTANT

This value might be ignored by your acquiring bank. For more information about overriding your default merchant descriptor, contact your acquiring bank.

This field is available only on the Barclays, Chase Paymentech Solutions, FDC Compass, FDC Nashville Global, and Visa Platform Connect processors.

These processors have specific requirements:

Chase Paymentech Solutions: When using this field for Payouts, use one of these formats:

<12-character merchant name>*<9-character product description>
<7-character merchant name>*<14-character product description>
<3-character merchant name>*<18-character product description>
FDC Compass and Visa Platform Connect: When using this field for Payouts, set it as follows:

For a credit card bill payment, set the value for this field to the name of the originator providing the credit card bill payment service.
For a funds disbursement, set the value for this field to the name of the originator sending the funds disbursement.
For a prepaid load, set the value for this field to the name of the partner providing the reload service.
FDC Nashville Global: When you do not include this field in a PIN Debit request, Visa Acceptance Solutions uses the merchant name in your account.

Specifications

Data Type:
String

Data Length

AIBMS: 22

American Express Direct: 27

Barclays: 23

Chase Paymentech Solutions: 22

Cielo: 13

Comercio Latino: 13

Elavon: 22

Elavon Americas: 23

FDC Compass: 25

FDC Nashville Global: 25

Getnet: 14 for aggregator transactions; 22 for other transactions.

GPN: 22

OmniPay Direct: 23

Prosa: 22

Rede: 13

SIX: 23

TSYS Acquiring Solutions: 38 for American Express card type; 23 for all other card types.

Vero: 23

Visa Platform Connect: 25

Worldpay VAP: 22

Mapping Information

REST API Field:

merchantInformation.merchantDescriptor.name

SCMP API Fields:

merchant_descriptor

pa_merchant_name

Simple Order API Fields:

invoiceHeader_merchantDescriptor

payerAuthEnrollService_merchantName

merchantInformation. merchantDescriptor. phone

Merchant phone number.

This number is primarily used to provide a means of contact when customer make card-not-present transactions, for example online purchases.

Specifications

Data Type:
String

Data Length:
13

Mapping Information

REST API Field:

merchantInformation.merchantDescriptor.phone

Simple Order API Field:

No Corresponding Field.

merchantInformation. merchantDescriptor. postalCode

Postal code for your business location.

IMPORTANT

Mastercard requires a postal code for any country that uses postal codes. You can provide the postal code in your Visa Acceptance Solutions account or you can include this field in your request.

This value might be displayed on the cardholder’s statement.

IMPORTANT

This value may be ignored by your acquiring bank. Contact your acquiring bank for more information about overriding your default merchant descriptor.

If your business is located in the US, you can use a five-digit or nine-digit postal code. A nine-digit postal code must follow this format: [5 digits][dash][4 digits]

Example:
12345-6789

If your business is located in Canada, use a six-character postal code. A six-character postal code must follow this format: [alpha][numeric][alpha][space] [numeric][alpha][numeric]

Example:
A1B 2C3

When you do not include this value in a PIN debit request, the merchant postal code from your account is used.

This field is required for a Payouts original credit transaction (OCT) service request that specifies a deferred OCT processing date and time. See the

REST

processingInformation. payoutOptions. deferredDateTime

API field.

To support Visa Direct transactions in Original Credit Transactions destined to issuers in Australia or Canada, you must include additional merchant address data in the authorization request:

Field 43—Card Acceptor Name/Location

Field 59—National Point-of-Service Geographical Data

Field 104, Usage 2—Transaction-Specific Data in TLV format, Dataset ID 56—Additional Acceptance Information, Tag 81—Acceptor Legal Business Name

To process Faster Refund Original Credit Transactions (OCTs) in AP and the EU, include these fields in the request:

Transaction Type

Record: Field 3

Positions: 1-2

Transaction Amount

Record: Field 4

Card Acceptor Name or Location

Record: Field 43

Transaction Identifier

Record: Field 62.2 (in bitmap format)

Message Reason Code

Record: Field 63.3

Acceptor Legal Business Name

Record: 104, Usage 2—Transaction-Specific Data (in TLV format)

Dataset ID: 56

Tag: 81

Business Application Identifier (BAI)

Record: 104, Usage 2—Transaction-Specific Data (in TLV format)

Dataset ID: 57

Tag: 01

Visa Merchant Identifier

Record: 126.5

Specifications

Data Type:
String

Data Length:
14

Mapping Information

REST API Field:

merchantInformation.merchantDescriptor.postalCode

SCMP API Field:

merchant_descriptor_postal_code

Simple Order API Field:

invoiceHeader_merchantDescriptorPostalCode

merchantInformation. merchantDescriptor.url

Address of your company’s website, for example,

http://www.example.com.

This value overrides the value specified by your merchant bank.

Specifications

Data Type:
String

Data Length:
255

Mapping Information

REST API Field:

merchantInformation.merchantDescriptor.url

SCMP API Field:

pa_merchant_url

Simple Order API Field:

payerAuthEnrollService_merchantURL

merchantInformation. merchantDomainName

URL or reverse domain name for your business.

This field is available only for Mastercard digital secure remote payment (DSRP) transactions on the FDC Compass and Visa Platform Connect processors.

Visa Platform Connect: With Mastercard, the value of this field corresponds to the following data in the TC 33 capture file:; Record: CP12 TCR3; Position: 5–168; Field: Acceptor Street Address

Specifications

Data Type:
String

Data Length:
127

Special Symbols Allowed:

Forward slash (/)

Colon(:)

Period (.)

Mapping Information

REST API Field:

merchantInformation.merchantDomainName

SCMP API Field:

merchant_domain_name

Simple Order API Field:

merchantDomainName

merchantInformation. partnerId

Partner ID used for either co-branding agreement or promotional discounts.

Visa Platform Connect: With Mastercard, the value of this field corresponds to the following data in the TC 33 capture file:; Record: CP12 TCR4; Position: 56–63; Field: Acceptor Partner ID Code

Specifications

Data Type:
String

Data Length:
10

Mapping Information

REST API Field:

merchantInformation.partnerId

SCMP API Field:

merchant_partneridcode

Simple Order API Field:

invoiceHeader_merchantDescriptorPartnerIdCode

merchantInformation. returnUrl

URL of the web page to which the customer is directed when the transaction is completed.

This URL overrides the return URL that was specified during merchant boarding.

Specifications

Data Type:
String

Data Length:
256

Mapping Information

REST API Field:

merchantInformation.returnUrl

SCMP API Field:

ap_initiate_return_url

Simple Order API Field:

apInitiateService_returnURL

merchantInformation. salesOrganizationId

Company ID assigned to an independent sales organization.

This field is available only for the Visa Platform Connect, and Rede processors.

This field is available only for aggregator transactions. Get the value for this field from the payment card company.

Visa Platform Connect:
This field is required in an authorization request message for Discover transactions.

Visa Platform Connect

The value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCR6

Local date and time at your physical location.

Include both the date and time in this field or leave it blank.

Format:
yyyyMMDDhhmmss

MM = month

yyyy = year

DD = day

hh = hour

mm = minutes

ss = seconds

Card-Present Transactions on the Visa Platform Connect
Processor: In Argentina, you must either include this field in the request, or your account must include a time zone:
When you do not include this field, the value for this field is generated based on the time zone recorded in your account.
When you do not include this field, and no time zone is recorded in your account, the value for this field is generated based on GMT when the request is received.

The value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCR9
Position: 16-21
Field: Local Date

Specifications

Data Type:
String

Data Length:
14

Mapping Information

REST API Field:

merchantInformation.transactionLocalDateTime

SCMP API Field:

transaction_local_date_time

Simple Order API Fields:

ccIncrementalAuthService_transactionLocalDateTime

transactionLocalDateTime

merchantInformation. transactionLocalDateTime

The local time of when a transaction is processed.

The value must follow the ISO 8601 UTC format.

Format:

YYYYMMddTHHmmssZ

Example:

20151103T123456Z

Specifications

Data Type:
String

Data Length:
16

Mapping

REST Field Name:

merchantInformation.transactionLocalDateTime

Simple Order Field Name:

RequestMessage_transactionLocalDateTime

merchantInformation. vatRegistrationNumber

Value-added tax identification number.

This field applies only when you include one or more VAT seller registration numbers in the request. The VAT seller registration number might be required for some Canadian transactions.

This field is available on the Barclays, Chase Paymentech Solutions, Elavon Americas, FDC Compass, GPN, OmniPay Direct, , TSYS Acquiring Solutions, Visa Platform Connect, and Worldpay VAP processors.

Specifications

Data Type:
String

Data Length:
20

Data Type:
String

Data Length

Barclays: 13

Chase Paymentech Solutions: 13 (Payouts transactions)

Elavon Americas: 20

FDC Compass: 13 (Payouts transactions)

GPN: 20

OmniPay Direct: 21

: 20

TSYS Acquiring Solutions: 20

Visa Platform Connect: 13 (Payouts transactions), 20 (other transactions)

Worldpay VAP: 20

Mapping Information

REST API Field:

merchantInformation.vatRegistrationNumber

SCMP API Fields:

merchant_vat_registration_number

seller_registration

Simple Order API Fields:

invoiceHeader_merchantVATRegistrationNumber

item_#_sellerRegistration

taxService_sellerRegistration

model

Model of the point-of-sale device.

Valid values:

A60

A80

A920

Aries 6

Aries 8

D135

E355

E600

E700

E800

E800 lite

Lane 3000

Lane 5000

Link 2500

M400

P400

S80

S300

SP30

Specifications

Data Type:
String

Data Length:
Pre-defined values

Mapping Information

REST API Field:

model

SCMP API Field:
No corresponding field

Simple Order API Field:
No corresponding field

orderInformation

These fields provide order information.

orderInformation.amountDetails.amexAdditionalAmounts[N].amount

orderInformation.amountDetails.anticipatedAmount

orderInformation.amountDetails.authorizedAmount

orderInformation.amountDetails.billingAmount

orderInformation.amountDetails.cashbackAmount

orderInformation.amountDetails.currencyConversion. indicator

orderInformation.amountDetails.currency

orderInformation.amountDetails.discountAmount

orderInformation.amountDetails.discountPercent

orderInformation.amountDetails.dutyAmount

orderInformation.amountDetails.exchangeRate

orderInformation.amountDetails. exchangeRateTimeStamp

orderInformation.amountDetails.foreignAmount

orderInformation.amountDetails.foreignCurrency

orderInformation.amountDetails.freightAmount

orderInformation.amountDetails.freight.taxRate

orderInformation.amountDetails.freight.taxable

orderInformation.amountDetails.gratuityAmount

orderInformation.amountDetails. minimumPartialAmount

orderInformation.amountDetails.nationalTaxIncluded

orderInformation.amountDetails.originalAmount

orderInformation.amountDetails.originalCurrency

orderInformation.amountDetails.refundBalance

orderInformation.amountDetails.setUpFee

orderInformation.amountDetails.settlementAmount

orderInformation.amountDetails.settlementCurrency

orderInformation.amountDetails.subAmount

orderInformation.amountDetails.surcharge.amount

orderInformation.amountDetails.taxAmount

orderInformation.amountDetails.taxAppliedAfterDiscount

orderInformation.amountDetails.taxAppliedLevel

orderInformation.amountDetails.taxDetails[]. amount

orderInformation.amountDetails.taxDetails[].rate

orderInformation.amountDetails.taxDetails[].taxID

orderInformation.amountDetails.taxDetails[].type

orderInformation.amountDetails.taxTypeCode

orderInformation.amountDetails.totalAmount

orderInformation.billTo.address1

orderInformation.billTo.address2

orderInformation.billTo.address3

orderInformation.billTo.address4

orderInformation.billTo.administrativeArea

orderInformation.billTo.alternateEmailAddress

orderInformation.billTo.alternateEmailVerificationStatus

orderInformation.billTo.alternatePhoneNumberVerificationStatus

orderInformation.billTo.alternatePhoneNumber

orderInformation.billTo.buildingNumber

orderInformation.billTo.company.address1

orderInformation.billTo.company.address2

orderInformation.billTo.company.city

orderInformation.billTo.company.country

orderInformation.billTo.company.name

orderInformation.billTo.company.phoneNumber

orderInformation.billTo.company.postalCode

orderInformation.billTo.company.state

orderInformation.billTo.company

orderInformation.billTo.country

orderInformation.billTo.county

orderInformation.billTo.district

orderInformation.billTo.email

orderInformation.billTo.firstName

orderInformation.billTo.lastName

orderInformation.billTo.locality

orderInformation.billTo.middleName

orderInformation.billTo.namePrefix

orderInformation.billTo.nameSuffix

orderInformation.billTo.phoneNumber

orderInformation.billTo.postalCode

orderInformation.billTo.title

orderInformation.exemptAmount

orderInformation.invoiceDetails.commodityCode

orderInformation.invoiceDetails.costCenter

orderInformation.invoiceDetails.invoiceDate

orderInformation.invoiceDetails.merchandiseCode

orderInformation.invoiceDetails. purchaseContactName

orderInformation.invoiceDetails.purchaseOrderDate

orderInformation.invoiceDetails.purchaseOrderNumber

orderInformation.invoiceDetails.referenceDataCode

orderInformation.invoiceDetails.referenceDataNumber

orderInformation.invoiceDetails.supplierOrderReference

orderInformation.invoiceDetails.taxable

orderInformation.invoiceDetails.transactionAdviceAddendum[].data

orderInformation.invoiceDetails.vatInvoiceReferenceNumber

orderInformation.isCryptocurrencyPurchase

orderInformation.lineItems[].allowedExportCountries[]

orderInformation.lineItems[].amountIncludesTax

orderInformation.lineItems[].commodityCode

orderInformation.lineItems[].discountAmount

orderInformation.lineItems[].discountApplied

orderInformation.lineItems[].discountRate

orderInformation.lineItems[].distributorProductSku

orderInformation.lineItems[].exemptAmount

orderInformation.lineItems[].invoiceNumber

orderInformation.lineItems[].jurisdiction[].code

orderInformation.lineItems[].jurisdiction[]. country

orderInformation.lineItems[].jurisdiction[].name

orderInformation.lineItems[].jurisdiction[].rate

orderInformation.lineItems[].jurisdiction[]. region

orderInformation.lineItems[].jurisdiction[]. taxAmount

orderInformation.lineItems[].jurisdiction[]. taxName

orderInformation.lineItems[].jurisdiction[]. taxable

orderInformation.lineItems[].jurisdiction[].type

orderInformation.lineItems[].orderAcceptance. administrativeArea

orderInformation.lineItems[].orderAcceptance.country

orderInformation.lineItems[].orderAcceptance.locality

orderInformation.lineItems[].orderAcceptance.postalCode

orderInformation.lineItems[].orderOrigin.administrativeArea

orderInformation.lineItems[].orderOrigin.country

orderInformation.lineItems[].orderOrigin.locality

orderInformation.lineItems[].orderOrigin.postalCode

orderInformation.lineItems[].passenger.email

orderInformation.lineItems[].passenger.firstName

orderInformation.lineItems[].passenger.id

orderInformation.lineItems.passenger.lastName

orderInformation.lineItems[].passenger.nationality

orderInformation.lineItems[].passenger.phone

orderInformation.lineItems[].passenger.status

orderInformation.lineItems[].passenger.type

orderInformation.lineItems[].productCode

orderInformation. lineItems[].productDescription

orderInformation.lineItems[].productName

orderInformation.lineItems[].productSku

orderInformation.lineItems[].quantity

orderInformation.lineItems[].referenceDataCode

orderInformation.lineItems[]. referenceDataNumber

orderInformation.lineItems[].restrictedExportCountries[]

orderInformation.lineItems[].shippingAddress1

orderInformation.lineItems[].shippingAddress2

orderInformation.lineItems[].shippingCity

orderInformation.lineItems[].shippingCountryCode

orderInformation.lineItems.shippingDestinationTypes

orderInformation.lineItems[].shippingFirstName

orderInformation.lineItems[].shippingLastName

orderInformation.lineItems[].shippingMiddleName

orderInformation.lineItems[].shippingPhone

orderInformation.lineItems[].shippingPostalCode

orderInformation.lineItems[].shippingState

orderInformation.lineItems[].taxAmount

orderInformation.lineItems[].taxAppliedAfterDiscount

orderInformation.lineItems[].taxDetails[].amount

orderInformation.lineItems[].taxDetails[].applied

orderInformation.lineItems[].taxDetails[].code

orderInformation.lineItems[].taxDetails[].rate

orderInformation.lineItems[].taxDetails[].taxID

orderInformation.lineItems[].taxDetails[].type

orderInformation.lineItems[].taxRate

orderInformation.lineItems[].taxStatusIndicator

orderInformation.lineItems[].taxTypeCode

orderInformation.lineItems[].taxableAmount

orderInformation.lineItems[].totalAmount

orderInformation.lineItems[].typeOfSupply

orderInformation.lineItems[].unitOfMeasure

orderInformation.lineItems[].unitPrice

orderInformation.lineItems[].weight

orderInformation.lineItems[].weightIdentifier

orderInformation.lineItems[].weightUnit

orderInformation.reordered

orderInformation.returnsAccepted

orderInformation.rewardPointsDetails. pointsAfterRedemption

orderInformation.rewardPointsDetails. pointsBeforeRedemption

orderInformation.rewardPointsDetails.pointsRedeemed

orderInformation.rewardPointsDetails. pointsValueAfterRedemption

orderInformation.rewardPointsDetails. pointsValueBeforeRedemption

orderInformation.rewardPointsDetails. pointsValueRedeemed

orderInformation.shippingDetails.giftWrap

orderInformation.shippingDetails.shipFromAdministrativeArea

orderInformation.shippingDetails.shipFromCountry

orderInformation.shippingDetails.shipFromLocality

orderInformation.shippingDetails.shipFromPostalCode

orderInformation.shippingDetails.shippingMethod

orderInformation.shipTo.address1

orderInformation.shipTo.address2

orderInformation.shipTo.address3

orderInformation.shipTo.address4

orderInformation.shipTo.administrativeArea

orderInformation.shipTo.buildingNumber

orderInformation.shipTo.company

orderInformation.shipTo.country

orderInformation.shipTo.administrativeArea

orderInformation.shipTo.destinationCode

orderInformation.shipTo.destinationTypes

orderInformation.shipTo.district

orderInformation.shipTo.email

orderInformation.shipTo.firstName

orderInformation.shipTo.lastName

orderInformation.shipTo.locality

orderInformation.shipTo.middleName

orderInformation.shipTo.phoneNumber

orderInformation.shipTo.postalCode

orderInformation.shipTo.address1

orderInformation.shipTo.address2

orderInformation.taxAmount

orderInformation.taxDetails[].amount

orderInformation.taxDetails[].type

orderInformation.taxableAmount

orderInformation.totaloffersCount

orderInformation. amountDetails.amexAdditionalAmounts[N]. amount

Additional amount.

This field is available only on the American Express Direct processor.

Array

of fields from

orderInformation.amountDetails.amexAdditionalAmounts[0].amount

to

orderInformation.amountDetails.amexAdditionalAmounts[4].amount

.

Specifications

Data Type:
String

Data Length:
12

Mapping Information

REST API Fields:

orderInformation.amountDetails.amexAdditionalAmounts[0].amount

through

orderInformation.amountDetails.amexAdditionalAmounts[4].amount

SCMP API Fields:

additional_amount0

through

additional_amount4

Simple Order API Fields:

purchaseTotals_additionalAmount0

through

purchaseTotals_additionalAmount4

orderInformation. amountDetails.amexAdditionalAmounts[N]. code

Additional amount type.

This field is available only on the American Express Direct processor.

Array

of fields from

orderInformation.amountDetails.amexAdditionalAmounts[0].code

to

orderInformation.amountDetails.amexAdditionalAmounts[4].code

.

Specifications

Data Type:
String

Data Length:
3

Mapping Information

REST API Fields:

orderInformation.amountDetails.amexAdditionalAmounts[0].code

through

orderInformation.amountDetails.amexAdditionalAmounts[4].code

SCMP API Fields:

additional_amount_type0

through

additional_amount_type4

Simple Order API Fields:

purchaseTotals_additionalAmountType0

through

purchaseTotals_additionalAmountType4

orderInformation. amountDetails.anticipatedAmount

The amount that is expected to be charged in the transaction.

Visa Platform Connect: This field is required for zero amount authorizations in order to confirm the amount is available for future authorizations.

Specifications

Data Type:
Numeric

Data Length:
15

Mapping Information

REST API Field:

orderInformation.amountDetails.anticipatedAmount

SCMP API Field:

anticipated_amount

Simple Order API Field:

purchaseTotals_anticipatedAmount

orderInformation. amountDetails.authorizedAmount

Amount of the purchase.

Specifications

Data Type:
String

Data Length:
15

Mapping Information

REST API Field:

orderInformation.amountDetails.authorizedAmount

SCMP API Fields:

auth_auth_amount

incremental_auth_amount

pin_debit_purchase_auth_amount

Simple Order API Fields:

ccAuthReply_amount

ccIncrementalAuthReply_amount

pinDebitPurchaseReply_amount

orderInformation. amountDetails.billingAmount

Amount charged during the billing period.

Specifications

Data Type:
String

Data Length:
19

Mapping Information

REST API Field:

orderInformation.amountDetails.billingAmount

SCMP API Field:
No corresponding field.

Simple Order API Field:
No corresponding field.

orderInformation. amountDetails.cashbackAmount

Cashback amount requested by the customer.

The value for this field must be in the acquirer’s currency.

Card-Present Credit Card Transactions: This field is available only on the Visa Platform Connect processor in Germany.

The value for this field corresponds to this data in the TC 33 capture file:

Record: CP01 TCR8
Position: 15-23
Field: Cashback Amount

The TC 33 capture file contains information about the payments and credits that a merchant submits to Visa Acceptance Solutions. The processor creates the TC 33 capture file at the end of the day and sends it to the merchant’s acquirer. The acquirer uses this information to facilitate end-of-day clearing processing with payment networks.
PIN Debit Transactions: This field is available only on the FDC Nashville Global and Visa Platform Connect processors.

When a cashback amount is included in a request, the cashback amount must be included in the value for the
orderInformation.amountDetails.totalAmount
field.

Specifications

Data Type:
String

Data Length:

Authorization: 9

Authorization Reversal: 9

PIN Debit Purchase: 13

Mapping Information

REST API Field:

orderInformation.amountDetails.cashbackAmount

SCMP API Field:

cashback_amount

Simple Order API Field:

cashbackAmount

orderInformation. amountDetails.currencyConversion. indicator

Enables Dynamic Currency Conversion during an authorization.

Available values:

N
: Not enabled (default)

Y
: Enabled

Syntax

This syntax is used with this field:

{
  "currencyConversion": {
    "indicator": "Y"
  }
}

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

orderInformation.amountdetails.currencyConversion.indicator

SCMP API Field:

dcc_indicator

Simple Order API Field:

dcc_dccIndicator

orderInformation. amountDetails.currency

Currency used in the transaction.

Use a three-character ISO currency code. For a list of ISO currency codes, see ISO Standard Currency Codes.

For authorization reversal or capture services, you must use the same currency that was used for the authorization.

For the PIN debit reversal service, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.

When using Dynamic Currency Conversion (DCC) with a Third-Party Provider, use the customer’s billing currency.

: For Mastercard installment payments in Peru, the value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCR5
Position: 108-110
Field: Financing Currency

Specifications

Data Type:
String

Data Length:
3

Mapping Information

REST API Fields:

orderInformation.amountDetails.currency

creditAmountDetails.currency

refundAmountDetails.currency

reversalAmountDetails.currency

reversalInformation.amountDetails.currency

SCMP API Fields:

auth_request_currency

currency

pin_debit_purchase_request_currency

Simple Order API Fields:

ccAuthReply_requestCurrency

pinDebitPurchaseReply_requestCurrency

purchaseTotals_currency

orderInformation. amountDetails.discountAmount

The total discount applied to the order.

Example: A $20.00 discount off the order total.

:
The discount amount cannot exceed 999999.99.

Specifications

Data Type:

Chase Paymentech Solutions, FDC Compass, TSYS Acquiring Solutions, FDC Nashville Global, and Worldpay VAP: String

Elavon Americas GPN OmniPay Direct and Visa Platform Connect: Numeric String

Data Length:

Chase Paymentech Solutions, FDC Compass, and TSYS Acquiring Solutions:13

FDC Nashville Global: 11

and Worldpay VAP: 8

Elavon Americas, GPN, OmniPay Direct, and Visa Platform Connect: 12

Mapping Information

REST API Field:

orderInformation.amountDetails.discountAmount

SCMP API Field:

order_discount_amount

Simple Order API Field:

purchaseTotals_discountAmount

Processor Field Names

Processor-specific field names for each processor supporting this field for Level II or Level III processing:

Chase Paymentech Solutions:
Discount Amount Applied to Order

Elavon Americas:
Discount Amount

FDC Compass:
Discount Amount Applied to Order

FDC Nashville Global:
Discount Amount

GPN:
Discount Amount

OmniPay Direct:
Discount Amount / Total Discount

:
Discount Amount

TSYS Acquiring Solutions:
Discount Amount

Visa Platform Connect:
discountAmount

Worldpay VAP:
discountAmount

orderInformation. amountDetails. discountPercent

The total discount percentage applied to the invoice.

Specifications

Data Type:
Number

Data Length:
7

Mapping

REST Field Name:

orderInformation.amountDetails.discountPercent

Simple Order Field Name:
No corresponding field.

orderInformation. amountDetails.dutyAmount

Total charges for any import or export duties included in the order.

FDC Nashville Global: This value cannot be negative.
GPN: The maximum value for this field is: 99,999.99.

Specifications

Data Length:

Chase Paymentech Solutions, FDC Compass:

Mastercard: 10

Visa: 13

Elavon Americas, GPN, OmniPay Direct, Visa Platform Connect: 12

FDC Nashville Global: 11

and Worldpay VAP: 8

TSYS Acquiring Solutions: 13

Mapping Information

REST API Field:

orderInformation.amountDetails.dutyAmount

SCMP API Field:

duty_amount

Simple Order API Field:

purchaseTotals_dutyAmount

Processor Field Names

This list provides the Level II/Level III processor field name for each processor that supports Level II or Level III data:

Chase Paymentech Solutions: Duty Amount

Elavon Americas: Duty Amount

FDC Compass: Duty Amount

FDC Nashville Global: Duty Amount

GPN: Duty Amount

OmniPay Direct: Duty Amount

: Duty Amount

TSYS Acquiring Solutions: Duty Amount

Visa Platform Connect: dutyAmount

Worldpay VAP: dutyAmount

orderInformation. amountDetails. exchangeRate

Exchange rate returned by the Dynamic Currency Conversion (DCC) service provider.

The value for this field includes a decimal point and a maximum of four decimal places.

Specifications

Data Type:
String

Data Length:
13

Mapping Information

REST API Field:

orderInformation.amountDetails.exchangeRate

SCMP API Field:

exchange_rate

Simple Order API Field:

purchaseTotals_exchangeRate

orderInformation. amountDetails. exchangeRateTimeStamp

The time stamp returned by a Dynamic Currency Conversion provider when a conversion request is made. This value is set to GMT.

Specifications

When you include this field in your request, you must also include the

orderInformation.amountDetails.totalAmount

field.

OmniPay Direct: For Level III transacations with Visa, the field value is set to 0 when this field is not included in the request.

Specifications

Data Type:
String

Data Length:
8

Data Length:

Chase Paymentech Solutions:
10 (Mastercard), 13 (Visa)

FDC Compass:
10 (Mastercard), 13 (Visa)

FDC Nashville Global:
13

:
8

Worldpay VAP:
8

TSYS Acquiring Solutions:
13

All other processors:
12

Mapping Information

REST API Field:

orderInformation.amountDetails.freightAmount

SCMP API Field:

freight_amount

Simple Order API Field:

purchaseTotals_freightAmount

Processor Field Names

The following list the processors and the corresponding processor field mapped to this field:

Chase Paymentech Solutions:
Freight Amount

Elavon Americas:
Freight/Shipping Amount

FDC Compass:
Freight Amount

FDC Nashville Global:
Freight Amount

GPN:
Freight Amount

OmniPay Direct:
Freight Amount / Shipping Amount

:
Freight Amount

TSYS Acquiring Solutions:
Freight Amount

:
freightAmount

Worldpay VAP:
shipping amount

orderInformation. amountDetails. freight.taxable

The indicator for whether or not an order is taxable.

The value must be set to

true

if the total sum of all of the values included in

orderInformation.lineItems[].taxAmount

request field are great than

0

.

Possible values:

false

: The order is not taxable.

true

: The order is taxable.

Specifications

Data Type:
Boolean

Data Length:
5

Mapping

REST Field Name:

orderInformation.amountDetails.freight.taxable

Simple Order Field Name:
No corresponding field.

orderInformation. amountDetails. freight. taxRate

The shipping tax rate applied to the charged freight amount.

Specifications

Data Type:
String

Data Length:
7

Mapping

REST Field Name:

orderInformation.amountDetails.freight.taxRate

Simple Order Field Name:
No corresponding field.

orderInformation. amountDetails.gratuityAmount

Gratuity or tip amount for restaurants when the card is present.

Allowed only when the

orderInformation.amountDetails.gratuityAmount

field value is

restaurant

.

Restaurant data is available only on the Visa Platform Connect processor.

When your customer uses a debit card or prepaid card, and you receive a partial authorization, the payment networks recommend that you do not submit a capture amount that is higher than the authorized amount. When the capture amount exceeds the partial amount that was approved, the issuer has chargeback rights for the excess amount.

Specifications

Data Type:
String

Data Length:
12

Mapping Information

REST API Field:

orderInformation.amountDetails.gratuityAmount

SCMP API Field:

gratuity_amount

Simple Order API Field:

ccCaptureService_gratuityAmount

orderInformation. amountDetails. minimumPartialAmount

The minimum partial amount required to be paid for the invoice.

Specifications

Data Type:
Number

Data Length:
25

Mapping

REST Field Name:

orderInformation.amountDetails.minimumPartialAmount

Simple Order Field Name:
No corresponding field.

orderInformation. amountDetails.nationalTaxIncluded

Flag that indicates whether a national tax is included in the order total.

Possible values:

0

: national tax not included

1

: national tax included

This value must be 1 if the sum of all

orderInformation.lineItems[].taxDetails[].amount

values > 0.

If you do not include any

orderInformation.lineItems[].taxDetails[].amount

values in your request, Visa Acceptance Solutions does not include in the data it sends to the processor.

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

orderInformation.amountDetails.nationalTaxIncluded

SCMP API Field:

national_tax_indicator

Simple Order API Field:

otherTax_nationalTaxIndicator

Processor Field Names

This list provides the Level II/Level III processor field name for each processor that supports Level II or Level III data:

Elavon Americas: National / Alternate Tax Included

OmniPay Direct: National Tax Included

TSYS Acquiring Solutions: National Tax Included Flag

Visa Platform Connect: nationalTaxIncluded

orderInformation. amountDetails.originalAmount

The purchase amount denominated in the local currency, when the

orderInformation.amountDetails.totalAmount

field is denominated in the customer's billing currency.

This field is available only for the Dynamic Currency Conversion service.

This value cannot be negative. You can include a decimal point (.) in this field to denote the currency exponent, but you cannot include any other special characters. If needed, the amount is truncated to the correct number of decimal places.

Specifications

Data Type:
String

Data Length:
15

Mapping Information

REST API Field:

orderInformation.amountDetails.originalAmount

SCMP API Field:

original_amount

Simple Order API Field:

purchaseTotals_originalAmount

orderInformation. amountDetails.originalCurrency

The local billing currency, when the

orderInformation.amountDetails.totalCurrency

field is set the customer's billing currency.

This field is available only for the Dynamic Currency Conversion service.

Specifications

Data Type:
String

Data Length:
5

Mapping Information

REST API Field:

orderInformation.amountDetails.originalCurrency

SCMP API Field:

original_currency

Simple Order API Field:

purchaseTotals_originalCurrency

orderInformation. amountDetails.serviceFeeAmount

orderInformation. amountDetails.setUpFee

The subscription set-up fee charged by the merchant.

Specifications

Data Type:
String

Data Length:
19

Mapping Information

REST API Field:

orderInformation.amountDetails.setUpFee

SCMP API Field:
No corresponding field.

Simple Order API Field:
No corresponding field.

orderInformation. amountDetails. subAmount

The sub-amount of the invoice.

Specifications

Data Type:
Number

Data Length:
25

Mapping

REST Field Name:

orderInformation.amountDetails.subAmount

Simple Order Field Name:
No corresponding field.

orderInformation. amountDetails.surcharge.amount

Surcharge amount that you are charging the customer for the transaction.

This field is available on the FDC Nashville Global, Worldpay VAP, and Visa Platform Connect processors.

The surcharge amount is included in the total transaction amount but is passed in a separate field to the issuer and acquirer for tracking. The issuer can provide information about the surcharge amount to the customer.

Visa Platform Connect: Canada Card-Present Transactions

Merchants in Canada must include surcharge information in authorization requests for card-present transactions.

Acquirers that have merchants in Canada must support this surcharge data in the TC 33 capture file:

Record: CP01 TCR8
Position: 13
Field: Surcharge credit/debit indicator

The TC 33 capture file contains information about the payments and credits that a merchant submits to Visa Acceptance Solutions. The processor creates the TC 33 capture file at the end of the day and sends it to the merchant’s acquirer. The acquirer uses this information to facilitate end-of-day clearing processing with payment networks.; PIN Debit Transactions

Include the surcharge amount in the value for
orderInformation.amountDetails.totalAmount
.

FDC Nashville Global: US Credit Card Transactions

The surcharge amount can be applied to card-present and card-not-present transactions on credit cards in the US. Support includes the surcharge API calls but the specific network rules are out of scope and the merchant may be subject to non-compliance assessments if surcharging is improperly applied.

Prior Approval Required

You must receive prior approval from Fiserv before assessing a surcharge amount. Contact Fiserv to register with the card brands to participate in the surcharge program. You will be required to sign a surcharging contract or addendum with Fiserv.

Worldpay VAP: Prior Notification Required for Worldpay VAP

The surcharge amount field can only be applied to Visa or Mastercard credit card payments. You must notify the card networks and acquirer of your intent to apply surcharges at least 30 days prior to assessing the surcharges. Contact the Worldpay VAP customer service manager to request the surcharge feature. Worldpay VAP must enable a flag to process the surcharge field, otherwise the transaction will fail.

Specifications

Data Type:
String

Data Length:
15

Mapping Information

REST API Field:

orderInformation.amountDetails.surcharge.amount

SCMP API Field:

surcharge_amount

Simple Order API Field:

surchargeAmount

orderInformation. amountDetails.taxAmount

Total tax amount for all items.

This field is available only on the American Express Direct and Barclays processors.

Specifications

Data Type:
String

Data Length

Canadian dollars (CAD): 7

US dollars (USD): 9

Mapping Information

REST API Field:

orderInformation.amountDetails.taxAmount

SCMP API Field:

total_tax_amount

Simple Order API Field:

purchaseTotals_taxAmount

Processor Field Names

This list provides the Level II/Level III processor field name for each processor that supports Level II or Level III data:

American Express Direct: Does not apply

orderInformation. amountDetails.taxAppliedAfterDiscount

Flag that indicates how the merchant manages discounts.

This field is available only on the Visa Platform Connect processor.

Possible values:

0

: no invoice level discount included

1

: tax calculated on the post-discount invoice total

2

: tax calculated on the pre-discount invoice total

This field relates to the value in the

orderInformation.amountDetails.discountAmount

field.

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

orderInformation.amountDetails.taxAppliedAfterDiscount

SCMP API Field:

order_discount_management_indicator

Simple Order API Field:

purchaseTotals_discountManagementIndicator

Processor Field Names

This list provides the Level II/Level III processor field name for each processor that supports Level II or Level III data:

Visa Platform Connect: discountManagementIndicator

orderInformation. amountDetails.taxAppliedLevel

Indicates how tax is calculated.

This field is available only on the Visa Platform Connect processor.

Possible values:

0

: Net prices with tax calculated at the line item level.

1

: Net prices with tax calculated at the invoice level.

2

: Gross prices with tax provided at the line item level.

3

: Gross prices with tax provided at the invoice level.

4

: No tax applied on the invoice for the transaction.

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

orderInformation.amountDetails.taxAppliedLevel

SCMP API Field:

tax_management_indicator

Simple Order API Field:

taxManagementIndicator

Processor Field Names

This list provides the Level II/Level III processor field name for each processor that supports Level II or Level III data:

Visa Platform Connect: taxManagementIndicator

orderInformation. amountDetails.taxDetails[]. amount

Amount of national tax or value added tax for countries in which more than one tax is applied to an order.

Provide this value if

orderInformation.lineItems[].taxDetails[].amount

differs from

orderInformation.lineItems[].taxAmount

. If you do not provide this value, Visa Acceptance Solutions assumes that

orderInformation.lineItems[].taxDetails[].amount

is equal to

orderInformation.lineItems[].taxAmount

.

: The value of this field cannot exceed
999999.99
.
FDC Nashville Global: The total should not include the local tax amount ( field) and national tax (
national_tax
field) incluced in the total tax (
tax_amount
field).
GPN: The maximum amount is 99,999.99.
: The maximum amount is 99,999.99.
OmniPay Direct: When you include this field in the request, you must also include the
orderInformation.lineItems[].taxAmount
field in the request.

Specifications

Data Type:
String

Data Length:

Chase Paymentech Solutions, FDC Compass, TSYS Acquiring Solutions: 10

FDC Nashville Global: 11

Elavon Americas, GPN, OmniPay Direct: 12

: 8

Mapping Information

REST API Fields
:

orderInformation.amountDetails.taxDetails[].amount

SCMP API Fields:

alternate_tax_amount

national_tax

vat_tax_amount

Simple Order API Fields:

otherTax_alternateTaxAmount

otherTax_nationalTaxAmount

otherTax_vatTaxAmount

Processor Field Names

This list identifies the processors using this field and the corresponding processor field name:

Chase Paymentech Solutions:
Alternate Tax Amount or VAT/Tax Amount

Elavon Americas:
National/Alternate Tax, Other Tax and VAT / Tax Amount (freight)

FDC Compass:
Alternate Tax Amount and VAT/Tax Amount

FDC Nashville Global:
Other Tax Amount and VAT/Tax Amount

GPN:
National Tax, Other Tax and VAT/Tax Amount (Freight/Shipping)

OmniPay Direct:
National Tax and VAT (Amount)

:
VAT Tax Amount

TSYS Acquiring Solutions:
National Tax Amount, Alternate Tax Amount and VAT/Tax Amount

orderInformation. amountDetails.taxDetails[]. rate

The Value Added Tax (VAT) or other tax rate used to calculate the tax applied to the order.

This field is available only on the Chase Paymentech Solutions, Elavon Americas, FDC Compass, FDC Nashville Global, GPN, Visa Platform Connect, OmniPay Direct, , TSYS Acquiring Solutions processors.

and TSYS Acquiring Solutions: The valid range is between 0.01 and 99.99 percent. The rate is entered as a decimal. For example:
60%:
0.6000
33.33%:
0.3333
25.5%:
0.2550
Visa Platform Connect: The valid range is between 0.01 and 99.99 percent. The rate is entered as a percentage. For example:
60%:
60.00
33.33%:
33.33
25.5%:
25.50
Chase Paymentech Solutions , Elavon Americas , FDC Compass , FDC Nashville Global , GPN , and OmniPay Direct: The valid range is between 1 and 99 percent. The rate is entered as a decimal. For example:
60%:
0.60
33%:
0.33
25%:
0.25

Specifications

Chase Paymentech Solutions, Elavon Americas, GPN, Visa Platform Connect, FDC Compass, and OmniPay Direct:

Data Type:
String

Data Length:
4

FDC Nashville Global:

Data Type:
String

Data Length:
5

:

Data Type:
Numeric

Data Length:
4

TSYS Acquiring Solutions:

Data Type:
String

Data Length:
6

Mapping Information

REST API Field:

orderInformation.amountDetails.taxDetails[].rate

SCMP API Fields:

other_tax#_rate

vat_rate

vat_tax_rate

Simple Order API Fields:

item_#_otherTax_#_rate

item_#_vatRate

otherTax_vatTaxRate

Processor Field Names

This list identifies the processor-specific field names for each processor supporting this field for Level II or Level III processing:

Chase Paymentech Solutions:
VAT/Tax Rate

Elavon Americas:
VAT / Tax Rate (Freight)

FDC Compass:
VAT/Tax Rate

FDC Nashville Global:
VAT/Tax Rate

GPN:
VAT/Tax Rate (Freight/Shipping)

OmniPay Direct:
VAT (Rate)

:
Tax Rate

TSYS Acquiring Solutions:
VAT/Tax Rate

Visa Platform Connect:
vat_tax_rate

orderInformation. amountDetails.taxDetails[]. taxID

Your tax ID number to use for the alternate tax amount.

This field is available only on the Chase Paymentech Solutions and FDC Compass processors.

Specifications

Data Type:
String

Data Length:
15

Mapping Information

REST API Field:

orderInformation.amountDetails.taxDetails[].taxID

SCMP API Field:

alternate_tax_id

Simple Order API Field:

otherTax_alternateTaxID

Processor Field Names

This list provides the Level II/Level III processor field name for each processor that supports Level II or Level III data:

Chase Paymentech Solutions: Alternate Tax ID

FDC Compass: Alternate Tax ID

orderInformation. amountDetails. taxDetails[]. type

The type of tax data that is required when using the

orderInformation.amountDetails.taxDetails.amount

request field.

Possible values:

alternate

: The total amount of alternate tax for the order.

green

: The green tax amount for Korean Processing.

local

: The sales tax for the order.

national

: The national tax for the order.

other

: Other tax.

vat

: The total amount of value added tax (VAT) included in the order.

Specifications

Data Type:
String

Data Length:
9

Mapping

REST Field Name:

orderInformation.amountDetails.taxDetails.type

Simple Order Field Name:
No corresponding field.

orderInformation. amountDetails.taxTypeCode

Contains the tax type code that corresponds to the entry in the

orderInformation.lineItems[].taxAmount

field.

This field is available only for Visa Platform Connect.

Possible values:

056

: Sales tax (U.S. Only)

TX~

: All taxes (Canada Only) Note: Replace ~ with a space.

Specifications

Data Type:
String

Data Length:
3

Mapping Information

REST API Field:

orderInformation.amountDetails.taxTypeCode

SCMP API Field:

total_tax_type_code

Simple Order API Field:

invoiceHeader_totalTaxTypeCode

Processor Field Names

This list provides the Level II/Level III processor field name for each processor that supports Level II or Level III data:

Visa Platform Connect: totalTaxTypeCode

orderInformation. amountDetails.totalAmount

Grand total for the order.

If your request includes line items, do not include this field in your request.

This value cannot be negative. You can include a decimal point (.), but you cannot include any other special characters. The amount is truncated to the correct number of decimal places. The minimum accepted value is

0.01

.

IMPORTANT

Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths.

Dynamic Currency Conversions: When this field is used in a request with Dynamic Currency Conversion, this field value must be denominated in the customer's billing currency.
Original Credit Transactions (OCT): The amount must be less than or equal to 50,000 USD. Amount limits differ depending on limitations imposed by your acquirer in addition to local laws and regulations. For more information, contact your acquirer.
PIN Debit Transactions: If the transaction includes a cashback amount, that amount must be included in this total amount. If the transaction includes a surcharge amount, that amount must be included in this total amount.
Zero Amount Authorizations: If your processor supports zero amount authorizations, you can set this field to
0
for the authorization to verify whether the card is lost or stolen.

Specifications

Data Type:
String

Data Length:

11 (maximum for e-check transactions)

17 (for other transactions)

Data Length

Comercio Latino: 19

eCheck transactions: 11 (for e-check transactions)

All other transactions: 17

Mapping Information

REST API Field:

orderInformation.amountDetails.totalAmount

SCMP API Fields:

auth_request_amount

bill_bill_amount

ecp_credit_total_amount

ecp_debit_total_amount

oct_amount

pin_debit_purchase_request_amount

tax_total_grand

Simple Order API Fields:

ccAuthReply_requestAmount

ccCaptureReply_amount

ecCreditReply_amount

ecDebitReply_amount

octReply_amount

pinDebitPurchaseReply_requestAmount

purchaseTotals_grandTotalAmount

taxReply_grandTotalAmount

On

Barclays and Comercio Latino

, only the

purchaseTotals_grandTotalAmount

field is supported for authorizations.

Processor Field Names

This list provides the Level II/Level III processor field name for each processor that supports Level II or Level III data.

orderInformation. billTo. address1

First line of the billing street address as it appears in the payment card issuer records.

IMPORTANT

This field is optional if your account is configured for relaxed requirements for address data.

FDMS Nashville: When the street name is numeric, it must be sent in numeric format. For example, if the address is One First Street
, it must be sent as 1 1st Street
.
Visa Platform Connect: When you populate billing street address 1 and billing street address 2, exceeds 40 characters, Visa Platform Connect truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and charge backs.

Credit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitation of the payment card networks prevents Visa Platform Connect from transmitting non-ASCII characters to the payment card networks. Therefore, Visa Platform Connect replaces non-ASCII characters with meaningless ASCII characters for transmission to the payment card networks.

Specifications

Data Type:
String

Data Length:

Chase Paymentech Solutions:
20

Moneris:
50

Worldpay VAP:
35

Visa Platform Connect:
40

All other processors:
60

Mapping Information

REST API Field:

orderInformation.billTo.address1

SCMP API Field:

bill_address1

Simple Order API Field:

billTo_street1

orderInformation. billTo. address2

Second line of the billing street address as it appears in the payment card issuer records.

Chase Paymentech Solutions, FDC Compass, and TSYS Acquiring Solutions

This value is used for AVS.

FDMS Nashville: The billing address 1 and billing address 2 fields together cannot exceed 20 characters.
Visa Platform Connect: When you populate billing street address 1 and billing street address 2, exceeds 40 characters, Visa Platform Connect truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and charge backs.

Credit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitation of the payment card networks prevents Visa Platform Connect from transmitting non-ASCII characters to the payment card networks. Therefore, Visa Platform Connect replaces non-ASCII characters with meaningless ASCII characters for transmission to the payment card networks.

Specifications

Data Type:
String

Data Length:

Chase Paymentech Solutions:
20

State or province in the billing address.

For the US, Canada, and Mainland China, use the ISO 3166-2 format for two-character state, province, or territory codes.

For all countries, use the ISO 3166-2 format when using this field for Payer Authentication.

IMPORTANT

This field is optional if your account is configured for relaxed requirements for address data.

Visa Platform Connect

Credit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the payment card networks prevent Visa Platform Connect from transmitting non-ASCII characters to the payment card networks. Therefore, Visa Platform Connect replaces non-ASCII characters with meaningless ASCII characters for transmission to the payment card networks.

Specifications

Data Type:
String

Data Length:
2

Mapping Information

REST API Field:

orderInformation.billTo.administrativeArea

SCMP API Field:

bill_state

Simple Order API Field:

billTo_state

orderInformation. billTo. alternateEmailAddress

Customer's alternate email address.

This field is available only for the processor.

Specifications

Data Type:
String

Data Length:
255

Mapping Information

REST API Field:

orderInformation.billTo.alternateEmailAddress

SCMP API Field:

customer_alternate_email

Simple Order API Field:

billTo_alternateEmailAddress

orderInformation. billTo.alternateEmailVerificationStatus

Verification results for customer's alternate email address.

If the field is not present in the authorization response, verification was not performed or data is unavailable.

This field is available only for the Visa Platform Connect processor.

Possible values:

VERIFIED:

Customer verified.

UNVERIFIED:

Customer not verified.

FAILED:

Customer verification failed.

Specifications

Data Type:
String

Data Length:
10

Mapping Information

REST API Field:

orderInformation.billTo.alternateEmailVerificationStatus

SCMP API Field:

customer_other_email_result

Simple Order API Field:

customer_emailResult

orderInformation. billTo. alternatePhoneNumber

Customer's alternate phone number.

This field is available only for the Visa Platform Connect processor.

Specifications

Data Type:
String

Data Length:
15

Mapping Information

REST API Field:

orderInformation.billTo.alternatePhoneNumber

SCMP API Field:

customer_alternate_phone_number

Simple Order API Field:

billTo_alternatePhoneNumber

orderInformation. billTo.alternatePhoneNumberVerificationStatus

Verification results for customer's alternate phone number.

If the field is not present in the authorization response, verification was not performed or data is unavailable.

This field is available only for the Visa Platform Connect processor.

Possible values:

VERIFIED:

Customer verified.

UNVERIFIED:

Customer not verified.

FAILED:

Customer verification failed.

Specifications

Data Type:
String

Data Length:
10

Mapping Information

REST API Field:

orderInformation.billTo.alternatePhoneNumberVerificationStatus

SCMP API Field:

customer_other_phone_result

Simple Order API Field:

customer_phoneResult

orderInformation. billTo.buildingNumber

Building number in the street address.

For example, for the street address Rua da Quitanda 187, set this field to the building number

187

.

This field is available only for these processors: Cielo, Comercio Latino, , and Visa Platform Connect.

These processors have specific requirements:

Comercio Latino: If a building number is not sent, Comercio Latino rejects the payment request. If the building number is not available, enter the number
0
.

Specifications

Data Type:
String

Data Length:
256

Mapping Information

REST API Field:

orderInformation.billTo.buildingNumber

SCMP API Field:

bill_building_number

Simple Order API Field:

billTo_buildingNumber

orderInformation. billTo.company.address1

First line in the street address of the company purchasing the product.

This field is available only for the American Express Direct processor.

Specifications

Data Type:
String

Data Length:
40

Mapping Information

REST API Field:

orderInformation.billTo.company.address1

SCMP API Field:

company_address1

Simple Order API Field:

billTo_companyStreet1

Processor Field Names

This list provides the Level II/Level III processor field name for each processor that supports Level II or Level III data:

American Express Direct: Does not apply

orderInformation. billTo.company.address2

Additional address information for the company purchasing the product.

Example: Attention: Accounts Payable

This field is available only for the American Express Direct processor.

Specifications

Data Type:
String

Data Length:
40

Mapping Information

REST API Field:

orderInformation.billTo.company.address2

SCMP API Field:

company_address2

Simple Order API Field:

billTo_companyStreet2

Processor Field Names

This list provides the Level II/Level III processor field name for each processor that supports Level II or Level III data:

American Express Direct: Does not apply

orderInformation. billTo.company.city

City in the address of the company purchasing the product.

This field is available only for the American Express Direct processor.

Specifications

Data Type:
String

Data Length:
30

Mapping Information

REST API Field:

orderInformation.billTo.company.city

SCMP API Field:

company_city

Simple Order API Field:

billTo_companyCity

Processor Field Names

This list provides the Level II/Level III processor field name for each processor that supports Level II or Level III data:

American Express Direct: Does not apply

orderInformation. billTo.company.country

Two-digit ISO standard code for the country in the address of the company purchasing the product.

Use the two-character ISO country code. .

This field is available only for the American Express Direct processor.

Specifications

Data Type:
String

Data Length:
2

Mapping Information

REST API Field:

orderInformation.billTo.company.country

SCMP API Field:

company_country

Simple Order API Field:

billTo_companyCountry

Processor Field Names

This list provides the Level II/Level III processor field name for each processor that supports Level II or Level III data:

American Express Direct: Does not apply

orderInformation. billTo. company

Name of the customer's company.

Visa Platform Connect

Payment card companies cannot process transactions that contain non-ASCII characters. Visa Platform Connect accepts and stores ASCII characters correcty and displays them correctly in reports. However, since payment card networks cannot accept non-ASCII characters, Visa Platform Connect replaces non-ASCII characters with meaningless ASCII characters when tranmitting information to payment card networks.

Specifications

Data Type:
String

Data Length:
60

Mapping Information

REST API Field:

orderInformation.billTo.company

SCMP API Field:

company_city

Simple Order API Field:

billTo_company

orderInformation. billTo. company. name

Name of the customer’s company.

This field is available only for these processors: American Express Direct, Moneris, and Visa Platform Connect.

This processor has specific requirements:

Visa Platform Connect: Credit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the payment card networks prevent Visa Platform Connect from transmitting non-ASCII characters to the payment card networks. Therefore, Visa Platform Connect replaces non-ASCII characters with meaningless ASCII characters for transmission to the payment card networks.

Specifications

Data Type:
String

Data Length:

Moneris:
50

Visa Platform Connect:
60

All other processors:
40

Mapping Information

REST API Field:

orderInformation.billTo.company.name

SCMP API Field:

company_name

Simple Order API Field:

billTo_companyName

Processor Field Names

This list provides the Level II/Level III processor field name for each processor that supports Level II or Level III data.

American Express Direct:
Does not apply

orderInformation. billTo. company.phoneNumber

This field value is the business phone number.

Use digits 0 through 9 only. The first digit cannot be 0. For example, 5552223333.

Specifications

Data Type:
String

Data Length:
10

Mapping Information

REST API Field:

orderInformation.billTo.company.phoneNumber

SCMP API Field:

company_phone

Simple Order API Field:

billTo_companyPhoneNumber

orderInformation. billTo.company.postalCode

Postal code in the address of the company purchasing the product.

For U.S. transactions, the postal code must consist of the 5 digit or 9 digit format:

5-digit ZIP format: 12345

9-digit ZIP+ format: 12345-6789

For Canadian transactions, the postal code must use the 6-digit postal code format:

6-digit format: A1B 2C3

This field is available only for the American Express Direct processor.

Specifications

Data Type:
String

Data Length:
10

Mapping Information

REST API Field:

orderInformation.billTo.company.postalCode

SCMP API Field:

company_zip

Simple Order API Field:

billTo_companyPostalCode

Processor Field Names

This list provides the Level II/Level III processor field name for each processor that supports Level II or Level III data:

American Express Direct: Does not apply

orderInformation. billTo.company.state

State or province in the address of the company purchasing the product.

For US and Canadian transactions, use the standard two-digit state/province codes.

This field is available only for the American Express Direct processor.

Specifications

Data Type:
String

Data Length:
2

Mapping Information

REST API Field:

orderInformation.billTo.company.state

SCMP API Field:

company_state

Simple Order API Field:

billTo_companyState

Processor Field Names

This list provides the Level II/Level III processor field name for each processor that supports Level II or Level III data:

American Express Direct: Does not apply

orderInformation. billTo.country

Country in the billing address.

Use the two-character ISO country code. .

IMPORTANT

This field is optional if your account is configured for relaxed requirements for address data.

Tax Calculation Service

U.S and Canadian Tax
: Required

International Tax and Value-Added Tax (VAT)
: Required

Visa Platform Connect: Credit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the payment card networks prevent Visa Platform Connect from transmitting non-ASCII characters to the payment card networks. Therefore, Visa Platform Connect replaces non-ASCII characters with meaningless ASCII characters for transmission to the payment card networks.

Specifications

Data Type:
String

Data Length:
2

Mapping Information

REST API Field:

orderInformation.billTo.country

SCMP API Field:

bill_country

Simple Order API Field:

billTo_country

orderInformation. billTo. county

The county of the customer.

Specifications

Data Type:
String

Data Length:
50

Mapping

REST Field Name:

orderInformation.billTo.county

Simple Order Field Name:

billTo_county

orderInformation. billTo.district

Customer’s neighborhood, community, or region (a barrio in Brazil) within the city or municipality.

Comercio Latino: If the district information is not available, specify the text string
district
.

Specifications

Data Type:
String

Data Length:
50

Mapping Information

REST API Field:

orderInformation.billTo.district

SCMP API Field:

bill_district

Simple Order API Field:

billTo_district

orderInformation. billTo.email

Customer's email address, including full domain name.

Format: name@host.domain

IMPORTANT

This field is optional if your account is configured for relaxed requirements for address data.

Visa Platform Connect: Credit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the payment card networks prevent Visa Platform Connect from transmitting non-ASCII characters to the payment card networks. Therefore, Visa Platform Connect replaces non-ASCII characters with meaningless ASCII characters for transmission to the payment card networks.

Specifications

Data Type:
String

Maximum Data Length:
255

Mapping Information

REST API Field:

orderInformation.billTo.email

SCMP API Field:

customer_email

Simple Order API Field:

billTo_email

orderInformation. billTo.firstName

The customer name.

Value should match value on card.

IMPORTANT

This field is optional if your account is configured for relaxed requirements for address data.

Visa Platform Connect: Credit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the payment card networks prevent Visa Platform Connect from transmitting non-ASCII characters to the payment card networks. Therefore, Visa Platform Connect replaces non-ASCII characters with meaningless ASCII characters for transmission to the payment card networks.

Specifications

Data Type:
String

Data Length:

Worldpay VAP:
25

All other processors:
60

Mapping Information

REST API Field:

orderInformation.billTo.firstName

SCMP API Field:

customer_firstname

Simple Order API Field:

billTo_firstName

Processor Field Names

This list provides the Level II/Level III processor field name for each processor that supports Level II or Level III data.

American Express Direct:
Does not apply

orderInformation. billTo.lastName

The last name of the person requesting the product.

This person may or may not be the cardholder.

IMPORTANT

This field is optional if your account is configured for relaxed requirements for address data.

American Express Direct: Combined, this field and should not exceed 40 characters.

Specifications

Data Type:
String

Data Length:
60

Data Length:

Worldpay VAP:
25

All other processors:
60

Mapping Information

REST API Field:

orderInformation.billTo.lastName

SCMP API Field:

customer_lastname

Simple Order API Field:

billTo_lastName

Processor Field Names

This list provides the Level II/Level III processor field name for each processor that supports Level II or Level III data.

American Express Direct:
Does not apply

orderInformation. billTo.locality

The city in the billing address.

IMPORTANT

This field is optional if your account is configured for relaxed requirements for address data.

Visa Platform Connect: Credit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the payment card networks prevent Visa Platform Connect from transmitting non-ASCII characters to the payment card networks. Therefore, Visa Platform Connect replaces non-ASCII characters with meaningless ASCII characters for transmission to the payment card networks.

Specifications

Data Type:
String

Maximum Data Length:
50

Mapping Information

REST API Field:

orderInformation.billTo.locality

SCMP API Field:

bill_city

Simple Order API Field:

billTo_city

The customer's phone number.

Include the country code when the order is from outside the US.

Visa Platform Connect: Credit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the payment card networks prevent Visa Platform Connect from transmitting non-ASCII characters to the payment card networks. Therefore, Visa Platform Connect replaces non-ASCII characters with meaningless ASCII characters for transmission to the payment card networks.

For installment payments with Mastercard in Brazil, the value for this field corresponds to the following data in the TC 33 capture file:

Record: CP07 TCR4
Position: 40-50
Field: Buyer Phone Number

The TC 33 capture file contains information about the payments and credits that a merchant submits to Visa Acceptance Solutions. The processor creates the TC 33 capture file at the end of the day and sends it to the merchant’s acquirer. The acquirer uses this information to facilitate end-of-day clearing processing with payment networks.

Specifications

Data Type:
String

Data Length:

Visa Platform Connect:
11 (Installment Payments with Mastercard in Brazil), 15 (All other payment types)

All other processors:
15

Mapping Information

REST API Field:

orderInformation.billTo.phoneNumber

SCMP API Field:

customer_phone

Simple Order API Field:

billTo_phoneNumber

orderInformation. billTo.postalCode

The postal code in the billing address.

The postal code must consist of five to nine digits.

When the billing country is the US, the nine-digit postal code must follow this format: [5 digits][dash][4 digits].

Example
: 12345-6789

When the billing country is Canada, the six-digit postal code must follow this format: [alpha][numeric][alpha][space][numeric][alpha][numeric]

Example
: A1B 2C3

IMPORTANT

This field is optional if your account is configured for relaxed requirements for address data.

American Express Direct: Before the postal code is sent to the processor, all non-alphanumeric characters are removed, and if the remaining value is longer than nine characters, the value is truncated starting from the right side.
Visa Platform Connect: Credit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the payment card networks prevent Visa Platform Connect from transmitting non-ASCII characters to the payment card networks. Therefore, Visa Platform Connect replaces non-ASCII characters with meaningless ASCII characters for transmission to the payment card networks.

Specifications

Data Type:
String

Data Length:
10

Data Length:

Comercio Latino: 9

Visa Platform Connect: 9

All other processors: 10

Mapping Information

REST API Field:

orderInformation.billTo.postalCode

SCMP API Field:

bill_zip

Simple Order API Field:

billTo_postalCode

orderInformation. billTo. title

The title of the customer.

Specifications

Data Type:
String

Data Length:
30

Mapping

REST Field Name:

orderInformation.billTo.title

Simple Order Field Name:

billTo_title

orderInformation. exemptAmount

Total amount of exempt amounts.

This value is the sum of the values for all the

orderInformation.lineItems[].exemptAmount

fields.

Specifications

Data Type:
String

Data Length:
15

Mapping Information

REST API Field:

orderInformation.exemptAmount

SCMP API Field:

tax_total_exempt_amount

Simple Order API Field:

taxReply_totalExemptAmount

orderInformation. invoiceDetails.commodityCode

International description code of the overall order's goods or services.

Contact your acquirer or processor for a list of codes.

This field is available only for the American Express Direct, Chase Paymentech Solutions, Elavon Americas, FDC Compass, FDC Nashville Global, GPN, Visa Platform Connect, OmniPay Direct, TSYS Acquiring Solutions, and Worldpay VAP processors.

Elavon Americas: Used to categorize purchases for VAT reporting.

Specifications

Data Type:
String

Data Length:
4

Mapping Information

REST API Field:

orderInformation.invoiceDetails.commodityCode

SCMP API Field:

summary_commodity_code

Simple Order API Field:

invoiceHeader_summaryCommodityCode

Processor Field Names

This list provides the Level II/Level III processor field name for each processor that supports Level II or Level III data:

Elavon Americas: Purchase Identifier

GPN: Summary Commodity Code and Commodity Code

OmniPay Direct: Summary Commodity Code

: Commodity Code

TSYS Acquiring Solutions: Does not apply

Visa Platform Connect: summaryCommodityCode

orderInformation. invoiceDetails.costCenter

Cost center for the goods being sold.

This field is available only on the Barclays processor.

Specifications

Data Type:
String

Data Length:
25

Mapping Information

REST API Field:

orderInformation.invoiceDetails.costCenter

SCMP API Field:

cost_center

Simple Order API Field:

invoiceHeader_costCenter

orderInformation. invoiceDetails.invoiceDate

Date of the tax calculation in Pacific Time.

If you do not include this field in the request, the tax calculation date is set to the current date.

You can provide a date in the past when you are calculating tax for a refund and want to know what the tax was on the date the order was placed.

You can provide a date in the future when you are calculating the tax for a future date, such as an upcoming tax holiday.

IMPORTANT

Adjust this value when you are in a different time zone and want the tax calculated with the rates that apply on a specific date.

Specifications

Data Type:
String

Data Length

Barclays: 14

Other processors: 8

Mapping Information

REST API Field:

orderInformation.invoiceDetails.invoiceDate

SCMP API Field:

invoice_date

Simple Order API Field:

invoiceHeader_invoiceDate

orderInformation. invoiceDetails. merchandiseCode

Identifier for the merchandise.

This field is available only on the American Express Direct, JCN Gateway, and Visa Platform Connect processors.

American Express Direct: The value is
1000
: gift card.
JCN Gateway: This value must be right justified. In Japan, this value is called a goods code.
Visa Platform Connect: This value must be right justified. In Japan, this value is called a goods code.

SCMP API Field:

purchaser_order_date

Simple Order API Field:

invoiceHeader_purchaserOrderDate

Processor Field Names

This list provides the Level II/Level III processor field name for each processor that supports Level II or Level III data:

Elavon Americas: Order Date

GPN: Order Date

OmniPay Direct: Order Date

: Order Date

TSYS Acquiring Solutions: Order Date

Visa Platform Connect: purchaserOrderDate

Worldpay VAP: orderDate

orderInformation. invoiceDetails.purchaseOrderNumber

Value used by your customer to identify the order.

This value is typically a purchase order number.

Visa Acceptance Solutions recommends that you do not populate the field with all zeros or nines.

This field is available only on theBarclays, Chase Paymentech Solutions, Elavon Americas, FDC Compass, FDC Nashville Global, GPN, OmniPay Direct, , TSYS Acquiring Solutions, Visa Platform Connect, and Worldpay VAP processors.

FDC Nashville Global: Only alphanumeric characters are accepted on FDC Nashville Global. Do not include hyphens or other non-alphanumeric characters. You must provide a value in this field or in the
clientReferenceInformation.code
field.

Specifications

Data Type:
String

Data Length:
25

Data Length

American Express Direct: 17

Barclays: 25

Chase Paymentech Solutions: 25

Elavon Americas: 17

FDC Compass: 25

FDC Nashville Global: 25

GPN: 17 for Mastercard, 25 for Visa

OmniPay Direct: 17 for Mastercard, 25 for Visa

FDMS Nashville: 25

: 25

Visa Platform Connect: 17

TSYS Acquiring Solutions: 25

Worldpay VAP: 17

Mapping Information

REST API Field:

orderInformation.invoiceDetails.purchaseOrderNumber

SCMP API Field:

user_po

Simple Order API Field:

invoiceHeader_userPO

Processor Field Names

This list provides the Level II/Level III processor field name for each processor that supports Level II or Level III data:

orderInformation. invoiceDetails. referenceDataCode

Data Length:
30

Mapping Information

REST API Field:

orderInformation.invoiceDetails.referenceDataNumber

SCMP API Field:

reference_data_number

Simple Order API Field:

invoiceHeader_referenceDataNumber

Processor Field Names

This list provides the Level II/Level III processor field name for each processor that supports Level II or Level III data:

American Express Direct: Does not apply

orderInformation. invoiceDetails.supplierOrderReference

Text description of the item.

This field is available on the Barclays, FDC Nashville Global, and OmniPay Direct processors.

FDC Nashville Global: Due to the limited functionality of this field, you should use the
orderInformation.lineItems[].productName
field instead.
IMPORTANT

Include only one of these fields in a request. Including both fields may result in an error.

Specifications

Data Type:
String

Data Length

Barclays: 25

FDC Nashville Global: 25

OmniPay Direct: 17 for Mastercard payment cards, 25 for Visa payment cards

Mapping Information

REST API Field:

orderInformation.invoiceDetails.supplierOrderReference

SCMP API Field:

supplier_order_reference

Simple Order API Field:

invoiceHeader_supplierOrderReference

Processor Field Names

This list provides the Level II/Level III processor field name for each processor that supports Level II or Level III data:

FDC Nashville Global: Item Description Part A

OmniPay Direct: Purchase Identifier / Merchant-Related Data / Merchant Reference Number

orderInformation. invoiceDetails. taxable

Flag that indicates whether an order is taxable.

This field is available only for FDMS Nashville, Visa Platform Connect, and .

Possible values:

true

: Order is taxable

false

: Order is not taxable

OmniPay Direct: This field is a flag that indicates whether tax is included in the total purchase amount.

Possible values:
true
: Tax is included
false
: Tax is not included
: This field is required for Level II Mastercard and Visa transactions. If
orderInformation.lineItems[].taxAmount
=
0
, set this field to
false
. If
orderInformation.lineItems[].taxAmount
> 0, set this field to
true
.
Visa Platform Connect: This value must be
true
if the the
orderInformation.lineItems[].taxAmount
value > 0.

If you do not include any
orderInformation.lineItems[].taxAmount
values in your request, the
orderInformation.invoiceDetails.taxable
field value is not included in the request.
Worldpay VAP: This field is required if
orderInformation.lineItems[].taxAmount
= 0. This field is optional if
orderInformation.lineItems[].taxAmount
> 0.

Specifications

Data Type:
Boolean

Mapping Information

REST API Field:

orderInformation.invoiceDetails.taxable

SCMP API Field:

tax_indicator

Simple Order API Field:

invoiceHeader_taxable

Processor Field Names

This list provides the Level II/Level III processor field name for each processor that supports Level II or Level III data:

FDMS Nashville: Does not apply

OmniPay Direct: Detail Tax Amount Indicator

: Tax Exempt

Visa Platform Connect: localTaxIncluded

Worldpay VAP: taxExempt

orderInformation. invoiceDetails. transactionAdviceAddendum[].data

Transaction Advice Addendum (TAA).

This field provides a description to display on the customer’s American Express card statement. It is frequently used for Level II transactions. Before using this field, contact customer support to have your account enabled for this feature.

This field is available only for the American Express Direct, Chase Paymentech Solutions, FDC Compass, Visa Platform Connect, and Worldpay VAP processors.

Specifications

Data Type:
String

Data Length:

Worldpay VAP:
26

All other processors:
40

Mapping Information

REST API Field:

orderInformation.invoiceDetails.transactionAdviceAddendum[].data

SCMP API Fields:

amexdata_taa1

amexdata_taa2

amexdata_taa3

amexdata_taa4

Simple Order API Fields:

invoiceHeader_amexDataTAA1

invoiceHeader_amexDataTAA2

invoiceHeader_amexDataTAA3

invoiceHeader_amexDataTAA4

Processor Field Names

This list provides the Level II/Level III processor field name for each processor that supports Level II or Level III data:

American Express Direct:
Does not apply

Chase Paymentech Solutions:

TAA1

TAA2

TAA3

TAA4

FDC Compass:

TAA1

TAA2

TAA3

TAA4

Visa Platform Connect:

amexDataTAA1

amexDataTAA2

amexDataTAA3

amexDataTAA4

Worldpay VAP:
itemDescription

orderInformation. invoiceDetails. vatInvoiceReferenceNumber

VAT invoice number associated with the transaction.

This field is available only on the Elavon Americas, FDC Nashville Global, Visa Platform Connect, , TSYS Acquiring Solutions, and Worldpay VAP processors.

Specifications

Data Type:
String

Data Length:
15

Mapping Information

REST API Field:

orderInformation.invoiceDetails.vatInvoiceReferenceNumber

SCMP API Field:

vat_invoice_ref_number

Simple Order API Field:

invoiceHeader_vatInvoiceReferenceNumber

Processor Field Names

This list provides the Level II/Level III processor field name for each processor that supports Level II or Level III data:

Elavon Americas: VAT Invoice Reference Number (Unique)

FDC Nashville Global: VAT Invoice Reference Number

: VAT Invoice Number

TSYS Acquiring Solutions: Unique VAT Invoice Reference Number

Visa Platform Connect: vatInvoiceReferenceNumber

Worldpay VAP: Invoice Reference Number

orderInformation. isCryptocurrencyPurchase

Flag that specifies whether the payment is for the purchase of cryptocurrency.

This field is available only for merchants who support quasi-cash.

This field is available only for Visa transactions on the Visa Platform Connect processor.

Possible values:

true

: Payment is for the purchase of cryptocurrency.

false

(default): Payment is not for the purchase of cryptocurrency.

The value for this field does not map to the TC 33 capture file.

Specifications

Data Type:
String

Data Length:
6

Mapping Information

REST API Field:

orderInformation.isCryptocurrencyPurchase

SCMP API Field:

cryptocurrency_purchase

Simple Order API Fields:

ccAuthService_cryptocurrencyPurchase

ccSaleService_cryptocurrencyPurchase

orderInformation. lineItems[].allowedExportCountries[]

List of countries where the product can be exported.

Use the two-character ISO country code. .

This field is used only when the

processingInformation.actionList

field contains the value

WATCHLIST_SCREENING

.

Specifications

Data Type:
String

Data Length:
2

Mapping Information

REST API Field:

orderInformation.lineItems[].allowedExportCountries[]

SCMP API Field:

export

Simple Order API Field:

item_#_export

orderInformation. lineItems[]. amountIncludesTax

This field contains a flag that indicates whether the tax amount is included in the line item total.

Possible values:

Y

: Tax included in item amount.

N

: Tax not included in item amount.

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

orderInformation.lineItems[].amountIncludesTax

SCMP API Field:

gross_net_indicator

Simple Order API Field:

item_#_grossNetIndicator

Processor Field Names

This list provides the Level II/Level III processor field name for each processor that supports Level II or Level III data:

Chase Paymentech Solutions: Gross/Net Indicator

Elavon Americas (Mastercard): Net/Gross Indicator

FDC Compass: Gross Net Indicator

: Gross Net Indicator

TSYS Acquiring Solutions: Net/Gross Indicator

orderInformation. lineItems[].commodityCode

Commodity code used to classify an item.

Only alphanumeric characters are accepted. Do not include hyphens or other non-alphanumeric characters.

This field is available on the Barclays, Chase Paymentech Solutions, Elavon Americas, FDC Compass, FDC Nashville Global, GPN, OmniPay Direct, , TSYS Acquiring Solutions, Visa Platform Connect, and Worldpay VAP processors.

Specifications

Data Type:
String

Data Length:
12

Data Length

Barclays: 35

Chase Paymentech Solutions: 12

Elavon Americas: 12

FDC Compass: 12

FDC Nashville Global: 12

GPN: 15 for Mastercard payment cards, 12 for Visa payment cards

OmniPay Direct: 4 for Mastercard payment cards, 12 for Visa payment cards

: 12

TSYS Acquiring Solutions: 12

Visa Platform Connect: 12

Mapping Information

REST API Field:

orderInformation.lineItems[].commodityCode

SCMP API Field:

commodity_code

Simple Order API Field:

item_#_commodityCode

Processor Field Names

This list provides the processor-specific field names for each processor supporting this field for Level II or Level III processing:

Barclays: Commodity Code

Chase Paymentech Solutions: Item Commodity Code

Elavon Americas: Item Commodity Code

FDC Compass: Item Commodity Code

FDC Nashville Global: Item Commodity Code

GPN: Item Commodity Code

OmniPay Direct: Item Commodity Code

: Commodity Code

TSYS Acquiring Solutions: Item Commodity Code

Visa Platform Connect: commodityCode

Worldpay VAP: commodityCode

orderInformation. lineItems[].discountAmount

Discount applied to the item.

This field may be required for all Level III processing, depending on your merchant category code. Check with your processor.

FDC Nashville Global: Do not set this field to 0 (zero) for Mastercard transactions.
GPN: The maximum value of this field is
99,999.99

Specifications

Data Type:
String

Data Length:
8

Data Length:

:
8

Worldpay VAP:
8

FDC Nashville Global:
13

TSYS Acquiring Solutions:
13

Elavon Americas:
9 (Mastercard), 12 (Visa)

FDC Compass:
10 (Mastercard), 13 (Visa)

Chase Paymentech Solutions:
10 (Mastercard), 13 (Visa)

All other processors:
12

Mapping Information

REST API Field:

orderInformation.lineItems[].discountAmount

SCMP API Field:

discount_amount

Simple Order API Field:

item_#_discountAmount

Processor Field Names

This list provides the processor-specific field names for each processor supporting this field for Level II or Level III processing:

Chase Paymentech Solutions:

Mastercard:
Discount Amount

Visa:
Discount Amount for Line Item

Elavon Americas:

Mastercard:
Discount Amount

Visa:
Discount Amount Per Line Item

FDC Compass:

Mastercard:
Discount Amount

Visa:
Discount Amount for Line Item

FDC Nashville Global:
Item Discount Amount

GPN:
Item Discount

OmniPay Direct:

Mastercard:
Discount Amount

Visa:
Discount Amount for Line Item

:
Discount Amount

TSYS Acquiring Solutions:

Mastercard:
Discount Amount

Visa:
Discount Amount Per Line Item

Visa Platform Connect:
discountAmount

Worldpay VAP:
Item Discount Amount

orderInformation. lineItems[].discountApplied

Flag indicating a discount was applied to the item.

Possible values:

Y

: Discount applied

N

: No Discount applied

This field is automatically set to

true

if the

orderInformation.lineItems[].discountApplied

field is greater than 0.

Specifications

Data Type:
Boolean

Length:
1

Mapping Information

REST API Field:

orderInformation.lineItems[].discountApplied

SCMP API Field:

discount_indicator

Simple Order API Field:

item_#_discountIndicator

Processor Field Names

This list provides the Level II/Level III processor field name for each processor that supports Level II or Level III data:

Chase Paymentech Solutions: Discount Indicator

Elavon Americas: Discount Indicator

FDC Compass: Discount Indicator

TSYS Acquiring Solutions: Discount Indicator

orderInformation. lineItems[].discountRate

Rate at which the item is discounted.

Additional details for all processors and all txns (Level II/III and non-Level II/III):

GPN, TSYS Acquiring Solutions, and Visa Platform Connect: A maximum of 2 decimal places is allowed. Example 5.25 (=5.25%)
OmniPay Direct: Valid range: 0.010 to 0.999 (1% to 99.9%). Example 0.050 (=5%)
: Maximum amount is 99.99. Example 5.25 (=5.25%)

Specifications

Data Type:
String

Data Length:
6

Mapping Information

REST API Field:

orderInformation.lineItems[].discountRate

SCMP API Field:

discount_rate

Simple Order API Field:

item_#_discountRate

Processor Field Names

This list provides the Level II/Level III processor field name for each processor that supports Level II or Level III data:

GPN: Item Discount Rate

OmniPay Direct: Item Discount Rate

: Discount Rate

TSYS Acquiring Solutions: Item Discount Rate

Visa Platform Connect: discountRate

orderInformation. lineItems[].distributorProductSku

Product's identifier code.

This field is inserted into the outgoing message without being parsed or formatted. This field is included as Distributor product SKU (Offer)
in the list of API fields with which you can create custom rules.

Specifications

Data Type:
String

Data Length:
15

Mapping Information

REST API Field:

orderInformation.lineItems[].distributorProductSku

SCMP API Field:

distributor_product_sku

Simple Order API Field:
No corresponding field.

orderInformation. lineItems[].exemptAmount

Exempt amount for the item.

Specifications

Data Type:
String

Data Length:
15

Mapping Information

REST API Field:

orderInformation.lineItems[].exemptAmount

SCMP API Fields:

other_tax#_status_indicator

tax_exempt_amount0…N

Simple Order API Fields:

item_#_otherTax_#_statusIndicator

taxReply_item_#_exemptAmount

orderInformation. lineItems[].invoiceNumber

Field to support an invoice number for a transaction.

You must specify the number of offer lines that will include an invoice number. By default, the first offer line includes an invoice number field. By default, the first offer line includes an invoice number field. The invoice number field can be included for up to 10 offer lines.

Specifications

Data Type:
String

Data Length:
23

Data Length:

:
15

All other processors:
23

Mapping Information

REST API Field:

orderInformation.lineItems[].invoiceNumber

SCMP API Field:

invoice_number

Simple Order API Field:

item_#_invoiceNumber

Processor Field Names

This list provides the Level II/Level III processor field name for each processor that supports Level II or Level III data.

American Express Direct:
Does not apply

Chase Paymentech Solutions:
Does not apply

FDC Compass:
Does not apply

FDC Nashville Global:
Does not apply

FDMS Nashville:
Amount

GPN:
Amount

:
Amount

TSYS Acquiring Solutions:
Amount

Visa Platform Connect:
invoiceNumber

Worldpay VAP:
invoiceNumber

orderInformation. lineItems[].jurisdiction[]. code

Jurisdiction code assigned by the tax provider.

Returned only when the

taxInformation.showTaxPerLineItem

field is set to

yes

.

Specifications

Data Type:
String

Data Length:
15

Mapping Information

REST API Field:

orderInformation.lineItems[].jurisdiction[].code

SCMP API Field:

tax_offer#_jurisdiction#_code

Simple Order API Field:

taxReply_item_#_jurisdiction_#_code

orderInformation. lineItems[].jurisdiction[]. country

Jurisdiction country for the item.

Returned only when the

taxInformation.showTaxPerLineItem

field is set to

yes

.

Specifications

Data Type:
String

Data Length:
15

Mapping Information

REST API Field:

orderInformation.lineItems[].jurisdiction[].country

SCMP API Field:

tax_offer#_jurisdiction#_country

Simple Order API Field:

taxReply_item_#_jurisdiction_#_country

orderInformation. lineItems[].jurisdiction[]. name

Free-text description of the jurisdiction for the item. For example, San Mateo County

Returned only when the

taxInformation.showTaxPerLineItem

field is set to

yes

.

Specifications

Data Type:
String

Data Length:
15

Mapping Information

REST API Field:

orderInformation.lineItems[].jurisdiction[].name

SCMP API Field:

tax_offer#_jurisdiction#_name

Simple Order API Field:

taxReply_item_#_jurisdiction_#_name

orderInformation. lineItems[].jurisdiction[]. rate

Jurisdiction tax rate for the item.

Returned only when the

taxInformation.showTaxPerLineItem

field is set to

yes

.

Specifications

Data Type:
String

Data Length:
15

Mapping Information

REST API Field:

orderInformation.lineItems[].jurisdiction[].rate

SCMP API Field:

tax_offer#_jurisdiction#_rate

Simple Order API Field:

taxReply_item_#_jurisdiction_#_rate

orderInformation. lineItems[].jurisdiction[]. region

Free-text description of the jurisdiction region for the item.

For example, CA (California State) or GB (Great Britain).

Returned only when the

taxInformation.showTaxPerLineItem

field is set to

yes

.

Specifications

Data Type:
String

Data Length:
15

Mapping Information

REST API Field:

orderInformation.lineItems[].jurisdiction[].region

SCMP API Field:

tax_offer#_jurisdiction#_region

Simple Order API Field:

taxReply_item_#_jurisdiction_#_region

orderInformation. lineItems[].jurisdiction[]. taxable

Jurisdiction taxable amount for the item, not including product level exemptions.

Returned only when the

taxInformation.showTaxPerLineItem

field is set to

yes

.

Specifications

Data Type:
String

Data Length:
15

Mapping Information

REST API Field:

orderInformation.lineItems[].jurisdiction[].taxable

SCMP API Field:

tax_offer#_jurisdiction#_taxable

Simple Order API Field:

taxReply_item_#_jurisdiction_#_taxable

orderInformation. lineItems[].jurisdiction[]. taxAmount

Jurisdiction taxable amount for the item.

Returned only when the

taxInformation.showTaxPerLineItem

field is set to

yes

.

Specifications

Data Type:
String

Data Length:
15

Mapping Information

REST API Field:

orderInformation.lineItems[].jurisdiction[].taxAmount

SCMP API Field:

tax_offer#_jurisdiction#_tax_amount

Simple Order API Field:

taxReply_item_#_jurisdiction_#_taxAmount

orderInformation. lineItems[].jurisdiction[]. taxName

Name of the jurisdiction tax for the item.

For example, CA State Tax.

Returned only when the

taxInformation.showTaxPerLineItem

field is set to

yes

.

Specifications

Data Type:
String

Data Length:
15

Mapping Information

REST API Field:

orderInformation.lineItems[].jurisdiction[].taxName

SCMP API Field:

tax_offer#_jurisdiction#_tax_name

Simple Order API Field:

taxReply_item_#_jurisdiction_#_taxName

orderInformation. lineItems[].jurisdiction[]. type

Type of jurisdiction for the item.

For example, city, county, state, country, or special.

Returned only when the

taxInformation.showTaxPerLineItem

field is set to

yes

.

Specifications

Data Type:
String

Data Length:
15

Mapping Information

REST API Field:

orderInformation.lineItems[].jurisdiction[].type

SCMP API Field:

tax_offer#_jurisdiction#_type

Simple Order API Field:

taxReply_item_#_jurisdiction_#_type

orderInformation. lineItems[]. orderAcceptance. administrativeArea

State where you accept the customer’s order.

Use the state, province and territory codes for the US and Canada.

This

line item

field overrides the corresponding request-level field.

This field is not used for Tax Calculation unless the

orderInformation.lineItems[].orderOrigin.locality

and

orderInformation.lineItems[].orderAcceptance.country

fields are present.

Specifications

Data Type:
String

Data Length:
2

Mapping Information

REST API Field:

orderInformation.lineItems[].orderAcceptance.administrativeArea

SCMP API Field:

order_acceptance_state

Simple Order API Fields:

item_#_orderAcceptanceState

taxService_orderAcceptanceState

orderInformation. lineItems[].orderAcceptance. country

Country where you accept the customer’s order.

Use the two-character ISO standard country code.

This

line item

field overrides the corresponding request-level field.

This field is not used for tax calculation unless the

and

orderInformation.lineItems[].orderOrigin.locality

fields are present.

Specifications

Data Type:
String

Data Length:
2

Mapping Information

REST API Field:

orderInformation.lineItems[].orderAcceptance.country

SCMP API Field:

order_acceptance_country

Simple Order API Fields:

item_#_orderAcceptanceCountry

taxService_orderAcceptanceCountry

orderInformation. lineItems[].orderAcceptance. locality

City where you accept the customer’s order.

This

line item

field overrides the corresponding request-level field.

This field is not used for tax calculation unless the

orderInformation.lineItems[].orderAcceptance.administrativeArea

and

orderInformation.lineItems[].orderAcceptance.country

fields are present.

Specifications

Data Type:
String

Data Length:
50

Mapping Information

REST API Field:

orderInformation.lineItems[].orderAcceptance.locality

SCMP API Field:

order_acceptance_city

Simple Order API Fields:

item_#_orderAcceptanceCity

taxService_orderAcceptanceCity

orderInformation. lineItems[].orderAcceptance. postalCode

Postal code where you accept the customer’s order.

This

line item

field overrides the corresponding request-level field.

This field is not used for Tax Calculation unless the

orderInformation.lineItems[].orderAcceptance.locality

,

orderInformation.lineItems[].orderAcceptance.administrativeArea

, and

orderInformation.lineItems[].orderAcceptance.country

fields are present.

Must be sent at the line or offer level to be surfaced in the Tax Detail Report.

Specifications

Data Type:
String

Data Length:
10

Mapping Information

REST API Field:

orderInformation.lineItems[].orderAcceptance.postalCode

SCMP API Field:

order_acceptance_zip

Simple Order API Fields:

item_#_orderAcceptancePostalCode

taxService_orderAcceptancePostalCode

orderInformation. lineItems[].orderOrigin. administrativeArea

State where you receive the customer’s order.

Use the state, province and territory codes for the US and Canada.

This

line item

field overrides the corresponding request-level field.

This field is not used for tax calculation unless the

orderInformation.lineItems[].orderOrigin.locality

and

orderInformation.lineItems[].orderOrigin.country

fields are present

Specifications

Data Type:
String

Data Length:
2

Mapping Information

REST API Field:

orderInformation.lineItems[].orderOrigin.administrativeArea

SCMP API Field:

order_origin_state

Simple Order API Fields:

item_#_orderOriginState

taxService_orderOriginState

orderInformation. lineItems[].orderOrigin.country

Country where you receive the customer’s order.

Use the two-character ISO standard country code.

This

line item

field overrides the corresponding request-level field.

This field is not used for tax calculation unless the

orderInformation.lineItems[].orderOrigin.administrativeArea

and

orderInformation.lineItems[].orderOrigin.locality>

fields are present.

Specifications

Data Type:
String

Data Length:
2

Mapping Information

REST API Field:

orderInformation.lineItems[].orderOrigin.country

SCMP API Field:

order_origin_country

Simple Order API Fields:

item_#_orderOriginCountry

taxService_orderOriginCountry

orderInformation. lineItems[].orderOrigin.locality

City where you receive the customer’s order.

This

line item

field overrides the corresponding request-level field.

This field is not used for tax calculation unless the

orderInformation.lineItems[].orderOrigin.administrativeArea

and

orderInformation.lineItems[].orderOrigin.country

fields are present

Specifications

Data Type:
String

Data Length:
50

Mapping Information

REST API Field:

orderInformation.lineItems[].orderOrigin.locality

SCMP API Field:

order_origin_city

Simple Order API Fields:

item_#_orderOriginCity

taxService_orderOriginCity

orderInformation. lineItems[].orderOrigin.postalCode

Postal code where you receive the customer’s order.

This

line item

field overrides the corresponding request-level field.

This field is not used for Tax Calculation unless the

orderInformation.lineItems[].orderOrigin.locality

,

orderInformation.lineItems[].orderOrigin.administrativeArea

, and

orderInformation.lineItems[].orderOrigin.country

fields are present.

Must be sent at the line or offer level to be surfaced in the Tax Detail Report.

Specifications

Data Type:
String

Data Length:
10

Mapping Information

REST API Field:

orderInformation.lineItems[].orderOrigin.postalCode

SCMP API Field:

order_origin_zip

Simple Order API Fields:

item_#_orderOriginPostalCode

taxService_orderOriginPostalCode

orderInformation. lineItems[].passenger.email

Passenger's email address, including the full domain name, such as jdoe@example.com.

Specifications

Data Type:
String

Data Length:
255

Mapping Information

REST API Field:

orderInformation.lineItems[].passenger.email

SCMP API Field:

passenger_email

Simple Order API Field:

item_#_passengerEmail

orderInformation. lineItems[].passenger.firstName

Passenger's first name.

Specifications

Data Type:
String

Data Length:
60

Mapping Information

REST API Field:

orderInformation.lineItems[].passenger.firstName

SCMP API Field:

passenger_firstname

Simple Order API Field:

item_#_passengerFirstName

orderInformation. lineItems[].passenger.id

ID of the passenger to whom the ticket was issued.

For example, you can use this field for the frequent flyer number.

Specifications

Data Type:
String

Data Length:
32

Mapping Information

REST API Field:

orderInformation.lineItems[].passenger.id

SCMP API Field:

passenger_id

Simple Order API Field:

item_#_passengerID

Type of product.

This value is used to determine the product category: electronic, handling, physical, service, or shipping. The default value is

default

.

Possible values:

adult_content

: Adult content.

coupon

: Coupon applied to the entire order.

default

: Default value for the product code. The value

default

is used when a request message does not include a value for the product code.

electronic_good

: Electronic product other than software.

electronic_software

: Software distributed electronically rather than on disks or other media.

gift_certificate

: Gift certificate.

handling_only

: Fee that you charge your customer to cover your administrative selling costs.

service

: Service that you perform for your customer.

shipping_and_handling

: Handling portion is the fee that you charge your customer to cover your administrative selling costs. Shipping is the charge for shipping the product to your customer.

shipping_only

: Charge for transporting tangible personal property from your location to your customer. You must maintain documentation that clearly establishes the location where the title to the property passed from you to your customer.

subscription

: subscription to a website or other content.

To use the Tax Calculation service, use values listed in the Tax Product Code Guide
. For information about this document, contact customer support.

For authorizations, when you set this to a value other than

default

or any of the values related to shipping and handling, the

orderInformation.lineItems[].quantity

,

orderInformation.lineItems[].productName

, and

orderInformation.lineItems[].productSku

fields are required.

Specifications

Data Type:
String

Data Length:
255

Mapping Information

REST API Field:

orderInformation.lineItems[].productCode

SCMP API Field:

product_code

Simple Order API Field:

item_#_productCode

Processor Field Names

This list provides the Level II/Level III processor field name for each processor that supports Level II or Level III data.

Chase Paymentech Solutions:
Product Code

Elavon Americas:

Mastercard: Product Code

Visa: Discount Per line Item

FDC Compass:
Product Code

FDC Nashville Global:
Item Product Code

GPN:
Product Code

OmniPay Direct:
Quantity / Item Quantity

:
Product Code

TSYS Acquiring Solutions:
Product Code

Worldpay VAP:
productCode

orderInformation. lineItems[]. productDescription

Brief description of item.

Specifications

Data Type:
String

Data Length:
256

Mapping Information

REST API Field:

orderInformation.lineItems[].productDescription

SCMP API Fields:

ap_initiate_product_description

product_description

Simple Order API Fields:

apInitiateService_productDescription

item_#_productDescription

orderInformation. lineItems[].productName

Name of product.

Specifications

Mapping Information

REST API Field:

orderInformation.lineItems[].productName

SCMP API Fields:

ap_initiate_product_name

product_name

Simple Order API Fields:

apInitiateService_productName

item_#_productName

Processor Field Names

This list provides the Level II/Level III processor field name for each processor that supports Level II or Level III data.

orderInformation. lineItems[].productSku

Identification code for the product.

Only alphanumeric characters are accepted. Do not include hyphens or other non-alphanumeric characters.

Specifications

Data Type:
String

Mapping Information

REST API Field:

orderInformation.lineItems[].productSKU

SCMP API Field:

merchant_product_sku

Simple Order API Field:

item_#_productSKU

Processor Field Names

This list provides the Level II/Level III processor field name for each processor that supports Level II or Level III data:

Barclays: Product Code

FDC Nashville Global: Item Customer Code

orderInformation. lineItems[].quantity

Quantity of the product.

The default is

1

.

Specifications

Data Type:
Integer

Data Length:
9

Mapping Information

REST API Field:

orderInformation.lineItems[].quantity

SCMP API Field:

quantity

Simple Order API Field:

item_#_quantity

Processor Field Names

This list provides the Level II/Level III processor field name for each processor that supports Level II or Level III data.

orderInformation. lineItems[]. referenceDataCode

Code that identifies the value of the corresponding

orderInformation.lineItems[].referenceDataNumber

field.

This field is a pass-though field. This means Visa Acceptance Solutions does not verify the value or modify it in any way before sending it to the precessor.

Possible values:

AN

: Client-defined asset code

MG

: Manufacturers part number

PO

: Purchase order number

SK

: Supplier stock keeping unit number

UP

: Universal product code

VC

: Supplier catalog number

VP

: Vendor part number

Specifications

Data Type:
String

Data Length:
2

Mapping Information

REST API Field:

orderInformation.lineItems[].referenceDataCode

SCMP API Field:

reference_data_#_code

Simple Order API Field:

item_#_referenceData_#_code

orderInformation. lineItems[]. referenceDataNumber

Reference number. The meaning of this value is defined by the value of the corresponding

orderInformation.lineItems[].referenceDataCode

field.

Specifications

Data Type:
String

Data Length:

For

PO

value: 22

For

VC

value: 20

For all other code values: 30

Mapping Information

REST API Field:

orderInformation.lineItems[].referenceDataNumber

SCMP API Field:

reference_data_#_number

Simple Order API Field:

item_#_referenceData_#_number

orderInformation. lineItems[].restrictedExportCountries[]

orderInformation.lineItems[].shippingCountryCode

SCMP API Field:

shipping_country_code

Simple Order API Field:

item_#_shippingCountryCode

orderInformation. lineItems.shippingDestinationTypes

orderInformation. lineItems[].taxAmount

Total tax to apply to the product.

Specify the value in US English characters. The amount cannot be negative. The tax amount and the

unit price

must be in the same currency.

This field is available only on the American Express Direct, Barclays, Chase Paymentech Solutions, Elavon Americas, FDC Compass, FDC Nashville Global, FDMS Nashville, GPN, OmniPay Direct, , TSYS Acquiring Solutions, Visa Platform Connect, and Worldpay VAP processors.

When you include this field, the Tax Calculation service does not calculate tax for the offer. Instead, it returns the value of the

orderInformation.lineItems.taxAmount

field in the reply message.

The tax amount value is additive as shown in this example.

Example:
This example uses a two-exponent currency such as USD:

You include these

offers

in your request:

orderInformation.lineItems[0].unitPrice=10.00
orderInformation.lineItems[0].quantity=1
orderInformation.lineItems[0].taxAmount=0.80
orderInformation.lineItems[1].unitPrice=20.00
orderInformation.lineItems[1].quantity=1
orderInformation.lineItems[1].taxAmount=1.60

The total authorized amount is 32.40, not 30.00 with 2.40 of tax included.

Airline Processing

Tax portion of the order amount. This value cannot exceed 99999999999999 (fourteen 9s). Format: English characters only. Optional request field for a line item.

Tax Calculation

Optional field for US, Canadian, international tax, and value-added taxes.

When you want to include

orderInformation.lineItems[].taxAmount

.

Specifications

Data Type:
String

Data Length:
15

Mapping Information

REST API Field:

orderInformation.lineItems.taxAmount

SCMP API Field:

tax_amount

Simple Order API Field:

item_#_taxAmount

Processor Field Names

This list provides the Level II/Level III processor field name for each processor that supports Level II or Level III data.

American Express Direct: Does not apply

Barclays: Tax Amount

Chase Paymentech Solutions: Tax Amount

Elavon Americas: VAT / Tax Amount

FDC Compass: Tax Amount

FDC Nashville Global: Local Tax Amount

FDMS Nashville: Does not apply

GPN

Level II: Amount 2

Level III: Tax Amount N

OmniPay Direct: Tax Amount / Total Tax Amount

: Tax Amount

Visa Platform Connect: localTax Amount

TSYS Acquiring Solutions

Mastercard: Tax Amount

Visa: VAT / Tax Amount

Worldpay VAP: taxAmount

orderInformation. lineItems[].taxAppliedAfterDiscount

Flag to indicate how you handle discount at the line item level.

This field is available only for the Visa Platform Connect processor.

Possible values:

0

: no line level discount provided

1

: tax was calculated on the post-discount line item total

2

: tax was calculated on the pre-discount line item total

Visa inserts a 0 (zero) value if an invalid value is included in this field.

This field relates to the value in the

orderInformation.amountDetails.discountAmount

field.

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

orderInformation.lineItems[].taxAppliedAfterDiscount

SCMP API Field:

discount_management_indicator

Simple Order API Field:

item_#_discountManagementIndicator

Processor Field Names

This list provides the Level II/Level III processor field name for each processor that supports Level II or Level III data:

Visa Platform Connect: discountManagementIndicator

orderInformation. lineItems[].taxDetails[].amount

Amount collected for tax.

Elavon Americas: For Mastercard, do not set this field to 0 (zero).
FDC Nashville Global: Visa: VAT or other tax amount.

Mastercard: Tax amount collected for a special type of tax. Do not set this field to 0 (zero).

Specifications

Data Type:
String

Data Length:

American Express Direct
7 (Canadian Dollars), 9 (U.S. Dollars)

Elavon Americas
10

Worldpay VAP
8

FDC Nashville Global
13

TSYS Acquiring Solutions
13

All other processors:
15

Mapping Information

REST API Field:

orderInformation.lineItems[].taxDetails[].amount

SCMP API Fields:

alternate_tax_amount

local_tax

national_tax

other_tax#_amount

tax_city_taxN

tax_county_taxN

tax_country_taxN

tax_district_taxN

tax_special_tax0...N

tax_state_taxN

tax_tax_amountN

Simple Order API Fields:

item_#_alternateTaxAmount

item_#_localTax

item_#_nationalTax

item_#_otherTax_#_amount

item_#_otherTax_localTaxAmount

taxReply_item_#_cityTaxAmount

taxReply_item_#_countyTaxAmount

taxReply_item_#_countryTaxAmount

taxReply_item_#_districtTaxAmount

taxReply_item_#_specialTaxAmount

taxReply_item_#_stateTaxAmount

taxReply_item_#_totalTaxAmount

Processor Field Names

This list provides the Level II/Level III processor field name for each processor that supports Level II or Level III data:

American Express Direct: Does not apply

Elavon Americas: Sales Tax Amount

FDC Nashville Global: Item Other Tax Amount and Item Local Tax Amount

Worldpay VAP: taxAmount

TSYS Acquiring Solutions: Local Tax

orderInformation. lineItems[].taxDetails[].applied

A flag that indicates whether an alternative tax amount (

orderInformation.amountDetails.taxDetails[].amount

) is included in the request.

Possible values for this field:

false

: Alternate tax amount is not included in the request

true

: Alternate tax amount is included in the request

Specifications

Data Type:
Boolean

Mapping Information

REST API Field:

orderInformation.lineItems[].taxDetails[].applied

SCMP API Field:

alternate_tax_amount_indicator

Simple Order API Fields:

item_#_alternateTaxType

otherTax_alternateTaxIndicator

Processor Field Names

This list provides the Level II/Level III processor field name for each processor that supports Level II or Level III data:

Elavon Americas: National /Alternate Tax Included

FDC Nashville Global: Other Tax Indicator

: Alternate Tax Indicator

TSYS Acquiring Solutions: Alternate Tax Amount Indicator

orderInformation. lineItems[].taxDetails[].code

Flag that indicates whether local sales tax is included in the order total.

Possible values:

0

: local sales tax not included

1

: local sales tax included

2

: tax exempt order

For Mastercard: Defines tax categories for domestic processing in certain locations.

Flag that indicates the type of tax collected for

orderInformation.lineItems[].taxDetails[].amount

.

Possible values:

00

: unknown

01

: federal or national sales tax

02

: states sales tax

03

: city sales tax

04

: local sales tax

05

: municipal sales tax

06

: other tax

10

: value-added tax (VAT)

11

: goods and services tax (GST)

12

: provincial sales tax

20

: room tax

21

: occupancy tax

22

: energy tax

Specifications

Data Type:
String

Data Length:
4

Mapping Information

REST API Field:

orderInformation.lineItems[].taxDetails[].code

SCMP API Fields:

alternate_tax_type_applied

local_tax_indicator

Simple Order API Fields:

item_#_alternateTaxTypeApplied

otherTax_localTaxIndicator

Processor Field Names

This list provides the Level II/Level III processor field name for each processor that supports Level II or Level III data:

Elavon Americas: Sales Tax Included

FDC Nashville Global: Item Tax Type Applied

OmniPay Direct: Local Tax Included

TSYS Acquiring Solutions: Local Tax Included Flag

orderInformation. lineItems[].taxDetails[].rate

Alternative tax rate applied to the item.

FDC Nashville Global: For Mastercard, this is the rate for a special tax.

For Visa, this is a VAT tax or other tax rate.
OmniPay Direct: This rate is used to generate the value of the
orderInformation.lineItems[].taxDetails[].amount

Line item
field.

When you include the
orderInformation.lineItems[].taxDetails[].amount

Line item
field or the
orderInformation.amountDetails.taxDetails[].amount
request field, do not include the
orderInformation.lineItems[].taxDetails[].rate
field. The
orderInformation.amountDetails.taxDetails[].amount
request field rate will be set using the following equation:

orderInformation.amountDetails.taxDetails[].amount
/
orderInformation.lineItems[].unitPrice
field.

For Visa, this is a VAT tax or other tax rate.

Specifications

Data Type:
String

Data Length:

OmniPay Direct:
4

Worldpay VAP:
8

All other processors:
5

Mapping Information

REST API Field:

orderInformation.lineItems[].taxDetails[].rate

SCMP API Fields:

alternate_tax_amount

vat_rate

Simple Order API Fields:

item_#_alternateTaxRate

item_#_vatRate

Processor Field Names

This list provides the Level II/Level III processor field name for each processor that supports Level II or Level III data:

FDC Nashville Global: Item Tax Rate Applied

GPN: Tax Rate N

OmniPay Direct: VAT / TAx Rate (Freight or Shipping)

Worldpay VAP: taxRate

orderInformation. lineItems[].taxDetails[].taxID

Your tax ID number to use for the alternate tax amount.

Specifications

Data Type:
String

Data Length:
15

Mapping Information

REST API Field:

orderInformation.lineItems[].taxDetails[].taxID

SCMP API Field:

alternate_tax_id

Simple Order API Field:

item_#_alternateTaxID

Processor Field Names

This list provides the Level II/Level III processor field name for each processor that supports Level II or Level III data:

Elavon Americas (Field name for Mastercard): Tax Amount

FDC Nashville Global: Tax Amount 1 Tax ID

: Alternate Tax ID

TSYS Acquiring Solutions: Alternate Tax Identifier

Worldpay VAP: cardAcceptorTaxId

orderInformation. lineItems[].taxDetails[].type

Description of the tax applied for the item.

This field is part of an array and can include one or more tax types along with the amounts for each tax. For each tax type, you must also include the

orderInformation.lineItems[].taxDetails[].amount

field. For each tax, the two fields should be added in the following form:

"orderInformation": {
  "lineItems":[
    "taxDetails":[
      "type": "city",
      "amount": "5.14"
      ]
    ]
  }

Possible values include:

city

county

state

national

special

Specifications

Data Type:
String

Data Length:
15

Mapping Information

REST API Field:

orderInformation.lineItems.taxDetails.type

SCMP API Fields:

tax_city_tax0...N

tax_county_tax0...N

tax_district_tax0...N

tax_state_tax0...N

tax_tax_amount0...N

Simple Order API Fields:

taxReply_item_#_cityTaxAmount

taxReply_item_#_countyTaxAmount

taxReply_item_#_districtTaxAmount

taxReply_item_#_stateTaxAmount

taxReply_item_#_totalTaxAmount

orderInformation. lineItems[].taxRate

Tax rate applied to the item.

This field is available only on the American Express Direct, Barclays, Chase Paymentech Solutions, Elavon Americas, FDC Compass, , TSYS Acquiring Solutions, and Visa Platform Connect processors.

For transactions on Visa payment cards, the valid range is from
0.01
(1%) to
0.99
(99%). Only whole percentage values accepted; values with additional decimal places will be truncated.; For other transactions, the valid range is from
0.00
(0%) to
99.99
(99.99%). Values with more than two digits beyond the decimal point will be truncated.
60%:
60.00
25.5%:
25.50
33.33%:
33.33
Barclays: The valid range is from
0.00
(0%) to
100.00
(100%), expressed as a whole number with decimals.; For example, 20.00 = 20% tax rate.
Chase Paymentech Solutions, Elavon Americas, and FDC Compass: For transactions on Mastercard payment cards, the valid range is from
0.00001
(0.001%) to
0.99999
(99.999%).
60%:
0.6000
25.5%:
0.2550
33.33%:
0.3333

For transactions on Visa payment cards, the valid range is from
0.01
(1%) to
0.99
(99%).
60%:
0.60
25%:
0.25
33%:
0.33

Specifications

Data Type:
String

Data Length:
4

Data Type:
String

Data Length

Barclays: 6

Chase Paymentech Solutions: 7 (Mastercard), 4 (Visa)

Elavon Americas: 5 (Mastercard), 4 (Visa)

FDC Compass: 7 (Mastercard), 4 (Visa)

TSYS Acquiring Solutions: 6

Other processors: 4

Mapping Information

REST API Field:

orderInformation.lineItems[].taxRate

SCMP API Field:

tax_rate

Simple Order API Field:

item_#_taxRate

Processor Field Names

This list provides the Level II/Level III processor field name for each processor that supports Level II or Level III data:

American Express Direct: Does not apply

Chase Paymentech Solutions: Tax Rate

Elavon Americas:

Mastercard: Tax Rate Applied

Visa: VAT/Tax Rate

FDC Compass: Tax Rate

: Tax Rate

TSYS Acquiring Solutions:

Mastercard: Tax Rate Applied

Visa: VAT/Tax Rate

Visa Platform Connect: taxRate

orderInformation. lineItems[].taxStatusIndicator

Status for exemption from sales and use tax.

This field is available only on the American Express Direct processor.

This field is a pass-though field, which means Visa Acceptance Solutions does not verify the value or modify it in any way before sending it to the processor.

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

orderInformation.lineItems[].taxStatusIndicator

SCMP API Field:

tax_status_indicator

Simple Order API Field:

item_#_taxStatusIndicator

Processor Field Names

This list provides the Level II/Level III processor field name for each processor that supports Level II or Level III data:

American Express Direct: Does not apply

orderInformation. lineItems[].taxTypeCode

Type of tax applied to the item.

This field is available only on the Barclays, Chase Paymentech Solutions, Elavon Americas, FDC Compass, , and TSYS Acquiring Solutions processors.

Possible values:

0000

: Unknown tax type

0001

: Federal/national sales tax

0002

: State sales tax

0003

: City sales tax

0004

: Local sales tax

0005

: Municipal sales tax

0006

: Other tax

0010

: Value-added tax (VAT)

0011

: Goods and services tax

0012

: Provincial sales tax

0013

: Harmonized sales tax

0014

: Quebec sales tax (QST)

0020

: Room tax

0021

: Occupancy tax

0022

: Energy tax

blank: tax not supported on line item

Barclays: Possible values:
S
: Single standard rate
AA
: Reduced rate AA
BB
: Reduced rate BB
CC
: Reduced rate CC
DD
: Reduced rate DD
E
: Exempt
Z
: Zero rated
Chase Paymentech Solutions, Elavon Americas, FDC Compass, , and TSYS Acquiring Solutions: Possible values:
0000
: unknown tax type
0001
: federal/national sales tax
0002
: state sales tax
0003
: city sales tax
0004
: local sales tax
0005
: municipal sales tax
0006
: other tax
0010
: value-added tax (VAT)
0011
: goods and services tax
0012
: provincial sales tax
0013
: harmonized sales tax
0014
: Quebec sales tax (QST)
0020
: room tax
0021
: occupancy tax
0022
: energy tax
blank: tax not supported on line item

Specifications

Data Type:
String

Data Length:
4

Data Length

Barclays: 2

Chase Paymentech Solutions: 4 numeric

Elavon Americas: 4 numeric

FDC Compass: 4 numeric

: 4 numeric

TSYS Acquiring Solutions: 4 numeric

Mapping Information

REST API Field:

orderInformation.lineItems[].taxTypeCode

SCMP API Field:

tax_type_applied

Simple Order API Field:

item_#_taxTypeApplied

Processor Field Names

This list provides the Level II/Level III processor field name for each processor that supports Level II or Level III data:

Chase Paymentech Solutions: Tax Type Applied

Elavon Americas: Tax Type Applied

FDC Compass: Tax Type Applied

: Tax Type

TSYS Acquiring Solutions: Tax Type Applied

orderInformation. lineItems[].totalAmount

Total amount for the item, calculated as: (unit price ✕ quantity)
.

This field is available only on the Barclays, Elavon Americas, FDC Compass, OmniPay Direct, , TSYS Acquiring Solutions, Visa Platform Connect, and Worldpay VAP processors.

Barclays: Must be numeric with two exponents.
Chase Paymentech Solutions: Do not use all zeros or spaces in Mastercard transactions.
FDC Compass: Do not use all zeroes or spaces in Mastercard transactions.
: Do not use all zeros or spaces in Mastercard transactions.

Specifications

Data Type:
String

Data Length:
12

Data Length:

Barclays 10 (Mastercard), 18 (Visa)

Chase Paymentech Solutions: 10 (Mastercard), 13 (Visa)

Elavon Americas: 9 (Mastercard), 12 (Visa)

FDC Compass: 10 (Mastercard), 13 (Visa)

OmniPay Direct: 12

: 12

TSYS Acquiring Solutions: 10 (Mastercard), 13 (Visa)

Visa Platform Connect: 12

Worldpay VAP: 8

Other processors: 12

Mapping Information

REST API Field:

orderInformation.lineItems[].totalAmount

SCMP API Field:

total_amount

Simple Order API Field:

item_#_totalAmount

Processor Field Names

This list provides the Level II/Level III processor field name for each processor that supports Level II or Level III data:

orderInformation. lineItems[].typeOfSupply

Code indicating whether the purchase is categorized as goods or services.

This field is available only for the Visa Platform Connect processor.

Possible values:

00

: Goods

01

: Services

Specifications

Data Type:
String

Data Length:
2

Mapping Information

REST API Field:

orderInformation.lineItems[].typeOfSupply

SCMP API Field:

type_of_supply

Simple Order API Field:

item_#_typeOfSupply

Processor Field Names

This list provides the Level II/Level III processor field name for each processor that supports Level II or Level III data:

orderInformation. lineItems[].unitOfMeasure

Code that specifies the unit of measure for the item.

Do not use all zeros or spaces in this field.

This field is available only for the American Express Direct, Barclays, Chase Paymentech Solutions, Elavon Americas, FDC Compass, FDC Nashville Global, GPN, OmniPay Direct, , TSYS Acquiring Solutions, Visa Platform Connect, and Worldpay VAP processors.

This processor has specific requirements:

For American Express Direct, see the EDI codes for units of measurement at el355.htm.

Specifications

Data Type:
String

Data Length:
2

Data Length

American Express Direct: 2

Barclays: 80

Chase Paymentech Solutions: 3 (Mastercard), 12 (Visa)

Elavon Americas: 3 (Mastercard), 12 (Visa)

FDC Compass: 3 (Mastercard), 12 (Visa)

FDC Nashville Global: 12

GPN: 12

OmniPay Direct: 12

: 12

TSYS Acquiring Solutions: 12

Visa Platform Connect: 12

Worldpay VAP: 12

Other processors: 12

Mapping Information

REST API Field:

orderInformation.lineItems[].unitOfMeasure

SCMP API Field:

unit_of_measure

Simple Order API Field:

item_#_unitOfMeasure

Processor Field Names

This list provides the Level II/Level III processor field name for each processor that supports Level II or Level III data:

orderInformation. lineItems[].unitPrice

Per-item price of the product.

This is an item-level field.

This value cannot be negative. You can include a decimal point (.), but you cannot include any other special characters. The amount is truncated to the correct number of decimal places.

This field is available only on the American Express Direct, Barclays, Chase Paymentech Solutions, Elavon Americas, FDC Compass, FDC Nashville Global, FDMS Nashville, GPN, OmniPay Direct, , TSYS Acquiring Solutions, Visa Platform Connect, and Worldpay VAP processors.

IMPORTANT

Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths.

Barclays: Value must be numeric with two exponents.; Limit authorization and capture amounts to 999999999999 (twelve 9s).

DCC with a Third-Party Provider
: Set this field to the converted amount that was returned by the DCC provider. You must include either this field or

orderInformation.amountDetails.totalAmount

in a request.

Zero Amount Authorizations
: If your processor supports zero amount authorizations, you can set this field to

0

for an authorization to find out whether the card is lost or stolen.

Level III transaction
: This value cannot be zero (0).

Specifications

Data Type:
String

Data Length:
8 (Mastercard), 10 (Visa)

Data Length

American Express Direct: 8 (CAD), 10 (USD)

Barclays: 8 (for Mastercard), 18 (for Visa)

Chase Paymentech Solutions: 13 (USD)

FDC Compass: 13 (USD)

FDC Nashville Global: 13 (USD)

FDMS Nashville: 15 (USD)

: 8 (Mastercard), 10 (Visa)

Other processors: 12

Mapping Information

REST API Field:

orderInformation.lineItems[].unitPrice

SCMP API Field:

amount

Simple Order API Field:

item_#_unitPrice

Processor Field Names

This list provides the Level II/Level III processor field name for each processor that supports Level II or Level III data.

orderInformation. lineItems[].weight

Weight of the item.

This field is available only on the American Express Direct processor.

Specifications

Data Type:
String

Data Length:
9

Mapping Information

REST API Field:

orderInformation.lineItems[].weight

SCMP API Field:

weight_amount

Simple Order API Field:

item_#_weightAmount

Processor Field Names

This list provides the Level II/Level III processor field name for each processor that supports Level II or Level III data:

American Express Direct: Does not apply

orderInformation. lineItems[].weightIdentifier

Type of weight.

This field is available only for the American Express Direct processor.

Possible values:

B

: Billed weight

N

: Actual net weight

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

orderInformation.lineItems[].weightIdentifier

SCMP API Field:

weight_identifier

Simple Order API Field:

item_#_weightIdentifier

Processor Field Names

This list provides the Level II/Level III processor field name for each processor that supports Level II or Level III data:

American Express Direct: Does not apply

orderInformation. lineItems[].weightUnit

Code that specifies the unit of measurement for the weight amount.

For example,

OZ

specifies ounces and

LB

specifies pounds.

The values are defined by the ANSI Accredited Standards Committee (ASC).

This field is available only on the American Express Direct processor.

Specifications

Data Type:
String

Data Length:
2

Mapping Information

REST API Field:

orderInformation.lineItems[].weightUnit

SCMP API Field:

weight_unit_measurement

Simple Order API Field:

item_#_weightunitOfMeasure

Processor Field Names

This list provides the Level II/Level III processor field name for each processor that supports Level II or Level III data:

American Express Direct: Does not apply

orderInformation. reordered

Indicates whether the cardholder is reordering previously purchased merchandise.

This field can contain one of these values:

01

: First time ordered

02

: Reordered

Specifications

Data Type:
Boolean

Data Length:
2

Mapping Information

REST API Field:

orderInformation.reordered

SCMP API Field:

pa_reorder

Simple Order API Field:

payerAuthEnrollService_reorder

orderInformation. returnsAccepted

Simple Order API Field:

payByPoints_pointsValueRedeemed

orderInformation. shippingDetails.giftWrap

Indicates whether the customer requested gift wrapping for this purchase.

This field can contain one of the following values:

yes

: The customer requested gift wrapping.

no

: The customer did not request gift wrapping.

Specifications

Data Type:
String

Data Length:
3

Mapping Information

REST API Field:

orderInformation.shippingDetails.giftWrap

SCMP API Field:

customer_gift_wrap

Simple Order API Field:

invoiceHeader_isGift

orderInformation. shippingDetails. shipFromAdministrativeArea

State from which the product is shipped.

Use the state, province and territory codes for the US and Canada.

This field is available only for the American Express Direct processor.

The value in this field is used to determine tax rules and rates applied to the transaction based on sourcing.

Tax Calculation: The value in this field is used for tax calculations only when the
orderInformation.shippingDetails.shipFromLocality
and
orderInformation.shippingDetails.shipFromCountry
fields are present.

Specifications

Data Type:
String

Data Length:
2

Mapping Information

REST API Field:

orderInformation.shippingDetails.shipFromAdministrativeArea

SCMP API Field:

ship_from_state

Simple Order API Fields:

item_#_shipFromState

shipFrom_state

Processor Field Names

This list provides the Level II/Level III processor field name for each processor that supports Level II or Level III data:

American Express Direct: Does not apply

orderInformation. shippingDetails.shipFromCountry

The country from which the product is shipped.

This field is available only for the American Express Direct processor.

Use two-character ISO standard country code.

Tax Calculation: The value in this field is used for tax calculations only when the
orderInformation.shippingDetails.shipFromLocality
and
orderInformation.shippingDetails.shipFromAdministrativeArea
fields are present.

Specifications

Data Type:
String

Data Length:
2

Mapping Information

REST API Field:

orderInformation.shippingDetails.shipFromCountry

SCMP API Field:

ship_from_country

Simple Order API Fields:

item_#_shipFromCountry

shipFrom_country

Processor Field Names

This list provides the Level II/Level III processor field name for each processor that supports Level II or Level III data:

American Express Direct: Does not apply

orderInformation. shippingDetails.shipFromLocality

City from which the product is shipped.

This field is available only for the American Express Direct processor.

The city is used to determine tax rules and rates applied to the transaction based on sourcing.

Use the two-character state, province, or territory codes for the US and Canada.

Tax Calculation: The value in this field is used for tax calculations only when the
orderInformation.shippingDetails.shipFromAdministrativeArea
and
orderInformation.shippingDetails.shipFromCountry
fields are present.

Specifications

Data Type:
String

Data Length:
30

Mapping Information

REST API Field:

orderInformation.shippingDetails.shipFromLocality

SCMP API Field:

ship_from_city

Simple Order API Fields:

item_#_shipFromCity

shipFrom_city

Processor Field Names

This list provides the Level II/Level III processor field name for each processor that supports Level II or Level III data:

American Express Direct: Does not apply

orderInformation. shippingDetails.shipFromPostalCode

Postal code for the address from which the goods are shipped, which is used to establish nexus, and which is used to determine tax rules and rates applied to the transaction based on sourcing.

The default value is the postal code associated with your account. You can use this field to override the default setting. This

line-item

field overrides the corresponding request-level field. The postal code must consist of 5 to 9 digits.

Canadian postal code
: The six-digit format is

[alpha][numeric][alpha][space] [numeric][alpha][numeric]

Example: A1B 2C3

US postal code
: The nine-digit format is

[5 digits][dash][4 digits]

.

Example: 12345-6789

This field is available only on the American Express Direct, Chase Paymentech Solutions, Elavon Americas, FDC Compass, FDC Nashville Global, GPN, OmniPay Direct, , TSYS Acquiring Solutions, Visa Platform Connect, and Worldpay VAP processors.

These processors have specific requirements:

American Express Direct: Before the postal code id sent to the processor, all non-alphanumeric characters are removed and, if the remaining value is longer than nine characters, the value is truncated starting from the right side.
Visa Platform Connect: This field is used to determine the nexus. The default is the postal code associated with your account. The postal code must consist of 5 to 9 digits.
Worldpay VAP: This field is used to determine the nexus. The default is the postal code associated with your account. The postal code must consist of 5 to 9 digits.

Specifications

Data Type:
String

Data Length:
10

Mapping Information

REST API Field:

orderInformation.shippingDetails.shipFromPostalCode

SCMP API Field:

ship_from_zip

Simple Order API Fields:

item_#_ shipFromPostalCode

shipFrom_postalCode

Processor Field Names

This list provides the Level II/Level III processor field name for each processor that supports Level II or Level III data.

American Express Direct:
Does not apply

Chase Paymentech Solutions:
Ship From ZIP/Postal Code

Elavon Americas:
Ship From Postal / ZIP Code

FDC Compass:
Ship From ZIP/Postal Code

FDC Nashville Global:
Ship From ZIP

GPN:
Ship From Postal/ZIP Code

OmniPay Direct:
Ship From Postal / ZIP Code

:
Origin ZIP

TSYS Acquiring Solutions:
Ship From Postal/ZIP Code

Visa Platform Connect:
shipFromAddress

Worldpay VAP:
shipFromPostalCode

orderInformation. shippingDetails.shippingMethod

Shipping method for the product.

Possible values:

lowcost

: Lowest-cost service.

sameday

: Courier or same-day service.

oneday

: Next-day or overnight service.

twoday

: Two-day service.

threeday

: Three-day service.

pickup

: Store pick-up.

other

: Other shipping method.

none

: No shipping method because product is a service or subscription.

Specifications

Data Type:
String

Data Length:
10

Mapping Information

REST API Field:

orderInformation.shippingDetails.shippingMethod

SCMP API Field:

shipping_method

Simple Order API Field:

shipTo_shippingMethod

187

in the following address:

Rua da Quitanda 187

Specifications

Data Type:
String

Data Length:
15

Mapping Information

REST API Field:

orderInformation.shipTo.buildingNumber

SCMP API Field:

ship_to_building_number

Simple Order API Field:

shipTo_buildingNumber

orderInformation. shipTo.buildingNumber

Building number in the street address.

Example
: The building number is

187

in the following address:

Rua da Quitanda 187

Specifications

Data Type:
String

Data Length:
15

Mapping Information

REST API Field:

orderInformation.shipTo.buildingNumber

SCMP API Field:

ship_to_building_number

Simple Order API Field:

shipTo_buildingNumber

orderInformation.shipTo.company

The company name included in the shipping address information.

Specifications

Data Type:
String

Data Length:
20

Mapping Information

REST API Field:

orderInformation.shipTo.company

Simple Order API Field:

shipTo_company

orderInformation. shipTo.country

Country of the shipping address.

Use the two-character ISO standard country code.

Specifications

Data Type:
Request

Data Format:
String

Data Length:
2

Mapping Information

REST API Field:

orderInformation.shipTo.country

SCMP API Field:

ship_to_country

Simple Order API Field:

shipTo_country

Processor Field Names

This list provides the Level II/Level III processor field name for each processor that supports Level II or Level III data:

Chase Paymentech Solutions: Destination Country Code

Elavon Americas: Destination Country Code

FDC Compass: Destination Country Code

FDC Nashville Global: Destination Country

GPN: Destination Country Code

OmniPay Direct: Destination Country Code

: Destination Country Code

TSYS Acquiring Solutions: Destination Country Code

Worldpay VAP: destinationCountryCode

orderInformation. shipTo.administrativeArea

County of the shipping address.

Specifications

Data Type:
String

Data Length:
80

Mapping Information

REST API Field:

orderInformation.shipTo.administrativeArea

SCMP API Field:

ship_to_county

Simple Order API Field:

shipTo_county

orderInformation. shipTo.destinationCode

Indicates destination chosen for the transaction.

Possible values:

01

: Ship to cardholder billing address.

02

: Ship to another verified address on file with merchant.

03

: Ship to address that is different than billing address.

04

: Ship to store (store address should be populated on request).

05

: Digital goods.

06

: Travel and event tickets, not shipped.

07

: Other.

Specifications

Data Type:
Integer

Data Length:
2

Mapping Information

REST API Field:

orderInformation.shipTo.destinationCode

SCMP API Field:

ship_to_destination_code

Simple Order API Field:

shipTo_destinationCode

orderInformation. shipTo.destinationTypes

Shipping destination.

Example
: Commercial, residential, store.

Specifications

Data Type:
String

Data Length:
25

Mapping Information

REST API Field:

orderInformation.shipTo.destinationTypes

SCMP API Field:

ship_to_destination_types

Simple Order API Field:

shipTo_destinationTypes

orderInformation. shipTo.district

Neighborhood, community, or region within a city or municipality.

Specifications

Data Type:
String

Data Length:
50

Mapping Information

REST API Field:

orderInformation.shipTo.district

SCMP API Field:

ship_to_district

Simple Order API Field:

shipTo_district

orderInformation. shipTo.email

orderInformation. shipTo.locality

City of the shipping address.

When the field is not included in the request and the service defaults to the

orderInformation.billTo.locality

field, and the value for this field is left blank in the Tax Detail Report.

Tax Calculation: The value in this field is used for tax calculations only when the
orderInformation.shipTo.administrativeArea
and
orderInformation.shipTo.country
API fields are present.

Specifications

Data Type:
String

Data Length:
40

Mapping Information

REST API Field:

orderInformation.shipTo.locality

SCMP API Field:

ship_to_city

Simple Order API Field:

shipTo_city

orderInformation.shipTo.middleName

The middle name of the recipient.

Specifications

Data Type:
String

Data Length:
50

Mapping Information

REST API Field:

orderInformation.shipTo.middleName

SCMP API Field:

ship_to_middlename

Simple Order API Field:

shipTo_middleName

orderInformation. shipTo.phoneNumber

Phone number for the shipping address.

This field is available only on the FDC Compass processor.

Specifications

Data Type:
String

Data Length:
15

Mapping Information

REST API Field:

orderInformation.shipTo.phoneNumber

SCMP API Field:

ship_to_phone

Simple Order API Field:

shipTo_phoneNumber

orderInformation. shipTo.postalCode

Postal code for the shipping address.

The postal code consists of 5 to 9 digits.

Canadian postal code
: The six-digit format is

[alpha][numeric][alpha][space] [numeric][alpha][numeric]

Example: A1B 2C3

US postal code
: The nine-digit format is

[5 digits][dash][4 digits]

.

Example: 12345-6789

Tax Calculation: When the
orderInformation.shipTo.postalCode
field is not included in the request and the service defaults to
orderInformation.billTo.postalCode
, the value for the
orderInformation.shipTo.postalCode
field is left blank in the Tax Detail Report.; When the postal code for the shipping address is not included in the request message, the postal code for the billing address is used for Tax Calculation. When the postal code for the billing address is not included in the request message, the postal code for the shipping address is required.

Specifications

Data Type:
String

Data Length:
10

Mapping Information

REST API Field:

orderInformation.shipTo.postalCode

SCMP API Field:

ship_to_zip

Simple Order API Field:

shipTo_postalCode

Processor Field Names

This list provides the Level II/Level III processor field name for each processor that supports Level II or Level III data:

orderInformation. shipTo.address1

First line of the shipping address.

When

orderInformation.shipTo.address1

is not included in the request and the service defaults to

orderInformation.billTo.address1

, the value for

orderInformation.shipTo.address1

is left blank in the Tax Detail Report.

Specifications

Data Type:
Request

Data Format:
String

Data Length:

Worldpay VAP:
35

All other processors:
60

Mapping Information

REST API Field:

orderInformation.shipTo.address1

SCMP API Field:

ship_to_address1

Simple Order API Field:

shipTo_street1

orderInformation. shipTo.address2

Second line of the shipping address.

Specifications

Data Type:
Request

Data Format:
String

Data Length:

Worldpay VAP:
35

All other processors:
60

Mapping Information

REST API Field:

orderInformation.shipTo.address2

SCMP API Field:

ship_to_address2

Simple Order API Field:

shipTo_street2

orderInformation. taxableAmount

orderInformation.taxDetails[].type = "national"

orderInformation.taxDetails[].type = "special"

orderInformation.taxDetails[].type = "state"

SCMP API Fields:

tax_total_city_tax

tax_total_country_tax

tax_total_county_tax

tax_total_special_tax

tax_total_state_tax

Simple Order API Fields:

taxReply_totalCityTaxAmount

taxReply_totalCountryTaxAmount

taxReply_totalCountyTaxAmount

taxReply_totalSpecialTaxAmount

taxReply_totalStateTaxAmount

orderInformation. taxDetails[].type

The type of tax.

This field can be set to the following values:

city

county

national

special

state

Specifications

Data Type:
String

Data Length:
15

Mapping Information

REST API Fields:

orderInformation.taxDetails[].type

Simple Order API Field: No corresponding field.

orderInformation. totaloffersCount

Total number of items in the order.

Possible values:

00

-

99

.

This field is available for processing secure transactions in France using the Banque de France et Tresor Public, BNP Paribas France, and Credit Mutuel-CIC processors.

Specifications

Data Type:
Integer

Data Length:
2

Mapping Information

REST API Field:

orderInformation.totaloffersCount

SCMP API Field:

total_offers_count

Simple Order API Fields:

ccAuthService_totaloffersCount

payerAuthEnrollService_totalOffersCount

orderInformation. amountDetails.refundBalance

This field specifies the amount remaining after the transaction which can be refunded.

This field is supported only for transactions with Korean Cyber Payments.

Specifications

Data Type:
String

Data Length:
15

Mapping Information

REST API Field:

orderInformation.amountDetails.refundBalance

Simple Order API Field:
No corresponding field.

order

These fields provide order information.

order.orderDiscountAmountSign

order.vatTaxAmountSign

order. orderDiscountAmountSign

Flag that indicates whether the invoice level discount amount should be interpreted as negative or positive.

Possible values:

negative

: discount amount is considered as a discount refund for the invoice.

positive

: discount amount is considered as a discount for the invoice.

This field relates to the value in the

order.orderDiscountAmount

field.

This field is available only on the Visa Platform Connect processor.

Specifications

Data Type:
String

Data Length:
8

Mapping Information

REST API Field:

order.orderDiscountAmountSign

SCMP API Field:

order_discount_amount_sign

Simple Order API Field:

purchaseTotals_discountAmountSign

Processor Field Names

This list provides the Level II/Level III processor field name for each processor that supports Level II or Level III data:

Visa Platform Connect: \ discountAmountSign

order. vatTaxAmountSign

Flag that indicates if the VAT tax amount should be interpreted as positive or negative.

Possible values:

negative

: VAT amount is negative in the invoice.

positive

: VAT amount is positive in the invoice.

A positive VAT tax amount reduces the amount of the invoice.

This field is related to the value in the

orderInformation.amountDetails.taxDetails[].amount

field.

This field is available only on the Visa Platform Connect processor.

Specifications

Data Type:
String

Data Length:
8

Mapping Information

REST API Field:

order.vatTaxAmountSign

SCMP API Field:

vat_tax_amount_sign

Simple Order API Field:

otherTax_vatTaxAmountSign

Processor Field Names

This list provides the Level II/Level III processor field name for each processor that supports Level II or Level III data:

Visa Platform Connect: vatTaxAmountSign

organizationInformation

These fields provide information about the organization.

organizationInformation.businessInformation. address.address1

organizationInformation.businessInformation. address.address2

organizationInformation.businessInformation. address.administrativeArea

organizationInformation.businessInformation. address.country

organizationInformation.businessInformation. address.locality

organizationInformation.businessInformation. address.postalCode

organizationInformation.businessInformation. businessContact.firstName

organizationInformation.businessInformation. businessContact.lastName

organizationInformation.businessInformation. businessContact.middleName

organizationInformation.businessInformation. businessContact.phoneNumber

organizationInformation.businessInformation. businessContact.email

organizationInformation. businessInformation.description

organizationInformation.businessInformation. doingBusinessAs

organizationInformation.businessInformation. emergencyContact.email

organizationInformation.businessInformation. emergencyContact.firstName

organizationInformation.businessInformation. emergencyContact.lastName

organizationInformation.businessInformation. emergencyContact.middleName

organizationInformation.businessInformation. emergencyContact.phoneNumber

organizationInformation. businessInformation.merchantCategoryCode

organizationInformation.businessInformation.name

organizationInformation.businessInformation. phoneNumber

organizationInformation.businessInformation. technicalContact.email

organizationInformation.businessInformation. technicalContact.firstName

organizationInformation.businessInformation. technicalContact.lastName

organizationInformation.businessInformation. technicalContact.middleName

organizationInformation.businessInformation. technicalContact.phoneNumber

organizationInformation. businessInformation.timeZone

organizationInformation. businessInformation.websiteUrl

organizationInformation.configurable

organizationInformation.organizationId

organizationInformation.parentOrganizationId

organizationInformation.status

organizationInformation.type

organizationInformation. businessInformation. address. address1

First line of the merchant street address.

This field is not required when you are using the

ADDPRODUCT

boarding flow.

Syntax

 {
  "organizationInformation": {
    "businessInformation": {
      "address": {
        "address1": "123 Baker St"
      }
     }
   }
}

The value of this field must conform to this regular expression:

^[\\u00C0-\\u00D6\\u00D8-\\u00F6\\u00F8-\\u01FFa-zA-Z0-9().\\-_#,;/@$:!% ]{1,}$

Specifications

Data Type:
String

Minimum Data Length:
1

Maximum Data Length:
60

Mapping Information

No corresponding fields.

organizationInformation. businessInformation. address. address2

Second line of the merchant street address.

Syntax

{
  "organizationInformation": {
    "businessInformation": {
      "address": {
        "address2": "Unit 1"
      }
    }
  }
}

The value of this field must conform to this regular expression:

^[\\u00C0-\\u00D6\\u00D8-\\u00F6\\u00F8-\\u01FFa-zA-Z0-9().\\-_#,;/@$:!% ]{1,}$

Specifications

Data Type:
String

Minimum Data Length:
0

Maximum Data Length:
60

Mapping Information

No corresponding fields.

organizationInformation. businessInformation. address. administrativeArea

State or province of the merchant. Required for Australia, US, and Canada.

Syntax

{
  "organizationInformation": {
    "businessInformation": {
      "address": {
        "administrativeArea": "CA"
      }
    }
  }
}

The value of this field must conform to this regular expression:

^[0-9a-zA-Z\\u00A1-\\uFFFF ]*$

Specifications

Data Type:
String

Minimum Data Length:
1

Maximum Data Length:
50

Mapping Information

No corresponding fields.

organizationInformation. businessInformation. address. country

The country in which the merchant resides.

This field is not required when you are using the

ADDPRODUCT

boarding flow.

Use the ISO Alpha-2 country code described in the ISO 3166 standard.

For more information, see the ISO country codes document: iso-3166-country-codes.html

Syntax

{
  "organizationInformation": {
    "businessInformation": {
      "address": {
        "country": "US"
      }
    }
  }
}

The value of this field must conform to this regular expression:

^[a-zA-Z]*$

Specifications

Data Type:
String

Minimum Data Length:
2

Maximum Data Length:
2

Mapping Information

No corresponding fields.

organizationInformation. businessInformation. address. locality

City in which the merchant resides.

This field is not required when you are using the

ADDPRODUCT

boarding flow.

Syntax

{
  "organizationInformation": {
    "businessInformation": {
      "address": {
        "locality": "San Francisco"
      }
    }
  }
}

The value of this field must conform to this regular expression:

^[0-9a-zA-Z _\\-\\.'\\u00A1-\\uFFFF]+$

Specifications

Data Type:
String

Minimum Data Length:
1

Maximum Data Length:
50

Mapping Information

No corresponding fields.

organizationInformation. businessInformation. address. postalCode

Postal code for the merchant billing address.

Syntax

{
  "organizationInformation": {
    "businessInformation": {
      "address": {
        "postalCode": "12345"
      }
    }
  }
}

The value of this field must conform to this regular expression:

^[0-9a-zA-Z ]*$

Specifications

Data Type:
String

Minimum Data Length:
1

Maximum Data Length:
20

Mapping Information

No corresponding fields.

organizationInformation. businessInformation. businessContact. firstName

First name of the business contact for the merchant business.

Syntax

{
  "organizationInformation": {
    "businessInformation": {
      "businessContact": {
        "firstName": "John"
      }
    }
  }
}

The value of this field must conform to this regular expression:

 ^[0-9a-zA-Z _\\-\\+\\.\\*\\\"/'&\\,\\(\\)!$;:?@\\#\\u00A1-\\uFFFF]+$

Specifications

Data Type:
String

Minimum Data Length:
1

Maximum Data Length:
50

Mapping Information

No corresponding fields.

organizationInformation. businessInformation. businessContact. lastName

Last name of the business contact for the merchant business.

Syntax

{
  "organizationInformation": {
    "businessInformation": {
      "businessContact": {
        "lastName": "Schmidt"
      }
    }
  }
}

The value of this field must conform to this regular expression:

 ^[0-9a-zA-Z _\\-\\+\\.\\*\\\"/'&\\,\\(\\)!$;:?@\\#\\u00A1-\\uFFFF]+$

Specifications

Data Type:
String

Minimum Data Length:
1

Maximum Data Length:
50

Mapping Information

No corresponding fields.

organizationInformation. businessInformation. businessContact. middleName

Middle name of the business contact for the merchant business.

Syntax

{
  "organizationInformation": {
    "businessInformation": {
      "businessContact": {
        "middleName": "Jacob"
      }
    }
  }
}

The value of this field must conform to this regular expression:

 ^[0-9a-zA-Z _\\-\\+\\.\\*\\\"/'&\\,\\(\\)!$;:?@\\#\\u00A1-\\uFFFF]+$

Specifications

Data Type:
String

Minimum Data Length:
0

Maximum Data Length:
50

Mapping Information

No corresponding fields.

organizationInformation. businessInformation. businessContact. phoneNumber

Phone number of the business contact for the merchant business.

Syntax

{
  "organizationInformation": {
    "businessInformation": {
      "businessContact": {
        "phoneNumber": "4564561234"
      }
    }
  }
}

The value of this field must conform to this regular expression:

 ^[0-9a-zA-Z\\\\+\\\\-]+$

Specifications

Data Type:
String

Minimum Data Length:
1

Maximum Data Length:
20

Mapping Information

No corresponding fields.

organizationInformation. businessInformation. businessContact. email

Email address of the business contact for the merchant business, including the full domain name, such as jdoe@example.com.

Syntax

{
  "organizationInformation": {
    "businessInformation": {
      "businessContact": {
        "email": "jdoe@example.com."
      }
    }
  }
}

The syntax must conform to this regular expression:

^([a-zA-Z0-9_\\-\\.]+)@((\\[[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.)|(([a-zA-Z0-9\\-]+\\.)+))([a-zA-Z]{2,50}|[0-9]{1,3})(\\]?)$

Specifications

Data Type:
String

Minimum Data Length:
1

Maximum Data Length:
100

Mapping Information

No corresponding fields.

organizationInformation. businessInformation. description

Description of the merchant business.

Syntax

{
  "organizationInformation": {
    "description": [
      "international food restaurant"
    ]
  }
}

The value of this field must conform to this regular expression:

^[\\u00C0-\\u00D6\\u00D8-\\u00F6\\u00F8-\\u01FF\\u00C0-\\u00D6\\u00D8
 -\\u00F6\\u00F8-\\u01FF\\n\\ra-zA-Z0-9().\\-_#,;/\\\\@$:&!?%
 \\u00AB\\u00BB\\u20AC\\u20A3\\u00AB\\u00BB\\u20AC\\u20A3 ]{1,}$

Specifications

Data Type:
String

Minimum Data Length:
0

Maximum Data Length:
250

Mapping Information

No corresponding fields.

organizationInformation. businessInformation. doingBusinessAs

The pseudonym, if one applies, for the merchant.

Syntax

{
  "organizationInformation": {
    "doingBusinessAs": [
      "Betos"
    ]
  }
}

The value of this field must conform to this regular expression:

^[0-9a-zA-Z _\\-\\+\\.\\*\\\"/'&\\,\\(\\)!$;:?@\\#\\u00A1-\\uFFFF]+$

Specifications

Data Type:
String

Minimum Data Length:
1

Maximum Data Length:
60

Mapping Information

No corresponding fields.

organizationInformation. businessInformation. emergencyContact. email

Email address of the merchant's emergency contact, including the full domain name.

Syntax

{
  "organizationInformation": {
    "businessInformation": {
      "emergencyContact": {
        "email": "jsmith@example.com"
      }
     }
   }
}

The syntax must conform to this regular expression:

^([a-zA-Z0-9_\\-\\.]+)@((\\[[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.)|(([a-zA-Z0-9\\-]+\\.)+))([a-zA-Z]{2,50}|[0-9]{1,3})(\\]?)$

Specifications

Data Type:
String

Minimum Data Length:
1

Maximum Data Length:
100

Mapping Information

No corresponding fields.

organizationInformation. businessInformation. emergencyContact. firstName

First name of the merchant's emergency contact.

Syntax

{
  "organizationInformation": {
    "businessInformation": {
      "emergencyContact": {
        "firstName": "John"
      }
    }
  }
}

The syntax must conform to this regular expression:

^[0-9a-zA-Z _\\-\\+\\.\\*\\\"/'&\\,\\(\\)!$;:?@\\#\\u00A1-\\uFFFF]+$

Specifications

Data Type:
String

Minimum Data Length:
1

Maximum Data Length:
50

Mapping Information

No corresponding fields.

organizationInformation. businessInformation. emergencyContact. lastName

Last name of the merchant's emergency contact.

Syntax

{
  "organizationInformation": {
    "businessInformation": {
      "emergencyContact": {
        "lastName": "Smith"
      }
    }
  }
}

The syntax must conform to this regular expression:

^[0-9a-zA-Z _\\-\\+\\.\\*\\\"/'&\\,\\(\\)!$;:?@\\#\\u00A1-\\uFFFF]+$

Specifications

Data Type:
String

Minimum Data Length:
1

Maximum Data Length:
50

Mapping Information

No corresponding fields.

organizationInformation. businessInformation. emergencyContact. middleName

Middle name of the merchant's emergency contact.

Syntax

{
  "organizationInformation": {
    "businessInformation": {
      "emergencyContact": {
        "middleName": "Steven"
      }
    }
  }
}

The syntax must conform to this regular expression:

^[0-9a-zA-Z _\\-\\+\\.\\*\\\"/'&\\,\\(\\)!$;:?@\\#\\u00A1-\\uFFFF]+$

Specifications

Data Type:
String

Minimum Data Length:
1

Maximum Data Length:
50

Mapping Information

No corresponding fields.

organizationInformation. businessInformation. emergencyContact. phoneNumber

Phone number of the merchant's emergency contact.

Syntax

{
  "organizationInformation": {
    "businessInformation": {
      "emergencyContact": {
        "phoneNumber": "4564561234"
      }
    }
  }
}

The syntax must conform to this regular expression:

^[0-9a-zA-Z\\+\\-]+$

Specifications

Data Type:
String

Minimum Data Length:
1

Maximum Data Length:
20

Mapping Information

No corresponding fields.

organizationInformation. businessInformation. merchantCategoryCode

A four-digit code that is used to classify the business by its goods and services.

This number is assigned by the merchant acquiring bank.

Syntax

{
  "organizationInformation": {
    "businessInformation": {
      "merchantCategoryCode": "1234"
    }
  }
}

The syntax must conform to this regular expression:

^\\d{3,4}$

Specifications

Data Type:
String

Minimum Data Length:
3

Maximum Data Length:
4

Mapping Information

No corresponding fields.

organizationInformation. businessInformation. name

Actual name of the merchant's business.

Syntax

{
  "organizationInformation": {
    "name": [
      "Betos Restaurant"
    ]
  }
}

The value of this field must conform to this regular expression:

^[0-9a-zA-Z _\-\+\.\*\"/'&\,\(\)!$;:?@\#¡-]+$

Specifications

Data Type:
String

Minimum Data Length:
1

Maximum Data Length:
60

Mapping Information

No corresponding fields.

organizationInformation. businessInformation. phoneNumber

Phone number of the merchant.

Syntax

{
  "organizationInformation": {
    "businessInformation": {
      "phoneNumber": "4564561234"
    }
  }
}

The value of this field must conform to this regular expression:

 ^[0-9a-zA-Z\\+\\-]+$

Specifications

Data Type:
String

Maximum Data Length:
20

Mapping Information

No corresponding fields.

organizationInformation. businessInformation. technicalContact. email

Email address of the technical contact, including the full domain name, such as jdoe@example.com.

Syntax

{
  "organizationInformation": {
    "businessInformation": {
      "technicalContact": {
        "email": "jsmerth@example.com"
      }
    }
  }
}

The syntax must conform to this regular expression:

^([a-zA-Z0-9_\\-\\.]+)@((\\[[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.)|(([a-zA-Z0-9\\-]+\\.)+))([a-zA-Z]{2,50}|[0-9]{1,3})(\\]?)$

Specifications

Data Type:
String

Maximum Data Length:
100

Mapping Information

No corresponding fields.

organizationInformation. businessInformation. technicalContact. firstName

First name of the merchant's technical contact.

Syntax

{
  "organizationInformation": {
    "businessInformation": {
      "technicalContact": {
        "firstName": "Jennifer"
      }
    }
  }
}

The syntax must conform to this regular expression:

^[0-9a-zA-Z _\\-\\+\\.\\*\\\"/'&\\,\\(\\)!$;:?@\\#\\u00A1-\\uFFFF]+$

Specifications

Data Type:
String

Maximum Data Length:
50

Mapping Information

No corresponding fields.

organizationInformation. businessInformation. technicalContact. lastName

Last name of the merchant's technical contact.

Syntax

{
  "organizationInformation": {
    "businessInformation": {
      "technicalContact": {
        "lastName": "Smerth"
      }
    }
  }
}

The syntax must conform to this regular expression:

^[0-9a-zA-Z _\\-\\+\\.\\*\\\"/'&\\,\\(\\)!$;:?@\\#\\u00A1-\\uFFFF]+$

Specifications

Data Type:
String

Maximum Data Length:
50

Mapping Information

No corresponding fields.

organizationInformation. businessInformation. technicalContact. middleName

Middle name of the merchant's technical contact.

Syntax

{
  "organizationInformation": {
    "businessInformation": {
      "technicalContact": {
        "middleName": "Stephanie"
      }
    }
  }
}

The syntax must conform to this regular expression:

^[0-9a-zA-Z _\\-\\+\\.\\*\\\"/'&\\,\\(\\)!$;:?@\\#\\u00A1-\\uFFFF]+$

Specifications

Data Type:
String

Maximum Data Length:
50

Mapping Information

No corresponding fields.

organizationInformation. businessInformation. technicalContact. phoneNumber

Phone number of the merchant's technical contact.

Syntax

{
  "organizationInformation": {
    "businessInformation": {
      "technicalContact": {
        "phoneNumber": "4564561234"
      }
    }
  }
}

The syntax must conform to this regular expression:

^[0-9a-zA-Z\\+\\-]+$

Specifications

Data Type:
String

Maximum Data Length:
20

Mapping Information

No corresponding fields.

organizationInformation. businessInformation. timeZone

Preferred time zone of the merchant.

Possible Values


America/Anchorage	Asia/Jerusalem	Europe/Belgrade
Africa/Cairo	Asia/Katmandu	Europe/Berlin
Africa/Johannesburg	Asia/Kuala_Lumpur	Europe/Brussels
Africa/Tripoli	Asia/Macao	Europe/Bucharest
Africa/Tunis	Asia/Magadan	Europe/Budapest
America/Bogota	Asia/Manila	Europe/Copenhagen
America/Buenos_Aires	Asia/Rangoon	Europe/Dublin
America/Chicago	Asia/Riyadh	Europe/Helsinki
America/Denver	Asia/Saigon	Europe/Istanbul
America/Edmonton	Asia/Seoul	Europe/Lisbon
America/Godthab	Asia/Shanghai	Europe/London
America/Halifax	Asia/Singapore	Europe/Madrid
America/Indianapolis	Asia/Taipei	Europe/Malta
America/La_Paz	Asia/Tbilisi	Europe/Minsk
America/Los_Angeles	Asia/Tokyo	Europe/Monaco
America/Mexico_City	Asia/Yakutsk	Europe/Moscow
America/New_York	Atlantic/Cape_Verde	Europe/Oslo
America/Noronha	Australia/Adelaide	Europe/Paris
America/Phoenix	Australia/Brisbane	Europe/Prague
America/Sao_Paulo	Australia/Broken_Hill	Europe/Riga
America/St_Johns	Australia/Darwin	Europe/Rome
America/Vancouver	Australia/Eucla	Europe/Stockholm
America/Winnipeg	Australia/Hobart	Europe/Vienna
Asia/Baku	Australia/Lindeman	Europe/Warsaw
Asia/Bangkok	Australia/Lord_Howe	Europe/Zurich
Asia/Calcutta	Australia/Melbourne	GMT
Asia/Dacca	Australia/Perth	Pacific/Auckland
Asia/Dubai	Australia/Sydney	Pacific/Honolulu
Asia/Hong_Kong	Europe/Amsterdam	Pacific/Norfolk
Asia/Jakarta	Europe/Athens	Pacific/Pago_Pago

Syntax

 {
  "organizationInformation": {
    "businessInformation": {
      "timeZone": "America/Chicago"
    }
  }
}

Specifications

Data Type:
Enum

Mapping Information

No corresponding fields.

organizationInformation. businessInformation. websiteUrl

URL of the merchant website.

Syntax

{
  "organizationInformation": {
    "businessInformation": {
      "websiteURL": "http://www.testwebsite.com"
     }
    }
}

The value of this field must conform to this regular expression:

 \\b((?:https?://|www\\d{0,3}[.]|[a-z0-9.\\-]+[.][a-z]{2,4}/)(?:[^\\s()<>]+|\\(([^\\s()<>]+|(\\([^\\s()<>]+\\)))*\\))+(?:\\(([^\\s()<>]+|(\\([^\\s()<>]+\\)))*\\)|[^\\s`!()\\[\\]{};:'\".,<>?Â«Â»â€œâ€â€˜â€™]))

Specifications

Data Type:
String

Minimum Data Length:
0

Maximum Data Length:
100

Mapping Information

No corresponding fields.

organizationInformation. configurable

The one organization, with the exception of TRANSACTING types, that may be used for product configuration.

Possible Values

true

: Use this value for merchant organizations.

false

(default): Use this value to enable transacting and structural organizations.

Syntax

{
  "organizationInformation": {
    "configurable": [
      "TRUE" 
      ]
    }
}

Specifications

Data Type:
Boolean

Mapping Information

No corresponding fields.

organizationInformation. organizationId

The ID assigned to the merchant during the boarding process.

This value cannot be changed. If this field is not set, a random ID is generated and applied.

The organization ID must be unique across all customers and environments (production and sandbox).

Syntax

{
  "organizationInformation": {
    "organizationId": [
      "merchant-test1" 
      ]
    }
}

The value of this field must conform to this regular expression:

^[0-9a-zA-Z_]+$

Specifications

Data Type:
String

Minimum Data Length:
6

Maximum Data Length:
30

Mapping Information

No corresponding fields.

organizationInformation. parentOrganizationId

The ID of the parent organization for the boarding merchant.

Syntax

{
  "organizationInformation": {
    "parentOrganizationId": [
      "bestcompanies" 
      ]
    }
}

The value of this field must conform to this regular expression:

^[0-9a-zA-Z_]+$

Specifications

Data Type:
String

Minimum Data Length:
6

Maximum Data Length:
30

Mapping Information

No corresponding fields.

organizationInformation. status

Determines the status of the merchant after they are boarded.

Possible Values

DRAFT

: Use this setting to indicate the draft status of the merchant.

LIVE

: Use this setting in the production (live) environment.

TEST

: Use this setting in the CAS (sandbox) environment.

Syntax

{
  "organizationInformation": {
    "status": [
      "LIVE" 
      ]
    }
}

Specifications

Data Type:
String

Minimum Data Length:
4

Maximum Data Length:
5

Mapping Information

No corresponding fields.

organizationInformation. type

Determines the type of merchant that is applied during the boarding process.

Possible Values

MERCHANT

STRUCTURAL

TRANSACTING

Syntax

{
  "organizationInformation": {
    "configurable": [
      "MERCHANT" 
      ]
    }
}

Specifications

Data Type:
String

Minimum Data Length:
6

Maximum Data Length:
30

Mapping Information

No corresponding fields.

otp

The one-time password (OTP) that the cardholder enters when the

stepUpOption.method

field is set to one of these values:

OTP_EMAIL

OTP_ONLINE_BANKING

OTP_SMS

Specifications

Data Type:
String

Data Length:
8

Mapping Information

REST API Field:

otp

Simple Order API Field:
No corresponding field.

p2peConfirmation

Status of the point-to-point encryption (P2PE) confirmation from the merchant.

The confirmation status is recorded only if the

p2peStatus

field is set to

Enabled

.

Valid values:

Pending

: Merchant has not yet confirmed the P2PE status.

Confirmed

: Merchant has confirmed the P2PE status.

Rejected

: Merchant has rejected the P2PE status.

Specifications

Data Type:
Enum of string

Data Length:
Pre-defined values

Mapping Information

REST API Field:

p2peConfirmation

SCMP API Field:
No corresponding field

Simple Order API Field:
No corresponding field

p2peConfirmationDateInUTC

Point-to-point encryption (P2PE) confirmation timestamp in UTC format.

Format:
yyyy-MM-DDThh:mm:ssZ

The P2PE confirmation timestamp is recorded only if the

p2peConfirmation

field is set to

Confirmed

.

Example
:

2021-08-11T22:47:57Z

equals August 11, 2021, at 22:47:57 (10:47:57 p.m.). The T separates the date and the time. The Z indicates UTC.

Specifications

Data Type:
String (date/time)

Data Length:
Formatted value

Mapping Information

REST API Field:

p2peConfirmationDateInUTC

SCMP API Field:
No corresponding field

Simple Order API Field:
No corresponding field

p2peStatus

Status of the point-to-point encryption (P2PE) for the terminal.

Valid values:

Enabled

Disabled

Specifications

Data Type:
Enum of string

Data Length:
Pre-defined values

Mapping Information

REST API Field:

p2peStatus

SCMP API Field:
No corresponding field

Simple Order API Field:
No corresponding field

partName

Point of Sale (POS) device name.

When sending a transaction request, you must send either the

partName

field or both the

make

and

model

fields.

The following values can be used:

INGENICO LANE 3000

INGENICO LANE 5000

INGENICO LINK 2500

PAX Aries 6

PAX Aries 8

PAX A60

PAX A80

PAX A920

PAX D135

PAX E600

PAX E700

PAX E800

PAX E800 lite

PAX SP30

PAX S80

PAX S300

Verifone E355

Verifone M400

Verifone P400

Specifications

Data Type:
String

Data Size:
Pre-defined values

Mapping Information

REST API Field:

partName

SCMP API Field:
No corresponding field

Simple Order API Field:
No corresponding field

paymentAccountInformation

These fields provide payment account information.

paymentAccountInformation.card.accountType

paymentAccountInformation.card.brandName

paymentAccountInformation.card.brands.brandName

paymentAccountInformation.card.brands.type

paymentAccountInformation.card.credentialType

paymentAccountInformation.card.currency

paymentAccountInformation.card.maxLength

paymentAccountInformation.card.prepaidReloadableCode

paymentAccountInformation.card.type

paymentAccountInformation.features. acceptanceLevel

paymentAccountInformation.features. accountFundingSource

paymentAccountInformation.features. accountFundingSourceSubType

paymentAccountInformation.features.cardPlatform

paymentAccountInformation.features.cardProduct

paymentAccountInformation.features.comboCard

paymentAccountInformation. features.corporatePurchase

paymentAccountInformation.features.healthCard

paymentAccountInformation.features.messageType

paymentAccountInformation.network.id

paymentAccountInformation. card.accountType

Type of payment credential.

If you have questions about this field, contact customer support.

Visa and Discover

Possible values:

PAN

: Full payment card number

TOKEN

: Network token

Mastercard

Due to BIN source information, the value

TOKEN

is returned to indicate that the BIN range is tokenizable and not whether the payment credential is the PAN or a token.

Possible value:

TOKEN

: Indicates that the payment card can be tokenized.

Specifications

Data Type:
String

Data Length:
5

Mapping Information

No corresponding fields.

paymentAccountInformation. card.brandName

Card brand name.

The brand name corresponds to the three-digit card type.

Specifications

Data Type:
String

Data Length:
20

Mapping Information

No corresponding fields.

paymentAccountInformation. card.brands.brandName

Card brand name.

The brand name corresponds to the three-digit card type. This field is returned in the

brands[]

array with the

paymentAccountInformation.card.brands.type

field when the card is co-branded with a local brand, such as China UnionPay, mada, or RuPay and a global brand, such as Visa or Mastercard.

Response example with the

brands[]

array:

{
   "paymentAccountInformation": {
      "card": {
         "type": "004",
         "brandName": "DISCOVER",
         "maxLength": "16",
         "currency": "CNY",
         "brands": [
            {
               "type": "004",
               "brandName": "DISCOVER"
            },
            {
               "type": "004",
               "brandName": "CHINA UNION PAY"
            }
         ]
      }

Specifications

Data Type:
String

Data Length:
20

Mapping Information

No corresponding fields.

paymentAccountInformation. card.brands.type

Three-digit value that indicates the card type.

This field is returned in the

brands[]

array with the

paymentAccountInformation.card.brands.brandName

field when the card is co-branded with a local brand, such as China UnionPay, mada, or RuPay and a global brand, such as Visa or Mastercard.

Response example with the

brands[]

array:

{
   "paymentAccountInformation": {
      "card": {
         "type": "004",
         "brandName": "DISCOVER",
         "maxLength": "16",
         "currency": "CNY",
         "brands": [
            {
               "type": "004",
               "brandName": "DISCOVER"
            },
            {
               "type": "062",
               "brandName": "CHINA UNION PAY"
            }
         ]
      }

Possible values:

001

: Visa

002

: Mastercard and Eurocard

003

: American Express

004

: Discover

005

: Diners Club

006

: Carte Blanche

007

: JCB

014

: EnRoute

021

: JAL

024

: Maestro (UK Domestic)

031

: Delta

033

: Visa Electron

034

: Dankort

036

: Cartes Bancaires

037

: Carta Si

039

: Encoded account number

040

: UATP

042

: Maestro (International)

050

: Hipercard

051

: Aura

054

: Elo

058

: Carnet

059

: ValueLink

061

: RuPay

062

: China UnionPay

066

: Banricompras

Specifications

Data Type:
String

Data Length:
3

Mapping Information

No corresponding fields.

paymentAccountInformation. card.credentialType

Type of payment credential.

If you have questions about this field, contact customer support.

Visa and Discover

Possible values:

PAN

: Full payment card number

TOKEN

: Network token

Mastercard

Due to BIN source information, the value

TOKEN

is returned to indicate that the BIN range is tokenizable and not whether the payment credential is the PAN or a token.

Possible value:

TOKEN

: Indicates that the payment card can be tokenized.

Specifications

Data Type:
String

Data Length:
5

Mapping Information

No corresponding fields.

paymentAccountInformation. card.currency

Currency used for the card.

Three-character ISO Standard Currency Codes.

Specifications

Data Type:
String

Data Length:
3

Mapping Information

No corresponding fields.

paymentAccountInformation. card.maxLength

Maximum length of the card number.

Specifications

Data Type:
String

Data Length:
2

Mapping Information

No corresponding fields.

paymentAccountInformation. card.prepaidReloadableCode

Flag that indicates whether the prepaid card is reloadable.

This field is available only on theWorldpay VAP processor.

Possible values:

Yes

: Prepaid card is reloadable.

No

: Prepaid card is not reloadable.

Unknown

: Cannot be determined whether prepaid card is reloadable.

Specifications

Data Type:
String

Data Length:
7

Mapping Information

REST API Field:

paymentAccountInformation.card.prepaidReloadableCode

SCMP API Field:

card_prepaid_reloadable

Simple Order API Field:

card_prepaidReloadable

paymentAccountInformation. card.type

Three-digit value that indicates the card type.

Possible values:

001

: Visa

002

: Mastercard and Eurocard

003

: American Express

004

: Discover

005

: Diners Club

006

: Carte Blanche

007

: JCB

014

: EnRoute

021

: JAL

024

: Maestro (UK Domestic)

031

: Delta

033

: Visa Electron

034

: Dankort

036

: Cartes Bancaires

037

: Carta Si

039

: Encoded account number

040

: UATP

042

: Maestro (International)

050

: Hipercard

051

: Aura

054

: Elo

058

: Carnet

059

: ValueLink

061

: RuPay

062

: China UnionPay

066

: Banricompras

068

: PayPak

Specifications

Data Type:
String

Data Length:
3

Mapping Information

No corresponding fields.

paymentAccountInformation. features. acceptanceLevel

Acceptance level of the primary account number (PAN).

Possible values:

0

: Normal

1

: Monitor

2

: Refuse

3

: Not allowed

4

: Private

5

: Test

Specifications

Data Type:
String

Data Length:
2

Mapping Information

No corresponding fields.

paymentAccountInformation. features. accountFundingSource

Funding source of the payment account.

Possible values:

CHARGE

CREDIT

CREDIT OR DEBIT

DEBIT

DEFERRED DEBIT

PREPAID

Specifications

Data Type:
String

Data Length:
20

Mapping Information

No corresponding fields.

paymentAccountInformation. features. accountFundingSourceSubType

Type of prepaid card.

This field is returned when the

accountFundingSource

field value is

PREPAID

.

Possible values:

Non-reloadable

Reloadable

Specifications

Data Type:
String

Data Length:
20

Mapping Information

No corresponding fields.

paymentAccountInformation. features. cardPlatform

Payment card platform.

Possible values:

BUSINESS

COMMERCIAL

CONSUMER

GOVERNMENT

Specifications

Data Type:
String

Data Length:
20

Mapping Information

No corresponding fields.

paymentAccountInformation. features. cardProduct

Type of issuer card product.

Examples:

Visa Signature

Visa Infinite

Visa Classic

Specifications

Data Type:
String

Data Length:
200

Mapping Information

No corresponding fields.

paymentAccountInformation. features. comboCard

Indicates the type of combo card.

Possible values:

0

: Not a combo card

1

: Credit and prepaid combo card

2

: Credit and debit combo card

Specifications

Data Type:
String

Data Length:
1

Mapping Information

No corresponding fields.

paymentAccountInformation. features.corporatePurchase

This field indicates whether the card can be used for corporate purchasing. This field is only applicable to American Express cards.

Possible values:

true

false

Specifications

Data Type:
Boolean

Mapping

REST Field Name:

paymentAccountInformation.features.corporatePurchase

SCMP Field Name:

corporate_purchase

Simple Order Field Name:

corporate_purchase

paymentAccountInformation. features. healthCard

This value indicates that a card number is a health card BIN.

Currently, this conditional field is supported only for Visa BINs.

Possible values:

true

false

Specifications

Data Type:
Boolean

Data Length:
5

Mapping Information

REST API Field:

paymentAccountInformation.features.healthCard

SCMP API Field:

health_card

Simple Order API Fields:

healthCard

paymentAccountInformation. features. messageType

Type of BIN-based authentication.

Possible values:

S

: Single message

D

: Dual message

Specifications

Data Type:
String

Data Length:
1

Mapping Information

No corresponding fields.

paymentAccountInformation. network.id

Contains the code that identifies the network.

Possible values:

0

: Normal

1

: Monitor

2

: Refuse

3

: Not allowed

4

: Private

5

: Test

Specifications

Data Type:
String

Data Length:
2

Mapping Information

No corresponding fields.

paymentCredentialType

The type of payment credentials that are requested by the Token Management Service.

By default, payment credentials include network token and cryptogram or dynamic CVV.

When this field is set to

NETWORK_TOKEN

, only the network token is requested and cryptogram or dynamic CVV are excluded.

When this field is set to

SECURITY_CODE

, the dynamic CVV is requested and is returned with the network token card number. Dynamic CVV is supported only for American Express card brands and

When this field is set to

CRYPTOGRAM

, the cryptogram is requested and returned with the network token card number. You cannot request the cryptogram for American Express card brands.

Possible values:

CRYPTOGRAM

NETWORK_TOKEN

SECURITY_CODE

Specifications

Data Type:
Enum

Mapping Information

REST API Field:

paymentCredentialType

SCMP API Field:
No corresponding field

Simple Order API Field:
No corresponding field

paymentInformation

These fields provide payment information.

paymentInformation.accountFeatures. accountHolderType

paymentInformation.accountFeatures.accountStatus

paymentInformation.accountFeatures.accountType

paymentInformation.accountFeatures.affluenceIndicator

paymentInformation.accountFeatures.balanceAmount

paymentInformation.accountFeatures. balanceAmountType

paymentInformation.accountFeatures.balanceSign

paymentInformation.accountFeatures.category

paymentInformation.accountFeatures.commercial

paymentInformation.accountFeatures.currency

paymentInformation.accountFeatures.group

paymentInformation.accountFeatures.healthCare

paymentInformation.accountFeatures.level3Eligible

paymentInformation.accountFeatures.payRoll

paymentInformation.accountFeatures.pinlessDebit

paymentInformation.accountFeatures.prepaid

paymentInformation.accountFeatures.regulated

paymentInformation.accountFeatures.signatureDebit

paymentInformation.bank.account.checkNumber

paymentInformation.bank.account. checkTransactionCode

paymentInformation.bank.account.correctedAccountNumber

paymentInformation.bank.account. correctedRoutingnumber

paymentInformation.bank.account.iban

paymentInformation.bank.account. imageReferenceNumber

paymentInformation.bank.accountName

paymentInformation.bank.accountNumber

paymentInformation.bank.account.type

paymentInformation.bank.address1

paymentInformation.bank.branchCode

paymentInformation.bank.checkDigit

paymentInformation.bank.code

paymentInformation.bank.country

paymentInformation.bank.iban

paymentInformation.bank.locality

paymentInformation.bank.name

paymentInformation.bank.routingNumber

paymentInformation.bank.scheme

paymentInformation.bank.swiftCode

paymentInformation.binCountry

paymentInformation.card.accountEncoderId

paymentInformation.card.bin

paymentInformation.card.cardType

paymentInformation.card.expirationMonth

paymentInformation.card.expirationYear

paymentInformation.card.hashedNumber

paymentInformation.card.issueNumber

paymentInformation.card.number

paymentInformation.card.passPhrase

paymentInformation.card.personalData

paymentInformation.card.productName

paymentInformation.card.productSubtype

paymentInformation.card.securityCode

paymentInformation.card.securityCodeIndicator

paymentInformation.card.sourceAccountType

paymentInformation.card.sourceAccountTypeDetails

paymentInformation.card.startMonth

paymentInformation.card.startYear

paymentInformation.card.suffix

paymentInformation.card.type

paymentInformation.card.typeSelectionIndicator

paymentInformation.card.useAs

paymentInformation.customer.customerId

paymentInformation.customer.id

paymentInformation.directDebit.mandate. clearingDate

paymentInformation.directDebit.mandate.id

paymentInfomation.eWallet.fundingSource

paymentInfomation.eWallet.name

paymentInformation.fluidData.descriptor

paymentInformation.fluidData.encoding

paymentInformation.fluidData.value

paymentInformation.initiationChannel

paymentInformation.instrumentIdentifier.id

paymentInformation.intent

paymentInformation.legacyToken.id

paymentInformation.method

paymentInformation.paymentAccountReference.id

paymentInformation.paymentInstrument.id

paymentInformation.paymentType.method.name

paymentInformation.paymentType.name

paymentInformation.paymentType.subTypeName

paymentInformation.shippingAddress.id

paymentInformation.tokenizedCard.assuranceMethod

paymentInformation.tokenizedCard.cryptogram

paymentInformation.tokenizedCard.expirationMonth

paymentInformation.tokenizedCard.expirationYear

paymentInformation.tokenizedCard.number

paymentInformation.tokenizedCard.prefix

paymentInformation.tokenizedCard.requestorId

paymentInformation.tokenizedCard.securityCode

paymentInformation.tokenizedCard.storageMethod

paymentInformation.tokenizedCard.suffix

paymentInformation.tokenizedCard.transactionType

paymentInformation.tokenizedCard.type

paymentInformation. accountFeatures. accountHolderType

Type of account holder.

This field is returned only when you send an account verification authorization request.

This field is available only for Visa Platform Connect

Possible values:

001

: Primary account holder

002

: Secondary account holder

Specifications

Data Type:
String

Data Length:
25

Mapping Information

REST API Field:

paymentInformation.accountFeatures.accountHolderType

SCMP API Fields:

account_holder_type

Simple Order API Fields:

accountHolder_type

paymentInformation. accountFeatures. accountStatus

Status of the account.

This field is available only on the Visa Platform Connect processor.

Possible values:

N

: Nonregulated

R

: Regulated

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

paymentInformation.accountFeatures.accountStatus

SCMP API Field:

payment_network_token_account_status

Simple Order API Field:

paymentNetworkToken_accountStatus

paymentInformation. accountFeatures. accountType

Type of account.

This field is returned only when you request a balance inquiry.

Authorization: Possible values:
00
: Does not apply or not specified.
10
: Savings account.
20
: Checking account.
30
: Credit card account.
40
: Universal account.
PIN Debit: Possible values:; 00
: Does not apply or not specified.
10
: Savings account.
20
: Checking account.
40
: Universal account.
96
: Cash benefits account.
98
: Food stamp account.

Specifications

Data Type:
String

Data Length:
2

Mapping Information

REST API Field:

paymentInformation.accountFeatures.accountType

SCMP API Fields:

auth_account_type

pin_debit_purchase_account_type

Simple Order API Fields:

ccAuthReply_accountType

pinDebitPurchaseReply_accountType

paymentInformation. accountFeatures.affluenceIndicator

Flag indicating a customer of high income.

Chase Paymentech Solutions: Flag that indicates whether a customer has a high credit limit.; This field is returned for Visa, Mastercard, Discover, and Diners Club. It enables you to market high cost items to these customers and to understand the kinds of cards that high income customers are using.; Possible values:
Y
: Yes, the customer has a high credit limit.
N
: No, the customer does not have a high credit limit.
X
: Does not apply / Unknown.
Worldpay VAP: Flag that indicates whether a Visa customer or Mastercard customer is in one of the affluent categories.; Possible values:
AFFLUENT
: High income customer with high spending pattern (>100k USD annual income and >40k USD annual card usage).
MASS AFFLUENT
: High income customer (>100k USD annual income).

Specifications

Data Type:
String

Data Length:

Chase Paymentech Solutions: 1

Worldpay VAP: 13

Mapping Information

REST API Field:

paymentInformation.accountFeatures.affluenceIndicator

SCMP API Field:

auth_affluence_indicator

Simple Order API Field:

ccAuthReply_affluenceIndicator

paymentInformation. accountFeatures. balanceAmount

Remaining balance on the account or prepaid card.

Specifications

Data type:
String

Data Length:
12

Mapping Information

REST API Field:

paymentInformation.accountFeatures.balanceAmount

SCMP API Fields:

auth_account_balance

pin_debit_purchase_auth_amount

Simple Order API Fields:

ccAuthReply_accountBalance

pinDebitPurchaseReply_accountBalance

paymentInformation. accountFeatures. balanceAmountType

Type of amount.

This field is returned only when you request a balance inquiry.

The issuer determines the value for this field.

Deposit Accounts: Possible values:; 01
: Current ledger (posted) balance.
02
: Current available balance, which is typically the ledger balance minus outstanding authorizations. Some depository institutions also include pending deposits and the credit or overdraft line associated with the account.
Credit Card Accounts: Possible values:

01
: Credit amount remaining for customer (open to buy).
02
: Credit limit.

Specifications

Type:
String

Length:
2

Mapping Information

REST API Field:

paymentInformation.accountFeatures.balanceAmountType

SCMP API Fields:

auth_amount_type

pin_debit_purchase_amount_type

Simple Order API Fields:

ccAuthReply_amountType

pinDebitPurchaseReply_amountType

paymentInformation. accountFeatures.balanceSign

Sign for the remaining balance on the account or prepaid card.

This field is returned only when the processor sends this value.

Possible values:

positive

negative

Specifications

Type:
String

Length:
8

Mapping Information

REST API Field:

paymentInformation.accountFeatures.balanceSign

SCMP API Fields:

auth_account_balance_sign

pin_debit_purchase_account_balance_sign

Simple Order API Fields:

ccAuthReply_accountBalanceSign

pinDebitPurchaseReply_accountBalanceSign

paymentInformation. accountFeatures.category

Card type category.

GPN: Visa or Mastercard product ID.
Visa Platform Connect: Visa product ID.
: Type of card used in the transaction. Possible values:
B
: Business card.
O
: Noncommercial card.
R
: Corporate card.
S
: Purchase card.
X^
: Visa B2B Virtual Payments
X1
: Flexible Rate B2B Virtual Program
Blank
: Purchase card not supported.

You must process the new values of
X^
for Visa B2B Virtual Payments and
X1
for Flexible Rate B2B Virtual Program returned in this field by VisaNet when you send the product ID for Virtual Payment products.
Worldpay VAP: Type of card used in the transaction. The only possible value is
PREPAID
, which specifies a prepaid card.
IMPORTANT

Before using this field on Worldpay VAP, you must contact customer support to have your account configured for this feature.

Specifications

Data Type:
String

Data Length:

GPN and Visa Platform Connect: 3

: 7

Mapping Information

REST API Field:

paymentInformation.accountFeatures.category

SCMP API Fields:

auth_card_category

incremental_auth_card_category

payment_network_token_original_card_category

Simple Order API Fields:

ccAuthReply_cardCategory

ccIncrementalAuthReply_cardCategory

paymentNetworkToken_originalCardCategory

paymentInformation. accountFeatures.commercial

Flag that indicates whether the card is a commercial card.

This field is returned only for Visa and Mastercard payment cards processed by Chase Paymentech Solutions.

A commercial card enables you to include Level II data in a request.

Possible values:

Y

: Yes, the card is a commercial card.

N

: No, the card is not a commercial card.

X

: Does not apply / Unknown.

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

paymentInformation.accountFeatures.commercial

SCMP API Field:

auth_card_commercial

Simple Order API Field:

ccAuthReply_cardCommercial

paymentInformation. accountFeatures.currency

Currency of the remaining balance on the account prepaid card.

Specifications

Data Type:
String

Data Length:
5

Mapping Information

REST API Field:

paymentInformation.accountFeatures.currency

SCMP API Fields:

auth_account_balance_currency

pin_debit_purchase_account_balance_currency

Simple Order API Fields:

ccAuthReply_accountBalanceCurrency

pinDebitPurchaseReply_accountBalanceCurrency

paymentInformation. accountFeatures.group

Type of commercial card.

This field is available only for theVisa Platform Connect processor.

Possible values:

B

: Business card.

R

: Corporate card.

S

: Purchasing card.

0

: Noncommercial card.

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

paymentInformation.accountFeatures.group

SCMP API Field:

auth_card_group

Simple Order API Field:

ccAuthReply_cardGroup

paymentInformation. accountFeatures.healthCare

Flag that indicates whether the card is a healthcare card.

This field is available only for Visa and Mastercard payment cards processed by the Chase Paymentech Solutions processor.

Possible values:

Y

: Yes, the card is a healthcare card.

N

: No, the card is not a healthcare card.

X

: Does not apply / Unknown.

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

paymentInformation.accountFeatures.healthCare

SCMP API Field:

auth_card_healthcare

Simple Order API Field:

ccAuthReply_cardHealthcare

paymentInformation. accountFeatures.level3Eligible

This field indicates whether the card is eligible for Level III interchange fees. This information enables you to include Level III data in a request.

This field is available only for Visa and Mastercard payment cards processed by the Chase Paymentech Solutions processor.

Possible values:

Y

: Yes, the card is eligible for Level III interchange fees.

N

: No, the card is not eligible for Level III interchange fees.

X

: Does not apply / Unknown.

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

paymentInformation.accountFeatures.level3Eligible

SCMP API Field:

auth_card_level_3_eligible

Simple Order API Field:

ccAuthReply_cardLevel3Eligible

paymentInformation. accountFeatures.payRoll

This field indicates whether the card is a payroll card.

This field is available only for Visa, Discover, Diners Club, and JCB payment cards processed by the Chase Paymentech Solutions processor.

Possible values:

Y

: Yes, the card is a payroll card.

N

: No, the card is not a payroll card.

X

: Does not apply / Unknown.

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

paymentInformation.accountFeatures.payRoll

SCMP API Field:

auth_card_payroll

Simple Order API Field:

ccAuthReply_cardPayroll

paymentInformation. accountFeatures.pinlessDebit

This field indicates whether the card is supported for PINless debits.

This field is available only for Visa and Mastercard payment cards processed by the Chase Paymentech Solutions processor.

Possible values:

Y

: Yes, the card is supported for PINless debits.

N

: No, the card is not supported for PINless debits.

X

: Does not apply / Unknown.

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

paymentInformation.accountFeatures.pinlessDebit

SCMP API Field:

auth_card_pinless_debit

Simple Order API Field:

ccAuthReply_cardPINlessDebit

paymentInformation. accountFeatures.prepaid

This field indicates whether the card is a prepaid card.

This information enables you to determine when a gift card or prepaid card is presented for use when establishing a new recurring, installment, or deferred billing relationship.

Possible values:

Y

: Yes, the card is a prepaid card.

N

: No, the card is not a prepaid card.

X

: Does not apply / Unknown.

This field is available only for Visa, Mastercard, Discover, Diners Club, and JCB payment cards processed by the Chase Paymentech Solutions processor.

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

paymentInformation.accountFeatures.prepaid

SCMP API Field:

auth_card_prepaid

Simple Order API Field:

ccAuthReply_cardPrepaid

paymentInformation. accountFeatures.regulated

This field indicates whether the card is regulated according to the Durbin Amendment.

When a card is regulated according to the Durbin Amendment, it means that the issuer has assets that exceed 10B USD and is subject to price caps and interchange rules.

This field is available only for Visa, Mastercard, Discover, Diners Club, and JCB payment cards processed by the Chase Paymentech Solutions processor.

Possible values:

Y

: Yes, the card is regulated according to the Durbin Amendment.

N

: No, the card is not regulated according to the Durbin Amendment.

X

: Does not apply / Unknown.

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

paymentInformation.accountFeatures.regulated

SCMP API Field:

auth_card_regulated

Simple Order API Field:

ccAuthReply_cardRegulated

paymentInformation. accountFeatures.signatureDebit

This field indicates whether the card is a signature debit card.

This information enables you to alter the way an order is processed. For example, you might not want to reauthorize a transaction for a signature debit card, or you might want to perform reversals promptly for a signature debit card.

This field is available only for Visa, Mastercard, and Maestro (International) payment cards processed by the Chase Paymentech Solutions processor.

Possible values:

Y

: Yes, the card is a signature debit card.

N

: No, the card is not a signature debit card.

X

: Does not apply / Unknown.

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

paymentInformation.accountFeatures.signatureDebit

SCMP API Field:

auth_card_signature_debit

Simple Order API Field:

ccAuthReply_cardSignatureDebit

paymentInformation. bank.account. checkNumber

Check number.

Chase Paymentech Solutions: Optional.
Cybersource ACH Service: Not used.
TeleCheck: Strongly recommended on debit requests. Optional on credits.

Specifications

Data Type:
String

Data Length:
8

Mapping Information

REST API Field:

paymentInformation.bank.account.checkNumber

SCMP API Field:

ecp_check_no

Simple Order API Field:

check_checkNumber

paymentInformation.bank.account. checkTransactionCode

paymentInformation. bank. account. iban

The International Bank Account Number (IBAN) for the bank account.

Specifications

Data Type:
Alphanumeric

Data Length:
50

Mapping

REST Field Name:

paymentInformation.bank.account.iban

Simple Order Field Name:

fundTransfer_iban

paymentInformation. bank.account. imageReferenceNumber

Image reference number associated with the check.

You cannot include any special characters.

Specifications

Data Type:
String

Data Length:
32

Mapping Information

REST API Field:

paymentInformation.bank.account.imageReferenceNumber

SCMP API Field:

ecp_image_reference_number

Simple Order API Fields:

check_imageReferenceNumber

paymentInformation. bank.accountName

Name used on the bank account.

You can use this field only when scoring a direct debit transaction.

Specifications

Data Type:
String

Data Length:
30

Mapping Information

REST API Field:

paymentInformation.bank.accountName

SCMP API Field:

bank_account_name

Simple Order API Field:

fundTransfer_accountName

paymentInformation. bank.accountNumber

The customer's bank account number.

When processing encoded account numbers, use this field for the encoded account number.

When scoring a direct debit transaction, use this field if you do not or are not allowed to provide the International Bank Account Number (IBAN).

IMPORTANT

Do not include the IBAN or BBAN in this field. Include the IBAN in the

paymentInformation.bank.account.iban

field.

Specifications

Data Type:
Non-negative integer (for e-check transactions); String (for all other transactions)

Data Length:
17 (for e-check transactions); 30 (for all other transactions)

Mapping Information

REST API Field:

paymentInformation.bank.accountNumber

SCMP API Fields:

bank_account_#

ecp_account_#

Simple Order API Fields:

check_accountNumber

fundTransfer_accountNumber

paymentInformation. bank.account.type

Account type.

Possible values:

paymentInformation.bank.name

SCMP API Field:

bank_name

Simple Order API Field:

bankInfo_name

paymentInformation. bank.routingNumber

The bank routing number. This is also called the transit number
.

Specifications

Data Type:
Non-negative integer

Data Length:
9

Mapping Information

REST API Field:

paymentInformation.bank.routingNumber

SCMP API Field:

ecp_rdfi

Simple Order API Fields:

check_bankTransitNumber

paymentInformation. bank. scheme

The bank scheme that establishes the rules for processing the direct debit.

Possible values:

bacs

: Bacs UK

sepa

: SEPA

Specifications

Data Type:
String

Data Length:
25

Mapping

REST Field Name:

paymentInformation.bank.scheme

Simple Order Field Name:

paymentScheme

paymentInformation. bank.swiftCode

The Bank Identification Code (BIC) that is the unique identifier for the business institution.

The BIC is established by the ISO 9362 international standard.

The BIC is also known as the SWIFT-BIC, the SWIFT ID, or the SWIFT code.

You can use this field only when scoring a direct debit transaction. Required only for cross-border transactions.

Specifications

Data Type:
String

Data Length:
30

Mapping Information

REST API Field:

paymentInformation.bank.swiftCode

SCMP API Field:

bank_swiftcode

Credit card BIN (the first eight digits of the credit card).

The BIN will be used in place of the first eight digits of the credit card when present.

Specifications

Data Type:
Positive Integer

Data Length:
8

Mapping Information

REST API Field:

paymentInformation.card.bin

SCMP API Field:

cc_bin

Simple Order API Field:

card_bin

paymentInformation. card.cardType

Three-digit value that indicates the card type. This field is required for the Payer Authentication Check Enrollment and Validation services.

IMPORTANT

Its a good idea to include the card type even when it is optional. Omitting the card type can cause the transaction to be processed with the wrong card type.

Card-Present Transactions:
This field is returned in the response message when the client software that is installed on the POS terminal uses the Token Management Service (TMS) to retrieve tokenized payment details. You must contact customer support to have your account enabled to receive these fields in the credit response message. This field is available only for Visa Acceptance Solutions integrations.

Card Type Codes Possible Values:
Each payment method, processor, and acquirer support different card types.

001 : Visa: For all processors except SIX, the Visa Electron card type is processed the same way that the Visa debit card is processed. Use card type value
001
for Visa Electron.
002 : Mastercard and Eurocard: For Eurocard, which is the European regional brand of Mastercard, you must include the card type field in a request for an authorization or stand-alone credit.
003 : American Express
004 : Discover
005 : Diners Club
006 : Carte Blanche: For this card type, you must include the card type field in a request for an authorization or stand-alone credit.
007 : JCB: For this card type, you must include the card type field in a request for an authorization or stand-alone credit.
014 : EnRoute: For this card type, you must include the card type field in a request for an authorization or stand-alone credit.
021 : JAL: For this card type, you must include the card type field in a request for an authorization or stand-alone credit.
024 : Maestro (UK Domestic)
033 : Visa Electron: Use this value only for SIX. For other processors, use
001
for all Visa card types. For this card type, you must include the card type field in a request for an authorization or stand-alone credit.
034 : Dankort: For this card type, you must include the card type field in a request for an authorization or stand-alone credit.
036 : Cartes Bancaires: For this card type, you must include the card type field in a request for an authorization or stand-alone credit.
037 : Carta Si: For this card type, you must include the card type field in a request for an authorization or stand-alone credit.
039 : Encoded account number: This value is supported only on Chase Paymentech Solutions. For this value, you must include the card type field in a request for an authorization or stand-alone credit.
040 : UATP: For this card type, you must include the card type field in a request for an authorization or stand-alone credit.
042 : Maestro (International): For this card type, you must include the card type field in a request for an authorization or stand-alone credit.
050 : Hipercard: For this card type on Cielo 3.0, Getnet, or Rede, you must include the card type field in a request for an authorization or stand-alone credit. This card type is not supported on Cielo 1.5.
051 : Aura
054 : Elo: For this card type on Getnet or Rede, you must include the card type field in a request for an authorization or stand-alone credit.
058 : Carnet
059 : ValueLink
060 : mada: Required when accepting mada cards with Apple Pay. Supported with Visa Platform Connect only.
061 : RuPay
062 : China UnionPay

065 : Korean Domestic Cards: For this card type on Getnet, Rede, and Korean Cyber Payments you must include the card type field in a request for an authorization or stand-alone credit.
066 : Banricompras

067 : Meeza: Available in Egypt only.

068 : PayPak: Available in Pakistan only.

Barclays
: This field is optional for Visa card transactions that use the Payouts AFT services.

Visa Platform Connect:
The value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01-TCR1

Position: 70-71

Field: Card ID

The TC 33 capture file contains information about the payments and credits that a merchant submits to Visa Acceptance Solutions. The processor creates the TC 33 capture file at the end of the day and sends it to the merchant’s acquirer. The acquirer uses this information to facilitate end-of-day clearing processing with payment networks.

Korean Cyber Payments:
All cards from the issuers below are supported along with Visa and Mastercard.

BC

Hana

Hyundai

KB Kookmin

Lotte

NH Nonghyup

Samsung

Shinhan

Specifications

Data Type:
String

Data Length:
3

Mapping Information

REST API Fields:

paymentInformation.card.cardType

paymentInformation.card.type

paymentInformation.tokenizedCard.type

SCMP API Field:

card_type

Simple Order API Field:

card_cardType

paymentInformation. card.expirationMonth

Two-digit month in which the payment card expires.

Format: MM

Possible values:

01

through

12

. Leading

0

is required.

IMPORTANT

This field is optional if your account is configured for relaxed requirements for expiration date. .

Barclays and Streamline: For Maestro (UK Domestic and International) cards, this value must be valid (01 through 12) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause Visa Acceptance Solutions to reject a request. However, an invalid expiration date might cause the issuer to reject a request.
Chase Paymentech Solutions: For encoded account numbers (
paymentInformation.card.type
or
paymentInformation.tokenizedCard.type
=
039
), set the value for this field to
12
if the card does not provide an expiration date.

Specifications

Data Type:
String

Data Length:
2

Mapping Information

REST API Field:

paymentInformation.card.expirationMonth

SCMP API Field:

customer_cc_expmo

Simple Order API Field:

card_expirationMonth

paymentInformation. card.expirationYear

Four-digit year in which the payment card expires.

Format: yyyy

IMPORTANT

This field is optional if your account is configured for relaxed requirements for expiration date. .

Barclays: For Maestro (UK Domestic and International) cards on Barclays and Streamline, this value must be valid (1900 through 3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause Visa Acceptance Solutions to reject a request. However, an invalid expiration date might cause the issuer to reject a request.
Chase Paymentech Solutions: For encoded account numbers (
paymentInformation.card.type
or
paymentInformation.tokenizedCard.type
=
039
), set the value for this field to
2021
if the card does not provide an expiration date.
Streamline: For Maestro (UK Domestic and International) cards on Barclays and Streamline, this value must be valid (1900 through 3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause Visa Acceptance Solutions to reject a request. However, an invalid expiration date might cause the issuer to reject a request.

Specifications

FDC Nashville Global
: You can provide two digits or four digits. When you provide two digits, they must be the last two digits of the year.

Mapping Information

REST API Fields:

paymentInformation.card.expirationYear

paymentInformation.tokenizedCard.expirationYear

SCMP API Field:

customer_cc_expyr

Simple Order API Field:

card_expirationYear

paymentInformation. card.hashedNumber

Provides a SHA-256 hashed value of the PAN.

This field can be used to meet Taiwan's Ministry of Finance mandate. This mandates requires merchants must generate a unique code based on the PAN as well as the customer's mobile number, membership number, or national ID for each authorization.

To receive this field during an authorization, you must request this field to be enabled through customer support.

Specifications

Data Type:
String

Data Length:
60

Mapping Information

REST API Field:

paymentInformation.card.hashedNumber

SCMP API Field:

customer_cc_hashed_number

Simple Order API Field:

card_hashedAccountNumber

paymentInformation. card.issueNumber

Number of times a Maestro (UK Domestic) card has been issued to the account holder.

The card might or might not have an issue number. The number can consist of one or two digits, and the first digit might be a zero. When you include this value in a request, include exactly what is printed on the card. A value of

2

is different than a value of

02

.

Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card.

The issue number is not required for Maestro (UK Domestic) transactions.

Specifications

Type:
String

Length:
5

Mapping Information

REST API Field:

paymentInformation.card.issueNumber

SCMP API Field:

customer_cc_issue_number

Simple Order API Field:

card_issueNumber

paymentInformation. card.number

Payment card number or network token.

Also known as the primary account number (PAN).

BIN Lookup Service: You can also use this field for encoded account numbers.

When you send multiple fields in the
paymentInformation[]
and
tokenInformation[]
objects, BIN Lookup processes fields in the
paymentInformation[]
object first, and then it processes fields in the
tokenInformation[]
object.

Chase Paymentech Solutions: When processing encoded account numbers, use this field for the encoded account number.

Specifications

FDMS Nashville (Card-Present transactions only):

Name of the card product.

This field is available only for BNDES transactions on the Visa Platform Connect processor.

Set the value for this field to

BNDES

.

The value for this field corresponds to the following data in the TC 33 capture file:

Record: CP07 TCR4

Position: 115-120

Field: Brazil Country Data

Specifications

Data Type:
String

Data Length:
15

Mapping Information

REST API Field:

paymentInformation.card.productName

SCMP API Field:

card_product_name

Simple Order API Field:

card_productName

paymentInformation. card.productSubtype

Two-letter indicator of the card subtype.

Set this field to

HC

for healthcare cards.

Specifications

Data Type:
String

Data Length:
2

Mapping Information

REST API Field:

paymentInformation.card.productSubtype

SCMP API Field:

card_product_subtype

Simple Order API Field:

ccAuthService_cardProductSubtype

paymentInformation. card.securityCode

Card verification number (CVN).

IMPORTANT

When enabling web browsers to auto-fill payment tokens, you must include

either the

paymentInformation.card.securityCode

or

paymentInformation.tokenizedCard.securityCode

field

in the authorization request.

Web browsers can replace primary account numbers with e-commerce tokens, which enables cardholders to auto-fill tokens, token expiration dates, and three-digit dynamic token verification values (DTVVs) on merchant payment entry forms.

You will receive the result code in the

processorInformation.consumerAuthenticationResponse.code

or

processorInformation.consumerAuthenticationResponse.codeRaw

fields.

This field is available only on the FDC Compass, FDMS Nashville, and Visa Platform Connect processors.

Specifications

Data Type:
String

Data Length:
4

Mapping Information

REST API Fields:

paymentInformation.card.securityCode

paymentInformation.tokenizedCard.securityCode

SCMP API Field:

customer_cc_cv_number

Simple Order API Field:

card_cvNumber

paymentInformation. card.securityCodeIndicator

Flag that specifies whether a CVN code was sent.

Possible values:

0

(default): CVN service not requested. This default value is used when you do not include the

paymentInformation.card.securityCode

or

paymentInformation.tokenizedCard.securityCode

field in the request.

1

(default): CVN service requested and supported. This default value is used when you include the

paymentInformation.card.securityCode

or

paymentInformation.tokenizedCard.securityCode

field in the request.

2

: CVN on payment card is illegible.

9

: CVN not imprinted on payment card.

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

paymentInformation.card.securityCodeIndicator

SCMP API Field:

customer_cc_cv_indicator

Simple Order API Field:

card_cvIndicator

paymentInformation. card.sourceAccountType

Flag that specifies the type of account associated with the card.

This field is available only for the China UnionPay, Cielo, Comercio Latino, eftpos, and Visa Platform Connect processors.

The cardholder provides this information during the payment process.

This field is required for transactions with Brazilian-issued cards.

Combo cards used in Brazil contain credit and debit functionality in one card. Visa systems use a credit bank identification number (BIN) for this type of card.

It is strongly recommended that you include this field for combo-card transactions because using the BIN to determine whether a card is debit or credit can cause errors during transaction processing.

China UnionPay Card Transactions: This field is available for China UnionPay card transactions only. Possible values:
C
: Domestic credit card
D
: Domestic debit card
F
: International credit card
I
: International debit card

When the value is
D
, the e-commerce indicator and CAVV fields must be included in the authorization request.

When the value is
C
,
F
, or
I
, the card verification number, expiration month, and expiration year fields must be included in the authorization request.
Cielo and Comercio Latino Card Transactions: For these processors, this field is available for authorizations only. Possible values:

CR
: Credit card
DB
: Debit card
eftpos Card Transactions: Possible values:

CH
: Checking account
SA
: Savings account
Visa Platform Connect Card Transactions: For combo-card transactions with Mastercard in Brazil, the
paymentInformation.card.useAs
or
paymentInformation.card.sourceAccountType
fields are
also available.

Possible values:

CH
: Checking account
CR
: Credit card account
LI
: Line of credit or credit portion of combo card
PP
: Prepaid card or prepaid portion of combo card
SA
: Savings account
UA
: Universal account

The value for this field corresponds to this data in the TC 33 capture file:

Record: CP07 TCR0
Positions: 42-43
Field: Account Selection

The TC 33 capture file contains information about the payments and credits that a merchant submits to Visa Acceptance Solutions. The processor creates the TC 33 capture file at the end of the day and sends it to the merchant’s acquirer. The acquirer uses this information to facilitate end-of-day clearing processing with payment networks.

If

paymentInformation.card.useAs

is set to the value of

CR

or

DB

and there is a value in the

paymentInformation.card.sourceAccountType

field, the value in the

paymentInformation.card.SourceAccountType

field takes precedence.

If

paymentInformation.card.useAs

is set to

CR/DB

and there is a value in the

paymentInformation.card.sourceAccountType

field, the value in the

paymentInformation.card.useAs

field takes precedence.

Specifications

Data Type:
String

Data Length:
2

Mapping Information

REST API Fields:

paymentInformation.card.sourceAccountType

SCMP API Field:

override_payment_method

Simple Order API Fields:

ccAuthService_overridePaymentMethod

ccCreditService_overridePaymentMethod

pinDebitCreditService_overridePaymentMethod

paymentInformation. card.sourceAccountTypeDetails

Type of account for a line of credit or prepaid card.

This field is available only for combo card transactions in Brazil on the Visa Platform Connect processor.

Include this field when the value for the or field is line of credit (LI) or prepaid card (PP).

Line of Credit: Possible values:

AGRC
: Visa Agro Custeio.
AGRE
: Visa Agro Electron.
AGRI
: Visa Agro Investimento.
AGRO
: Visa Agro.
Prepaid Card: Possible values:

VVA
: Visa Vale Alimentacao.
VVF
: Visa Vale Flex.
VVR
: Visa Vale Refeicao.
TC 33 Capture File: The value for this field corresponds to the following data in the TC 33 capture file:

Record: CP07 TCR0
Position: 44-47
Field: Account Accessed

Specifications

Data Type:
String

Data Length:
4

Mapping Information

REST API Field:

paymentInformation.card.sourceAccountTypeDetails

SCMP API Field:

override_payment_details

Simple Order API Fields:

ccAuthService_overridePaymentDetails

ccCreditService_overridePaymentDetails

paymentInformation. card.startMonth

Month of the start of the Maestro (UK Domestic) card validity period.

Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card.

Possible values:

01

through

12

.

The start date is not required for Maestro (UK Domestic) transactions.

Specifications

Data Type:
String

Data Length:
2

Data Format:
MM

Mapping Information

REST API Field:

paymentInformation.card.startMonth

SCMP API Field:

customer_cc_startmo

Simple Order API Field:

card_startMonth

paymentInformation. card.startYear

Year of the start of the Maestro (UK Domestic) card validity period.

Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card.

The start date is not required for Maestro (UK Domestic) transactions.

Specifications

Data Type:
String

Data Length:
4

Data Format:
yyyy

Mapping Information

REST API Field:

paymentInformation.card.startYear

SCMP API Field:

customer_cc_startyr

Simple Order API Field:

card_startYear

paymentInformation. card.suffix

Last four digits of the customer’s account number.

You can use this value on the receipt that you give to the customer.

Card-Not-Present and PIN Debit Transactions: This field is returned only for tokenized transactions.
Card-Present Transactions: This field is returned in the response message when the client software that is installed on the POS terminal uses the Token Management Service (TMS) to retrieve tokenized payment details.

You must contact customer support to have your account enabled to receive these fields in the credit response message.

This field is supported only for Visa Acceptance Solutions integrations.
Visa Platform Connect: The value for this field corresponds to the following data in the TC 33 capture file:
Record: CP01 TCR8
Position: 85
Field: American Express last 4 PAN return indicator

The TC 33 capture file contains information about the payments and credits that a merchant submits to Visa Acceptance Solutions. The processor creates the TC 33 capture file at the end of the day and sends it to the merchant’s acquirer. The acquirer uses this information to facilitate end-of-day clearing processing with payment networks.

Specifications

Data Type:
String

Data Length:
4

Mapping Information

REST API Field:

paymentInformation.card.suffix

SCMP API Field:

card_suffix

Simple Order API Field:

card_suffix

paymentInformation. card.type

Three-digit value that indicates the card type. This field is required for the Payer Authentication Check Enrollment and Validation services.

IMPORTANT

Its a good idea to include the card type even when it is optional. Omitting the card type can cause the transaction to be processed with the wrong card type.

Card-Present Transactions:
This field is returned in the response message when the client software that is installed on the POS terminal uses the Token Management Service (TMS) to retrieve tokenized payment details. You must contact customer support to have your account enabled to receive these fields in the credit response message. This field is available only for Visa Acceptance Solutions integrations.

Card Type Codes Possible Values:
Each payment method, processor, and acquirer support different card types.

001 : Visa: For all processors except SIX, the Visa Electron card type is processed the same way that the Visa debit card is processed. Use card type value
001
for Visa Electron.
002 : Mastercard and Eurocard: For Eurocard, which is the European regional brand of Mastercard, you must include the card type field in a request for an authorization or stand-alone credit.
003 : American Express
004 : Discover
005 : Diners Club
006 : Carte Blanche: For this card type, you must include the card type field in a request for an authorization or stand-alone credit.
007 : JCB: For this card type, you must include the card type field in a request for an authorization or stand-alone credit.
014 : EnRoute: For this card type, you must include the card type field in a request for an authorization or stand-alone credit.
021 : JAL: For this card type, you must include the card type field in a request for an authorization or stand-alone credit.
024 : Maestro (UK Domestic)
033 : Visa Electron: Use this value only for SIX. For other processors, use
001
for all Visa card types. For this card type, you must include the card type field in a request for an authorization or stand-alone credit.
034 : Dankort: For this card type, you must include the card type field in a request for an authorization or stand-alone credit.
036 : Cartes Bancaires: For this card type, you must include the card type field in a request for an authorization or stand-alone credit.
037 : Carta Si: For this card type, you must include the card type field in a request for an authorization or stand-alone credit.
039 : Encoded account number: This value is supported only on Chase Paymentech Solutions. For this value, you must include the card type field in a request for an authorization or stand-alone credit.
040 : UATP: For this card type, you must include the card type field in a request for an authorization or stand-alone credit.
042 : Maestro (International): For this card type, you must include the card type field in a request for an authorization or stand-alone credit.
050 : Hipercard: For this card type on Cielo 3.0, Getnet, or Rede, you must include the card type field in a request for an authorization or stand-alone credit. This card type is not supported on Cielo 1.5.
051 : Aura
054 : Elo: For this card type on Getnet or Rede, you must include the card type field in a request for an authorization or stand-alone credit.
058 : Carnet
059 : ValueLink
060 : mada: Required when accepting mada cards with Apple Pay. Supported with Visa Platform Connect only.
061 : RuPay
062 : China UnionPay

065 : Korean Domestic Cards: For this card type on Getnet, Rede, and Korean Cyber Payments you must include the card type field in a request for an authorization or stand-alone credit.
066 : Banricompras

067 : Meeza: Available in Egypt only.

068 : PayPak: Available in Pakistan only.

Barclays
: This field is optional for Visa card transactions that use the Payouts AFT services.

Visa Platform Connect:
The value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01-TCR1

Position: 70-71

Field: Card ID

The TC 33 capture file contains information about the payments and credits that a merchant submits to Visa Acceptance Solutions. The processor creates the TC 33 capture file at the end of the day and sends it to the merchant’s acquirer. The acquirer uses this information to facilitate end-of-day clearing processing with payment networks.

Korean Cyber Payments:
All cards from the issuers below are supported along with Visa and Mastercard.

BC

Hana

Hyundai

KB Kookmin

Lotte

NH Nonghyup

Samsung

Shinhan

Specifications

Data Type:
String

Data Length:
3

Mapping Information

REST API Fields:

paymentInformation.card.cardType

paymentInformation.card.type

paymentInformation.tokenizedCard.type

SCMP API Field:

card_type

Simple Order API Field:

card_cardType

paymentInformation. card.typeSelectionIndicator

Flag that identifies how the card type was selected.

This field is only supported for Credit Mutuel-CIC.

Possible values:

0

: Card type was selected based on default acquirer settings.

1

: Customer selected the card type.

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

paymentInformation.card.typeSelectionIndicator

SCMP API Field:

card_type_selection_indicator

Simple Order API Field:

cardTypeSelectionIndicator

paymentInformation. card.useAs

Flag that specifies the type of account associated with the card.

This field is available only for China UnionPay, Cielo, Comercio Latino, , and Visa Platform Connect.

The cardholder provides this information during the payment process.

This field is required for transactions with Brazilian-issued cards.

Combo cards used in Brazil contain credit and debit functionality in one card. Visa systems use a credit bank identification number (BIN) for this type of card.

It is strongly recommended that you include this field for combo-card transactions because using the BIN to determine whether a card is debit or credit can cause errors during transaction processing.

China UnionPay Card Transactions: Possible values:
C
: Domestic credit card
D
: Domestic debit card
F
: International credit card
I
: International debit card

When the value is
D
, the e-commerce indicator and CAVV fields must be included in the authorization request.

When the value is
C
,
F
, or
I
, the card verification number, expiration month, and expiration year fields must be included in the authorization request.
Cielo and Comercio Latino Card Transactions: For these processors, this field is available for authorizations only. Possible values:

CR
: Credit card
DB
: Debit card
PP
: Prepaid card
Visa Platform Connect Card Transactions: For combo-card transactions with Mastercard in Brazil, the
paymentInformation.card.useAs
or
paymentInformation.card.sourceAccountType
fields are
available.

Possible values:

CH
: Checking account
CR
: Credit card account
LI
: Line of credit or credit portion of combo card
PP
: Prepaid card or prepaid portion of combo card
SA
: Savings account

The value for this field corresponds to this data in the TC 33 capture file:

Record: CP07 TCR0
Positions: 42-43
Field: Account Selection

The TC 33 capture file contains information about the payments and credits that a merchant submits to Visa Acceptance Solutions. The processor creates the TC 33 capture file at the end of the day and sends it to the merchant’s acquirer. The acquirer uses this information to facilitate end-of-day clearing processing with payment networks.

A value of

CR

or

DB

in this field takes precedence over any value in the

paymentInformation.sourceAccountType

field.

Specifications

Data Type:
String

Data Length:
2

Mapping Information

REST API Fields:

paymentInformation.card.useAs

SCMP API Field:

card_usage

Simple Order API Field:

card_usage

paymentInformation. customer.customerId

Subscription ID or token ID.

When you use Recurring Billing or Token Management Service and you include this value in a request, many of the fields that are normally required for an authorization or credit become optional.

Payouts:
When you include this field in your request, the following fields are optional:

paymentInformation.card.number

paymentInformation.tokenizedCard.expirationMonth

paymentInformation.tokenizedCard.expirationYear

Specifications

Data Type:
String

Data Length:
26

Mapping Information

REST API Field:

paymentInformation.customer.customerId

SCMP API Field:

subscription_id

Simple Order API Field:

recurringSubscriptionInfo_subscriptionID

paymentInformation. customer.id

The unique identifier for the Token Management Service (TMS) customer token.

BIN Lookup Service: When you send multiple fields in the
paymentInformation[]
and
tokenInformation[]
objects, BIN Lookup processes fields in the
paymentInformation[]
object first, and then it processes fields in the
tokenInformation[]
object.

Specifications

Data Type:
String

Data Length:
1—32

Mapping Information

No corresponding fields.

paymentInformation. directDebit. mandate. clearingDate

The date on which the direct debit should be processed.

Specifications

Data Type:
String

Data Length:
8

Mapping

REST Field Name:

paymentInformation.directDebit.mandate.clearingDate

Simple Order Field Name:

apSaleService_dateCollect

paymentInformation. directDebit. mandate. id

The identifier for the direct debit mandate.

Specifications

Data Type:
String

Data Length:
35

Mapping

REST Field Name:

paymentInformation.directDebit.mandate.id

Simple Order Field Name:

RequestMessage_mandateID

paymentInformation. fluidData.descriptor

paymentInformation.fluidData.value

SCMP API Field:

encrypted_payment_data

Simple Order API Field:

encryptedPayment_data

paymentInformation. initiationChannel

This code indicates how the account information was obtained.

This field is available only for payments processed with Mastercard and American Express on the Visa Platform Connect processor.

This field is supported for Mastercard only on Cybersource through VisaNet. When the initiation channel is not provided via this API field, the value is extracted from EMV tag 9F6E for Mastercard transactions. Call support to enable this feature.

Possible values for Mastercard transactions:

00

(default): Card

01

: Removable secure element that is personalized for use with a mobile phone and controlled by the wireless service provider. Examples are subscriber identity module (SIM), and universal integrated circuit card (UICC).

02

: Key fob

03

: Watch

04

: Mobile tag

05

: Wristband

06

: Mobile phone case or sleeve

07

: Mobile phone with a non-removable, secure element that is controlled by the wireless service provider. For example, code division multiple access (CDMA).

08

: Removable secure element that is personalized for use with a mobile phone and not controlled by the wireless service provider. For example: memory card used with a mobile phone.

09

: Mobile phone with a non-removable, secure element that is not controlled by the wireless service provider.

10

: Removable secure element that is personalized for use with a tablet or e-reader and is controlled by the wireless service provider. Examples are subscriber identity module (SIM) and universal integrated circuit card (UICC).

11

: Tablet or e-reader with a non-removable, secure element that is controlled by the wireless service provider.

12

: Removable secure element that is personalized for use with a tablet or e-reader and is not controlled by the wireless service provider.

13

: Tablet or e-book with a non-removable, secure element that is not controlled by the wireless service provider.

14

: Mobile phone or smartphone with a payment application running in a host processor.

15

: Tablet or e-reader with a payment application running in a host processor.

16

: Mobile phone or smartphone with a payment application running in the Trusted Execution Environment (TEE) of a host processor.

17

: Tablet or e-reader with a payment application running in the TEE of a host processor.

18

: Watch with a payment application running in the TEE of a host processor.

19

: Watch with a payment application running in a host processor.

Values

20

through

99

indicate the form factor but not the storage technology:

20

: Card

21

: Mobile phone

22

: Tablet or e-reader

23

: Watch or wristband, including a fitness band smart strap, disposable band, watch add-on, security band, or ID band.

24

: Sticker

25

: PC

26

: Device peripheral, such as a mobile phone case or sleeve.

27

: Electronic tag, such as a mobile tag or a key fob.

28

: Jewelry such as ring, bracelet, necklace and cuff links.

29

: Fashion accessory, such as a handbag, handbag charm, or eyewear.

30

: Garment such as a dress.

31

: Domestic appliance, such as a refrigerator or washing machine.

32

: Vehicle or vehicle-attached device.

33

: Media or gaming device, including a set-top box, media player, or television.

Values

34

through

99

are reserved for future form factors. Any value in this range may occur within form factor and transaction data without prior notice.

Possible values for American Express transactions:

AC

: mPOS accessory/dongle with contact and contactless interfaces, with or without PIN pad

AS

: mPOS accessory/dongle with contact and contactless interfaces and PIN on glass support. For example, a Secure Card Reader for PIN combined with a software-based PIN on commercial off-the-shelf (COTS) hardware

CC

: Contactless payment on COTS (CPoC)—mobile-device-based contactless-only mPOS without PIN support

CS

: CPoC—mobile-device-based contactless-only mPOS with PIN on glass support

The value for this field corresponds to the following data in the TC 33 capture file for American Express transactions:

Record: CP01-TCRB

Position: 79-80

Field: American Express Mobile Device Type

The TC 33 capture file contains information about the payments and credits that a merchant submits to Visa Acceptance Solutions. The processor creates the TC 33 capture file at the end of the day and sends it to the merchant’s acquirer. The acquirer uses this information to facilitate end-of-day clearing processing with payment networks.

Specifications

Data Type:
String

Data Length:
2

Mapping Information

REST API Field:

paymentInformation.initiationChannel

SCMP API Field:

payment_initiation_channel

Simple Order API Field:

paymentInitiationChannel

paymentInformation. instrumentIdentifier.id

Unique identifier for the Token Management Service (TMS) instrument identifier token.

BIN Lookup Service: When you send multiple fields in the
paymentInformation[]
and
tokenInformation[]
objects, BIN Lookup processes fields in the
paymentInformation[]
object first, and then it processes fields in the
tokenInformation[]
object.

Specifications

Data Type:
String

Data Length:
32

Mapping Information

No corresponding fields.

paymentInformation. intent

Reason for payment when using an alternative payment method.

Example:

Charity

Specifications

Data Type:
String

Data Length:
255

Mapping Information

REST API Field:

paymentInformation.intent

SCMP API Field:

ap_initiate_intent

Simple Order API Field:

apInitiateService_intent

paymentInformation. legacyToken. id

Unique identifier for the legacy secure store token.

Specifications

Data Type:
String

Minimum Data Length:
1

Maximum Data Length:
32

Mapping Information

No corresponding fields.

paymentInformation. method

Method of payment used for the order.

This field can contain one of the following values:

consumer

(default): Customer credit card

corporate

: Corporate credit card

debit

: Debit card, such as a Maestro (UK Domestic) card

cod

: Collect on delivery

check

: Electronic check

p2p

: Person-to-person payment

private1

: Private label credit card

other

: Other payment method

Specifications

Data Type:
String

Data Length:
10

Mapping Information

REST API Field:

paymentInformation.method

SCMP API Field:

payment_type

Simple Order API Field:

invoiceHeader_tenderType

paymentInformation. paymentInstrument.id

Unique identifier for the Token Management Service (TMS) payment instrument token.

BIN Lookup Service: When you send multiple fields in the
paymentInformation[]
and
tokenInformation[]
objects, BIN Lookup processes fields in the
paymentInformation[]
object first, and then it processes fields in the
tokenInformation[]
object.

Specifications

Data Type:
String

Data Length:
32

Mapping Information

No corresponding fields.

paymentInformation. paymentType.method.name

The indicator for the payment type.

Possible values:: AFTERPAY
KLARNA

Specifications

Data Type:
String

Data Length:
3

Mapping Information

REST API Field:

paymentInformation.paymentType.method.name

SCMP API Field:

ap_payment_type

Simple Order API Field:

apPaymentType

paymentInformation. paymentType.name

Name of the payment type.

Possible values:

CARD : PIN Debit transaction
CHECK : eCheck transaction
bankTransfer : Online bank transfer transaction
localCard : Korea Cyber Payment local card transaction.
carrierBilling : Korea Cyber Payment carrier billing transaction.

Specifications

Data Type:
Enum

Mapping Information

No corresponding fields.

paymentInformation. paymentType. subTypeName

Payment type details.

When the

paymentInformation.paymentType.name

field has a value of

CARD

, these are the possible values:

CREDIT : Credit card transaction.
DEBIT : PIN debit card transaction.
PREPAID : Prepaid card transaction.

Specifications

Data Type:
Enum

Mapping Information

No corresponding fields.

paymentInformation. shippingAddress.id

Unique identifier for the Token Management Service (TMS) shipping address token.

BIN Lookup Service: When you send multiple fields in the
paymentInformation[]
and
tokenInformation[]
objects, BIN Lookup processes fields in the
paymentInformation[]
object first, and then it processes fields in the
tokenInformation[]
object.

Specifications

Data Type:
String

Data Length:
32

Mapping Information

No corresponding fields.

paymentInformation. tokenizedCard. assuranceMethod

Confidence level of the provided token.

This value is provided by the token service provider.

Possible values:

00

: No issuer identity and verification (ID&V).

10

: Card issuer account verification.

11

: Card issuer interactive, single-factor cardholder authentication.

12

: Card issuer interactive, two-factor cardholder authentication.

13

: Card issuer risk-oriented, non-interactive cardholder authentication.

14

: Card issuer asserted authentication.

This field is available only for processing Apple Pay, Authorizations with Payment Network Tokens, Google Pay, PIN Debit Processing, and Samsung Pay transactions.

This field replaced the

paymentInformation.tokenizedCard.assuranceLevel

.

Specifications

Data Type:
Integer

Length:
2

Mapping Information

REST API Field:

paymentInformation.tokenizedCard.assuranceMethod

SCMP API Field:

payment_network_token_assurance_method

Simple Order API Field:

paymentNetworkToken_assuranceMethod

paymentInformation. tokenizedCard.cryptogram

Token authentication verification value cryptogram.

For token-based transactions with 3-D Secure, you must submit both types of cryptograms: network token and 3-D Secure.

For all processors except RuPay, the value for this field must be 28-character Base64 or 40-character hex binary. All cryptograms use one of these formats.

On RuPay for the payer authentication seamless flow, use the customer's payment network token value.

Specifications

Data Type:
String

Data Length:
256

Mapping Information

REST API Field:

paymentinformation.tokenizedCard.cryptogram

SCMP API Field:

network_token_cryptogram

Simple Order API Field:

ccAuthService_networkTokenCryptogram

paymentInformation. tokenizedCard.expirationMonth

Month in which the token expires.

This field is a response field that is included in the response message when the payment blob for the tokenized transaction is decrypted.

Format:
MM

Possible values:

01

through

12

Specifications

Data Type:
String

Data Length:
2

Mapping Information

REST API Field:

paymentInformation.tokenizedCard.expirationMonth

SCMP API Field:

token_expiration_month

Simple Order API Field:

token_expirationMonth

paymentInformation. tokenizedCard.expirationYear

Year in which the token expires.

This field is a response field that is included in the response message when the payment blob for the tokenized transaction is decrypted.

Format:
yyyy

Specifications

Data Type:
String

Data Length:
4

Mapping Information

REST API Field:

paymentInformation.tokenizedCard.expirationYear

SCMP API Field:

token_expiration_year

Simple Order API Field:

Card verification number (CVN).

IMPORTANT

When enabling web browsers to auto-fill payment tokens, you must include

either the

paymentInformation.card.securityCode

or

paymentInformation.tokenizedCard.securityCode

field

in the authorization request.

Web browsers can replace primary account numbers with e-commerce tokens, which enables cardholders to auto-fill tokens, token expiration dates, and three-digit dynamic token verification values (DTVVs) on merchant payment entry forms.

You will receive the result code in the

processorInformation.consumerAuthenticationResponse.code

or

processorInformation.consumerAuthenticationResponse.codeRaw

fields.

This field is supported on FDC Compass, FDMS Nashville, and Visa Platform Connect.

Specifications

Data Type:
String

Data Length:
4

Mapping Information

REST API Fields:

paymentInformation.card.securityCode

paymentInformation.tokenizedCard.securityCode

SCMP API Field:

customer_cc_cv_number

Simple Order API Field:

card_cvNumber

paymentInformation. tokenizedCard.storageMethod

Type of technology used in the device to store token data.

This field is available only on the FDC Compass processor.

Possible values:

001

: Secure Element (SE). Smart card or memory with restricted access and encryption to prevent data tampering. For storing payment credentials, an SE is tested against a set of requirements defined by the payment networks.

002

: Host card emulation (HCE). Emulation of a smart card by using software to create a virtual and exact representation of the card. Sensitive data is stored in a database that is hosted in the cloud. For storing payment credentials, a database must meet very stringent security requirements that exceed PCI DSS.

Specifications

Data Type:
Integer

Data Length:
3

Mapping Information

REST API Field:

paymentInformation.tokenizedCard.storageMethod

SCMP API Field:

payment_network_token_device_tech_type

Simple Order API Field:

paymentNetworkToken_deviceTechType

paymentInformation. tokenizedCard.suffix

Last four digits of token.

This field is available only for merchant-initiated transactions on the Elavon Americas processor.

This field is included in the response message when it decrypts the payment blob for the tokenized transaction.

Specifications

Data Type:
String

Data Length:
4

Mapping Information

REST API Field:

paymentInformation.tokenizedCard.suffix

SCMP API Field:

token_suffix

Simple Order API Field:

token_suffix

paymentInformation. tokenizedCard.transactionType

Type of transaction that provided the payment network token data.

This field is available only on the Elavon Americas, FDC Compass, RuPay, and Visa Platform Connect processors.

This value does not specify the token service provider. It specifies the entity that provided you with information about the token.

Possible values:

1

: In-app transaction.

For Apple Pay, Google Pay, RuPay seamless flow, Samsung Pay, and Visa Safe Click (VSC).

2

: Near-field communication (NFC) transaction. The customer’s mobile device provided the token data for a contactless EMV transaction. For recurring transactions, use this value if the original transaction was a contactless EMV transaction.

3

: A transaction using stored customer credentials on Visa Platform Connect, whether for merchant-initiated transactions (MITs) or customer-initiated transactions (CITs).

Elavon Americas: For Google Pay transactions, this field is used only for merchant-initiated transactions.

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

paymentInformation.tokenizedCard.transactionType

SCMP API Field:

payment_network_token_transaction_type

Simple Order API Field:

paymentNetworkToken_transactionType

paymentInformation. tokenizedCard.type

Three-digit value that indicates the card type. This field is required for the Payer Authentication Check Enrollment and Validation services.

IMPORTANT

Its a good idea to include the card type even when it is optional. Omitting the card type can cause the transaction to be processed with the wrong card type.

Card-Present Transactions:
This field is returned in the response message when the client software that is installed on the POS terminal uses the Token Management Service (TMS) to retrieve tokenized payment details. You must contact customer support to have your account enabled to receive these fields in the credit response message. This field is available only for Visa Acceptance Solutions integrations.

Card Type Codes Possible Values:
Each payment method, processor, and acquirer support different card types.

001 : Visa: For all processors except SIX, the Visa Electron card type is processed the same way that the Visa debit card is processed. Use card type value
001
for Visa Electron.
002 : Mastercard and Eurocard: For Eurocard, which is the European regional brand of Mastercard, you must include the card type field in a request for an authorization or stand-alone credit.
003 : American Express
004 : Discover
005 : Diners Club
006 : Carte Blanche: For this card type, you must include the card type field in a request for an authorization or stand-alone credit.
007 : JCB: For this card type, you must include the card type field in a request for an authorization or stand-alone credit.
014 : EnRoute: For this card type, you must include the card type field in a request for an authorization or stand-alone credit.
021 : JAL: For this card type, you must include the card type field in a request for an authorization or stand-alone credit.
024 : Maestro (UK Domestic)
033 : Visa Electron: Use this value only for SIX. For other processors, use
001
for all Visa card types. For this card type, you must include the card type field in a request for an authorization or stand-alone credit.
034 : Dankort: For this card type, you must include the card type field in a request for an authorization or stand-alone credit.
036 : Cartes Bancaires: For this card type, you must include the card type field in a request for an authorization or stand-alone credit.
037 : Carta Si: For this card type, you must include the card type field in a request for an authorization or stand-alone credit.
039 : Encoded account number: This value is supported only on Chase Paymentech Solutions. For this value, you must include the card type field in a request for an authorization or stand-alone credit.
040 : UATP: For this card type, you must include the card type field in a request for an authorization or stand-alone credit.
042 : Maestro (International): For this card type, you must include the card type field in a request for an authorization or stand-alone credit.
050 : Hipercard: For this card type on Cielo 3.0, Getnet, or Rede, you must include the card type field in a request for an authorization or stand-alone credit. This card type is not supported on Cielo 1.5.
051 : Aura
054 : Elo: For this card type on Getnet or Rede, you must include the card type field in a request for an authorization or stand-alone credit.
058 : Carnet
059 : ValueLink
060 : mada: Required when accepting mada cards with Apple Pay. Supported with Visa Platform Connect only.
061 : RuPay
062 : China UnionPay

065 : Korean Domestic Cards: For this card type on Getnet, Rede, and Korean Cyber Payments you must include the card type field in a request for an authorization or stand-alone credit.
066 : Banricompras

067 : Meeza: Available in Egypt only.

068 : PayPak: Available in Pakistan only.

Barclays
: This field is optional for Visa card transactions that use the Payouts AFT services.

Visa Platform Connect:
The value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01-TCR1

Position: 70-71

Field: Card ID

The TC 33 capture file contains information about the payments and credits that a merchant submits to Visa Acceptance Solutions. The processor creates the TC 33 capture file at the end of the day and sends it to the merchant’s acquirer. The acquirer uses this information to facilitate end-of-day clearing processing with payment networks.

Korean Cyber Payments:
All cards from the issuers below are supported along with Visa and Mastercard.

BC

Hana

Hyundai

KB Kookmin

Lotte

NH Nonghyup

Samsung

Shinhan

Specifications

Data Type:
String

Data Length:
3

Mapping Information

REST API Fields:

paymentInformation.card.cardType

paymentInformation.card.type

paymentInformation.tokenizedCard.type

SCMP API Field:

card_type

Simple Order API Field:

card_cardType

paymentInfomation. eWallet.fundingSource

The source of the eWallet funds.

Possible values:

BankTransfer

CreditCard

KakaoMoney

MobileTransfer

NaverPayPoint

This field is supported only for transactions with Korean Cyber Payments.

Specifications

Data Type:
String

Data Length:
30

Mapping Information

REST API Field:

paymentInfomation.eWallet.fundingSource

Simple Order API Field:
No corresponding field.

paymentInfomation. eWallet.name

The name of the eWallet.

Possible values:

Apple Pay

Kakaopay

L.Pay

NaverPay

PAYCO

SamsungPay

SSG Pay

TOSS Pay

This field is supported only for transactions with Korean Cyber Payments.

Specifications

Data Type:
String

Data Length:
30

Mapping Information

REST API Field:

paymentInfomation.eWallet.name

Simple Order API Field:
No corresponding field.

paymentInformation. paymentAccountReference.id

Sends the Payment Account Reference (PAR) value in payment transactions.

A PAR is a unique reference value associated with a specific cardholder PAN.

PAR has a well-defined format (according to the January 2016 EMVCo documentation).

The PAR must be a fixed length of 29 uppercase Roman and alphanumeric values comprised of a four-character BIN Controller ID that is assigned by EMVCo followed with a 25-character value.

PAR identifies the card account, not just the card.

The PAR is a non-payment identifier that can be associated with PANs and tokens, as defined by EMVCo.

PAR enables all participants in the payments chain to have a single, non-sensitive value assigned to a consumer.

The PAR value can replace sensitive cardholder identification fields and be transmitted across the payments ecosystem to facilitate cardholder identification.

Specifications

Data Type:
String

Data Length:
29

Mapping Information

No corresponding fields.

paymentInsightsInformation

These fields provide payment metrics.

paymentInsightsInformation.orchestration.infoCodes[]

paymentInsightsInformation. responseInsights.category

paymentInsightsInformation.responseInsights. categoryCode

paymentInsightsInformation. orchestration. infoCodes[]

This value is the information code associated with Service Orchestration.

Possible values:

RETRY_NW_TOKEN_TO_PAN

: Service Orchestration retried a falsely declined network token transaction with the primary account number (PAN).

DATA_ENRICHMENT_CARD_VERIFICATION

: Service Orchestration modified the transaction amount in card verification payload to optimize the approval rate.

RETRY_3DS_TO_NO_3DS

: Service Orchestration retried a falsely declined 3-D Secure transaction as a non-3-D Secure transaction.

RETRY_WITH_ALTERNATIVE_PROCESSOR

: Service Orchestration retried a falsely declined transaction using an alternative processor.

Specifications

Data Type:
string

Data Length:
60

Mapping Information

REST API Field:

paymentInsightsInformation.orchestration.infoCodes[]

SCMP API Field:

auth_insights_orchestration_infocodes

Simple Order API Field:

ccAuthReply_paymentInsightsInformation _orchestration_infoCodes

paymentInsightsInformation. responseInsights.category

This value is a categorization of the authorization response message from the processor.

Possible values:

GENERIC_ERROR

ISSUER_CANNOT_APPROVE_AT_THIS_TIME

ISSUER_CANNOT_APPROVE_WITH_THESE_DETAILS

ISSUER_WILL_NEVER_APPROVE

OTHERS

PAYMENT_INSIGHTS_INTERNAL_ERROR

PAYMENT_INSIGHTS_RESPONSE_CATEGORY_MATCH_NOT_FOUND

Specifications

Data Type:
String

Data Length:
60

Mapping Information

REST API Field:

paymentInsightsInformation.responseInsights.category

SCMP API Field:

auth_insights_response_category

Simple Order API Field:

ccAuthReply_paymentInsightsInformation_responseInsightsCategory

paymentInsightsInformation. responseInsights. categoryCode

The categorization code of the authorization response message from the processor.

Possible values:

01

:

ISSUER_WILL_NEVER_APPROVE

02

:

ISSUER_CANNOT_APPROVE_AT_THIS_TIME

03

:

ISSUER_CANNOT_APPROVE_WITH_THESE_DETAILS

04

:

GENERIC_ERROR

97

:

PAYMENT_INSIGHTS_INTERNAL_ERROR

98

:

OTHERS

99

:

PAYMENT_INSIGHTS_RESPONSE_CATEGORY_MATCH_NOT_FOUND

Specifications

Data Type:
String

Data Length:
2

Mapping Information

REST API Field:

paymentInsightsInformation.responseInsights.categoryCode

SCMP API Field:

auth_insights_response_category_code

Simple Order API Field:

ccAuthReply_paymentInsightsInformation_responseInsightsCategoryCode

paymentOptions

These fields provide payment options.

paymentOptions.limit

paymentOptions.offset

paymentOptions. limit

The maximum number of options retrieved from the processor and displayed to the customer.

Only numeric values that range from

1

through

250

are supported.

Specifications

Data Type:
String

Data Length:
3

Mapping

REST Field Name:

paymentOptions.limit

Simple Order Field Name:

apOptionsService_limit

paymentOptions. offset

The first option in the list of options received from the processor that is displayed to the customer.

Only numeric values that range from

0

through

9999

are supported.

REST API Field:

paymentSoftwareVersion

SCMP API Field:
No corresponding field

Simple Order API Field:
No corresponding field

payoutInformation

These fields provide Payout information.

payoutInformation.geoRestrictionIndicator

payoutInformation.pullFunds. crossBorderParticipant

payoutInformation.pullFunds.domesticParticipant

payoutInformation.pushFunds. crossBorderParticipant

payoutInformation.pushFunds.domesticParticipant

payoutInformation.pushFunds. moneyTransferCrossBorder

payoutInformation.pushFunds.moneyTransferDomestic

payoutInformation.pushFunds. moneyTransferFastFundsCrossBorder

payoutInformation.pushFunds. moneyTransferFastFundsDomestic

payoutInformation.pushFunds. nonMoneyTransferCrossBorder

payoutInformation.pushFunds. nonMoneyTransferDomestic

payoutInformation.pushFunds. nonMoneyTransferFastFundsCrossBorder

payoutInformation.pushFunds. nonMoneyTransferFastFundsDomestic

payoutInformation.pushFunds. onlineGamblingCrossBorder

payoutInformation.pushFunds. onlineGamblingDomestic

payoutInformation.pushFunds. onlineGamblingFastFundsCrossBorder

payoutInformation.pushFunds. onlineGamblingFastFundsDomestic

payoutInformation. geoRestrictionIndicator

These fields provide pin encryption information.

pinEncryptionKeyName

pinEncryptionKsi

pinEncryptionKeyName

Optional name for the PIN encryption Base Derivation Key (BDK) that is loaded on the terminal.

To get this value, contact Visa Acceptance Solutions customer support.

Specifications

Data Type:
String

Data Length:
64

Mapping Information

REST API Field:

pinEncryptionKeyName

SCMP API Field:
No corresponding field

Simple Order API Field:
No corresponding field

pinEncryptionKsi

Key serial identifier of the PIN encryption Base Derivation Key (BDK) that is loaded on the terminal.

To get this value, contact Visa Acceptance Solutions customer support.

Specifications

Data Type:
String

Data Length:
32

Mapping Information

REST API Field:

pinEncryptionKsi

SCMP API Field:
No corresponding field

Simple Order API Field:
No corresponding field

planInformation

These fields provide plan information.

planInformation.billingPeriod.length

planInformation.billingPeriod.unit

planInformation.description

planInformation.name

planInformation.planPeriod.length

planInformation.planPeriod.unit

planInformation. billingPeriod.length

The plan billing period length.

The billing period length and unit must be included in your plan request. For example, to bill once a month, set the length to

1

and the unit to

M

. To bill once every seven days, set the length to

7

and the unit to

D

.

Specifications

Data Type:
String

Data Length:
2

Mapping Information

REST API Field:

planInformation.billingPeriod.length

SCMP API Field:
No corresponding field.

Simple Order API Field:
No corresponding field.

planInformation. billingPeriod.unit

The plan billing period unit.

Possible values:

D

: Day

M

: Month

W

: Week

Y

: Year

The billing period length and unit must be included in your plan request. For example, to bill once a month, set the length to

1

and the unit to

REST API Field:

planInformation.name

SCMP API Field:
No corresponding field.

Simple Order API Field:
No corresponding field.

planInformation. planPeriod.length

The plan period length.

The period length and unit must be included in your request. For example, to end the plan after 12 months, set the length to

12

and the unit to

M

. To end the plan after two years, set the length to

2

and the unit to

Y

.

Specifications

Data Type:
String

Data Length:
2

Mapping Information

REST API Field:

planInformation.planPeriod.length

SCMP API Field:
No corresponding field.

Simple Order API Field:
No corresponding field.

planInformation. planPeriod.unit

The plan period unit.

Possible values:

D

: Day

M

: Month

W

: Week

Y

: Year

The period length and unit must be included in your request. For example, to end the plan after 12 months, set the length to

12

and the unit to

M

. To end the plan after two years, set the length to

2

and the unit to

Y

.

Specifications

Data Type:
String

Data Length:
5

Mapping Information

REST API Field:

planInformation.planPeriod.unit

SCMP API Field:
No corresponding field.

Simple Order API Field:
No corresponding field.

pointOfSaleInformation

These fields provide point-of-sale information.

pointOfSaleInformation.amexCAPNData

pointOfSaleInformation.cardholderVerificationMethod

pointOfSaleInformation.cardPresent

pointOfSaleInformation.catLevel

pointOfSaleInformation.deviceId

pointOfSaleInformation.emv.cardSequenceNumber

pointOfSaleInformation.emv.cardholderVerificationMethodUsed

pointOfSaleInformation.emv.chipValidationResult

pointOfSaleInformation.emv.chipValidationType

pointOfSaleInformation.emv.fallback

pointOfSaleInformation.emv.fallbackCondition

pointOfSaleInformation.emv.isRepeat

pointOfSaleInformation.emv.tags

pointOfSaleInformation.encryptedKeySerialNumber

pointOfSaleInformation.encryptedPin

pointOfSaleInformation.entryMode

pointOfSaleInformation.isDedicatedHardwareTerminal

pointOfSaleInformation.laneNumber

pointOfSaleInformation.operatingEnvironment

pointOfSaleInformation.partnerSdkVersion

pointOfSaleInformation.pinBlockEncodingFormat

pointOfSaleInformation.pinEntrySolution

pointOfSaleInformation.serviceCode

pointOfSaleInformation.storeAndForwardIndicator

pointOfSaleInformation.terminalCapability

pointOfSaleInformation.terminalCardCaptureCapability

pointOfSaleInformation.terminalCompliance

pointOfSaleInformation.terminalId

pointOfSaleInformation.terminalInputCapability

pointOfSaleInformation.terminalOutputCapability

pointOfSaleInformation.terminalPinCapability

pointOfSaleInformation.terminalSerialNumber

pointOfSaleInformation.trackData

pointOfSaleInformation. amexCAPNData

Point-of-sale details for the transaction.

This field enables you to comply with American Express CAPN requirements.

Visa Acceptance Solutions generates this value, which consists of a series of codes that identify terminal capability, security data, and specific conditions present at the time the transaction occurred. To comply with the CAPN requirements, this value must be included in all subsequent follow-on requests, such as captures and follow-on credits.

When you perform authorizations, captures, and credits through Visa Acceptance Solutions, Visa Acceptance Solutions passes this value from the authorization service to the subsequent services for you. However, when you perform authorizations through Visa Acceptance Solutions and perform subsequent services through other financial institutions, you must ensure that requests for captures and credits include this value.

This field is available only for transactions using American Express payment cards on the American Express Direct, and Elavon Americas processors.

American Express Direct: For forced captures, obtain the value for this field from the authorization response.; For verbal authorizations, you cannot obtain a value for this field, so Visa Acceptance Solutions uses a default value. Visa Acceptance Solutions generates the value based on these factors:
Whether the transaction is an e-commerce transaction.
Whether the transaction is a card-present transaction.
Whether the payment data is swiped or keyed.

Specifications

Data Type:
String

Data Length:
12

Mapping Information

REST API Field:

pointOfSaleInformation.amexCAPNData

SCMP API Fields:

auth_pos_data

bill_pos_data

Simple Order API Fields:

ccAuthReply_posData

ccCaptureService_posData

pointOfSaleInformation. cardholderVerificationMethod

List of cardholder verification methods (CVMs) supported by the terminal.

This field is available only for Visa Acceptance Solutions integrations on the Barclays processor.

Possible values:

CDCVM

: Cardholder device CVM—supported only on Barclays

Signature

Specifications

Data Type:
String

Data Length:
15

Mapping Information

REST API Field:

pointOfSaleInformation.cardholderVerificationMethod[]

SCMP API Field:

terminal_cvm_capabilities_#

Simple Order API Field:

pos_terminalCVMcapabilities_#

pointOfSaleInformation. cardPresent

Indicates whether the card is present at the time of the transaction.

Possible values:

N

: Card is not present

Y

: Card is present

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

pointOfSaleInformation.cardPresent

SCMP API Field:

card_present

Simple Order API Field:

pos_cardPresent

pointOfSaleInformation. catLevel

Type of cardholder-activated terminal.

Possible values:

1

: Automated dispensing machine

2

: Self-service terminal

3

: Limited amount terminal

4

: In-flight commerce (IFC) terminal

5

: Radio frequency device

6

: Mobile acceptance terminal

7

: Electronic cash register

8

: E-commerce device at your location

9

: Terminal or cash register that uses a dial-up connection to connect to the transaction processing network

10

: Card-activated fuel dispenser

11

: Travel ticket vending machine

Applicable Values for Card-Present Transactions:

Chase Paymentech Solutions: Only values

1

,

2

, and

3

are supported.

eftpos: Only values

1

,

2

,

7

,

10

, and

11

are supported.

FDC Nashville Global: Only values

7

,

8

, and

9

are supported.

GPN: Only values

6

,

7

,

8

, and

9

are supported.

JCN Gateway: Only values

6

,

7

,

8

, and

9

are supported.

TSYS Acquiring Solutions: Only value

6

is supported.

Visa Platform Connect: Values

1

through

6

are supported, but some acquirers do not support all six values.

Applicable Values for PIN Debit Transactions:

Only values

7

,

8

, and

9

are supported.

Specifications

Data Type:
Non-negative integer

Data Length:
2

Mapping Information

REST API Field:

pointOfSaleInformation.catLevel

SCMP API Field:

cat_level

Simple Order API Field:

pos_catLevel

pointOfSaleInformation. deviceId

Value created by the client software that uniquely identifies the POS device.

This value is not sent to the processor. Instead, the value is forwarded to the Visa Acceptance Solutions reporting software.

This field is available only for Visa Acceptance Solutions integrations.

Specifications

Data Type:
String

Data Length:
32

Mapping Information

REST API Field:

pointOfSaleInformation.deviceId

SCMP API Field:

pos_device_id

Simple Order API Field:

pos_deviceID

pointOfSaleInformation. emv.cardholderVerificationMethodUsed

Cardholder verification method (CVM).

This field specifies the method that was used to verify the cardholder's identity.

Possible values:

0

: No verification

1

: Signature

2

: PIN

3

: Cardholder device CVM (CDCVM)—available only on the Barclays processor

4

: Biometric

5

: OTP

This field is available only for Visa Acceptance Solutions integrations and the Barclays processor.

Specifications

Data Type:
Integer

Data Length:
1

Mapping Information

REST API Field:

pointOfSaleInformation.emv.cardholderVerificationMethodUsed

SCMP API Field:

cardholder_verification_method

Simple Order API Field:

ccAuthService_cardholderVerificationMethod

pointOfSaleInformation. emv.cardSequenceNumber

Number assigned to a specific card when two or more cards are associated with the same primary account number.

This value enables issuers to distinguish among multiple cards that are linked to the same account. This value can also act as a tracking tool when the issuer reissues cards. When this value is available, it is provided by the chip reader. When the chip reader does not provide this value, do not include this field in your request.

Specifications

Data Type:
String with numbers only

Data Length:

American Express Direct: 2

Visa Platform Connect: 2

Other Processors: 3

Mapping Information

REST API Field:

pointOfSaleInformation.emv.cardSequenceNumber

SCMP API Field:

emv_request_card_sequence_number

Simple Order API Field:

emvRequest_cardSequenceNumber

pointOfSaleInformation. emv.chipValidationResult

Cryptogram validation results returned by the entity or service specified in

pointOfSaleInformation.emv.chipValidationType

.

Possible values:

A

: Application cryptogram is valid, but the application transaction counter (ATC) is outside the allowed range. (A large increase in ATC values can indicate data copying or other fraud.)

C

: Chip validation was completed successfully.

E

: Application cryptogram is valid, but the ATC indicates possible replay fraud.

F

: Format error in the chip data.

G

: Application cryptogram is valid but is not a valid authorization request cryptogram (ARQC).

I

: Application cryptogram is invalid.

T

: Application cryptogram is valid, but terminal verification results (TVR) or card verification results (CVR) are invalid.

U

: Application cryptogram could not be validated because of a technical error.

This field is available only for Mastercard near-field communication (NFC) authorizations that use payment network tokens on the Visa Platform Connect processor.

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

pointOfSaleInformation.emv.chipValidationResult

SCMP API Field:

emv_reply_chip_validation_results

Simple Order API Field:

emvReply_chipValidationResults

pointOfSaleInformation. emv.chipValidationType

Entity or service that provided the validation results returned in the

pointOfSaleInformation.emv.chipValidationResult

field.

Possible values:

02

: Mastercard pre-validation service. The Mastercard authorization platform validated the cryptogram before the issuer received the authorization request.

03

: Mastercard stand-in service. The Mastercard authorization platform validated the cryptogram because the issuer was not available.

50

: Issuer.

90

: Chip fall-back transaction downgrade process. The chip could not be read.

This field is available only for Mastercard near-field communication (NFC) authorizations that use payment network tokens on the Visa Platform Connect processor.

Specifications

Data Type:
String

Data Length:
2

Mapping Information

REST API Field:

pointOfSaleInformation.emv.chipValidationType

SCMP API Field:

emv_reply_chip_validation_type

Simple Order API Field:

emvReply_chipValidationType

pointOfSaleInformation. emv.fallback

Indicates that a fallback method can be used for authentication.

When a technical problem prevents a successful exchange of information between a chip card and a chip-capable terminal, you can use fallback to swipe the card or key the payment card information into the POS terminal.

Possible values:

Y

: Fallback available

N

(default): Fallback method not available

This field is supported on processors that support EMV fallback transactions.

Specifications

Data Type:
String

Data Length:
5

Mapping Information

REST API Field:

pointOfSaleInformation.emv.fallback

SCMP API Field:

emv_request_fallback

Simple Order API Field:

emvRequest_fallback

pointOfSaleInformation. emv.fallbackCondition

Reason for the EMV fallback transaction.

An EMV fallback transaction occurs when an EMV transaction fails for one of these reasons:

Technical failure: the EMV terminal or EMV card cannot read and process chip data.

Empty candidate list failure: the EMV terminal does not have any applications in common with the EMV card. EMV terminals are coded to determine whether the terminal and EMV card have any applications in common. EMV terminals provide this information to you.

Possible values:

1

: Transaction was initiated with information from a magnetic stripe, and the previous transaction at the EMV terminal either used information from a successful chip read or it was not a chip transaction.

2

: Transaction was initiated with information from a magnetic stripe, and the previous transaction at the EMV terminal was an EMV fallback transaction because the attempted chip read was unsuccessful.

This field is available only on the GPN, JCN Gateway, and Visa Platform Connect processors.

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

pointOfSaleInformation.emv.fallbackCondition

SCMP API Field:

emv_request_fallback_condition

Simple Order API Field:

emvRequest_fallbackCondition

pointOfSaleInformation. emv.isRepeat

Indicates the authorization is a duplicate authorization request.

When the

issuerInformation.pinRequestIndicator

field is included in the authorization response message, you must submit a duplicate authorization request that includes the customer's PIN.

This field is available only for Mastercard transactions on the Visa Platform Connect processor.

Possible value:

01

: Duplicate authorization request

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

pointOfSaleInformation.emv.isRepeat

SCMP API Field:

emv_request_repeat

Simple Order API Field:

emvRequest_repeat

pointOfSaleInformation.emv.tags

EMV data that is transmitted from the chip card to the issuer and from the issuer to the chip card.

The EMV data is in the tag-length-value format and includes chip card tags, terminal tags, and transaction detail tags.

WARNING

These tags contain sensitive information and must not be included in this field:

56: Track 1 equivalent data

57: Track 2 equivalent data

5A: Application PAN

5F20: Cardholder name

5F24: Application expiration date

99: Transaction PIN

9F0B: Cardholder name (extended)

9F1F: Track 1 discretionary data

9F20: Track 2 discretionary data

For contact EMV captures, contact EMV stand-alone credits, and contactless EMV stand-alone credits, you must include these tags in this field.

95: Terminal verification results

9F10: Issuer application data

9F26: Application cryptogram

Merchants that accept contactless transactions that must include the tap-to-phone indicator in tag 9F6E byte 4 bit 8. Possible values:

0

: Transaction did not originate from a tap-to-phone acceptance device.

1

: Transaction originated from a tap-to-phone acceptance device.

Acquirers must support the tap-to-phone indicator in the TC 33 capture file location:

Record: CP02 TCR0

Position: 150

Field: Tap-to-Phone Indicator

IMPORTANT

If the original transaction includes EMV tag 55 (FDI Field 55), this tag must be included in follow-on reversal transactions.

JCN Gateway: These tags must be included:
4F: Application identifier
84: Dedicated file name
Card-Present Transactions: Include this tag for better interchange rates:
84: Dedicated file name

The value for Tag 84 corresponds to these data in the TC 33 capture file:
Record: CP02 TCR0
Position: 118-149
Field: Dedicated File Name - Application ID (AID)

The TC 33 capture file contains information about the payments and credits that a merchant submits to Visa Acceptance Solutions. The processor creates the TC 33 capture file at the end of the day and sends it to the merchant’s acquirer. The acquirer uses this information to facilitate end-of-day clearing processing with payment networks.; Include these optional Mastercard integrated-circuit-card‐data EMV tag values in authorization requests:

9F60: Authenticated application data
96: Kernel identifier‐terminal

Specifications

Data Type:
String

Data Length:

: 252

: 199 bytes for Japan

Other processors: 999

Mapping Information

REST API Field:

pointOfSaleInformation.emv.tags

SCMP API Field:

emv_request_combined_tags

Simple Order API Field:

emvRequest_combinedTags

pointOfSaleInformation. encryptedKeySerialNumber

Combination of the POS terminal's unique identifier and a transaction counter that is used when decrypting the encrypted PIN.

The entity that injected the PIN encryption keys into the terminal decrypts the encrypted PIN and creates this value.

For all terminals that are using derived unique key per transaction (DUKPT) encryption, this is generated as a single number within the terminal.

This field is supported only for Visa Acceptance Solutions integrations and only for processors that support chip and online PIN transactions.

Specifications

Data Type:
String

Data Length:
20

Mapping Information

REST API Field:

pointOfSaleInformation.encryptedKeySerialNumber

SCMP API Field:

pin_data_key_serial_number

Simple Order API Field:

pinDataKeySerialNumber

pointOfSaleInformation. encryptedPin

Encrypted PIN data.

This value is provided by the client software that is installed on the POS terminal.

This field is available only for Visa Acceptance Solutions integrations and only for processors that support chip and online PIN transactions. In the request, you must encrypt the PIN to send the data. Required for Discover and Diners Club online PIN and ATM transactions.

Specifications

Data Type:
String

Data Length:
16

Mapping Information

REST API Field:

pointOfSaleInformation.encryptedPin

SCMP API Field:

pin_data_encrypted_pin

Simple Order API Field:

pinDataEncryptedPIN

pointOfSaleInformation. entryMode

Method of entering payment card information into the POS terminal.

This field is available only on the FDC Compass, OmniPay Direct, and Visa Platform Connect processors.

Possible values:

contact

: Read from direct contact with chip card.

contactless

: Read from a contactless interface using chip data.

keyed

: Manually keyed into POS terminal.

OmniPay Direct:
For card-present transactions, this value is not supported.

For PIN debit transactions, this value is not supported.

msd

: Read from a contactless interface using magnetic stripe data (MSD).

OmniPay Direct:
For card-present transactions, this value is not supported.

swiped

: Read from payment card magnetic stripe.

The

contact

,

contactless

, and

msd

values are supported only for EMV transactions.

Specifications

Data Type:
String

Data Length:
11

Mapping Information

REST API Field:

pointOfSaleInformation.entryMode

SCMP API Field:

pos_entry_mode

Simple Order API Field:

pos_entryMode

pointOfSaleInformation. isDedicatedHardwareTerminal

Type of mPOS device.

Possible values:

0

: Dongle

1

: Phone or tablet

This field is available only for Mastercard transactions on the Visa Platform Connect processor.

The value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCR6

Position: 141

Field: Mastercard mPOS Transaction

The TC 33 capture file contains information about the payments and credits that a merchant submits to Visa Acceptance Solutions. The processor creates the TC 33 capture file at the end of the day and sends it to the merchant’s acquirer. The acquirer uses this information to facilitate end-of-day clearing processing with payment networks.

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

pointOfSaleInformation.isDedicatedHardwareTerminal

SCMP API Field:

mpos_device_type

Simple Order API Field:

mPOS_deviceType

pointOfSaleInformation. laneNumber

Identifier for one of the terminals at your retail location that is used to complete a transaction.

This field is a request and response field. You defined the value for this field in the request message. This value must be printed on the receipt.

This field is available only for Mastercard transactions on the FDC Nashville Global processor.

Use the

pointOfSaleInformation.terminalId

field to identify the main terminal at your retail location.

Specifications

Data Type:
String

Data Length:
8

Mapping Information

REST API Field:

pointOfSaleInformation.laneNumber

SCMP API Field:

terminal_id_alternate

Simple Order API Field:

pos_terminalIDAlternate

pointOfSaleInformation. operatingEnvironment

Operating environment.

This field is available only on the American Express Direct and Visa Platform Connect processors.

Possible values for Mastercard:

2

: On merchant premises, unattended, or customer terminal. Examples: oil, kiosk, self-checkout, home computer, mobile telephone, personal digital assistant.

Visa Platform Connect:
Customer terminal is supported only for Mastercard transactions.

4

: Off merchant premises, unattended, or customer terminal. Examples: vending machine, mobile telephone, personal digital assistant.

Visa Platform Connect:
Customer terminal is supported only for Mastercard transactions.

Possible values for all card types except Mastercard:

0

: No terminal used or unknown environment.

1

: On merchant premises, attended.

2

: On merchant premises, unattended. Examples: oil, kiosks, self-checkout, mobile telephone, personal digital assistant (PDA).

3

: Off merchant premises, attended. Examples: portable POS devices at trade shows, at service calls, or in taxis.

4

: Off merchant premises, unattended. Examples: vending machines, home computer, mobile telephone, PDA.

5

: On premises of customer, unattended.

9

: Unknown delivery mode.

S

: Electronic delivery of product. Examples: music, software, or eTickets that are downloaded over the Internet.

T

: Physical delivery of product. Examples: music or software that is delivered by mail or by a courier.

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

pointOfSaleInformation.operatingEnvironment

SCMP API Field:

pos_environment

Simple Order API Field:

pos_environment

pointOfSaleInformation. partnerSdkVersion

Version of the software installed on the POS terminal.

This value is provided by the client software that is installed on the POS terminal.

This value is not sent to the processor. Instead, the value is forwarded to the Visa Acceptance Solutions reporting software.

This field is available only for Visa Acceptance Solutions integrations.

Specifications

Data Type:
String

Data Length:
32

Mapping Information

REST API Field:

pointOfSaleInformation.partnerSdkVersion

SCMP API Field:

partner_sdk_version

Simple Order API Field:

partnerSDKversion

pointOfSaleInformation. pinBlockEncodingFormat

Format that is used to encode the PIN block.

This value is provided by the client software that is installed on the POS terminal.

Possible values:

0

: ISO 9564 format 0

1

: ISO 9564 format 1

2

: ISO 9564 format 2

3

: ISO 9564 format 3

This field is available only for Visa Acceptance Solutions integrations and only for processors that support chip and online PIN transactions.

Specifications

Data Type:
Integer

Data Length:
1

Mapping Information

REST API Field:

pointOfSaleInformation.pinBlockEncodingFormat

SCMP API Field:

pin_data_pin_block_encoding_format

Simple Order API Field:

pinDataPINblockEncodingFormat

pointOfSaleInformation. pinEntrySolution

Type of PIN pad on the terminal.

Possible values:

PCI-SPoC

: Screen (This value includes SPoC (Software-based PIN Entry on COTS), CPoC (Contactless Payments on COTS), and MPoC (Mobile Payments on COTS). COTS is Commercial Off-the-Shelf.)

PCI-PTS

: Physical PIN pad

Specifications

Data Type:
String

Data Length:
50

Mapping Information

REST API Field:

pointOfSaleInformation.pinEntrySolution

SCMP API Field:

terminal_pin_entry_solution

Simple Order API Field:

pos_pinEntrySolution

pointOfSaleInformation. serviceCode

Service code that is included in the track data.

This field is available only for American Express and Mastercard transactions on the Visa Platform Connect processor.

You can extract the service code from the track data and provide it in this API field.

Specifications

Data Type:
String

Data Length:
3

Mapping Information

REST API Field:

pointOfSaleInformation.serviceCode

SCMP API Field:

pos_service_code

Simple Order API Field:

pos_serviceCode

pointOfSaleInformation. storeAndForwardIndicator

When connectivity is unavailable, the client software that is installed on the POS terminal can store a transaction in its memory and send it for authorization when connectivity is restored.

This value is provided by the client software that is installed on the POS terminal.

This value is not sent to the processor. Instead, the value is forwarded to the Visa Acceptance Solutions reporting software.

Possible values:

true

: Transaction was stored and then forwarded.

false

(default): Transaction was not stored and then forwarded.

This field is available only for Visa Acceptance Solutions integrations.

Specifications

Data Type:
String

Data Length:
5

Mapping Information

REST API Field:

pointOfSaleInformation.storeAndForwardIndicator

SCMP API Field:

store_and_forward_indicator

Simple Order API Field:

pos_storeAndForwardIndicator

pointOfSaleInformation. terminalCapability

POS terminal’s capability.

This field is available only for the American Express Direct, BNP Paribas France, Banque de France et Tresor Public, Chase Paymentech Solutions, Credit Mutuel-CIC, eftpos, FDC Nashville Global, FDMS Nashville, GPN, JCN Gateway, OmniPay Direct, Prosa, , SIX, TSYS Acquiring Solutions, Visa Platform Connect, and Worldpay VAP processors.

Possible values:

1

: Terminal has a magnetic stripe reader only.

2

: Terminal has a magnetic stripe reader and manual entry capability.

3

: Terminal has manual entry capability only.

4

: Terminal can read chip cards.

5

: Terminal can read contactless chip cards; cannot use contact to read chip cards.

6

: Terminal has a magnetic stripe and chip reader capability.

7

: Terminal has a magnetic stripe and contactless reader capability.

8

: Terminal has a chip and contactless reader capability.

9

: Terminal has a magnetic stripe, chip reader, and contactless reader capability .

For an EMV transaction, the field value must be:

4

or

5

.

For eftposcard-present transactions, the value must be:

1

,

4

,

5

,

6

,

7

,

8

, or

9

.

Specifications

Data Type:
Integer

Data Length:
1

Mapping Information

REST API Field:

pointOfSaleInformation.terminalCapability

SCMP API Field:

terminal_capability

Simple Order API Field:

pos_terminalCapability

pointOfSaleInformation. terminalCardCaptureCapability

Indicates whether the terminal can capture the card.

This field is available only for Visa Acceptance Solutions integrations on the Visa Platform Connect processor.

Possible values:

1

: Terminal can capture card.

0

: Terminal cannot capture card.

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

pointOfSaleInformation.terminalCardCaptureCapability

SCMP API Field:

terminal_card_capture_capability

Simple Order API Field:

pos_terminalCardCaptureCapability

pointOfSaleInformation. terminalCompliance

Flag that indicates whether the terminal is compliant with standards mandated by the Reserve Bank of India for card-present domestic transactions in India.

This field is available only for Mastercard transactions on the Visa Platform Connect processor.

Format:

First character indicates whether the terminal supports terminal line encryption (TLE). Possible values:

1

: Not certified

2

: Certified

Second character indicates whether the terminal supports Unique Key Per Transaction (UKPT) and Derived Unique Key Per Transaction (DUKPT). Possible values:

1

: Not certified

2

: Certified

Example:

21

indicates that the terminal supports TLE but does not support UKPT/DUKPT.

You and the terminal vendors are responsible for terminal certification. If you have questions, contact your acquirer.

The value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCR6

Position: 92-93

Field: Mastercard Terminal Compliance Indicator

The TC 33 capture file contains information about the payments and credits that a merchant submits to Visa Acceptance Solutions. The processor creates the TC 33 capture file at the end of the day and sends it to the merchant’s acquirer. The acquirer uses this information to facilitate end-of-day clearing processing with payment networks.

Specifications

Data Type:
Integer

Data Length:
2

Mapping Information

REST API Field:

pointOfSaleInformation.terminalCompliance

SCMP API Field:

terminal_compliance

Simple Order API Field:

pos_terminalCompliance

pointOfSaleInformation. terminalId

Terminal identifier assigned by the acquirer.

This value must be printed on the receipt.

This field is a request and response field.

This field is available only for Visa Acceptance Solutions integrations.

For requests, you can define this value yourself; however, you should consult the processor for requirements.

These processors have specific requirements:

FDC Nashville Global: To have your account configured to support this field, contact customer support. This value must be a value that FDC Nashville Global issued to you.
Visa Platform Connect: A list of all possible values is stored in your account. When terminal ID validation is enabled for your account, the value you send for this field is validated against the list each time you include the field in a request. To enable or disable terminal ID validation, contact customer support.

When you do not include this field in a request, the default value in your account is used.

Specifications

Data Type:
String

Data Length:
8

Mapping Information

REST API Field:

pointOfSaleInformation.terminalId

SCMP API Field:

terminal_id

Simple Order API Field:

pos_terminalID

pointOfSaleInformation. terminalInputCapability

Complete list of card input methods supported by the terminal.

Possible values:

Keyed

: Terminal can accept card data that is entered manually.

Swiped

: Terminal can accept card data from a magnetic stripe reader.

Contact:

: Terminal can accept card data in EMV contact mode.

Contactless:

: Terminal can accept card data in EMV contactless mode.

BarCode:

: Terminal can read bar codes.

QRcode:

: Terminal can read QR codes.

OCR:

: Terminal can perform optical character recognition (OCR).

This field is available only for Visa Acceptance Solutions integrations.

Specifications

Data Type:
String

Data Length:
15

Mapping Information

REST API Field:

pointOfSaleInformation.terminalInputCapability

SCMP API Field:

terminal_input_capabilities_#

Simple Order API Field:

pos_terminalInputCapabilities_#

pointOfSaleInformation. terminalOutputCapability

Indicates whether the terminal can print or display messages.

Possible values:

1

: Neither

2

: Print only

3:

Display only

4:

Print and display

This field is available only for Visa Acceptance Solutions integrations.

For Mastercard cashback transactions, you must send this field with the value of

5

to indicate that the terminal supports purchase-only approvals.

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

pointOfSaleInformation.terminalOutputCapability

SCMP API Field:

terminal_output_capability

Simple Order API Field:

pos_terminalOutputCapability

pointOfSaleInformation. terminalPinCapability

Maximum PIN length that the terminal can capture.

Possible values:

0

: No PIN capture capability

1

: PIN capture capability unknown

2:

PIN pad down.

4:

Four characters

5:

Five characters

6:

Six characters

7:

Seven characters

8:

Eight characters

9:

Nine characters

10:

Ten characters

11:

Eleven characters

12:

Twelve characters

This field is available only for Visa Acceptance Solutions integrations on the Visa Platform Connect processor.

The value of this field corresponds to this data in the TC 33 capture file:

Record: CP01 TCR 1

Position: 15-16

Field: POS Entry Mode

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

pointOfSaleInformation.terminalPinCapability

SCMP API Field:

terminal_pin_capability

Simple Order API Field:

pos_terminalPINcapability

pointOfSaleInformation. terminalSerialNumber

Terminal serial number assigned by the hardware manufacturer.

This value is provided by the client software that is installed on the POS terminal.

This value is not sent to the processor. Instead, the value is forwarded to the Visa Acceptance Solutions reporting software.

This field is available only for Visa Acceptance Solutions integrations.

Specifications

Data Type:
String

Data Length:
32

Mapping Information

REST API Field:

pointOfSaleInformation.terminalSerialNumber

SCMP API Field:

terminal_serial_number

Simple Order API Field:

pos_terminalSerialNumber

pointOfSaleInformation. trackData

For card-present transactions, this field applies to the card’s track 1 and 2 data. For PIN debit transactions, this field applies to track 2 data from the debit card; the sentinels are required.

This field is available only for the American Express Direct, Banque de France et Tresor Public, BNP Paribas France, Chase Paymentech Solutions, Credit Mutuel-CIC, FDC Nashville Global, FDMS Nashville, GPN, JCN Gateway, OmniPay Direct, Prosa, , SIX, TSYS Acquiring Solutions, Visa Platform Connect and Worldpay VAP processors.

Card-Present Transactions: FDMS Nashville:
This value consists of one of the following:
Track 1 data
Data for both tracks 1 and 2; Other Processors:
This value consists of one of the following:
Track 1 data
Track 2 data
Data for both tracks 1 and 2; Example:

%B4111111111111111^SMITH/ JOHN ^2412101976110000868000000?;4111111111111111=24121019761186800000?
PIN Debit Transactions: In the following example, the card number is 4111111111111111, the expiration year is 16, and the expiration month is 12. The end sentinel (?) follows the final character of data recorded on the track.; Example:

;4111111111111111=16121019761186800000?

Specifications

Data Type:
String

Data Length:
119

Mapping Information

REST API Field:

pointOfSaleInformation.trackData

SCMP API Field:

track_data

Simple Order API Field:

pos_trackData

processingInformation

These fields provide processing information.

processingInformation.actionList

processingInformation.actionTokenTypes

processingInformation.authorizationOptions. aftIndicator

processingInformation.authorizationOptions. aggregatedAuthIndicator

processingInformation.authorizationOptions. authIndicator

processingInformation.authorizationOptions. authType

processingInformation.authorizationOptions. balanceInquiry

processingInformation.authorizationOptions. balanceUpdate

processingInformation.authorizationOptions.initiator. credentialStoredOnFile

processingInformation.authorizationOptions. billPayment

processingInformation.authorizationOptions. billPaymentType

processingInformation.authorizationOptions. cashAdvanceIndicator

processingInformation.authorizationOptions. debtRecoveryIndicator

processingInformation.authorizationOptions.declineAvsFlags

processingInformation.authorizationOptions. deferredAuthIndicator

processingInformation.authorizationOptions. extendAuthIndicator

processingInformation.authorizationOptions. ignoreAvsResult

processingInformation.authorizationOptions. ignoreCvResult

processingInformation.authorizationOptions.initiator. credentialStoredOnFile

processingInformation.authorizationOptions.initiator. merchantInitiatedTransaction.originalAuthorizedAmount

processingInformation.authorizationOptions.initiator. merchantInitiatedTransaction.processorTransactionID

processingInformation.authorizationOptions.initiator. merchantInitiatedTransaction.reason

processingInformation.authorizationOptions.initiator. merchantInitiatedTransaction.previousTransactionID

processingInformation.authorizationOptions.initiator. storedCredentialUsed

processingInformation.authorizationOptions.initiator.type

processingInformation.authorizationOptions.moneyLoad

processingInformation.authorizationOptions. partialAuthIndicator

processingInformation.authorizationOptions. paymentTypeIndicator

processingInformation.authorizationOptions.serviceType

processingInformation.authorizationOptions. splitPaymentTransaction

processingInformation.authorizationOptions. transactionMode

processingInformation.authorizationOptions. transportationMode

processingInformation.authorizationOptions. verbalAuthCode

processingInformation.authorizationOptions. verbalAuthTransactionId

processingInformation.authorizationOptions. cardVerificationIndicator

processingInformation.bankTransferOptions.effectiveDate

processingInformation.bankTransferOptions.fraudScreeningLevel

processingInformation.bankTransferOptions.paymentCategoryCode

processingInformation.bankTransferOptions.secCode

processingInformation.bankTransferOptions.settlementMethod

processingInformation.bankTransferOptions.terminalCity

processingInformation.bankTransferOptions.terminalState

processingInformation.purchaseOptions.benefitAmount

processingInformation.purchaseOptions.benefitType

processingInformation.binSource

processingInformation.businessApplicationId

processingInformation.capture

processingInformation.captureOptions. captureSequenceNumber

processingInformation.captureOptions. dateToCapture

processingInformation.captureOptions.isFinal

processingInformation.captureOptions. totalCaptureCount

processingInformation.commerceIndicator

processingInformation. electronicBenefitsTransfer.category

processingInformation.electronicBenefitsTransfer. voucherSerialNumber

processingInformation.enableEscrowOption

processingInformation.enablerId

processingInformation.extendedCreditTotalCount

processingInformation.foreignRetailIndicator

processingInformation.fundingOptions.initiator. originatorInitiatedTransaction.originalTransactionId

processingInformation.fundingOptions.initiator.type

processingInformation.industryDataType

processingInformation.issuer.discretionaryData

processingInformation.japanPaymentOptions. bonusAmount

processingInformation.japanPaymentOptions. bonusMonth

processingInformation.japanPaymentOptions.bonuses

processingInformation.japanPaymentOptions. businessName

processingInformation.japanPaymentOptions.businessNameAlphaNumeric

processingInformation.japanPaymentOptions. businessNameKatakana

processingInformation.japanPaymentOptions.firstBillingMonth

processingInformation.japanPaymentOptions.jis2TrackData

processingInformation.japanPaymentOptions.paymentMethod

processingInformation.japanPaymentOptions. preapprovalType

processingInformation.japanPaymentOptions. secondBonusAmount

processingInformation.japanPaymentOptions. secondBonusMonth

processingInformation.japanPaymentOptions.installments

processingInformation.japanPaymentOptions.terminalId

processingInformation.leastCostRouting

processingInformation.linkId

processingInformation.loanOptions.assetType

processingInformation.loanOptions.type

processingInformation.merchantVerificationValue

processingInformation.mobileRemotePaymentType

processingInformation.nationalNetDomesticData

processingInformation.networkPartnerID

processingInformation.networkRoutingOrder

processingInformation.originalPaymentId

processingInformation.payByPointsIndicator

processingInformation.paymentFlowMode

processingInformation.paymentSolution

processingInformation.payoutOptions.deferredDateTime

processingInformation.payoutOptions.acquirerBin

processingInformation.payoutOptions.networkId

processingInformation.payoutOptions.payoutInquiry

processingInformation.processorId

processingInformation.purchaseLevel

processingInformation.purchaseOptions. isElectronicBenefitsTransfer

processingInformation.purchaseOptions.type

processingInformation.purchaseOptions. eligibilityIndicator

processingInformation.purposeOfPayment

processingInformation.reconciliationId

processingInformation.recurringOptions.firstRecurringPayment

processingInformation.recurringOptions.loanPayment

processingInformation.refundOptions.reason

processingInformation.reportGroup

processingInformation.transactionReason

processingInformation.transactionTimeout

processingInformation.transactionTypeIndicator

processingInformation.validationLevel

processingInformation.visaCheckoutID

processingInformation.walletType

processingInformation. actionList

This field denotes one or more actions to include with the payment.

These actions invoke other services bundled with the risk service.

Possible values are:

CONSUMER_AUTHENTICATION

: Verifies that a card is enrolled in Payer Authentication along with your request.

DECISION_SKIP

: Skips Decision Manager services.

TOKEN_CREATE

: Creates a token from the payment data in your request.

VALIDATE_CONSUMER_AUTHENTICATION

: Includes a Payer Authentication result in your request.

BILLING_AGREEMENT_CREATE

: Creates a Standing Instruction billing agreement.

UPDATE_AGREEMENT

: Modifies an existing Standing Instruction billing agreement.

Specifications

Data Type:
Array of strings

Data Length:
2,147,483,647

Mapping Information

REST API Field:

processingInformation.actionList

SCMP API Field:
No corresponding field

Simple Order API Field:
No corresponding field

processingInformation. actionTokenTypes

Indicates the type of TMS token to be created in the request.

Possible Values

customer

instrumentIdentifier

paymentInstrument

shippingAddress

Specifications

Data Type:
Enum

Data Length:
20

Mapping Information

No corresponding fields.

processingInformation. authorizationOptions. aftIndicator

Indicates whether the transaction is an Account Funding Transaction (AFT).

You must receive prior approval from the processor before processing AFTs. Contact your processor to participate in AFT services.

This field is available only for Visa and Mastercard on these processors:

Barclays

Chase Paymentech Solutions

FDC Nashville Global

First Data Merchant Solutions

LloydsTSB Cardnet International

Streamline

Visa Platform Connect

Possible values:

true

: This is an AFT transaction.

false

(default): This is not an AFT transaction.

Specifications

Data Type:
String

Data Length:
5

First Data Merchant Solutions: 6

LloydsTSB Cardnet International: 6

Mapping Information

REST API Field:

processingInformation.authorizationOptions.aftIndicator

SCMP API Field:

aft_indicator

Simple Order API Field:

aft_indicator

processingInformation. authorizationOptions. aggregatedAuthIndicator

Flag for a mass transit transaction that indicates whether the authorization is aggregated.

This field is available only for mass transit transactions on the Visa Platform Connect processor.

Possible values:

true

: Aggregated

false

(default): Not aggregated

The value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCR7

Position: 150-151

Field: Transit Transaction Type Indicator

The TC 33 capture file contains information about the payments and credits that a merchant submits to Visa Acceptance Solutions. The processor creates the TC 33 capture file at the end of the day and sends it to the merchant’s acquirer. The acquirer uses this information to facilitate end-of-day clearing processing with payment networks.

Specifications

Data Type:
String

Mapping Information

REST API Field:

processingInformation.authorizationOptions.aggregatedAuthIndicator

SCMP API Field:

aggregated_auth_indicator

Simple Order API Field:

ccAuthService_aggregatedAuthIndicator

processingInformation. authorizationOptions. authIndicator

Purpose of the authorization.

Possible values:

0

: Preauthorization.

1

: Final authorization.

To set the default for this field, contact customer support.

Barclays and Elavon: The default for Barclays and Elavon is
1
(final authorization). To change the default for this field, contact customer support.
: When the value for this field is
0
, it corresponds to the following data in the TC 33 capture file:
Record: CP01 TCR0
Position: 164
Field: Additional Authorization Indicators; When the value for this field is
1
, it does not correspond to any data in the TC 33 capture file.

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

processingInformation.authorizationOptions.authIndicator

SCMP API Field:

auth_indicator

Simple Order API Field:

authIndicator

processingInformation. authorizationOptions. authType

Authorization type.

Possible values:

AUTOCAPTURE

: Automatic capture

STANDARDCAPTURE

: Standard capture

VERBAL

: Forced capture or verbal authorization

Automatic Capture and Standard Capture: To request an automatic capture if your account is not configured for automatic captures, set this field to
AUTOCAPTURE
and include it in a bundled authorization and capture request.

To override an automatic capture and request a standard capture if your account is configured for automatic captures, set this field to
STANDARDCAPTURE
and include it in a standard authorization or bundled authorization and capture request.
Forced Capture: A forced capture occurs when you process an authorization outside the Visa Acceptance Solutions system but then capture the order through Visa Acceptance Solutions. To indicate that you are performing a forced capture, set this field to
verbal
and include it in a bundled authorization and capture request along with other fields required for a forced capture.
Verbal Authorization: When you request an authorization through Visa Acceptance Solutions, the issuing bank might ask you to call the payment processor to answer questions about the transaction. When this happens, the processor gives you a verbal authorization code for the transaction. To indicate that you are capturing a verbal authorization, set this field to
verbal
and include it in a capture request along with other fields required for a verbal authorization.

Specifications

Automatic Capture and Standard Capture:

Data Type
: String

Data Length
: 15

Forced Capture and Verbal Authorization:

Data Type
: String

Data Length
: 11

Mapping Information

REST API Field:

processingInformation.authorizationOptions.authType

SCMP API Field:

auth_type

Simple Order API Fields:

ccAuthService_authType

ccCaptureService_authType

processingInformation. authorizationOptions. balanceInquiry

Flag that specifies whether to return balance information.

Possible values:

true

: Return balance information.

false

: Do not return balance information.

Specifications

Data Type: Boolean

Mapping Information

REST API Field:

processingInformation.authorizationOptions.balanceInquiry

Simple Order API Field:

balanceInquiry

processingInformation. authorizationOptions. balanceUpdate

The merchant uses this value to inform Visa Acceptance Solutions if a transaction is a money load with a balance update.

Possible values:

true

false

Specifications

Data Type: Boolean

Data Length: 10

Mapping Information

REST API Field:

processingInformation.authorizationOptions.balanceUpdate

processingInformation. authorizationOptions. billPayment

Indicates payment for bill or payment towards existing contractual loan.

For Visa card types only.

Authorization service:
Flag that specifies whether this payment is for a bill or for an existing contractual loan. This value is case sensitive. Possible values:

true

: Visa bill payment or loan payment.

false

(default): Not a Visa bill payment or loan payment.

Capture service:
Flag that specifies whether this is a credit for a bill that the customer paid with a Visa card. Possible values:

true

: Credit for a Visa bill payment.

false

(default): Not a credit for a Visa bill payment.

Specifications

Data Type:
Boolean

Mapping Information

REST API Field:

processingInformation.authorizationOptions.billPayment

SCMP API Field:

bill_payment

Simple Order API Fields:

For Card-Not-Present and Card-Present Transactions:

ccAuthService_billPayment

For Card-Not-Present Transactions Only:

ccCreditService_billPayment

processingInformation. authorizationOptions. billPaymentType

Reason for the payment.

Possible values:

001

: Utility payment.

002

: Government services.

003

: Mobile phone top-up.

004

: Coupon payment.

005

: Installment-based repayment.

15

: Public utilities.

35

: Billing payment.

38

: Cellular phone top-up.

46

: Tax payment.

47

: Tax payment refunds.

This field is available only for bill payments in Brazil and Colombia with Mastercard on the processor. To participate in the Mastercard Bill Payment program, you must sign up with Mastercard.

The value for this field corresponds to the following data in the TC 33 capture file:

Record: CP07 TCR0

Position: 48-50

Field: Bill Payment Transaction Type Identifier

Specifications

Data Type:
String

Data Length:
3

Mapping Information

REST API Field:

processingInformation.authorizationOptions.billPaymentType

SCMP API Field:

bill_payment_type

Simple Order API Field:

billPaymentType

processingInformation. authorizationOptions. initiator. credentialStoredOnFile

Indicates whether the customer initiated the transaction and whether the credentials are stored for future authorizations.

This field is available only on the FDC Compass and Visa Platform Connect processors.

Future authorizations that use the stored credentials can be merchant-initiated transactions or customer-initiated credentials-on-file transactions.

Possible values:

true

: Credentials from this transaction are stored for future authorizations.

false

: Credentials from this transaction are not stored for future authorizations.

For the endpoint

/tss/v2/transactions/{id}

, possible values are

Y

or

N

.

Visa Platform Connect: The value for this field corresponds to the following data in the TC 33 capture file:
Record: CP01 TCR1
Position: 136
Field: POS Environment

The TC 33 capture file contains information about the payments and credits that a merchant submits to Visa Acceptance Solutions. The processor creates the TC 33 capture file at the end of the day and sends it to the merchant’s acquirer. The acquirer uses this information to facilitate end-of-day clearing processing with payment networks.

Specifications

Data Type:
String

Data Length:
5

For the endpoint

/tss/v2/transactions/{id}

, the data length is 1.

Mapping Information

REST API Field:

processingInformation.authorizationOptions.initiator.credentialStoredOnFile

SCMP API Field:

subsequent_auth_first

Simple Order API Field:

subsequentAuthFirst

processingInformation. authorizationOptions. cashAdvanceIndicator

Indicates merchant provided a cash advance during a POS transaction.

Possible values:

true:

Transaction is a cash advance.

false:

Transaction is not a cash advance.

Specifications

Data Type:
String

Data Length:
5

Mapping Information

REST API Field:

processingInformation.authorizationOptions.cashAdvanceIndicator

SCMP API Field:

cash_advance_indicator

Simple Order API Field:

cashAdvanceIndicator

processingInformation. authorizationOptions. debtRecoveryIndicator

Flag for a mass transit transaction that indicates whether the purpose of the authorization is to recover debt.

This field is available only for mass transit transactions.

Possible values:

true

: Debt recovery transaction

false

(default): Not a debt recovery transaction

Visa Platform Connect: This field is required for MTT merchant-initiated mail order or telephone order (MOTO) debt recovery on Visa Platform Connect and optional for other kinds of MTT debt recovery and other processors.

The value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCR7
Position: 150-151
Field: Transit Transaction Type Indicator

The TC 33 capture file contains information about the payments and credits that a merchant submits to Visa Acceptance Solutions. The processor creates the TC 33 capture file at the end of the day and sends it to the merchant’s acquirer. The acquirer uses this information to facilitate end-of-day clearing processing with payment networks.

Specifications

Data Type:
String

Data Length:
5

Mapping Information

REST API Field:

processingInformation.authorizationOptions.debtRecoveryIndicator

SCMP API Field:

debt_recovery_indicator

Simple Order API Field:

ccAuthService_debtRecoveryIndicator

processingInformation. authorizationOptions.declineAvsFlags

User defined list of AVS codes that will cause system to decline a transaction.

When triggered, the AVS will return a

DAVSNO

flag.

Use a

space

to separate the values in the list.

IMPORTANT

To receive declines for the AVS code

N

, include the value

N

in the list.

Cielo 3.0 and cybersource Latin American Processing AVS Codes

IMPORTANT

cybersource Latin American Processing refers to a specific processing connection and does not refer to any other processors that support the Latin American region.

AVS Code	Description
D	Postal code and address match (partial match).
E	AVS not supported for this card type (not supported), or the acquirer returned an unrecognized value for the AVS response (invalid).
F	Postal code matches, but the CPF and address do not match (partial match).
G	AVS not supported or verified (not supported).
I	AVS information is not available (no match).
K	CPF matches, but the postal code and address do not match (partial match).
L	Postal code and CPF match, but the address does not match (partial match).
N	Postal code, CPF, and address do not match (no match).
O	CPF and address match, but the postal code does not match (partial match).
R	Your implementation does not support AVS (not supported) or the system is unavailable.
T	Address matches, but the CPF and postal coded do not match (partial match).
V	Postal code, CPF and address matches (match).

CPF (Cadestro de Pessoas Fisicas) is only required for Redecard in Brazil.

AVS Codes for All Other Processors

Amerian Express Cards

For American Express cards only, you can receive Visa and Cybersource AVS codes in addition to American Express AVS codes.

When using the Visa Platform Connect processor, American Express AVS codes are converted to VISA AVS codes before they are returned. As a result, American Express AVS codes are not returned for American Express cards.

American Express Card codes: F, H, K, L, O, T, V

Domestic and International Visa Cards

Returned AVS codes are the standard Visa AVS codes.

AVS is considered either domestic or international, depending on the location of the issuing bank. If the bank is located in the U.S., AVS is domestic. If the bank is located outside of the U.S., AVS is international. You should be prepared to handle both domestic and international AVS codes, as both types of codes can be returned whether or not the card is domestic or international.

International Visa Codes: B, C, D, G , I, M, P

Domestic Visa Codes: A, F, N, R, S, U, W, X, Y, Z

Visa Acceptance Solutions Codes

In addition to standard Visa codes, Visa Acceptance Solutions provides the following numeric codes:

Visa Acceptance Solutions codes: 1, 2, 3, 4

AVS Code	Description
A	Street address matches, but the postal code doesn't match (partial match)
B	Street address matches, but the postal code is not verified. Only returned for Visa cards not issued in the U.S. (partial match)
C	Street address and postal code do not match. Returned only for Visa cards not issued in the U.S. (partial match)
D	Street address and postal code match. (match)
E	AVS data is invalid or the AVS is not allowed for this card type. (invalid)
F	Card member name does not match, but billing postal code matches. (partial match)
G	Issuing back outside of the U.S. does not support AVS. (not supported)
H	Card member name does not match, but street address and postal code match. Only returned for American Express cards.
I	Address not verified. (no match)
K	Card member name matches, but billing address and postal code does not match. (partial match)
L	Card member name and billing postal code match, but billing address does not match (partial match)
M	Street address and postal code match. (match)
N	One of the following: Street address does not match (American Express Cards only), card member name does not match, street address does not match, postal code does not match. (no match)
O	Card member name and billing address match, but billing postal code does not match. (partial match)
P	Postal code matches, but street address not verified. (partial match)
R	System unavailable.
S	Issuing bank in the U.S. does not support AVS (not supported)
T	Card member name does not match, but address matches. (partial match)
U	Address information unavailable for one of these reasons: The U.S. bank does not support AVS outside of the US or the AVS system is not functioning properly. (system unavailable)
V	Card member name, billing address and billing postal code match. (match)
W	Street address does not match, but the 9-digit postal code matches (partial match)
X	Street address and the 9-digit postal code matches (match)
Y	Street address and the 5-digit postal code matches (match)
Z	Street address does not match, but the 5-digit postal code matches (partial match)
1	AVS is not supported for this processor and/or card type. Or AVS is disabled on your `Visa Acceptance Solutions` account. (not supported)
2	The processor returned an unrecognized value. (unrecognized)
3	Address is confirmed. Only returned for PayPal Express checkout. (match)
4	Address not confirmed. Only returned for PayPal Express checkout. (no match)
5	No AVS code returned (no match)

Specifications

Data Type:
String

Data Length:
15

Mapping Information

REST API Field:

processingInformation.authorizationOptions.declineAvsFlags

SCMP API Field:

decline_avs_flags

Simple Order API Field:

businessRules_declineAVSFlags

processingInformation. authorizationOptions. deferredAuthIndicator

Flag that indicates whether the authorization request is a deferred authorization.

This field is available for Mastercard transactions on the Visa Platform Connect processor.

Possible values:

true

: Deferred authorization

false

(default): Not a deferred authorization

For mass transit transactions, the value for this field corresponds to this data in the TC 33 capture file:

First data item:

Record: CP01 TCR0

Position: 160-163

Field: Message Reason Code

Second data item:

Record: CP01 TCR7

Position: 150-151

Field: Transit Transaction Type Indicator

The TC 33 capture file contains information about the payments and credits that a merchant submits to Visa Acceptance Solutions. The processor creates the TC 33 capture file at the end of the day and sends it to the merchant’s acquirer. The acquirer uses this information to facilitate end-of-day clearing processing with payment networks.

Specifications

Data Type:
Boolean

Data Length:
5

Mapping Information

REST API Field:

processingInformation.authorizationOptions.deferredAuthIndicator

SCMP API Field:

auth_deferred_auth_indicator

Simple Order API Field:

ccAuthService_deferredAuthIndicator

processingInformation. authorizationOptions. extendAuthIndicator

Flag that indicates whether the authorization request is an extended authorization.

Possible values:

true

: Deferred authorization

false

(default): Not a deferred authorization

The TC 33 capture file contains information about the payments and credits that a merchant submits to Visa Acceptance Solutions. The processor creates the TC 33 capture file at the end of the day and sends it to the merchant’s acquirer. The acquirer uses this information to facilitate end-of-day clearing processing with payment networks.

Specifications

Data Type:
Boolean

Data Length:
5

Mapping Information

REST API Field:

processingInformation.authorizationOptions.extendAuthIndicator

SCMP API Field:

auth_extend_auth_indicator

Simple Order API Field:

ccAuthService_extendAuthIndicator

processingInformation. authorizationOptions. ignoreAvsResult

Flag for a sale request that specifies whether to allow the capture service to run even when the authorization receives an AVS decline.

An AVS decline is indicated by a

response flag value of

DAVSNO

.

Possible values:

true

: Ignore the results of AVS checking, and run the capture service.

false

(default): If the authorization receives an AVS decline, do not run the capture service.

When the value of this field is

true

, the list in the

processingInformation.authorizationOptions.declineAvsFlags

field is ignored.

Specifications

Data Type:
Boolean

Mapping Information

REST API Field:

processingInformation.authorizationOptions.ignoreAvsResult

SCMP API Field:

ignore_avs

Simple Order API Field:

businessRules_ignoreAVSResult

processingInformation. authorizationOptions. ignoreCvResult

Flag for a sale request that specifies whether to allow the capture service to run even when the authorization receives a CVN decline.

A CVN decline is indicated by the

processorInformation.cardVerification.resultCode

value of

D

or

N

.

Possible values:

true

: Ignore the results of CVN checking, and run the capture service.

false

(default): If the authorization receives a CVN decline, do not run the capture service.

Specifications

Data Type:
Boolean

Mapping Information

REST API Field:

processingInformation.authorizationOptions.ignoreCvResult

SCMP API Field:

ignore_bad_cv

Simple Order API Field:

businessRules_ignoreCVResult

processingInformation. authorizationOptions. initiator. credentialStoredOnFile

Indicates whether the customer initiated the transaction and whether the credentials are stored for future authorizations.

This field is available only on the FDC Compass and Visa Platform Connect processors.

Future authorizations that use the stored credentials can be merchant-initiated transactions or customer-initiated credentials-on-file transactions.

Possible values:

true

: Credentials from this transaction are stored for future authorizations.

false

: Credentials from this transaction are not stored for future authorizations.

For the endpoint

/tss/v2/transactions/{id}

, possible values are

Y

or

N

.

Visa Platform Connect: The value for this field corresponds to the following data in the TC 33 capture file:
Record: CP01 TCR1
Position: 136
Field: POS Environment

The TC 33 capture file contains information about the payments and credits that a merchant submits to Visa Acceptance Solutions. The processor creates the TC 33 capture file at the end of the day and sends it to the merchant’s acquirer. The acquirer uses this information to facilitate end-of-day clearing processing with payment networks.

Specifications

Data Type:
String

Data Length:
5

For the endpoint

/tss/v2/transactions/{id}

, the data length is 1.

Mapping Information

REST API Field:

processingInformation.authorizationOptions.initiator.credentialStoredOnFile

SCMP API Field:

subsequent_auth_first

Simple Order API Field:

subsequentAuthFirst

processingInformation. authorizationOptions. initiator. merchantInitiatedTransaction. agreementId

Unique ID generated by the merchant for recurring and unscheduled card-on-file transactions, and shared in subsequent transactions.

This field is required for all unscheduled card-on-file and recurring subsequent transactions from Saudi Arabia merchants. The merchant generates an agreement ID for each card holder or payment agreement. This field can contain foreign/Arabic character set. This value is forwarded to the Saudi payment processor.

Specifications

Data Type:
String

Data Length:
140

Mapping Information

REST API Field:

processingInformation.authorizationOptions.initiator.merchantInitiatedTransaction.agreementId

SCMP API Field:

agreement_id

Simple Order API Field:

agreementID

processingInformation. authorizationOptions. initiator. merchantInitiatedTransaction. originalAuthorizedAmount

Amount of the original authorization.

This field is available only on the FDC Compass, FDC Nashville Global, Streamline, and Visa Platform Connect processors.

This field is available only for the following types of transactions using Discover:

Merchant-initiated transactions.

FDC Nashville Global:
Recurring payments that use payment network tokens.

FDC Nashville Global and Streamline:
Subsequent authorizations.

Specifications

Data Type:
String

Data Length:
60

Mapping Information

REST API Field:

processingInformation.authorizationOptions.initiator. merchantInitiatedTransaction.originalAuthorizedAmount

SCMP API Field:

subsequent_auth_original_amount

Simple Order API Field:

subsequentAuthOriginalAmount

processingInformation. authorizationOptions. initiator. merchantInitiatedTransaction. processorTransactionID

This field is available only on the FDMS Nashville processor.

The transaction ID value for subsequent merchant-initiated transactions. The value for this field is returned in the

processorInformation.transactionID

field in the response message for the initial authorization in the series.

Specifications

Data Type:
String

Data Length:
16

Mapping Information

REST API Field:

processingInformation.authorizationOptions.initiator. merchantinitiatedTransaction.processorTransactionID

SCMP API Field:

processor_trans_id

Simple Order API Field:

processorTransId

processingInformation. authorizationOptions. initiator. merchantInitiatedTransaction. reason

The reason for the incremental authorization or merchant-initiated transaction.

This field is available merchant-initiated transactions identified in the table of field values below.

This field is available only on the FDC Compass and Visa Platform Connect processors.

Field Values
Possible Value	Transaction Type	Supported Card Types
1	Resubmission	Discover Mastercard Visa
2	Delayed charge	Discover Mastercard Visa
3	Reauthorization for split shipment	Discover Visa
4	No show	Discover Mastercard Visa
5	Incremental authorization	Discover Visa
6	Partial shipment	Discover Mastercard
7	Recurring or subscription	Mastercard
8	Standing order	Mastercard
9	Installment	Mastercard
10	Unscheduled Card-on-File (COF)	American Express Discover Mastercard

Visa Platform Connect: Possible values:
1
: Resubmission.
2
: Delayed charge.
3
: Reauthorization for split shipment.
4
: No show.
5
: Incremental authorization.; The value for this field corresponds to the following data in the TC 33 capture file:
Record: CP01 TCR0
Position: 160-163
Field: Message Reason Code

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

processingInformation.authorizationOptions.initiator.merchantInitiatedTransaction.reason

SCMP API Field:

subsequent_auth_reason

Simple Order API Field:

subsequentAuthReason

processingInformation. authorizationOptions. initiator. merchantInitiatedTransaction. previousTransactionID

Network transaction identifier that was returned for a previous authorization in the series.

This field is available only on the FDC Compass, FDI Australia, and Visa Platform Connect processors.

The value for this field was returned in the

processorInformation.transactionID

field in the response message for either the original authorization in the series or the previous authorization in the series.

FDI Australia: This field is supported only for installment payments and merchant-initiated transactions.

Specifications

Data Type:
String

Data Length:

29 (Discover and Diners Club)

15 (All other card types)

Mapping Information

REST API Field:

processingInformation.authorizationOptions. initiator.merchantInitiatedTransaction.previousTransactionID

SCMP API Field:

subsequent_auth_transaction_id

Simple Order API Field:

subsequentAuthTransactionID

processingInformation. authorizationOptions. initiator. storedCredentialUsed

Indicates whether you obtained the payment information from credentials on file (COF) instead of from the customer.

This field is supported only for FDC Compass and .

Possible values:

true

: Transaction uses COF.

false

: Transaction does not use COF.

When you use the Token Management Service, this field is set to

true

for you.

Specifications

Data Type:
Boolean

Mapping Information

REST API Field:

processingInformation.authorizationOptions. initiator.storedCredentialUsed

SCMP API Field:

subsequent_auth_stored_credential

Simple Order API Field:

subsequentAuthStoredCredential

processingInformation. authorizationOptions. initiator.type

Indicates whether the requested installment payment or recurring payment is a merchant-initiated transaction (MIT).

This field is available only on the FDC Compass, FDC Nashville Global, Streamline, and Visa Platform Connect processors.

This field can be used with these request fields:

The

processingInformation.commerceIndicatore

field set to

recurring

(for recurring transactions) or

install

(for installment transactions).

The

processingInformation.authorizationOptions.initiator. merchantInitiatedTransaction.reason

subsequentAuthReason

field set to any value supported for that field.

Possible values:

merchant

: Merchant-initiated transaction.

customer

: Not a merchant-initiated transaction.

Visa Platform Connect:
The value for this field does not correspond to any data in the TC 33 capture file.

Specifications

Data Type:
String

Data Length:
8

Mapping Information

REST API Field:

processingInformation.authorizationOptions.initiator.type

SCMP API Field:

subsequent_auth

Simple Order API Field:

subsequentAuth

processingInformation. authorizationOptions. moneyLoad

The merchant uses this value to inform Visa Acceptance Solutions if a transaction is money load only.

Possible values:

true

false

Specifications

Data Type: Boolean

Data Length: 10

Mapping Information

REST API Field:

processingInformation.authorizationOptions.moneyLoad

processingInformation. authorizationOptions. partialAuthIndicator

Flag that specifies whether partial authorizations are enabled.

This field is available only for the FDC Compass and Visa Platform Connect processor.

When a request includes this field, this value overrides the information in your account. Possible values:

true

: Enables partial authorization transactions.

false

: Does not enable partial authorization transactions.

Visa Platform Connect: To set the default for this field, contact customer support.

The value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCR0
Position: 164
Field: Additional Authorization Indicators

Specifications

Data Type:
String

Data Length:
5

Mapping Information

REST API Field:

processingInformation.authorizationOptions.partialAuthIndicator

SCMP API Fields:

auth_partial_auth_indicator

pin_debit_purchase_partial_auth_indicator

Simple Order API Fields:

ccAuthService_partialAuthIndicator

pinDebitPurchaseService_partialAuthIndicator

processingInformation. authorizationOptions. paymentTypeIndicator

This value indicates whether the transaction is a Credential-on-File, installment, or recurring payment. It is sent only for transactions processed by SMCC.

Possible values:

C

: Credential on File for initial storage, or unscheduled card on file for subsequent merchant-initiated transactions.

I

: Installment payment.

R

: Recurring payment, such as for utility bills and magazines.

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

processingInformation.authorizationOptions.paymentTypeIndicator

SCMP API Field:

payment_type_indicator

Simple Order API Field:

paymentTypeIndicator

processingInformation.authorizationOptions.serviceType

This field value defines the type of Account Funding Transaction (AFT).

The service type value,

0B

, denotes a back-to-back funding transaction that automatically transfers funds from one bank account to the account used to make a purchase. This type of transaction ensures that the purchasing account maintains adequate funds.

This field value is used in request and response for Europe domestic and intra-EEA AFTs.

Possible values:

00

= Normal transaction

01

= Originator hold

02

= Visa deferred Original Credit Transaction (OCT) hold, default interval

03

= Visa deferred OCT hold, user-defined interval

09

= Cancel pending deferred OCT request

0B

= Back-to-back transactions for AFT

0I

= Visa Direct custom program 1

0Q

= Query the status of the deferred OCT

A0

= Alias Directory 2

Specifications

Data Type:
String

Data Length:
10

Mapping Information

REST API Field:

processingInformation.authorizationOptions.serviceType

SCMP API Field:

service_processing_service_type

Simple Order API Field:

serviceProcessing_serviceType

processingInformation. authorizationOptions. splitPaymentTransaction

Flag that indicates a split payment transaction. A split payment allows the use of two payment methods for a single transaction.

Possible values:

true

: split payment transaction is supported

false

(default): split payment transaction is not supported

Specifications

Data Type:
Boolean

Data Length:
5

Mapping Information

REST API Field:

processingInformation.authorizationOptions.splitPaymentTransaction

SCMP API Field:

split_payment_transaction

Simple Order API Field:

ccAuthService_splitPaymentTransaction

processingInformation. authorizationOptions. transactionMode

Identifies the type of transaction.

This field is required for all mobile and telephone transactions from Saudi Arabia merchants.

Possible values:

M

: mobile order

T

: telephone order

Specifications

Data Type:
Alphanumeric

Data Length:
1

Mapping Information

REST API Field:

processingInformation.authorizationOptions.transactionMode

SCMP API Field:

transaction_mode

Simple Order API Field:

transactionMode

processingInformation. authorizationOptions. transportationMode

Mode of transportation or type of transportation-related payment.

This field is available only for the Visa Platform Connect processor.

Possible values:

00

: Use this value for debt recovery, more than one transportation mode, or an unknown transportation mode.

01

: Urban bus

02

: Interurban bus

03

: Light train mass transit

04

: Train

05

: Commuter train

06

: Waterborne vehicle

07

: Toll

08

: Parking

09

: Taxi

10

: High-speed train

11

: Rural bus

12

: Express commuter train

13

: Paratransit

14

: Self-driving vehicle

15

: Coach

16

: Locomotive

17

: Powered motor coach

18

: Trailer

19

: Regional train

20

: Inter-city transportation

21

: Funicular train

22

: Cable car

This field is supported only for mass transit transactions.

The value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCR7

Position: 153-154

Field: Transportation Mode Indicator

The TC 33 capture file contains information about the payments and credits that a merchant submits to Visa Acceptance Solutions. The processor creates the TC 33 capture file at the end of the day and sends it to the merchant’s acquirer. The acquirer uses this information to facilitate end-of-day clearing processing with payment networks.

Specifications

Data Type:
String

Data Length:
2

Mapping Information

REST API Field:

processingInformation.authorizationOptions.transportationMode

SCMP API Field:

transportation_mode

Simple Order API Field:

ccAuthService_transportationMode

processingInformation. authorizationOptions. verbalAuthCode

Authorization code you received verbally or other manner outside of the system.

Specifications

Data Type:
String

Data Length:
7

Data Length:

JCN Gateway:
Data Length:
6 (captures), 7 (all other services)

All other processors:
7

Mapping Information

REST API Field:

processingInformation.authorizationOptions.verbalAuthCode

SCMP API Fields:

auth_code

pin_debit_purchase_authorization_code

Simple Order API Fields:

ccAuthService_verbalAuthCode

ccCaptureService_verbalAuthCode

pinDebitPurchaseService_verbalAuthCode

processingInformation. authorizationOptions. verbalAuthTransactionId

Transaction ID (TID).

This field is available only for the American Express card type on the American Express Direct processor.

This field enables you to comply with American Express CAPN requirements.

Forced Capture: Obtain the value for this field from the authorization response.
Verbal Authorization: You cannot obtain a value for this field so Visa Acceptance Solutions uses the default value of
000000000000000
(15 zeros).

Specifications

Data Type:
String

Data Length:
15

Mapping Information

REST API Field:

processingInformation.authorizationOptions.verbalAuthTransactionId

SCMP API Field:

bill_transaction_id

Simple Order API Field:

ccCaptureService_transactionID

processingInformation. authorizationOptions. cardVerificationIndicator

Indicates a card verification check during a transaction.

Possible values:

True:

Transaction includes a card verification check.

False:

Transaction does not include a card verification check.

Specifications

Data Type:
String

Data Length:
5

Mapping Information

REST API Field:

processingInformation.authorizationOptions.cashAdvanceIndicator

SCMP API Field:

auth_card_verification_indicator

Simple Order API Field:

ccAuthService_cardVerificationIndicator

processingInformation. bankTransferOptions. effectiveDate

Effective date for the transaction.

The effective date must be within 45 days of the current day. If you do not include this value, Visa Acceptance Solutions sets the effective date to the next business day.

Format:
MMDDYYYY

This field is available only for the Cybersource ACH Service processor.

When the effective date is not set, the echeck transaction is batched at the next available batch time. When the echeck transaction is batched, the payment status changes to Payment. However, when the effective date is set to a date in advance, the transaction batches on the set date. While the transaction is awaiting batching, the transaction status is set to Submitted. When the echeck transaction is batched on the effective date, the transaction status changes to Payment.

Specifications

Data Type:
String

Data Length:
8

REST API Field:

processingInformation.bankTransferOptions.effectiveDate

SCMP API Field:

ecp_effective_date

Simple Order API Fields

ecCreditService_effectiveDate

ecDebitService_effectiveDate

processingInformation. bankTransferOptions. fraudScreeningLevel

Level of fraud screening. Possible values:

1

: Validation (default if the field has not already been configured for your merchant ID)

2

: Verification

3

: Guarantee

Specifications

Data Type:
Non-negative integer

Data Length:
1

Mapping Information

REST API Field:

processingInformation.bankTransferOptions.fraudScreeningLevel

SCMP API Fields:

ecp_debit_verification_level

ecp_verification_level

Simple Order API Fields:

ecDebitReply_verificationLevel

ecDebitService_verificationLevel

processingInformation. bankTransferOptions. paymentCategoryCode

Flag that indicates whether to process the payment.

Use with deferred payments.

Possible values:

0

: Standard debit with immediate payment (default).

1

: For deferred payments, indicates that this is a deferred payment and that you will send a debit request with ecp_payment_mode
=

2

in the future.

2

: For deferred payments, indicates notification to initiate payment.

Chase Paymentech Solutions
and
TeleCheck
processors: use for deferred and partial payments.

Visa Acceptance Solutions ACH Service
: not used.

Specifications

Data Type:
Integer

Data Length:
1

Mapping Information

REST API Field:

processingInformation.bankTransferOptions.paymentCategoryCode

SCMP API Field:

ecp_payment_mode

Simple Order API Fields:

ecDebitService_paymentMode

processingInformation. bankTransferOptions. secCode

The authorization method used for the transaction.

Possible values:

ARC

: Accounts receivable conversion; check mailed and processed electronically

(only used with the Chase Paymentech Solutions processor)

CCD

: Cash concentration or disbursement; funds distributed or consolidated between corporate entities

(do not use with the TeleCheck processor)

PPD

: Prearranged payment and deposit; payment from a non-consumer organization to a consumer account

TEL

: Telephone initiated

WEB

: Internet or wireless network initiated

Chase Paymentech Solutions: In Canada, use
WEB
for all ACH transactions.

Specifications

Data Type:
String

Data Length:
3

Mapping Information

REST API Field:

processingInformation.bankTransferOptions.secCode

SCMP API Field:

ecp_sec_code

Simple Order API Fields:

check_secCode

processingInformation. bankTransferOptions. settlementMethod

Method used to settle the credit. Possible values:

A

: Automated Clearing House

B

: Best possible

F

: Facsimile

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

processingInformation.bankTransferOptions.settlementMethod

SCMP API Fields:

ecp_credit_settlement_method

ecp_debit_settlement_method

ecp_settlement_method

Simple Order API Fields:

ccCreditReply_settlementMethod

ecCreditReply_settlementMethod

ecCreditService_settlementMethod

ecDebitReply_settlementMethod

ecDebitService_settlementMethod

processingInformation. bankTransferOptions. terminalCity

City in which the terminal is located.

If more than four alphanumeric characters are submitted, the transaction will be declined. You cannot include any special characters.

Specifications

Data Type:
String

Data Length:
4

Mapping Information

REST API Field:

processingInformation.bankTransferOptions.terminalCity

SCMP API Field:

ecp_terminal_city

Simple Order API Fields:

check_terminalCity

processingInformation. bankTransferOptions. terminalState

State in which the terminal is located.

If more than two alphanumeric characters are submitted, the transaction will be declined. You cannot include any special characters.

Specifications

Data Type:
String

Data Length:
2-character USPS code

Mapping Information

REST API Field:

processingInformation.bankTransferOptions.terminalState

SCMP API Field:

ecp_terminal_state

Simple Order API Fields:

check_terminalState

processingInformation. purchaseOptions. benefitAmount

This field contains the benefit amount being processed. It is for the Workplace Benefit Product for acquirers and issuers in the Europe region.

Possible values:

12.00

: Benefit amount (in regional currency) being processed.

Specifications

Data Type:
String

Data Length:
20

Mapping Information

REST API Field:

processingInformation.purchaseOptions.benefitAmount

SCMP API Fields:

benefit_amount

Simple Order API Fields:

benefit_amount

processingInformation. purchaseOptions. benefitType

This field value indicates the type of benefit. It is for the Workplace Benefit Product for acquirers and issuers in the Europe region.

This field is available only for Visa Platform Connect.

Possible values:

00

: Does not apply

10

: Savings account

20

: Checking account

30

: Credit card account

40

: Universal account (represented by customer ID)

70

: Employee benefit

96

: Cash benefits account (for use by Electronic Benefits Transfer transactions only)

98

: Food stamps account (for use by Electronic Benefits Transfer transactions only)

4T

: Transportation or Transit

52

: General benefit

53

: Meal voucher

54

: Fuel

55

: Ecological or sustainability

58

: Philanthropy, patronage, or consumption

59

: Gift

5S

: Sports or culture

5T

: Book or education

Specifications

Data Type:
String

Data Length:
100

Mapping Information

REST API Field:

processingInformation.purchaseOptions.benefitType

SCMP API Fields:

benefit_type

Simple Order API Fields:

benefit_type

processingInformation. binSource

Source of the bank identification number (BIN).

You must provide the BIN source value for a source-level lookup. When you do not include this field, the lookup is performed against the default merged BIN sources data.

Possible values:

itmx

rupay

Specifications

Data Type:
String

Data Length:
20

Mapping Information

No corresponding fields.

processingInformation. businessApplicationId

Type of transaction.

This field is a pass-through
, which means that the value is not verified or modified in any way before it is sent to the processor.

You can provide a business application ID in this field or in your account. When a request includes this field, the value in the field overrides the information in your account. Call customer support to update your account information.

Visa Platform Connect

The value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCR8

Position: 108-109

Field: Business Application Identifier (BAI)

Non-Payouts Transactions

Possible values:

AA

: Account to account.

BB

: Business to business.

BI

: Bank-initiated money transfer.

BP

: Non-card bill payment.

CB

: Consumer Bill Payment.

CC

: Cash claim.

CI

: Cash in.

CO

: Cash out.

CP

: Card bill payment.

FD

: Funds disbursement (general), including:

Commission payments

Digital goods or games

Insurance payments

Loan disbursements

Lottery payouts

Shared economy

Non-government-initiated tax refund services such as tax preparation businesses

GD

: Government disbursement, including:

Government-initiated tax refunds

Government benefit and welfare disbursements

GP

: Gambling payout other than online gambling.

LO

: Loyalty credits and rebates (not supported in European systems).

MA

: Mobile air time payment.

MD

: Merchant disbursement (acquirers or aggregators settling to merchants).

MI

: Merchant-initiated money transfer.

MP

: Face-to-face merchant payment.

OG

: Online gambling payout.

PD

: Payroll pension disbursement.

PG

: Payment to government.

PP

: Person to person.

PS

: Payment for goods and services (general).

RP

: Request to pay.

TU

: Top-up for enhanced prepaid loads.

WT

: Wallet transfer.

Barclays, FDC Compass, and Visa Platform Connect Payouts Transactions: Possible values:
BB
: Business to business.
CB
: Consumer bill payment.
FD
: Funds disbursement (general), including:
Commission payments
Digital goods or games
Insurance payments
Loan disbursements
Lottery payouts
Shared economy
Non-government-initiated tax refund services such as tax preparation businesses
GD
: Government disbursement, including:
Government-initiated tax refunds
Government benefit and welfare disbursements
GP
: Gambling payout other than online gambling.
LO
: Loyalty credits and rebates (not supported in European systems).
MD
: Merchant disbursement (acquirers or aggregators settling to merchants).
OG
: Online gambling payout.
PD
: Payroll pension disbursement.
WT
: Wallet transfer.

Additional values for Payouts transactions on the Visa Platform Connect: Possible values:
PP
: Person to person.
RP
: Request to pay.

Chase Paymentech Solutions Payouts Transactions: Possible values:
AA
: Account to account.
PP
: Person to person.

Account Funding Transactions (AFT) only

Set

processingInformation.authorizationOptions.aftIndicator

field to

true

to process Payouts AFTs for Visa and Mastercard.

You must receive prior approval from your processor before processing AFTs. Contact your processor to participate in AFT services.

Barclays for Mastercard and Visa AFTs: For Mastercard, the
recipientInformation.accountType
value must be the same the
processingInformation.businessApplicationId
value.

Possible values for Mastercard:
AA
: Account to account. The
recipientInformation.accountType
value must be either
01
,
02
,
03
or
06
.
FT
: Funds transfer where OCT not available. The
recipientInformation.accountType
value must be either
00
,
01
,
02
,
03
or
06
.
PD
: Payroll disbursement. The
recipientInformation.accountType
value must be
03
.
TU
: Top Up: Prepaid load. The
recipientInformation.accountType
value must be either
01
,
02
,
03
or
06
.
WT
: Wallet transfer. The
recipientInformation.accountType
value must be either
00
,
01
,
02
,
03
,
06
or absent.

Possible values for Visa:
AA
: Account to account.
FD
: Funds disbursement, e.g. insurance payout.
FT
: Funds transfer where OCT not available.
PD
: Payroll disbursement.
TU
: Top Up: Prepaid load.
WT
: Wallet transfer.

FDC Nashville Global for Mastercard and Visa AFTs: Visa will not reject transactions for any possible values, however, the acquirer will only support the values specified below.

Possible values for Mastercard:
AA
: Account to account.
BB
: Business to business.
CO
: Cash out.
CP
: Card bill payment.
MD
: Merchant disbursement (acquirers or aggregators settling to merchants).
PP
: Person to person.
WT
: Wallet transfer.

Possible values for Visa:
AA
: Account to account.
BI
: Money transfer (bank-initiated).
CB
: Consumer bill payment.
FT
: Funds transfer.
PP
: Person to person.
TU
: Top Up: Prepaid load.
WT
: Wallet transfer.

LloydsTSB Cardnet International and First Data Merchant Solutions for Mastercard and Visa AFT: Possible values:
AA
: Account to account.
BI
: Money transfer (bank-initiated).
FD
: Funds disbursement, e.g. insurance payout.
FT
: Funds transfer.
PD
: Payroll disbursement.
PP
: Person to person.
TU
: Top Up: Prepaid load.
WT
: Wallet transfer.

Streamline for Mastercard and Visa AFTs: Possible values:
AA
: Account to account.
FD
: Funds disbursement, e.g. insurance payout.
FT
: Funds transfer.
PD
: Payroll disbursement.
PP
: Person to person.
TU
: Top Up: Prepaid load.
WT
: Wallet transfer.

Specifications

Data Type:
String

Data Length:
2

Mapping Information

REST API Field:

processingInformation.businessApplicationId

SCMP API Field:

business_application_id

Simple Order API Field:

invoiceHeader_businessApplicationID

processingInformation. capture

Flag that indicates whether to include a capture with the authorization, making it a bundled transaction, which is also known as a sale.

Possible values:

true

: Include a capture with the authorization.

false

(default): Do not include a capture with the authorization.

Specifications

Data Type:
Boolean

Data Length:
5

Mapping Information

REST API Field:

processingInformation.capture

SCMP API Field:
No corresponding field

Simple Order API Field:
No corresponding field

processingInformation. captureOptions. captureSequenceNumber

Capture number when requesting multiple partial captures for one authorization.

This value is used along with

processingInformation.captureOptions.totalCaptureCount

to track which capture is being processed.

Example:
These are the values for the second of five captures:

processingInformation.captureOptions.captureSequenceNumber=2
processingInformation.captureOptions.totalCaptureCount=5

The value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCR8

Position: 158-159

Field: Clearing Sequence Number

Specifications

Data Type:
Integer

Data Length:
2

Mapping Information

REST API Field:

processingInformation.captureOptions.captureSequenceNumber

SCMP API Field:

capture_sequence

Simple Order API Field:

ccCaptureService_sequence

processingInformation. captureOptions. dateToCapture

Date on which the customer initiated a contactless transit transaction.

This field is available only for mass transit transactions.

Format:
MMDD

Specifications

Data Type:
String

Data Length:
4

Mapping Information

REST API Field:

processingInformation.captureOptions.dateToCapture

SCMP API Field:

auth_capture_date

Simple Order API Field:

ccAuthService_captureDate

processingInformation. captureOptions. isFinal

Indicates whether to release the authorization hold on the remaining funds.

Possible values:

true

: Release the authorization hold on the remaining funds.

false

: Do not release the authorization hold on the remaining funds.

Specifications

Data Type:
String

Data Length:
5

Mapping Information

REST API Field:

processingInformation.captureOptions.isFinal

SCMP API Field:

ap_capture_is_final

Simple Order API Field:

apCaptureService_isFinal

processingInformation. captureOptions. totalCaptureCount

Total number of captures when requesting multiple partial captures for one authorization.

This value is used along with

processingInformation.captureOptions.captureSequenceNumber

to track which capture is being processed.

When you do not know the total number of captures that you are going to request, set this field to at least one more than the

processingInformation.captureOptions.captureSequenceNumber

field until you reach the final capture. For the final capture, set both fields to the same value.

Example:
These are the values for the second of five captures:

processingInformation.captureOptions.captureSequenceNumber=2
processingInformation.captureOptions.totalCaptureCount=5

The value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCR8

Position: 160-161

Field: Clearing Sequence Count

Specifications

Data Type:
Integer

Data Length:
2

Mapping Information

REST API Field:

processingInformation.captureOptions.totalCaptureCount

SCMP API Field:

capture_total_count

Simple Order API Field:

ccCaptureService_totalCount

processingInformation. commerceIndicator

The type of transaction.

Some payment card companies use this information when determining discount rates.

Possible Values for the Authorization Service:

E-Commerce Indicator Values
Value	Description
5	Secure e-commerce transaction with a credential-on-file (COF) token. Include paymentinformation.tokenizedCard.cryptogram in the authorization request.
aesk	American Express SafeKey authentication was successful.
aesk attempted	American Express SafeKey authentication was attempted but did not succeed.
dipb	Discover card type.
install	Installment payment. For merchant-initiated transactions on with Mastercard in India or with an India-issued card, the install value is used for the installment payment scenario and for unscheduled credentials-on-file transactions.
install_internet	Non-U.S. e-commerce (Internet) installment payment. This value is not supported on all processors.
internet	Default value for authorizations. E-commerce order placed from a website.
js	JCB J/Secure authentication was successful.
js_attempted	JCB J/Secure authentication was attempted but did not succeed.
moto	Mail order or telephone order.
oci	Authentication was successful for `eftpos` card.
oci_attempted	Authentication was attempted but not successful for `eftpos` card.
oci_failure	Authentication was unsuccessful for `eftpos` card.
pb	ProtectBuy authentication was successful.
pb_attempted	ProtectBuy authentication was attempted but did not succeed.
recurring	Recurring payment that is a U.S. transaction or non-U.S. mail order/telephone order (MOTO) transaction. For merchant-initiated transactions on `Visa Platform Connect` with Mastercard in India or with an India-issued card, the recurring value is used for the recurring payment scenario.
recurring_internet	Recurring payment that is a non-U.S. e-commerce (Internet) transaction.
retail	Card-present transaction.
rpy	`RuPay` PaySecure authentication was successful.
spa	For Mastercard Identity Check: Authentication was successful or was attempted but did not succeed. The e-commerce indicator for all Mastercard Identity Check transactions, including authentication attempts, must be set to spa . Otherwise, the transactions are processed as non-identity check transactions. For secure transactions in France: Successful authentication for a Mastercard card or a Cartes Bancaires card that is co-badged with Mastercard.
spa_failure	For Mastercard Identity Check: Authentication failed. For secure transactions in France: Authentication failure for a Mastercard card or a Cartes Bancaires card that is co-badged with Mastercard.
up3ds	For secure transactions for `China UnionPay`: Authentication was successful for a China UnionPay domestic debit card.
up3ds_attempted	For secure transactions for `China UnionPay`: Authentication was attempted but did not succeed for a China UnionPay domestic debit card.
up3ds_failure	For secure transactions for `China UnionPay` domestic debit cards: Authentication failed for a China UnionPay domestic debit card.
vbv	For Visa Secure: Authentication was successful. For secure transactions in France: Successful authentication for a Visa card or a Cartes Bancaires card that is co-badged with Visa.
vbv_attempted	For Visa Secure: Authentication was attempted but did not succeed. For secure transactions in France: Authentication was attempted for a Visa card or a Cartes Bancaires card that is co-badged with Visa.
vbv_failure	For Visa Secure: Authentication failed. For secure transactions in France: Authentication failure for a Visa card or a Cartes Bancaires card that is co-badged with Visa.

Apple Pay: For the merchant decryption method, one of these values is required:
aesk
,
dipb
,
internet
,
spa
,
vbv
.
Card-Present: For a card-present transaction, you must set this field to
retail
.
Credit Service: internet
: E-commerce order placed through a website.
moto
: Mail order or telephone order.
Not supported on Cielo or UATP.

On Barclays, this value is not permitted for Maestro International cards.
recurring
: Recurring payment that is a U.S. transaction or non-U.S. MOTO transaction.
On Barclays, this value is not permitted for Maestro International cards.
recurring_internet
: Recurring payment that is a non-U.S. e-commerce (internet) transaction.
China UnionPay Processor: internet
(default): E-commerce order placed using a website.
recurring
: Recurring payment transaction.

up3ds
: Secure transaction indicating that authentication was successful for a China UnionPay card.
up3ds_attempted
: Secure transaction indicating that authentication was attempted but did not succeed for a China UnionPay card.

up3ds_failure
: Secure transaction indicating that authentication failed for a China UnionPay card.
Payer Authentication: When you request the payer authentication and authorization services separately, get the value for this field from the
processingInformation.commerceIndicator
response field.
Payouts: For the Barclays processor, the value for an account funding transaction (AFT) can be one of these indicators:
internet
—For a transaction that does not use 3-D Secure.
vbv
or
vbv_attempted
—For a transaction that uses 3-D Secure.

For the Chase Paymentech Solutions processor, the value for an account funding transaction (AFT) and original credit transaction (OCT) is
internet
.

For the FDC Compass and Visa Platform Connect processors, the value for an original credit transaction (OCT) is
internet
.
PIN Debit: For a PIN debit transaction, you must set this field to
retail
.
Samsung Pay: For the merchant decryption method, one of these values is required:
aesk
,
internet
,
spa
.

Specifications

Data Type:
String

Data Length:

Account funding transaction (AFT): 20

Card-not-present transaction: 20

Card-present transaction: 20

Original credit transaction (OCT): 13

PIN debit transaction: 13

Mapping Information

REST API Field:

processingInformation.commerceIndicator

SCMP API Field:

e_commerce_indicator

Simple Order API Fields:

ccAuthService_commerceIndicator

ccCreditService_commerceIndicator

octService_commerceIndicator

pinDebitCreditService_commerceIndicator

pinDebitPurchaseService_commerceIndicator

processingInformation. electronicBenefitsTransfer.category

Flag that specifies the category for the EBT transaction.

Possible values:

cash

: Cash benefits, which can be used to purchase any item at a participating retailer, as well as to obtain cash-back or make a cash withdrawal from a participating ATM.

food

: Food stamp benefits, which can be used only to purchase food items authorized by the USDA SNAP program.

Specifications

Data Type:
String

Data Length:
4

Mapping Information

REST API Field:

processingInformation.electronicBenefitsTransfer.category

SCMP API Field:

pin_debit_ebt_category

Simple Order API Fields:

pinDebitCreditService_ebtCategory

pinDebitPurchaseService_ebtCategory

processingInformation. electronicBenefitsTransfer. voucherSerialNumber

The serial number printed on the EBT voucher.

Specifications

Data Type:
Integer

Data Length:
15

Mapping Information

REST API Field:

processingInformation.electronicBenefitsTransfer.voucherSerialNumber

SCMP API Field:

pin_debit_ebt_voucher_serial_number

Simple Order API Field:

pinDebitPurchaseService_ebtVoucherSerialNumber

processingInformation. enableEscrowOption

Indicates whether to use the customer’s escrow agreement.

The escrow agreement can be used only if the transaction is greater than or equal to 50,000 KRW. You must enter the shipping details in the KCP administration panel for escrow payments.

Primarily used for real estate transactions.

IMPORTANT

Available only for bank transfer payments.

Possible values:

true

: Use the customer’s escrow agreement.

false

: Do not use the customer’s escrow agreement.

Specifications

Data Type:
String

Data Length:
5

Mapping Information

REST API Field:

processingInformation.enableEscrowOption

SCMP API Field:

ap_initiate_escrow_agreement

Simple Order API Field:

apInitiateService_escrowAgreement

processingInformation. enablerId

This field is the Enabler Verification Value (EVV) that Visa assigns to identify an enabler.

Instead of using acquirers, some merchants use enablers to process payments. Enablers are third parties with their own systems to process transactions for merchants or acquirers. This EVV is an optional five-character hexadecimal value that Visa assigns to identify the enabler that processes requests for authorization and OCT services. If the wrong enabler ID is used in a transaction, the transaction is still accepted. If the enabler ID character string is longer than five characters, the transaction is declined.

The agent unique ID data is still supported in the TC 33 capture file in the first five positions:

Record: CP12 TCR1

Position: 138-148

The five positions that follow the agent unique ID in CP12 TCR1 are used for the EVV. The final position is reserved for 0. Except for the first digit which is fixed, CP12-TCR1 positions 138-148 () now occupy all of ISO field 126.18.

Specifications

Data Type:
String

Data Length:
5

Mapping Information

REST API Field:

processingInformation.enablerId

SCMP API Field:

enabler_id

Simple Order API Fields:

enablerId

processingInformation. extendedCreditTotalCount

Number of months over which the cardholder can pay for the purchase.

You can use this field when offering extended credit to a cardholder at a retail location. The cardholder provides this value. The issuer pays you for the purchase in one payment, and then the cardholder pays the issuer in the number of monthly payments specified by this value.

This field is available only for acquirers in South Africa on the Visa Platform Connect processor.

Specifications

Data Type:
String

Data Length:
2

Mapping Information

REST API Field:

processingInformation.extendedCreditTotalCount

SCMP API Field:

extended_credit_total_count

Simple Order API Field:

extendedCreditTotalCount

processingInformation. foreignRetailIndicator

This value indicates whether a domestic transaction involves a marketplace retailer that is in a different country, where the domestic transaction is not processed for authorization, clearing, and settlement on VisaNet for any reason.

Possible value:

F

: foreign retailer

This field is supported only on Visa Platform Connect.

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

processingInformation.foreignRetailIndicator

SCMP API Field:

foreign_retail_indicator

Simple Order API Field:

foreignRetailIndicator

processingInformation. fundingOptions.initiator. originatorInitiatedTransaction. originalTransactionId

This field contains a Visa-generated Transaction Identifier (TID). It is unique for each original authorization and financial request. The identifier connects original messages to subsequent messages.

This field is mandatory only when the value for field

processingInformation.fundingOptions.initiator.type

is

originator

. Otherwise, it is conditional.

This field is available only on Visa Direct for Pull Funds Transfer service.

Specifications

Data Type:
String

Data Length:
15

Mapping Information

REST API Field:

processingInformation.fundingOptions.initiator. originatorInitiatedTransaction.originalTransactionId

SCMP API Field:
No corresponding field.

Simple Order API Field:
No corresponding field.

processingInformation. fundingOptions.initiator.type

Code that denotes whether the customer identification data belongs to the sender or the recipient.

Possible values:

P

: Payee (recipient)

S

: Payer (sender)

When this field is set to

S

, these API request fields are required:

senderInformation.personalIdType

senderInformation.personalIdSubType

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

processingInformation.fundingOptions.initiator.type

SCMP API Field:

customer_entity_identifier

Simple Order API Field:

ccAuthService_initiatorType

processingInformation. industryDataType

Indicates whether the transaction includes industry data.

For certain industries, you must set this field to an industry data value to be sent to the processor. When this field is not set to an industry value or is not included in the request, industry data does not go to the processor.

Possible Values:

airline

auto_rental

: Auto Rental Processing guide (Contact customer support for the Auto Rental guide)

healthcare_medical

: Healthcare Processing guide (Contact customer support for the Healthcare Processing guide)

healthcare_transit

: Healthcare Processing guide (Contact customer support for the Healthcase Processing guide)

lodging

: Lodging Processing guide (Contact customer support for the Lodging Processing Guide guide)

restaurant

transit

Specifications

Data Type:
String

Data Length:
18

Mapping Information

REST API Field:

processingInformation.industryDataType

SCMP API Field:

industry_datatype

Simple Order API Fields:

ccAuthService_industryDatatype

ccCaptureService_industryDatatype

ccCreditService_industryDatatype

PinDebitPurchaseService_industryDatatype

processingInformation. issuer.discretionaryData

Data defined by the issuer.

This field is available only for Visa and Mastercard on the Visa Platform Connect processor.

The value for this field corresponds to the following data in the TC 33 capture file:

Record: CP08 TCR1

Position: 5-168

Field: Free Form Text

The tables provide examples of the formats for discretionary data specific to acquirers for issuer-funded installment payments. The issuers and acquirers work together to develop and reach consensus on the formats. You must contact your acquirer for information about the formats to use.

IMPORTANT

Review the issuer data when issuer additional data is part of the response. To ensure the transaction is fully supported by the issuer, it's important to closely inspect the issuer data to ensure it follows the format provided with the issuer’s specification. Should you find any discrepancies in the data, please initiate the required follow-on transactions.

Example:
Discretionary Data Format for Issuer-Funded Installment Payments with Visa Guatemala

VC10000000050000

Discretionary Data Format for Issuer-Funded Installment Payments with Visa Guatemala
Position (Character or Digit #)	Number of Characters or Digits	Description
1-2	2	Prefix. Set this value to VC .
3-4	2	Total number of installments.
5-16	12	Total amount.

Example:
Discretionary Data Format for Issuer-Funded Installment Payments with Visa Uruguay

00612012345678910000000008160003359

Discretionary Data Format for Issuer-Funded Installment Payments with VisaNet Uruguay
Position (Character or Digit #)	Number of Characters or Digits	Description
1-2	2	Plan type. Set this value to 00 . Specifies that the transaction is an e-commerce transaction.
3	1	Grace period. Number of months that the issuer waits before charging customers.
4-5	2	Total number of installments. Possible values: 00 through 99 .
6	1	POS entry mode. Set this value to 0 . Specifies that the transaction is an e-commerce transaction.
7-15	9	Identity document number. Set this value to the number on the customer’s identity document or leave it blank. Format: right justified with 0 (zero) padding on the left.
16	1	Financial inclusion law indicator. Possible values: 1 : Law 17934 2 : Law 18099 3 : Asignaciones familiares (AFAM) (family allowance program) 4 : Real state law 5 : Law 19210
17-28	12	Financial inclusion amount. This value is the amount the bank returns to the customer.
29-35	7	Merchant-generated invoice number.

Example : Discretionary Data Format for Issuer-Funded Installment Payments with Mastercard Taiwan
Field	Position	Length	Description
Filler	1 - 90	90	Spaces
Installment-Tx-Indicator	91	1	Installment Transaction Indicator
Installment-Tranaction Response Code	92 - 93	2	Installment Transaction Response Code
Filler	94 - 120	27	Spaces
Period Number	121 - 122	2	Period Number
Down Payment	123 - 130	8	Down Payment
Installment Payments	131 - 138	8	Installment Payments
Formality Fee	139 - 144	6	Formality Fee

Specifications

Data Type:
String

Data Length:
255

IMPORTANT

For an authorization, the maximum length for this value is 255 characters. In the capture file, the value is truncated at 164 characters.

Mapping Information

REST API Field:

issuerInformation.discretionaryData

When you do not include this field in a request that uses installment payments for one of the Japanese payment options, the first billing month is set to the calendar month that follows the transaction date.

Specifications

Data Type:
String

Data Length:
2

Mapping Information

REST API Field:

processingInformation.japanPaymentOptions.firstBillingMonth

SCMP API Field:

jpo_first_billing_month

Simple Order API Field:

jpo_firstBillingMonth

processingInformation. japanPaymentOptions.jis2TrackData

Japanese Industrial Standard Type 2 (JIS2) track data from the front of the card.

This field is available only on the JCN Gateway and Visa Platform Connect processors.

Specifications

Data Type:
String

Data Length:
69

Mapping Information

REST API Field:

processingInformation.japanPaymentOptions.jis2TrackData

SCMP API Field:

jpo_jis2_track_data

Simple Order API Field:

jpo_jis2TrackData

processingInformation. japanPaymentOptions.paymentMethod

Type of Japanese payment option.

This field is available only on the JCN Gateway processor, and for the Sumitomo Mitsui Card Co. acquirer on the Visa Platform Connect processor.

This field is required for authorization and capture requests if set to these values:

21

,

22

,

23

,

24

,

31

,

32

,

34

,

61

, or

80

.

Possible values:

This value is a 2-digit code indicating the payment method. Use Payment Method Code value that applies to the transaction.

10

: One-time payment

21

,

22

,

23

,

24

: Bonus payment (one-time)

31

,

32

,

33

,

34

: Integrated payment (Bonus + Installment)

61

: Installment payment

80

: Revolving payment

Specifications

Data Type:
String

Data Length:
2

Mapping Information

REST API Field:

processingInformation.japanPaymentOptions.paymentMethod

SCMP API Field:

jpo_payment_method

Simple Order API Field:

jpo_paymentMethod

processingInformation. japanPaymentOptions. preapprovalType

This field specifies the type of transaction that was processed.

This field is only used with Japanese payments.

Possible values:

0

= Authorizes and captures a specified amount in a sales transaction.

1

= Authorizes

0

or

1

as the amount of funds to authenticate the cardholder.

2

= Authorizes a specified amount of funds.

3

= Cancels the transaction.

4

= Refunds or reverses the transaction amount. This transaction is initiated by the merchant.

5

= Cancels the authorization releasing the reserved funds.

6

= Posts authorization.

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

processingInformation.japanPaymentOptions.preapprovalType

SCMP API Field:

jpo_preapproval_type

Simple Order API Field:

jpo_preapprovalType

processingInformation. japanPaymentOptions. secondBonusAmount

If this field is included in a Japanese payment transaction, it specifies the amount of the second bonus.

Specifications

Data Type:
String

Data Length:
12

Mapping Information

REST API Field:

processingInformation.japanPaymentOptions.secondBonusAmount

SCMP API Field:

jpo_second_bonus_amount

Simple Order API Field:

jpo_secondBonusAmount

processingInformation. japanPaymentOptions. secondBonusMonth

If a bonus is to be paid, this value specifies the second month that a bonus is paid.

This field is only used with Japanese payments.

Possible values:

1-12

Specifications

Data Type:
String

Data Length:
2

Mapping Information

REST API Field:

processingInformation.japanPaymentOptions.secondBonusMonth

SCMP API Field:

jpo_second_bonus_month

Simple Order API Field:

jpo_secondBonusMonth

processingInformation. japanPaymentOptions.installments

Number of installment payments.

This field is available only on the JCN Gateway processor, and for the Sumitomo Mitsui Card Co. acquirer on the Visa Platform Connect processor.

This field is required for authorization and capture requests if the value of the

processingInformation.japanPaymentOptions.paymentMethod

field is set to

21

,

22

,

23

,

24

,

31

,

32

,

33

,

34

, or

80

.

Specifications

Data Type:
String

Data Length:
2

Mapping Information

REST API Field:

processingInformation.japanPaymentOptions.installments

SCMP API Field:

jpo_installments

Simple Order API Field:

jpo_installments

processingInformation. japanPaymentOptions.terminalId

Unique Japan Credit Card Association (JCCA) terminal identifier that is provided by Visa Acceptance Solutions.

The difference between this field and the

pointOfSaleInformation.terminalId

field is that you can define the

pointOfSaleInformation.terminalId

field, but the

processingInformation.japanPaymentOptions.terminalId

field is defined by the JCCA and is used only in Japan.

This field is available only on the JCN Gateway and Visa Platform Connect processors.

Visa Platform Connect

The value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCR9

Position: 130-142

Field: Terminal Identification Number

The TC 33 capture file contains information about the payments and credits that a merchant submits to Visa Acceptance Solutions. The processor creates the TC 33 capture file at the end of the day and sends it to the merchant’s acquirer. The acquirer uses this information to facilitate end-of-day clearing processing with payment networks.

Specifications

Data Type:
Integer

Data Length:
13

Mapping Information

REST API Field:

processingInformation.japanPaymentOptions.terminalId

SCMP API Field:

jpo_jcca_terminal_id

Simple Order API Field:

jpo_jccaTerminalID

processingInformation. leastCostRouting

Flag that specifies whether to request that the processor use least-cost routing for the transaction.

This field is available only on the FDI Australia and Worldpay VAP processors.

When the request includes this field, this value overrides the information in your account.

Possible values:

Y

: Request that the processor use least-cost routing for the transaction

N

(default): Do not request that the processor use least-cost routing for the transaction

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

processingInformation.leastCostRouting

SCMP API Field:

auth_least_cost_routing

Simple Order API Field:

ccAuthService_leastCostRouting

processingInformation. linkId

Value that links the current authorization request to the original authorization request.

This value is used for partial authorizations and split shipments. Set this value to the request ID that was returned in the response message from the original authorization request.

Specifications

Data Type:
String

Data Length:
26

Mapping Information

REST API Field:

processingInformation.linkId

SCMP API Field:

link_to_request

Simple Order API Field:

linkToRequest

processingInformation. loanOptions.assetType

Flag that specifies whether a loan is for a recoverable item or a non-recoverable item.

This field is available only for BNDES transactions on the Visa Platform Connect processor.

Possible values:

N

: Non-recoverable item

R

: Recoverable item

The value for this field corresponds to the following data in the TC 33 capture file:

Record: CP07 TCR2

Position: 26

Field: Asset Indicator

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

processingInformation.loanOptions.assetType

SCMP API Field:

loan_asset_type

Simple Order API Field:

loan_assetType

processingInformation. loanOptions.type

Type of loan or installment payment plan based on an agreement between you and the issuer.

This field is available only for these type of payments on the Visa Platform Connect processor:

BINDES transactions

Installment payments with Mastercard in Brazil

Example:
AGRO-CUSTEIO

Example:
AGRO-INVEST

Example:
BNDES-Type1

Example:
CBN

Example:
FINAME

For BNDES transactions, the value for this field corresponds to the following data in the TC 33 capture file:

Record: CP07 TCR2

Position: 27-46

Field: Loan Type

For installment payments with Mastercard in Brazil, the value for this field corresponds to the following data in the TC 33 capture file:

Record: CP07 TCR4

Position: 5-24

Field: Financing Type

Specifications

Data Type:
String

Data Length:
20

Mapping Information

REST API Field:

processingInformation.loanOptions.type

SCMP API Field:

loan_type

Simple Order API Field:

loan_type

processingInformation. merchantVerificationValue

The override value of the Merchant Verification Value received by various card brands.

Specifications

Data Type:
String

Data Length:
25

Mapping Information

REST API Field:

processingInformation.merchantVerificationValue

SCMP API Field:

merchant_verification_value

Simple Order API Field:

ccAuthService_merchantVerificationValue

processingInformation. mobileRemotePaymentType

Type of payment initiated from a cardholder’s mobile device.

This field is available only for Mastercard transactions on the Visa Platform Connect processor.

Possible values:

1

: Customer-initiated remote purchase, face-to-face

2

: Customer-initiated remote purchase, e-commerce

3

: Customer-initiated remote purchase, mail order / telephone order

4

: Customer-initiated bill pay

5

: Customer-initiated top up

6

: Customer-initiated cash out

7

: ATM-triggered or agent-initiated cash out

8

: Merchant-initiated remote purchase, face-to-face

9

: Merchant-initiated remote purchase, e-commerce

Visa Platform Connect

The value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCR6

Position: 94

Field: Mastercard Mobile Remote Payment Program Indicator

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

processingInformation.mobileRemotePaymentType

SCMP API Field:

mobile_remote_payment_type

Simple Order API Field:

ccAuthService_mobileRemotePaymentType

processingInformation. nationalNetDomesticData

Supplementary domestic transaction information provided by the acquirer.

Specifications

Data Type:
String

Data Length:
123

IMPORTANT

For an authorization, the maximum length for this value is 255 characters. In the capture file, the value is truncated at 161 characters.

Mapping Information

REST API Field:

processingInformation.nationalNetDomesticData

SCMP API Field:

national_net_domestic_data

Simple Order API Field:

nationalNetDomesticData

processingInformation. networkPartnerID

Merchant payment gateway ID that is assigned by Mastercard and provided by your acquirer when a registered merchant payment gateway service provider is involved in the transaction.

This field is available only for the Visa Platform Connect processor.

For Mastercard transactions on Visa Platform Connect, set this field to

00000163065

. If you do not include this field, Visa Acceptance Solutions will provide it for you.

If you support card-not-present Mastercard transactions, you must include this field in all transaction requests. When you process card-not-present transactions and do not include this field in your request, Visa Acceptance Solutions sets the field value to

00000163065

.

Specifications

Data Type:
String

Data Length:
11

Mapping Information

REST API Field:

processingInformation.networkPartnerId

SCMP API Field:

network_partner_id

Simple Order API Field:

ccAuthService_networkPartnerId

processingInformation. networkRoutingOrder

Priority order of the networks through which the transaction will be routed.

IMPORTANT

This field is supported only for businesses located in the U.S.

Set this value to a series of one-character network codes in your preferred order:

Network	Code
Accel/Exchange	E
AFFN	U
Alaska Option	3
CU24	C
Quest/Electronic Benefits Transfer (EBT)	K
Interlink	G
Maestro	8
NETS	P
NYCE	F
Pulse	H
Shazam (ITS)	7
Star	M
Visa/PLUS	V

For example, if the Star network is your first preference and Pulse is your second preference, set this field to a value of

MH

.

When you do not include this value in your PIN debit request, Visa Acceptance Solutions uses the list of network codes from your account.

Specifications

Data Type:
String

Data Length:
30

Mapping Information

REST API Field:

processingInformation.networkRoutingOrder

SCMP API Field:

network_order

Simple Order API Fields:

pinDebitCreditService_networkOrder

pinDebitPurchaseService_networkOrder

processingInformation. originalPaymentId

Links the current merchant initiated transaction (MIT) back to the original customer initiated transaction (CIT).

By linking the merchant initiated transaction back to the original customer initiated transaction, you extend the settlement period by one additional cycle. This is true when the transaction amount is $0 or more.

Specifications

Data Type:
String

Data Length:
11

Mapping Information

REST API Field:

processingInformation.networkPartnerId

SCMP API Field:

network_partner_id

Simple Order API Field:

ccAuthService_networkPartnerId

processingInformation. payByPointsIndicator

Indicates whether transaction uses loyalty points.

Possible values:

true

: Transaction uses loyalty points.

false

: Transaction does not use loyalty points.

Specifications

Data Type:
Boolean

Data Length:
Does not apply

Mapping Information

REST API Field:

processingInformation.payByPointsIndicator

SCMP API Field:

pay_by_points_indicator

Simple Order API Field:

payByPoints_indicator

processingInformation. paymentFlowMode

The indicator for whether a payment is processed using a hosted order page
(HOP) or an inline
widget.

Possible values:

HOP

: Hosted order page

inline

: Inline widget

Specifications

Data Type:
String

Data Length:
50

Mapping

REST Field Name:

processingInformation.paymentFlowMode

Simple Order Field Name:

apSessionsService_paymentFlowMode

processingInformation. paymentSolution

Type of payment solution that is being used for the transaction.

This unique ID distinguishes digital payment solution transactions and authorizations with payment network tokens on the Visa Acceptance Solutions platform for reporting purposes.

Possible values:

001

: Apple Pay

004

: Visa Acceptance Solutions In-App Solution

005

: Masterpass

006

: Android Pay

007

: Chase Pay

008

: Samsung Pay

012

: Google Pay

014

: Mastercard credential-on-file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token.

015

: Visa credential-on-file (COF) payment network token. Returned in authorizations that use a payment network token associated with a Token Management Service (TMS) token.

027

: Click to Pay

visacheckout

: Visa Click to Pay.

Specifications

Apple Pay, Google Pay, Samsung Pay, Visa payment network tokens, and Mastercard payment network tokens:

Data Type:
String

Data Length:
3

Visa Click to Pay:

Data Type:
String

Data Length:
12

Mapping Information

REST API Field:

processingInformation.paymentSolution

SCMP API Field:

payment_solution

Simple Order API Field:

paymentSolution

processingInformation. payoutOptions. deferredDateTime

Date and time when the requested Payouts original credit transaction (OCT) is to be processed.

This field is required for a Payouts OCT service request that specifies a deferred OCT processing date and time.

To use the deferred OCT processing option, include this field in the OCT request and specify the date and time in UTC.

Format:
yyyymmddhhmm

This field is available only for Payouts OCT transactions on the Visa Platform Connect processor.

Specifications

Data Type:
String

Data Length:
12

Mapping Information

REST API Field:

processingInformation.payoutOptions.deferredDateTime

SCMP API Field:

oct_deferred_date_time

Simple Order API Field:

octService_deferredDateTime

processingInformation. payoutOptions. acquirerBin

Acquirer bank identification number (BIN).

The Funds Transfer application is registered under this BIN. This field must match the information provided during enrollment.

Specifications

Data Type:
String

Data Length:
20

Mapping Information

No corresponding fields.

processingInformation. payoutOptions. networkId

The payment network identification code.

The networks specified must be a subset of the information that was provided during program enrollment.

Possible values:

0020

: Accel/Exchange

0024

: CU24

0003

: Interlink

0016

: Maestro

0018

: NYCE

0027

: NYCE

0009

: Pulse

0017

: Pulse

0019

: Pulse

0008

: Star

0010

: Star

0011

: Star

0012

: Star

0015

: Star

0002

: Visa/PLUS

Specifications

Data Type:
String

Data Length:
4

Mapping Information

No corresponding fields.

processingInformation. payoutOptions. payoutInquiry

Request parameter that is related to payouts information in BIN lookup.

Set the field to

true

, and provide attributes so that fund transfer and payouts information are included in the response. When payouts information is not provided or found, the response will have the standard account lookup.

Possible values:

true

false

Specifications

Data Type:
Boolean

Data Length:
5

Mapping Information

No corresponding fields.

processingInformation. processorId

Value that identifies the acquirer to use for the transaction.

This field is available only on the Visa Platform Connect processor.

Contact customer support to get the value for this field.

Specifications

Data Type:
String

Data Length:
3

Mapping Information

REST API Field:

processingInformation.processorId

SCMP API Field:

processor_id

Simple Order API Field:

processorID

processingInformation. purchaseLevel

Flag indicates the capture or credit request includes Level III data.

Set the value for this field to

3

.

This field is available on the American Express Direct, Barclays, Chase Paymentech Solutions, Elavon Americas, FDC Compass, FDC Nashville Global, GPN, OmniPay Direct, , TSYS Acquiring Solutions, Visa Platform Connect, and Worldpay VAP processors.

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

processingInformation.purchaseLevel

SCMP API Field:

purchasing_level

Simple Order API Fields:

ccCaptureService_purchasingLevel

ccCreditService_purchasingLevel

On the Barclays processor, the

invoiceHeader_purchaserVATRegistrationNumber

field is available for the capture service, and the

ccCreditService_purchasingLevel

field is available for the credit service.

processingInformation. purchaseOptions. isElectronicBenefitsTransfer

Flag that indicates that this transaction is an EBT transaction.

This field is available only on the Visa Platform Connect processor.

Possible value:

EBT

Specifications

Date Type:
Boolean

Data Length:
3

Mapping Information

REST API Field:

processingInformation.purchaseOptions.isElectronicBenefitsTransfer

SCMP API Field:

pin_debit_payment_type

Simple Order API Fields:

pinDebitCreditService_paymentType

pinDebitPurchaseService_paymentType

processingInformation. purchaseOptions.type

This flag indicates an EBT voucher transaction. Also used to indicate the type of transaction for the Mastercard Benefits Payment Scheme in Brazil.

This field is available only on the Visa Platform Connect processor.

Possible values:

verbal

: EBT voucher transaction.

01

: Meal voucher for the employee nutrition program (PAT).

02

: Food voucher for the employee nutrition program (PAT).

03

: Culture voucher for worker's culture program (PCT).

04

: Meal voucher for the consolidation of labor laws program (CLT).

05

: Food voucher for the consolidation of labor laws program (CLT).

Specifications

Data Type:
String

Data Length:
6

Mapping Information

REST API Field:

processingInformation.purchaseOptions.type

SCMP API Fields:

pin_debit_transaction_type

auth_transaction_type

Simple Order API Fields:

pinDebitPurchaseService_transactionType

ccAuthReply_transactionType

processingInformation. purchaseOptions. eligibilityIndicator

This flag indicates that this transaction is eligible for the Mastercard Benefits Payment Scheme in Brazil.

This field is available only on the Visa Platform Connect processor.

Possible values:

Y

: This transaction is eligible.

N

: This transaction is not eligible.

The value in this field corresponds to this data in the TC 33 capture file:

Record: CP07 TCR0

Position: 97-98

Field: MasterCard - Brazilian Benefit Program

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

API processingInformation.purchaseOptions.eligibilityIndicator

SCMP API Field:

auth_eligibility_indicator

Simple Order API Fields:

ccAuthService_eligibilityIndicator

ccAuthReply_eligibilityIndicator

processingInformation. purposeOfPayment

This code indicates the purpose of the funds being processed.

This field is received during original credit transactions (OCT) and account funding transactions (AFT).

This field is available only on these processors:

First Data Merchant Solutions

LloydsTSB Cardnet International

Streamline

Visa Platform Connect

The value for this field corresponds to the following data in the TC 33 capture file:

Field: Purpose of Payment Code

Record: CP01 TCR0

Position: 53-54

Mastercard and Maestro Requirements: IMPORTANT

Mastercard requires merchants processing gambling transactions to include this field in the authorization and refund request and to set its field value to
16
.

First Data Merchant Solutions and LloydsTSB Cardnet International: This field is required with Visa when the
recipientInformation.country
field value is one of these countries:
Australia
Bangladesh
Chile
Colombia
Egypt
India
These are the valid values:
ISACCT
: Account management.
ISAIRB
: Air transport related business.
ISALLW
: Transaction is the payment of allowance.
ISANNI
: Settlement of annuity.
ISBENE
: Unemployment disability benefit.
ISBEXP
: Business expenses.
ISBONU
: Bonus payment.
ISBUSB
: Bus transport related business.
ISCASH
: Cash management transfer.
ISCBTV
: Payment of cable TV bill.
ISCCHD
: Government institute issued related to cash compensation, helplessness, disability.
ISCCRD
: Credit card payment.
ISCDBL
: Payment of credit card bill.
ISCHAR
: Payment for charity reasons.
ISCOLL
: Collection payment.
ISCOMC
: Commercial payment.
ISCOMM
: Commission.
ISCOMP
: Compensation relating to interest loss/value date adjustment and can include fees.
ISCPYR
: Payment of copyright.
ISDCRD
: Related to a debit card payment.
ISDEPT
: Payment of a deposit.
ISDIVD
: Payment of dividend.
ISEDUC
: Payment of study/tuition fees.
ISELEC
: Payment of electricity bill.
ISENRG
: Energies.
ISFEES
: General fees.
ISFERB
: Payment for ferry related business.
ISFREX
: Foreign exchange.
ISGASB
: Payment of gas bill.
ISGFRP
: Compensation to unemployed persons during insolvency procedures.
ISGOVT
: Government payment.
ISHLTI
: Health insurance.
ISICCP
: Reimbursement of credit card payment.
ISIDCP
: Reimbursement of debit card payment.
ISINPC
: Payment of car insurance premium.
ISINSC
: Transaction is related to the payment of an insurance claim.
ISINSMI
: Installment.
ISINSU
: Insurance premium.
ISINVS
: Payment of mutual funds, investment products and shares.
ISINTC
: Intra company payment.
ISINTE
: Interest.
ISINTX
: Investment.
ISLBRI
: Labor insurance.
ISLICF
: License fee.
ISUIFI
: Life insurance.
ISLOAN
: Loan.
ISMDCS
: Medical services.
ISMP2B
: Mobile P2B payment.
ISMP2P
: Mobile P2P payment.
ISMTUP
: Mobile top up.
ISNOWS
: Not otherwise specified.
ISOTHR
: Other.
ISOTLC
: Transaction is related to a payment of other telecom related bill.
ISPAYR
: Payroll.
ISPEFC
: Contribution to pension fund.
ISPENS
: Pension payment.
ISPHON
: Payment of telephone bill.
ISPPTI
: Property insurance.
ISRELG
: Transaction is for general rental/lease.
ISRENT
: The payment of rent.
ISRLWY
: Payment for railway transport related business.
ISROYA
: Royalties.
ISSALA
: Salary payment.
ISSANG
: Payment to savings/retirement account.
ISSECU
: Securities.
ISSSBE
: Social security benefit.
ISSTDY
: Study.
ISSUBS
: Subscription.
ISSUPP
: Supplier payment.
ISTAXR
: Refund of a tax payment or obligation.
ISTAXS
: Tax payment.
ISTBIL
: Transaction is related to a payment of telecommunications related bill.
ISTRAD
: Trade services operation.
ISTREA
: Treasury payment.
ISTRPT
: Payment for travel.
ISUBIL
: Utility bill payment.
ISVATX
: Value added tax payment.
ISWHLD
: With holding.
ISWTER
: Payment of water.
Streamline: This field is required in all countries except in South Africa, and Canada and US cross-border transactions.

Specifications

Data Type:
String

Length:
12

Mapping Information

REST API Field:

processingInformation.purposeOfPayment

SCMP API Field:

auth_purpose_of_payment

oct_purpose_of_payment

Simple Order API Field:

authService_purposeOfPayment

octService_purposeOfPayment

processingInformation. reconciliationId

Transaction reference number.

Identifier used for tracking a request through to the payment processor for reconciliation.

This value is not returned for all processors.

Syntax

The syntax must conform to this regular expression.

Visa Platform Connect: [a-zA-Z0-9\-]
All other processors:: [a-zA-Z0-9]

Specifications

Data Type:
String

Data Length
:

Visa Platform Connect
: 25

TeleCheck
: 50

China UnionPay
: 12

All other processors
: 60

Mapping Information

REST API Field:

processingInformation.reconciliationId

SCMP API Fields:

auth_trans_ref_no

ecp_ref_no

Simple Order API Fields:

ccAuthReply_reconciliationId

ccAuthService_reconciliationId

ecCreditService_referenceNumber

ecDebitService_referenceNumber

processingInformation. recurringOptions.firstRecurringPayment

Flag that specifies whether this transaction is the first in a series of recurring payments.

Possible values:

true

: Yes, this is the first payment in a series of recurring payments.

false

(default): No, this is not the first payment in a series of recurring payments.

This field is available only on the Barclays, Credit Mutuel-CIC, FDC Nashville Global (with American Express cards and Visa cards), and OmniPay Direct processors.

Specifications

Data Type:
String

Data Length:
5

Mapping Information

REST API Field:

processingInformation.recurringOptions.firstRecurringPayment

SCMP API Field:

auth_first_recurring_payment

Simple Order API Field:

ccAuthService_firstRecurringPayment

processingInformation. recurringOptions.loanPayment

Flag that specifies whether this is a payment towards an existing contractual loan.

Possible values:

true

: Loan payment.

false

(default): Not a loan payment.

Specifications

Data Type:
Boolean

Mapping Information

REST API Field:

processingInformation.recurringOptions.loanPayment

SCMP API Field:

debt_indicator

Simple Order API Field:

debtIndicator

processingInformation. refundOptions.reason

Reason for a refund.

Barclays:
Used only for Mastercard and Maestro payment of winning transactions. Restricted to gaming merchants with MCC 7995.

Specifications

Data Type:
String

Data Length:
3

Mapping Information

REST API Field:

processingInformation.refundOptions.reason

SCMP API Fields:

ap_refund_reason

credit_refund_reason

Simple Order API Fields:

apRefundService_reason

ccCreditService_refundReason

processingInformation. reportGroup

Value that you create that enables you to identify a group of transactions.

This field is available only on the Worldpay VAP processor.

Specifications

Data Type:
String

Data Length:
25

Mapping Information

REST API Field:

processingInformation.reportGroup

SCMP API Field:

report_group

Simple Order API Field:

reportGroup

processingInformation. transactionReason

Transaction reason code. Sends the reason code as 5120, which indicates the sales tax/value added tax part of original credit transactions (OCTs).

This field is available only on the Visa Platform Connect processor.

To process Faster Refund Original Credit Transactions (OCTs) in AP and the EU, include these fields in the request:

Transaction Type

Record: Field 3

Positions: 1-2

Transaction Amount

Record: Field 4

Card Acceptor Name or Location

Record: Field 43

Transaction Identifier

Record: Field 62.2 (in bitmap format)

Message Reason Code

Record: Field 63.3

Acceptor Legal Business Name

Record: 104, Usage 2—Transaction-Specific Data (in TLV format)

Dataset ID: 56

Tag: 81

Business Application Identifier (BAI)

Record: 104, Usage 2—Transaction-Specific Data (in TLV format)

Dataset ID: 57

Tag: 01

Visa Merchant Identifier

Record: 126.5

Specifications

Data Type:
String

Data Length:
4

Mapping Information

REST API Field:

processingInformation.transactionReason

SCMP API Field:

transaction_reason

Simple Order API Field:

transactionReason

processingInformation. transactionTimeout

The time limit in seconds for the transaction.

The time limit begins when the customer is directed to the merchant URL that is included in the sale service response. The maximum value is

99999

, which is about 27-hours. When the transaction reaches the time limit, the payment system changes the status to abandoned.

Specifications

Data Type:
Integer

Data Length:
5

Mapping

REST Field Name:

processingInformation.transactionTimeout

Simple Order Field Name:

ap_SaleService_transactionTimeout

processingInformation. transactionTypeIndicator

Transaction type indicator for Mastercard authorizations, authorization reversals, and credits.

Possible values:

C02

: Mastercard rebate

C03

: rePower load value

C04

: Gaming pre-pay

C07

: General person-to-person

C52

: General transfer to own account

C53

: Agent cash out

C54

: Payment of own credit card bill

C55

: Business Disbursement

C56

: Government or non-profit disbursement

C57

: Rapid merchant settlement

C58

: Cash in at ATM (Usage limited to specific countries)

C59

: Cash in at point of sale (Usage limited to specific countries)

C65

: General business to business transfer

C67

: Mastercard merchant-presented QR

C68

: Mastercard merchant-presented QR refund payment

C91

: Utility payments (for Brazil domestic use only)

C92

: Government services (for Brazil domestic use only)

C93

: Mobile phone top ups (for Brazil domestic use only)

C94

: Coupon booklet payments (for Brazil domestic use only)

F07

: General person-to-person transfer

F08

: Person-to-person transfer to card account

F52

: General transfer to own account

F53

: Agent cash out

F54

: Payment of own credit card bill

F55

: Business disbursement

F61

: Transfer to own staged digital wallet account

F64

: Transfer to own debit or prepaid account

F65

: General business-to-business transfer

P10

: Installment-based repayment

P01

: Mastercard ATM cash pick-up transaction

P70

: Cryptocurrency

P71

: High-risk securities

Specifications

Data Type:
String

Data Length:
3

Mapping Information

REST API Field:

processingInformation.transactionTypeIndicator

SCMP API Field:

transaction_type_indicator

Simple Order API Field:

transactionTypeIndicator

processingInformation. validationLevel

The validation level that is required to validate routing and account numbers for eCheck transactions.

The service uses two modes of validation:

Basic mode validates the account number format and routing number.

Advance mode validates account and routing number combination.

IMPORTANT

If the Advanced mode is unavailable or cannot validate the account, the service defaults to the Basic mode.

This field supports the Visa Bank Account Validation service which ensures that eCheck transactions comply with Nacha (National Automated Clearing House Association) guidelines.

Possible values:

1

: Basic mode

2

: Advance mode

Specifications

Data Type:
Integer

Data Length:
1

Mapping Information

REST API Field:

processingInformation.validationLevel

SCMP API Field:
No corresponding field

Simple Order API Field:
No corresponding field

processingInformation. visaCheckoutID

Identifier for a Visa Click to Pay order.

Visa Click to Pay provides a unique order ID for every transaction in the Visa Click to Pay

callID

field.

Specifications

Data Type:
String

Data Length:
48

Mapping Information

REST API Field:

processingInformation.visaCheckoutID

SCMP API Field:

vc_order_id

Simple Order API Field:

vc_orderID

processingInformation. walletType

Type of wallet.

This field is available only on the FDC Compass, FDC Nashville Global, FDI Australia, Visa Platform Connect, and TSYS Acquiring Solutions processors.

Possibles values:

101

: Masterpass remote payment. The customer created the wallet by manually interacting with a customer-controlled device such as a computer, tablet, or phone. This value is supported only for Masterpass transactions on Chase Paymentech Solutions and Visa Platform Connect.

102

: Masterpass remote near field communication (NFC) payment. The customer created the wallet by tapping a Masterpass card or customer-controlled device at a contactless card reader. This value is supported only for card-present Masterpass transactions on Visa Platform Connect.

103

: Masterpass Apple Pay payment. The payment was made with a combination of Masterpass and Apple Pay. This value is supported only for Masterpass Apple Pay transactions on Visa Platform Connect.

216

: Masterpass Google Pay payment. The payment was made with a combination of Masterpass and Google Pay. This value is supported only for Masterpass Google Pay transactions on Visa Platform Connect.

217

: Masterpass Samsung Pay payment. The payment was made with a combination of Masterpass and Samsung Pay. This value is supported only for Masterpass Samsung Pay transactions on Visa Platform Connect.

327

: Mastercard Remote Commerce Programs.

SDW

: Staged digital wallet. An issuer or operator created the wallet. This value is supported only for Masterpass transactions on Chase Paymentech Solutions.

FDC Compass , FDC Nashville Global , FDI Australia , and TSYS Acquiring Solutions: The value that is sent to the processor is the value that the processor expects for this field.
Visa Platform Connect: This field is a passthrough
; therefore, the value is not verified or modified in any way before it is sent to the processor.

The value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCR8
Position: 72-76
Field: Agent Unique ID

Specifications

Data Type:
String

Data Length:
5

Mapping Information

REST API Field:

processingInformation.walletType

SCMP API Field:

wallet_type

Simple Order API Field:

wallet_type

processorInformation

These fields provide processor information.

processorInformation.achVerification.resultCode

processorInformation.achVerification.resultCodeRaw

processorInformation.amexVerbalAuthReferenceNumber

processorInformation.approvalCode

processorInformation.authIndicator

processorInformation.authorizationOptions. panReturnIndicator

processorInformation.avs.code

processorInformation.avs.codeRaw

processorInformation.cardReferenceData

processorInformation.cardVerification.resultCode

processorInformation.cardVerification.resultCodeRaw

processorInformation.consumerAuthenticationResponse. code

processorInformation.consumerAuthenticationResponse. codeRaw

processorInformation.electronicVerificationResults.code

processorInformation.electronicVerificationResults.codeRaw

processorInformation.electronicVerificationResults.email

processorInformation.electronicVerificationResults.emailRaw

processorInformation.electronicVerificationResults. firstName

processorInformation.electronicVerificationResults.firstNameRaw

processorInformation.electronicVerificationResults. lastName

processorInformation.electronicVerificationResults.lastNameRaw

processorInformation.electronicVerificationResults.middleName

processorInformation.electronicVerificationResults.middleNameRaw

processorInformation.electronicVerificationResults.name

processorInformation.electronicVerificationResults.nameRaw

processorInformation.electronicVerificationResults. phoneNumber

processorInformation.electronicVerificationResults. phoneNumberRaw

processorInformation.electronicVerificationResults. postalCode

processorInformation.electronicVerificationResults. postalCodeRaw

processorInformation.electronicVerificationResults. street

processorInformation.electronicVerificationResults. streetRaw

processorInformation.emsTransactionRiskScore

processorInformation.enhancedDataEnabled

processorInformation.forwardedAcquirerCode

processorInformation.issuerInformation.code

processorInformation.issuerInformation.name

processorInformation.masterCardAuthenticationType

processorInformation.masterCardServiceCode

processorInformation.masterCardServiceReplyCode

processorInformation.merchantAdvice.code

processorInformation.merchantAdvice.codeRaw

processorInformation.merchantAdvice.nameMatch

processorInformation.merchantNumber

processorInformation.merchantRiskPrediction

processorInformation.networkTransactionId

processorInformation.paymentAccountReferenceNumber

processorInformation.preApprovalToken

processorInformation.rawResponse

processorInformation.rawResponseLocal

processorInformation.responseCategoryCode

processorInformation.responseCode

processorInformation.responseDetails

processorInformation.retrievalReferenceNumber

processorInformation.routing.network

processorInformation.routing. customerSignatureRequired

processorInformation.routing.networkName

processorInformation.sellerProtection.eligibility

processorInformation.systemTraceAuditNumber

processorInformation.transactionID

processorInformation.transactionIntegrityCode

processorInformation. achVerification. resultCode

Results from the ACH verification service.

Specifications

Data Type:
String

Data Length:
2

Mapping Information

REST API Field:

processorInformation.achVerification.resultCode

SCMP API Field:

ecp_debit_verification_code

Simple Order API Field:

ecDebitReply_verificationCode

processorInformation. achVerification. resultCodeRaw

Raw results from the ACH verification service.

Specifications

Data Type:
String

Data Length:
2

Mapping Information

REST API Field:

processorInformation.achVerification.resultCoderaw

SCMP API Fields:

ecp_credit_verification_code_raw

ecp_debit_verification_code_raw

Simple Order API Fields:

ecCreditReply_verificationCodeRaw

ecDebitReply_verificationCodeRaw

processorInformation. amexVerbalAuthReferenceNumber

Referral response number for a verbal authorization.

Give this number to American Express when you call them for a verbal authorization.

This field is available only for the FDMS Nashville processor when using an American Express card.

Specifications

Data Type:
String

Data Length:
6

Mapping Information

REST API Field:

processorInformation.amexVerbalAuthReferenceNumber

SCMP API Field:

auth_referral_response_number

Simple Order API Field:

ccAuthReply_referralResponseNumber

processorInformation. approvalCode

Approval code. The value of this field depends on service requested. See service-specific description below.

Authorization and Incremental Authorization: This field is returned only when the processor sends this value.
Credit: This field is returned only when the issuer returns this value and the credit is authorized.
PIN debit: Authorization code that is returned by the processor.
Elavon Encrypted Account Number Program: The returned value is
OFFLINE
.
TSYS Acquiring Solutions: The returned value for a successful zero amount authorization is
000000
.

Authorization

Type:
String

Length:
Depends on processor

Incremental Authorization

Data Type:
String

Data Length:
7

Credit

Data Type:
String

Data Length:
6

Mapping Information

REST API Field:

processorInformation.approvalCode

SCMP API Fields:

auth_auth_code

credit_auth_code

incremental_auth_code

oct_approval_code

pin_debit_purchase_authorization_code

pin_debit_credit_authorization_code

Simple Order API Fields:

ccAuthReply_authorizationCode

ccCreditReply_authorizationCode

ccIncrementalAuthReply_authorizationCode

octReply_approvalCode

pinDebitCreditReply_authorizationCode

pinDebitPurchaseReply_authorizationCode

processorInformation. authIndicator

Type of authorization that was performed.

This field is not returned for unmarked authorizations. Some processors that support the final authorization indicator do not send this field.

Possible values for all processors except :

0

: Preauthorization

1

: Final authorization

Possible value for Visa transactions:

0

: Authorization for an estimated amount

Possible values for Mastercard transactions:

0

: Preauthorization

1

: Final authorization

2

: Undefined authorization

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

processorInformation.authIndicator

SCMP API Field:

auth_indicator

Simple Order API Field:

authIndicator

processorInformation. authorizationOptions. panReturnIndicator

Flag that indicates whether a primary account number (PAN) is associated with an ExpressPay-enabled card or device in an authorization request.

This field is available only for the Visa Platform Connect processor.

Possible values:

1

: ExpressPay Translation (PAN request)

2

: ExpressPay Translation (PAN request) and expiration date request

This field is required in the authorization request message you send to American Express ExpressPay for a contactless transaction. If a PAN is provided, it is returned in an authorization request response message. The value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCRB

Position: 86-108

Field: American Express PAN, Extended

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

processorInformation.authorizationOptions. panReturnIndicator

SCMP API Field:

pan_return_indicator

Simple Order API Field:

ccAuthService_panReturnIndicator

processorInformation. avs. code

Code returned by the Address Verification Service (AVS) during authorization. .

Specifications

Type:
String

Length:
1

Mapping Information

REST API Field:

processorInformation.avs.code

SCMP API Fields:

auth_auth_avs

avs

Simple Order API Fields:

afsService_avsCode

ccAuthReply_avsCode

processorInformation. avs.codeRaw

AVS result code sent directly from the processor.

This field is returned only when the processor sends this value.

IMPORTANT

Do not use this value to evaluate the AVS result. Use this value only when debugging your order management system.

Specifications

Data Type:
String

Data Length:
10

Mapping Information

REST API Field:

processorInformation.avs.codeRaw

SCMP API Field:

auth_avs_raw

Simple Order API Field:

ccAuthReply_avsCodeRaw

processorInformation. cardReferenceData

Transaction identifier that is generated by the payment card company.

This field is available only for industry-practice merchant-initiated token transactions with Discover or Diners Club payment cards processed by the , HSBC, and Streamline processors.

Set the value for this field to the value for the

processorInformation.cardReferenceData

field that was in the response message when you obtained the customer's credentials.

When you use this field, you must also include the

issuerInformation.transactionInformation

field.

Specifications

Data Type:
String

Data Length:
46

Mapping Information

REST API Field:

processorInformation.cardReferenceData

SCMP API Field:

auth_card_reference_data

Simple Order API Fields:

Request field:

ccAuthService_cardReferenceData

Response field:

ccAuthReply_cardReferenceData

processorInformation. cardVerification.resultCode

Result of card verification.

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

processorInformation.cardVerification.resultCode

SCMP API Field:

cv_result

Simple Order API Fields:

afsService_cvCode

ccAuthReply_cvCode

processorInformation. cardVerification.resultCodeRaw

CVN result code sent directly from the processor.

This field is returned only when the processor sends this value.

IMPORTANT

Do not use this value to evaluate the CVN result. Use this value only when debugging your order management system.

Specifications

Data Type:
String

Data Length:
11

Mapping Information

REST API Field:

processorInformation.cardVerification.resultCodeRaw

SCMP API Field:

auth_cv_result_raw

Simple Order API Field:

ccAuthReply_cvCodeRaw

processorInformation. consumerAuthenticationResponse. code

Mapped response code for American Express SafeKey, RuPay PaySecure, or Visa Secure.

IMPORTANT

A value of

0

for a Visa transaction indicates that Visa downgraded the transaction. When Visa approves an authorization and downgrades it, you are liable for the transaction. To confirm the downgrade, look at the e-commerce indicator for the transaction in the Business Center. You can proceed with the transaction if you want to accept liability. If you do not want to accept liability, reverse the authorization, attempt to authenticate the customer again, and request another authorization.

American Express SafeKey Response Codes
Response Code	Description
1	CAVV failed validation and authentication.
2	CAVV passed validation and authentication.
3	CAVV passed the validation attempt.
4	CAVV failed the validation attempt.
7	CAVV failed the validation attempt and the issuer is available.
8	CAVV passed the validation attempt and the issuer is available.
9	CAVV failed the validation attempt and the issuer is not available.
A	CAVV passed the validation attempt and the issuer is not available.
U	Issuer does not participate or 3-D Secure data was not used.
99	An unknown value was returned from the processor.

Visa Secure Response Codes
Response Code	Description
0	CAVV not validated because erroneous data was submitted. IMPORTANT Visa downgraded the transaction. When you receive an authorization approval and the CAVV response code is 0 , you are liable for the transaction. To confirm the downgrade, look at the e-commerce indicator for the transaction in the Business Center. You can proceed with the transaction if you want to accept liability. If you do not want to accept liability, reverse the authorization, attempt to authenticate the customer again, and request another authorization.
1	CAVV failed validation and authentication.
2	CAVV passed validation and authentication.
3	CAVV passed the validation attempt.
4	CAVV failed the validation attempt.
6	CAVV not validated because the issuer does not participate.
7	CAVV failed the validation attempt and the issuer is available.
8	CAVV passed the validation attempt and the issuer is available.
9	CAVV failed the validation attempt and the issuer is not available.
A	CAVV passed the validation attempt and the issuer is not available.
B	CAVV passed the validation with information only; no liability shift.
C	CAVV attempted but not validated; issuer did not return CAVV code.
D	CAVV not validated or authenticated; issuer did not return CAVV code.
I	Invalid security data.
U	Issuer does not participate or 3-D secure data was not used.
99	An unknown value was returned from the processor.

Specifications

Data Type:
String

Data Length:
3

Mapping Information

REST API Field:

processorInformation.consumerAuthenticationResponse.code

SCMP API Field:

auth_cavv_response_code

Simple Order API Field:

ccAuthReply_cavvResponseCode

processorInformation. consumerAuthenticationResponse. codeRaw

CAVV response code sent directly from the processor for American Express SafeKey, RuPay PaySecure, or Visa Secure.

Specifications

Data Type:
String

Data Length:
3

Mapping Information

REST API Field:

processorInformation.consumerAuthenticationResponse.codeRaw

SCMP API Field:

auth_cavv_response_code_raw

Simple Order API Field:

ccAuthReply_cavvResponseCodeRaw

processorInformation. customer.personalIDResult

Personal identifier result.

If you included

buyerInformation.personalIdentification[].id

and

buyerInformation.personalIdentification[].type

in the request, this value indicates whether

buyerInformation.personalIdentification[].id

and

buyerInformation.personalIdentification[].type

matched a value in a record on file.

REST API Field:

processorInformation.electronicVerificationResults.emailRaw

SCMP API Field:

auth_ev_email_raw

Simple Order API Field:

ccAuthReply_evEmailRaw

processorInformation. electronicVerificationResults. firstName

Mapped electronic verification response code from the processor for the customer’s first name.

This field is available only for theVisa Platform Connect processor.

Possible values:

N

: No match.

O

: Partial match.

Y

: Match.

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

processorInformation.electronicVerificationResults.firstName

SCMP API Field:

auth_ev_firstname

Simple Order API Field:

ccAuthReply_evFirstName

processorInformation. electronicVerificationResults. firstNameRaw

Raw electronic verification response code from the processor for the customer’s first name.

This field is available only for the Visa Platform Connect processor.

Possible values:

01

: Match.

50

: Partial match.

99

: No match.

Specifications

Data Type:
String

Data Length:
2

Mapping Information

REST API Field:

processorInformation.electronicVerificationResults.firstNameRaw

SCMP API Field:

auth_ev_firstname_raw

Simple Order API Field:

ccAuthReply_evFirstNameRaw

processorInformation. electronicVerificationResults. lastName

Mapped electronic verification response code from the processor for the customer’s last name.

This field is available only for the Visa Platform Connect processor.

Possible values:

N

: No match.

O

: Partial match.

Y

: Match.

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

processorInformation.electronicVerificationResults.lastName

SCMP API Field:

auth_ev_lastname

Simple Order API Field:

ccAuthReply_evLastName

processorInformation. electronicVerificationResults. lastNameRaw

Raw electronic verification response code from the processor for the customer’s last name.

This field is available only for the Visa Platform Connect processor.

Possible values:

01

: Match.

50

: Partial match.

99

: No match.

Specifications

Data Type:
String

Data Length:
2

Mapping Information

REST API Field:

processorInformation.electronicVerificationResults.lastNameRaw

SCMP API Field:

auth_ev_lastname_raw

Simple Order API Field:

ccAuthReply_evLastNameRaw

processorInformation. electronicVerificationResults. middleName

Mapped electronic verification response code from the processor for the customer’s middle name.

This field is available only for the Visa Platform Connect processor.

Possible values:

N

: No match.

O

: Partial match.

Y

: Match.

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

processorInformation.electronicVerificationResults.middleName

SCMP API Field:

auth_ev_middlename

Simple Order API Field:

ccAuthReply_evMiddleName

processorInformation. electronicVerificationResults. middleNameRaw

Raw electronic verification response code from the processor for the customer’s middle name.

This field is available only for the Visa Platform Connect processor.

Possible values:

01

: Match.

50

: Partial match.

99

: No match.

Specifications

Data Type:
String

Data Length:
2

Mapping Information

REST API Field:

processorInformation.electronicVerificationResults.middleNameRaw

SCMP API Field:

auth_ev_middlename_raw

Simple Order API Field:

ccAuthReply_evMiddleNameRaw

processorInformation. electronicVerificationResults. name

Mapped electronic verification response code from the processor for the customer’s full name: first name, middle name, and last name.

This field is supported only for Visa Platform Connect.

Possible values:

N

: No match.

O

: Partial match.

Y

: Match.

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

processorInformation.electronicVerificationResults.name

SCMP API Field:

auth_ev_name

Simple Order API Field:

ccAuthReply_evName

processorInformation. electronicVerificationResults. nameRaw

Raw electronic verification response code from the processor for the customer’s full name: first name, middle name, and last name.

REST API Field:

processorInformation.electronicVerificationResults.streetRaw

SCMP API Field:

auth_ev_street_raw

Simple Order API Field:

ccAuthReply_evStreetRaw

processorInformation. emsTransactionRiskScore

Fraud score for a MasterCard transaction.

This field is available only for the Visa Platform Connect processor, for authorizations on Mastercard payment cards issued in the US. To receive a fraud score, you must have Mastercard Expert Monitoring Solutions enabled for your account.

Positions 1-3: Fraud score. This value ranges from 001 to 998, where 001 indicates the least likely fraudulent transaction and 998 indicates the most likely fraudulent transaction.

Positions 4-5: Reason code that specifies the reason for the fraud score. Possible values:

01: Suspicious cross border activity.

02: Suspicious transaction.

03: High number of transactions.

04: High number of transactions at an unattended terminal.

05: Suspicious recent history of transactions.

06: Suspicious activity and high number of transactions.

07: Suspicious cardholder not present activity.

08: Suspicious activity and low number of transactions.

09: Suspicious service station activity.

10: Suspicious online activity.

11: High amount transaction or high cumulated amount recently spent.

12: Suspicious gambling activity.

13: Suspicious phone or mail order activity.

14: Suspicious grocery store activity.

15: High risk country.

16: High amount, high number of transactions, and cross border.

17: Suspicious activity including previous declined transactions.

18: Suspicious airline activity.

19: Score forced to be 001 because the transaction being scored was a 04xx message.

20: Not a financial transaction.

21: Abnormal geographic activity.

22: Abnormal, high frequency at the same MCC.

23: High amount recent ATM activity.

24: Suspicious recent ATM activity or suspicious ATM activity following a recent abnormal activity.

25: Suspicious telecom activity.

26: High number of international ATM transactions.

27: High cumulated withdrawal amount on international ATM.

28: High velocity of domestic ATM transactions.

29: High risk MCC.

Positions 6-32: Reserved for future use.

Specifications

Data Type:
String

Data Length:
32

Mapping Information

REST API Field:

processorInformation.emsTransactionRiskScore

SCMP API Field:

auth_ems_transaction_risk_score

Simple Order API Field:

ccAuthReply_emsTransactionRiskScore

processorInformation. enhancedDataEnabled

Flag returned by Visa Acceptance Solutions to indicate the airline data is sent to the processor.

Possible values returned:

true

: The airline data is included in the request to the processor.

false

: The airline data is not included in the request to the processor.

Specifications

Data Type:
String

Data Length:
5

Mapping Information

REST API Field:

processorInformation.enhancedDataEnabled

SCMP API Field:

credit_enhanced_data_enabled

Simple Order API Field:

ccCreditReply_enhancedDataEnabled

processorInformation. forwardedAcquirerCode

Name of the Japanese acquirer that processed the transaction.

This field is only returned by the JCN Gateway processor.

Contact the Visa Acceptance Solutions Japan Support Group for more information.

Specifications

Data Type:
String

Data Length:
32

Mapping Information

REST API Field:

processorInformation.forwardedAcquirerCode

SCMP API Fields:

auth_forward

auth_reversal_forward

credit_forward

Simple Order API Fields:

ccAuthReply_forwardCode

ccAuthReversalReply_forwardCode

ccCreditReply_forwardCode

processorInformation. masterCardAuthenticationType

Type of authentication for which the transaction qualifies as determined by the Mastercard authentication service, which confirms the identity of the cardholder.

Mastercard provides this value to Visa Acceptance Solutions.

This field is available only on the Visa Platform Connect processor.

Possible values:

1

: Transaction qualifies for Mastercard authentication type 1.

2

: Transaction qualifies for Mastercard authentication type 2.

The value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCR6

Position: 132

Field: Mastercard Member Defined Data

The TC 33 capture file contains information about the payments and credits that a merchant submits to Visa Acceptance Solutions. The processor creates the TC 33 capture file at the end of the day and sends it to the merchant’s acquirer. The acquirer uses this information to facilitate end-of-day clearing processing with payment networks.

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

processorInformation.masterCardAuthenticationType

SCMP API Field:

auth_transaction_qualification

Simple Order API Field:

ccAuthReply_transactionQualification

processorInformation. masterCardServiceCode

Mastercard service that was used for the transaction.

Mastercard provides this value to Visa Acceptance Solutions.

This field is available only for the Visa Platform Connect processor.

Possible value is

53

: Mastercard card-on-file token service.

The value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCR6

Position: 133-134

Field: Mastercard Merchant on-behalf service

The TC 33 capture file contains information about the payments and credits that a merchant submits to Visa Acceptance Solutions. The processor creates the TC 33 capture file at the end of the day and sends it to the merchant’s acquirer. The acquirer uses this information to facilitate end-of-day clearing processing with payment networks.

Specifications

Data Type:
String

Data Length:
2

Mapping Information

REST API Field:

processorInformation.masterCardServiceCode

SCMP API Fields:

auth_payment_card_service

auth_reversal_payment_card_service

Simple Order API Fields:

ccAuthReply_paymentCardService

ccAuthReversalReply_paymentCardService

processorInformation. masterCardServiceReplyCode

Result of the Mastercard card-on-file token service.

Mastercard provides this value to Visa Acceptance Solutions.

This field is available only for the Visa Platform Connect processor.

Possible values:

C

: Service completed successfully.

F

: One of the following:

Incorrect Mastercard POS entry mode. The Mastercard POS entry mode should be

81

for an authorization or authorization reversal.

Incorrect Mastercard POS entry mode. The Mastercard POS entry mode should be

01

for a tokenized request.

Token requestor ID is missing or formatted incorrectly.

I

: One of the following:

Invalid token requestor ID.

Suspended or deactivated token.

Invalid token (not in mapping table).

T

: Invalid combination of token requestor ID and token.

U

: Expired token.

W

: Primary account number (PAN) listed in electronic warning bulletin.

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

processorInformation.masterCardServiceReplyCode

SCMP API Fields:

auth_payment_card_service_result

auth_reversal_payment_card_service_result

Simple Order API Fields:

ccAuthReply_paymentCardServiceResult

ccAuthReversalReply_paymentCardServiceResult

processorInformation. merchantAdvice.code

Category code indicating information about a decline.

When this field is used for Mastercard with FDC Nashville Global, it is available only for card-not-present declined transactions. When this field is used for Visa with FDC Nashville Global, it is available for both card-present and card-not-present declined transactions.

IMPORTANT

Use the values returned in this field for Visa and Mastercard to determine whether to retry declined transactions. Update your retry logic to ensure that a retry is not attempted when the card association do not approve the transactions. A retry on a transaction with a value in this field that prohibits retry, such as

Issuer never approves

or

Do not try again

, can incur a penalty from card companies.

IMPORTANT

If a decline does not have a merchant advice code in the response, the default is not to retry the transaction.

Visa and Mastercard, in addition to the merchant advice codes, provide decline response codes. American Express and Discover do not provide category codes, but they do provide decline response codes.

Possible values for Chase Paymentech Solutions, FDC Nashville Global, GPX, and Visa Platform Connect processors:

Visa:

1

: Issuer never approves

2

: Issuer cannot approve at this time

3

: Data quality/revalidate payment information

Mastercard:

01

: New account information available

02

: Try again later

03

: Do not try again

04

: Token not supported

21

: Do not honor

22

: Merchant does not qualify for product code

24

: Retry after 1 hour

25

: Retry after 24 hours

26

: Retry after 2 days

27

: Retry after 4 days

28

: Retry after 6 days

29

: Retry after 8 days

30

: Retry after 10 days

40

: Non-reloadable prepaid card

41

: Non-reloadable prepaid card

42

: Sanctions score exceeds applicable threshold value

99

: Do not try again

Specifications

Data Type:
String

Data Length:
2

Mapping Information

REST API Field:

processorInformation.merchantAdvice.code

SCMP API Fields:

credit_merchant_advice_code

merchant_advice_code

oct_merchant_advice_code

Simple Order API Fields:

ccAuthReply_merchantAdviceCode

ccCreditReply_merchantAdviceCode

octService__merchantAdviceCode

processorInformation. merchantAdvice.codeRaw

Raw merchant advice code sent directly from the processor.

This field is processed by the Barclays, FDC Compass, and Visa Platform Connect processors.

Possible values for FDC Compass and Visa Platform Connect processors:

00

: No information, or response not provided.

01

: New account information is available. Obtain the new information.

02

: Try again later.

03

: Do not try again. Obtain another type of payment from the customer.

04

: Problem with a token or a partial shipment indicator. Do not try again.

08

: Payment blocked by the payment card company.

21

: Recurring payment cancellation service.

99

: An unknown value was returned from the processor.

7903

: Do not try again

7921

: Do not honor

7940

: Non‐reloadable prepaid card

7941

: Non‐reloadable prepaid card

7942

: Sanctions score exceeds applicable threshold value

Visa Platform Connect

The value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCR7

Position: 96-99

Field: Response Data—Merchant Advice Code

Specifications

Data Type:
String

Data Length:
2

Mapping Information

REST API Field:

processorInformation.merchantAdvice.codeRaw

SCMP API Fields:

auth_merchant_advice_code_raw

credit_merchant_advice_code_raw

oct_merchant_advice_code_raw

Simple Order API Fields:

ccAuthReply_merchantAdviceCodeRaw

ccCreditReply_merchantAdviceCodeRaw

octService__merchantAdviceCodeRaw

processorInformation. merchantAdvice.nameMatch

Flag returned by an issuer to indicate the result of an account name for which you sent a zero amount authorization request.

Possible values returned:

00

: Name match performed.

01

: Name match not performed.

02

: Name match not supported.

Use the response value to verify an account name before you request authorization for an AFT or an OCT.

When you send a zero-amount authorization request, the message must include the

orderInformation.billTo.lastName

field. The authorization request should include these additional request fields if the information is available:

orderInformation.billTo.firstName

orderInformation.billTo.lastName

IMPORTANT

This field is available only for the Visa Platform Connect processor, and only from acquirers that support account inquiry services.

Specifications

Data Type:
String

Data Length:
2

Mapping Information

REST API Field:

processorInformation.merchantAdvice.nameMatch

SCMP API Field:

auth_name_match

Network transaction identifier (TID).

This field is available only for the Visa Platform Connect processor and only when the credit is authorized.

You can use this value to identify a specific transaction when you are discussing the transaction with your acquirer.

Specifications

Type:
String

Length:
15

Mapping Information

REST API Field:

processorInformation.networkTransactionId

SCMP API Field:

credit_auth_payment_network_transaction_id

Simple Order API Field:

ccCreditReply_paymentNetworkTransactionID

processorInformation. paymentAccountReferenceNumber

Visa-generated reference number that identifies a transaction for which you provided one of the following:

Visa primary account number (PAN)

Visa-generated token for a PAN

This reference number provides a link to the cardholder account and to all transactions for that account.

This field is available on the

Visa Platform Connect and Elavon Americas processors.

`Visa Platform Connect` Processor Specific Information

The following information is specific to the Visa Platform Connect processor:

For transactions with American Express, the value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCR8

Position: 79-107

Field: PAR—Payment Account Reference

For Token Management Service transactions, the value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCR8

Position: 79-110

Field: Payment Account Reference

The TC 33 capture file contains information about the payments and credits that a merchant submits to Visa Acceptance Solutions. The processor creates the TC 33 capture file at the end of the day and sends it to the merchant’s acquirer. The acquirer uses this information to facilitate end-of-day clearing processing with payment networks.

Specifications

Data Type:
String

Data Length:
35

Mapping Information

REST API Field:

processorInformation.paymentAccountReferenceNumber

SCMP API Field:

payment_account_reference

Simple Order API Field:

paymentAccountReference

processorInformation. preApprovalToken

The pre-approval
token generated by an alternative payment method.

When the alternative payment method approves an order, it generates a pre-approval token in the

processorInformation.token

response field. The pre-approval token is also known as a session token
or a processor token
.

Specifications

Data Type:
String

Data Length:
60

Mapping Information

REST API Field:

processorInformation.preApprovalToken

SCMP API Field:

ap_auth_preapproval_token

Simple Order API Field:

apAuthService_preapprovalToken

processorInformation. responseCategoryCode

Processor-defined response category code.

This field is returned only for:

Japanese issuers

Domestic transactions in Japan

Credit Mutuel-CIC—the value returned in this field is a processor transaction ID required for troubleshooting. The associated detail error code is in the

processorInformation.responseCategoryCode

field or the

issuerInformation.responseCode

field, depending on which service you requested.

Specifications

Data Type:
String

Data Length:
3

Data Length:

Comercio Latino:
36

All other processors:
3

Mapping Information

REST API Field:

processorInformation.responseCategoryCode

SCMP API Field:

additional_processor_response

Simple Order API Field:

additionalProcessorResponse

processorInformation. responseCode

Response code from the issuer or the processor providing the status of the request.

This field is returned only when the processor sends this value.

IMPORTANT

Do not use this field to evaluate the result of the request.

This field is available for these services:

Authorization and Incremental Authorization
—This field is returned only when the processor sends this value.

Credit
—This field is returned only when the credit is authorized and the processor sends this value.

PIN Debit
—This field is the value that is returned by the processor or bank in a response.

This field is available only for the AIBMS, Comercio Latino, China UnionPay, JCN Gateway, and Visa Platform Connect processors.

These processors have specific requirements:

AIBMS: When this value is
08
, you can accept the transaction if the customer provides you with identification.
China UnionPay: The reason code indicates that the request was completed successfully, the reason that the request was declined, or it can provide other information that you can use to determine subsequent action. China UnionPay returns one of these values as the reason code:
00
: Approved or completed successfully.
01
: Declined. Contact the issuer.
03
: Declined. Invalid merchant.
04
: Pick up. China UnionPay recommends withholding the card.
05
: Declined. Failed cardholder certification.
10
: Partial amount approved.
11
: Approved or completed successfully (VIP customer).
12
: Declined. Invalid transaction.
13
: Declined. Invalid amount.
14
: Declined. Invalid card number.
15
: Declined. No matching issuer.
16
: Approved. Update the third magnetic track.
20
: Declined. Update the QR code.
21
: Declined. Card has not been initialized or it is dormant.
22
: Declined. Operation error or exceeds the number of days allowed for transaction.
25
: Declined. Unable to locate original transaction. Contact the issuer.
30
: Declined due to format error. Retry.
34
: Pick up (fraudulent card). China UnionPay recommends withholding the card.
38
: Declined. PIN retry limit exceeded.
40
: Declined. Transaction is not supported.
41
: Pick up (lost card). China UnionPay recommends withholding the card.
43
: Pick up (stolen card). China UnionPay recommends withholding the card.
45
: Declined. Fallback transaction not allowed.
51
: Declined. Insufficient balance.
54
: Declined. Expired card.
55
: Declined. Incorrect PIN.
57
: Declined. Transaction is not allowed on the card.
58
: Declined. Transaction is not allowed by the issuer.
59
: Declined. Suspected fraud.
61
: Declined. Transaction amount exceeds limit.
62
: Declined. Restricted card.
64
: Declined. Transaction amount does not match original transaction amount.
65
: Declined. Transaction exceeds the limited times of withdrawal.
68
: Declined. Issuer response time-out. Retry later.
75
: Declined. Number of PIN tries exceeds the limit.
90
: Declined. Daily cutoff is in progress. Retry later.
91
: Declined. Issuer status is abnormal. Retry later.
92
: Declined. Connectivity of issuer is abnormal. Retry later.
94
: Declined. Duplicate transaction.
96
: Declined. Switch system malfunction. Retry later.
97
: Declined. Unregistered terminal number.
98
: Declined. Issuer response time-out.
99
: Declined. Error in PIN format. Retry sign-in.
A0
: Declined. Error in MAC verification. Retry sign-in.
A2
: Approved. Transaction successful with defect. Confirm with transfer-in bank.
A3
: Declined. Transfer recipient's account not found.
A4
: Approved. Transaction successful with defect. Confirm with transfer-in bank.
A5
: Approved. Transaction successful with defect. Confirm with transfer-in bank.
A6
: Approved. Transaction successful with defect. Confirm with transfer-in bank.
A7
: Security processing failure.
B1
: Declined. Transaction receipt not printed.
C1
: Declined. Illegal status of acquirer.
D1
: Incorrect institution identification code.
D2
: Data error.
D3
: Invalid file type.
D4
: File Processed.
D5
: File not found.
D6
: Transaction not supported by recipient.
D7
: File locked.
D8
: Unsuccessful.
D9
: Incorrect file length.
DA
: File decompression error.
DB
: File name error.
DC
: File cannot be received.
F1
: File record format error.
F2
: File record repeated.
F3
: File record does not exist.
F4
: File record error.
N1
: Declined. Unregistered account exceeds transaction limit.
N2
: Declined. Transaction amount exceeds balance.
P1
: Declined. Contact phone number not found.
Y1
: Approved.
Y3
: Approved.
Z1
: Declined.
Z3
: Declined.
1A
: Declined. Additional customer authentication is required.
Comercio Latino: This value is the status code and the error or response code received from the processor separated by a colon.

Format: [status code]:E[error code] or [status code]:R[response code]

Example:
2:R06
JCN Gateway: Processor-defined detail error code. The associated response category code is in the
processorInformation.responseCategoryCode
REST API field.
Visa Platform Connect: The response code value
Z5
(valid account, but amount is not supported) is returned when the anticipated amount mentioned in the transaction exceeds the account limit or available funds.

The response code value
70
(PIN data required) is possible in these countries only when the PIN data is not included in domestic card-present transactions:

Albania
Azerbaijan
Georgia
India
Moldova
Montenegro
North Macedonia
Ukraine
The response code value
1A
(additional customer authentication required) is possible only in these countries when Strong Customer Authentication (SCA_ is requested for an e-commerce or card-present transaction:

Albania
Azerbaijan
Georgia
Moldova
Montenegro
North Macedonia
Ukraine
These response codes are available only for Mastercard on the Visa Platform Connect processor.

Mastercard declined authorizations:
If an authorization is declined for a point-of-sale transaction, Mastercard returns a combined response code and decline reason code. The codes are added to the authorization response in this field:
Record: Field 104
Dataset ID: 65
Tag: 48

The response code
can be one of these values:
51
: Insufficient funds
79
: Life cycle
82
: Policy
83
: Fraud or security

The decline reason code
indicates the reason that the authorization was declined, or it can provide other information that you can use to determine subsequent action. Mastercard returns one of these values as the decline reason code:
01
: New account information available.
02
: Cannot approve at this time. Retry later.
03
: Do not retry.
24
: Retry after 1 hour.
25
: Retry after 24 hours.
26
: Retry after 2 days.
27
: Retry after 4 days.
28
: Retry after 6 days.
29
: Retry after 8 days.
30
: Retry after 10 days.

Specifications

Data Type:
String

Data Length

JCN Gateway: 3

Other supported processors: 6 (eCheck transactions); 10 (other transactions)

Mapping Information

REST API Field:

processorInformation.responseCode

SCMP API Fields:

auth_auth_response

auth_reversal_auth_response

credit_auth_response

ecp_credit_result_code

ecp_debit_result_code

incremental_auth_response

oct_response_code

pin_debit_credit_processor_response

pin_debit_purchase_processor_response

pin_debit_reversal_processor_response

Simple Order API Fields:

ccAuthReply_processorResponse

ccAuthReply_merchantAdviceCode

ccAuthReversalReply_processorResponse

ccCreditReply_processorResponse

ccIncrementalAuthReply_processorResponse

ecCreditReply_processorResponse

ecDebitReply_processorResponse

octReply_processorResponse

pinDebitCreditReply_processorResponse

pinDebitPurchaseReply_processorResponse

pinDebitReversalReply_processorResponse

processorInformation. responseDetails

Additional information about a declined transaction.

This field is available only for the OmniPay Direct and Visa Platform Connect processors.

Specifications

Data Type:
String

Data Length:
255

Mapping Information

REST API Field:

processorInformation.responseDetails

SCMP API Field:

additional_data

Simple Order API Field:

additionalData

processorInformation. retrievalReferenceNumber

Reconciliation reference number.

This field is available only for the Visa Platform Connect processor.

Visa Platform Connect: Retrieval request number.

Specifications

Data Type:
String

Data Length:
20

Mapping Information

REST API Field:

processorInformation.retrievalReferenceNumber

SCMP API Field:

auth_reconciliation_reference_number

Simple Order API Field:

ccAuthReply_reconciliationReferenceNumber

processorInformation. routing. network

Indicates whether the transaction was routed on a credit network, a debit network, or the STAR signature debit network.

This field is available only on the FDC Nashville Global processor.

Possible values:

C

: Credit network

D

: Debit network (without signature)

S

: STAR signature debit network

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

processorInformation.routing.network

SCMP API Fields:

pin_debit_credit_network_code

pin_debit_purchase_network_code

routing_network_type

Simple Order API Fields:

pinDebitCreditReply_networkCode

pinDebitPurchaseReply_networkCode

routing_networkType

processorInformation. routing. customerSignatureRequired

Indicates whether you need to obtain the cardholder's signature.

This field is available only on the FDC Nashville Global processor.

Possible values:

Y

: You need to obtain the cardholder's signature.

N

: You do not need to obtain the cardholder's signature.

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

processorInformation.routing.customerSignatureRequired

SCMP API Field:

routing_signature_cvm_required

Simple Order API Field:

routing_signatureCVMRequired

processorInformation. routing. networkName

Name of the network on which the transaction was routed.

This field is available only on the FDC Nashville Global processor.

Possible values:

NYCE

PULSE

STAR

Visa

Mastercard

Specifications

Data Type:
String

Data Length:
10

Mapping Information

REST API Field:

processorInformation.routing.networkName

SCMP API Field:

routing_network_label

Simple Order API Field:

routing_networkLabel

processorInformation. sellerProtection.eligibility

Indicates whether customer has seller protection enabled.

Possible values:

true

: Seller protection is enabled.

false

: Seller protection is not enabled.

Specifications

Data Type:
Boolean

Data Length:
5

Mapping Information

REST API Field:

processorInformation.sellerProtection.eligibility

SCMP API Field:

ap_seller_protection_eligibility

Simple Order API Field:

apReply_sellerProtection_eligibility

processorInformation. systemTraceAuditNumber

Receipt number.

This field is available only on the American Express Direct, Visa Platform Connect, and SIX processors.

Credit Card Transactions

American Express Direct:
System trace audit number (STAN). This value identifies the transaction and is useful when investigating a chargeback dispute.

Visa Platform Connect:
System trace number that must be printed on the customer’s receipt.

Specifications

Data Type:
String

Data Length:
6

Mapping Information

REST API Field:

processorInformation.systemTraceAuditNumber

SCMP API Field:

receipt_number

Simple Order API Field:

receiptNumber

processorInformation. transactionID

Transaction identifier (TID) or Processor transaction ID that is used to identify and track a transaction throughout its life cycle.

This field is available only on the American Express Direct, Elavon Americas, and Moneris processors.

American Express Direct and Elavon Americas: This field is available only American Express card transactions on these processors.

American Express generates this value. To comply with the CAPN requirements, this value must be included in all subsequent follow-on requests, such as captures and follow-on credits.

When you perform authorizations, captures, and credits through Visa Acceptance Solutions, Visa Acceptance Solutions passes this value from the authorization service to the subsequent services for you. However, when you perform authorizations through Visa Acceptance Solutions and perform subsequent services through other financial institutions, you must ensure that requests for captures and credits include this value.
Moneris: This value identifies the transaction on a host system. It contains the following information:

Terminal used to process the transaction.
Shift during which the transaction took place.
Batch number.
Transaction number within the batch.

You must store this value. If you give the customer a receipt, display this value on the receipt.

Example
For the value
66012345001069003
:

Terminal ID =
66012345
Shift number =
001
Batch number =
069
Transaction number =
003

Specifications

Data Type:
String

Data Length:
87 (for e-check transactions); 15 (for all other transactions)

Mapping Information

REST API Field:

processorInformation.transactionID

SCMP API Fields:

auth_payment_network_transaction_id

auth_processor_trans_id

auth_reversal_processor_trans_id

auth_transaction_id

bill_processor_trans_id

credit_processor_trans_id

ecp_credit_processor_trans_id

ecp_debit_processor_trans_id

incremental_auth_payment_network_transaction_id

oct_payment_network_transaction_id

pin_debit_purchase_transaction_id

Simple Order API Fields:

ccAuthReply_transactionID

ccAuthReply_paymentNetworkTransactionID

ccAuthReply_processorTransactionID

ccAuthReversalReply_processorTransactionID

ccCaptureReply_processorTransactionID

ccCreditReply_processorTransactionID

ccIncrementalAuthReply_paymentNetworkTransactionID

ecCreditReply_processorTransactionID

ecDebitReply_processorTransactionID

octReply_paymentNetworkTransactionID

pinDebitPurchaseReply_transactionID

processorInformation. transactionIntegrityCode

Transaction integrity classification provided by Mastercard.

This field is available only for the Visa Platform Connect processor.

This value indicates Mastercard’s evaluation of the transaction’s safety and security.

Possible values for card-present transactions:

A1

: EMV or token in a secure, trusted environment.

B1

: EMV or chip equivalent.

C1

: Magnetic stripe.

E1

: Key entered.

U0

: Unclassified.

Possible values for card-not-present transactions:

A2

: Digital transactions.

B2

: Authenticated checkout.

C2

: Transaction validation.

D2

: Enhanced data.

E2

: Generic messaging.

U0

Data Type:
String

Data Length:
255

Mapping Information

REST API Field:

processorInformation.responseDetails

Simple Order API Field:
No corresponding field.

productInformation

These fields provide product information.

productInformation.selectedProducts.commerceSolutions. accountUpdater.configurationInformation.configurations.amex.active

productInformation.selectedProducts.commerceSolutions. accountUpdater.configurationInformation.configurations.amex.mode

productInformation.selectedProducts.commerceSolutions. accountUpdater.configurationInformation.configurations.amex.seNumber

productInformation.selectedProducts.commerceSolutions. accountUpdater.configurationInformation.configurations.amex.subscriberId

productInformation.selectedProducts.commerceSolutions. accountUpdater.configurationInformation.configurations.daysWindow

productInformation.selectedProducts.commerceSolutions. accountUpdater.configurationInformation.configurations.masterCard.active

productInformation.selectedProducts.commerceSolutions. accountUpdater.configurationInformation.configurations.masterCard. interbankCardAssociationNumber

productInformation.selectedProducts.commerceSolutions. accountUpdater.configurationInformation.configurations.masterCard.merchantId

productInformation.selectedProducts.commerceSolutions. accountUpdater.configurationInformation.configurations.preferredDay

productInformation.selectedProducts.commerceSolutions. accountUpdater.configurationInformation.templateId

productInformation.selectedProducts.commerceSolutions. accountUpdater.configurationInformation.configurations.visa.active

productInformation.selectedProducts.commerceSolutions. accountUpdater.configurationInformation.configurations.visa.merchantId

productInformation.selectedProducts.commerceSolutions. accountUpdater.configurationInformation.configurations.visa.segmentId

productInformation.selectedProducts.commerceSolutions. accountUpdater.subscriptionInformation.enabled

productInformation.selectedProducts.commerceSolutions. accountUpdater.subscriptionInformation.selfServiceability

productInformation.selectedProducts.commerceSolutions. tokenManagement.configurationInformation.configurations.networkTokenEnrollment. businessInformation.acquirer.acquirerId

productInformation.selectedProducts.commerceSolutions. tokenManagement.configurationInformation.configurations.networkTokenEnrollment. businessInformation.acquirer.acquirerMerchantId

productInformation.selectedProducts.commerceSolutions. tokenManagement.configurationInformation.configurations.networkTokenEnrollment. businessInformation.address.country

productInformation.selectedProducts.commerceSolutions. tokenManagement.configurationInformation.configurations.networkTokenEnrollment. businessInformation.address.locality

productInformation.selectedProducts.commerceSolutions. tokenManagement.configurationInformation.configurations.networkTokenEnrollment. businessInformation.websiteUrl

productInformation.selectedProducts.commerceSolutions. tokenManagement.configurationInformation.configurations.networkTokenEnrollment. businessInformation.doingBusinessAs

productInformation.selectedProducts.commerceSolutions. tokenManagement.configurationInformation.configurations.networkTokenEnrollment. businessInformation.name

productInformation.selectedProducts.commerceSolutions. tokenManagement.configurationInformation.configurations.networkTokenServices. americanExpressTokenService.enableTransactionalTokens

productInformation.selectedProducts.commerceSolutions. tokenManagement.configurationInformation.configurations.networkTokenServices. americanExpressTokenService.seNumber

productInformation.selectedProducts.commerceSolutions. tokenManagement.configurationInformation.configurations.networkTokenServices. americanExpressTokenService.enableService

productInformation.selectedProducts.commerceSolutions. tokenManagement.configurationInformation.configurations.networkTokenServices. americanExpressTokenService.tokenRequestorId

productInformation.selectedProducts.commerceSolutions. tokenManagement.configurationInformation.configurations.networkTokenServices. paymentCredentials.enabled

productInformation.selectedProducts.commerceSolutions. tokenManagement.configurationInformation.configurations.networkTokenServices. mastercardDigitalEnablementService.enableTransactionalTokens

productInformation.selectedProducts.commerceSolutions. tokenManagement.configurationInformation.configurations.networkTokenServices. mastercardDigitalEnablementService.enableService

productInformation.selectedProducts.commerceSolutions. tokenManagement.configurationInformation.configurations.networkTokenEnrollment. networkTokenServices.mastercardDigitalEnablementService.enrollment

productInformation.selectedProducts.commerceSolutions. tokenManagement.configurationInformation.configurations.networkTokenServices. mastercardDigitalEnablementService.tokenRequestorId

productInformation.selectedProducts.commerceSolutions. tokenManagement.configurationInformation.configurations.networkTokenServices. notifications.enabled

productInformation.selectedProducts.commerceSolutions. tokenManagement.configurationInformation.configurations.networkTokenServices. synchronousProvisioning.enabled

productInformation.selectedProducts.commerceSolutions. tokenManagement.configurationInformation.configurations.networkTokenServices. visaTokenService.enableTransactionalTokens

productInformation.selectedProducts.commerceSolutions. tokenManagement.configurationInformation.configurations.networkTokenServices. visaTokenService.enableService

productInformation.selectedProducts.commerceSolutions. tokenManagement.configurationInformation.configurations.networkTokenEnrollment. networkTokenServices.visaTokenService.enrollment

productInformation.selectedProducts.commerceSolutions. tokenManagement.configurationInformation.configurations.networkTokenServices. visaTokenService.relationshipId

productInformation.selectedProducts.commerceSolutions. tokenManagement.configurationInformation.configurations.networkTokenServices. visaTokenService.tokenRequestorId

productInformation.selectedProducts.commerceSolutions. tokenManagement.configurationInformation.configurations.parentProfileId

productInformation.selectedProducts.commerceSolutions. tokenManagement.configurationInformation.configurations.templateId

productInformation.selectedProducts.commerceSolutions. tokenManagement.configurationInformation.configurations.vault.defaultTokenType

productInformation.selectedProducts.commerceSolutions. tokenManagement.configurationInformation.configurations.vault.location

productInformation.selectedProducts.commerceSolutions. tokenManagement.configurationInformation.configurations.vault.sensitivePrivileges. cardNumberMaskingFormat

productInformation.selectedProducts.commerceSolutions. tokenManagement.configurationInformation.configurations.vault.tokenFormats. customer

productInformation.selectedProducts.commerceSolutions. tokenManagement.configurationInformation.configurations.vault.tokenFormats. instrumentIdentifierBankAccount

productInformation.selectedProducts.commerceSolutions. tokenManagement.configurationInformation.configurations.vault.tokenFormats. instrumentIdentifierCard

productInformation.selectedProducts.commerceSolutions. tokenManagement.configurationInformation.configurations.vault.tokenFormats. paymentInstrument

productInformation.selectedProducts.commerceSolutions. tokenManagement.subscriptionInformation.enabled

productInformation.selectedProducts.commerceSolutions. tokenManagement.subscriptionInformation.selfServiceability

productInformation.selectedProducts.commerceSolutions. valueAddedServices.reporting.subscriptionInformation.enabled

productInformation.selectedProducts.commerceSolutions. valueAddedServices.reporting.subscriptionInformation.selfServiceability

productInformation.selectedProducts.commerceSolutions. valueAddedServices.transactionSearch.subscriptionInformation.enabled

productInformation.selectedProducts.commerceSolutions. valueAddedServices.transactionSearch.subscriptionInformation.selfServiceability

productInformation.selectedProducts.payments. cardPresentConnect.configurationInformation.configurations. partnerSolutionIdentifier

productInformation.selectedProducts.payments. cardPresentConnect.configurationInformation.templateId

productInformation.selectedProducts.payments. cardPresentConnect.subscriptionInformation.enabled

productInformation.selectedProducts.payments. cardPresentConnect.subscriptionInformation.selfServiceability

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.common. allowCapturesGreaterThanAuthorizations

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.common.amexVendorCode

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.common. creditCardRefundLimitPercent

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.common. defaultAuthTypeCode

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.common.domesticMerchantId

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.common. businessCenterCreditCardRefundLimitPercent

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.common. enableDuplicateMerchantReferenceNumberBlocking

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.common. enableInterchangeOptimization

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.common.enablePartialAuth

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.common. enableSplitShipment

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.common. foodAndConsumerServiceId

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.common. masterCardAssignedId

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.common.merchantCategoryCode

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.common.merchantDescriptorInformation. city

productInformation.selectedProducts. payments.cardProcessing.configurationInformation. configurations.common.merchantDescriptorInformation.country

productInformation.selectedProducts. payments.cardProcessing.configurationInformation. configurations.common.merchantDescriptorInformation.name

productInformation.selectedProducts. payments.cardProcessing.configurationInformation. configurations.common.merchantDescriptorInformation.phone

productInformation.selectedProducts. payments.cardProcessing.configurationInformation. configurations.common.merchantDescriptorInformation.state

productInformation.selectedProducts. payments.cardProcessing.configurationInformation. configurations.common.merchantDescriptorInformation.street

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.common. merchantDescriptorInformation.url

productInformation.selectedProducts. payments.cardProcessing.configurationInformation. configurations.common.merchantDescriptorInformation.zip

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.common. preferCobadgedSecondaryBrand

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.common.processLevel3Data

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.features.cardNotPresent. amexTransactionAdviceAddendum1

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.features.cardNotPresent. ignoreAddressVerificationSystem

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.features.cardNotPresent.installment. enableInstallment

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.features.cardNotPresent.installment. installmentPlan

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.features.cardNotPresent. processors.[processorName].enableEmsTransactionRiskScore

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.features.cardNotPresent. processors.[processorName].payouts.acquiringInstitutionId

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.features.cardNotPresent. processors.[processorName].payouts.businessApplicationId

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.features.cardNotPresent. processors.[processorName].payouts.currencies.[currency].enabledCnp

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.features.cardNotPresent. processors.[processorName].payouts.currencies.[currency].enabledCp

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.features.cardNotPresent. processors.[processorName].payouts.currencies.[currency].enabled

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.features.cardNotPresent. processors.[processorName].payouts.currencies.[currency].merchantId

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.features.cardNotPresent. processors.[processorName].payouts.currencies.[currency].serviceEnablementNumber

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.features.cardNotPresent. processors.[processorName].payouts.currencies.[currency].terminalId

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.features.cardNotPresent. processors.[processorName].payouts.currencies.[currency].terminalIds

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.features.cardNotPresent. processors.[processorName].payouts.financialInstitutionId

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.features.cardNotPresent. processors.[processorName].payouts.merchantAbaNumber

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.features.cardNotPresent. processors.[processorName].payouts.merchantId

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.features.cardNotPresent. processors.[processorName].payouts.networkOrder

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.features.cardNotPresent. processors.[processorName].payouts.reimbursementCode

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.features.cardNotPresent. processors.[processorName].payouts.terminalId

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.features.cardNotPresent. processors.[processorName].prestigiousPropertyIndicator

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.features.cardNotPresent. processors.[processorName].relaxAddressVerificationSystemAllowExpiredCard

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.features.cardNotPresent. processors.[processorName].relaxAddressVerificationSystemAllowZipWithoutCountry

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.features.cardNotPresent. processors.[processorName].relaxAddressVerificationSystem

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.features.cardNotPresent. visaStraightThroughProcessingOnly

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.features.cardPresent. enableTerminalIdLookup

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.features.cardPresent.processors.[processorName]. defaultPointOfSaleTerminalId

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.features.cardPresent.processors.[processorName]. disablePointOfSaleTerminalIdValidation

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.features.cardPresent.processors.[processorName]. enablePinTranslation

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.features.cardPresent.processors.[processorName]. financialInstitutionId

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.features.cardPresent.processors. [processorName].pinDebitNetworkOrder

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.features.cardPresent.processors.[processorName]. pinDebitReimbursementCode

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.features.cardPresent.processors.[processorName]. pointOfSaleTerminalIds

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.common.processors.[processorName]. abaNumber

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.common.processors.[processorName]. acquirer.interbankCardAssociationId

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.common.processors.[processorName]. acquirer.countryCode

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.common.processors.[processorName]. acquirer.discoverInstitutionId

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.common.processors.[processorName]. acquirer.fileDestinationBin

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]. avsFormat

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.common.processors.[processorName]. bankNumber

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.common.processors.[processorName]. batchGroup

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.common.processors.[processorName]. businessApplicationId

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.common.processors.[processorName]. chainNumber

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.common.processors.[processorName]. currencies.[currency].enabled

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.common.processors.[processorName].currencies.[currency]. merchantId

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.common.processors.[processorName]. currencies.[currency].serviceEnablementNumber

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.common.processors.[processorName].currencies.[currency]. terminalId

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.common.processors.[processorName].currencies.[currency]. terminalIds

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.common.processors.[processorName]. defaultPointOfSaleTerminalId

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.common.processors.[processorName]. enableAutoAuthReversalAfterVoid

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.common.processors.[processorName]. enableCreditAuth

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.common.processors.[processorName]. enableCVVResponseIndicator

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.common.processors.[processorName]. enableDynamicCurrencyConversion

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.common.processors.[processorName]. enableExpresspayPanTranslation

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.common.processors.[processorName]. enableLevel2

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.common.processors.[processorName]. enableLeastCostRouting

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.common.processors.[processorName]. enableLongTransRefNo

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.common.processors.[processorName]. enableMultiCurrencyProcessing

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.common.processors.[processorName]. enableMultiLineItems

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.common.processors.[processorName]. enableMultipleTransactionAdviceAddendum

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.common.processors.[processorName]. enableTransactionReferenceNumber

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.common.processors.[processorName]. paymentTypes.[paymentType].currencies.[currency].enabled

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]. serviceEnablementNumber

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.common.processors.[processorName]. paymentTypes.[paymentType].enabled

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.common.processors[]. paymentTypes[].serviceEnablementNumber

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.common.processors.[processorName]. enablePosNetworkSwitching

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.common.processors.[processorName]. quasiCash

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.common.processors.[processorName]. sendAmexLevel2Data

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.common.processors.[processorName]. settlementCurrency

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.common.processors.[processorName]. softDescriptorType

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.common.processors.[processorName]. storeID

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.common.processors.[processorName]. travelAgencyCode

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.common.processors.[processorName]. travelAgencyName

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.common.processors.[processorName]. vitalNumber

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.common.sicCode

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.common. subMerchantBusinessName

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.common.subMerchantId

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.common. visaDelegatedAuthenticationId

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.common.processors.[processorName]. acquirer

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.common.processors.[processorName]. allowMerchantDescriptorOverride

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.common.processors.[processorName]. allowMultipleBills

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.common.processors.[processorName]. enhancedData

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.common.processors.[processorName]. fireSafetyIndicator

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.common.processors.[processorName]. industryCode

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.common.processors.[processorName]. merchantId

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.common.processors.[processorName]. merchantBinNumber

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.common.processors.[processorName]. merchantLocationNumber

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.common.processors.[processorName]. merchantTier

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.common.processors.[processorName]. sicCode

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.common.processors.[processorName]. terminalId

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.features.cardNotPresent. processors.[processorName].relaxAddressVerificationSystem

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.features.cardNotPresent. processors.[processorName].relaxAddressVerificationSystemAllowExpiredCard

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.features.cardNotPresent. processors.[processorName].relaxAddressVerificationSystemAllowZipWithoutCountry

productInformation.selectedProducts.payments. cardProcessing.configurationInformation.configurations.features.cardPresent. processors.[processorName].defaultPointOfSaleTerminalId

productInformation.selectedProducts.payments. cardProcessing.subscriptionInformation.enabled

productInformation. selectedProducts.payments.cardProcessing. subscriptionInformation.features.cardNotPresent.enabled

productInformation. selectedProducts.payments.cardProcessing. subscriptionInformation.features.cardPresent.enabled

productInformation.selectedProducts.payments. customerInvoicing.subscriptionInformation.enabled

productInformation.selectedProducts.payments. customerInvoicing.subscriptionInformation.selfServiceability

productInformation.selectedProducts.payments. cybsReadyTerminal.subscriptionInformation.enabled

productInformation.selectedProducts.payments. cybsReadyTerminal.subscriptionInformation.selfServiceability

productInformation.selectedProducts.payments. differentialFee.subscriptionInformation.enabled

productInformation.selectedProducts.payments. differentialFee.subscriptionInformation.features.surcharge.enabled

productInformation.selectedProducts.payments. differentialFee.subscriptionInformation.selfServiceability

productInformation.selectedProducts.payments. digitalPayments.subscriptionInformation.enabled

productInformation.selectedProducts.payments. digitalPayments.subscriptionInformation.features[].enabled

productInformation.selectedProducts.payments. digitalPayments.subscriptionInformation.selfServiceability

productInformation.selectedProducts.payments.echeck. configurationInformation.configurations.common.accountHolderName

productInformation.selectedProducts.payments.echeck. configurationInformation.configurations.common.accountNumber

productInformation.selectedProducts.payments.echeck. configurationInformation.configurations.common.accountRoutingNumber

productInformation.selectedProducts.payments.echeck. configurationInformation.configurations.common.accountType

productInformation.selectedProducts.payments.echeck. configurationInformation.configurations.common.processors.[processorName].batchGroup

productInformation.selectedProducts.payments.echeck. configurationInformation.configurations.common.processors.[processorName]. companyEntryDescription

productInformation.selectedProducts.payments.echeck. configurationInformation.configurations.common.processors.[processorName].companyId

productInformation.selectedProducts.payments.echeck. configurationInformation.configurations.common.processors.[processorName].setCompletedState

productInformation.selectedProducts.payments.echeck. configurationInformation.configurations.underwriting.enableCredits

productInformation.selectedProducts.payments.echeck. configurationInformation.configurations.underwriting.enableHold

productInformation.selectedProducts.payments.echeck. configurationInformation.configurations.underwriting.holdingDays

productInformation.selectedProducts.payments.echeck. configurationInformation.configurations.underwriting. monthlyTotalTransactionAmountLimit

productInformation.selectedProducts.payments.echeck. configurationInformation.configurations.underwriting.riskReserveMethod

productInformation.selectedProducts.payments.echeck. configurationInformation.configurations.underwriting.riskReserveRate

productInformation.selectedProducts.payments.echeck. configurationInformation.configurations.underwriting.riskReserveTargetAmount

productInformation.selectedProducts.payments.echeck. configurationInformation.configurations.underwriting.solutionOrganizationId

productInformation.selectedProducts.payments.echeck. configurationInformation.configurations.underwriting.standardEntryClassCodes

productInformation.selectedProducts.payments.echeck. configurationInformation.configurations.underwriting.transactionAmountLimit

productInformation.selectedProducts.payments.echeck. configurationInformation.templateId

productInformation.selectedProducts.payments.echeck. subscriptionInformation.enabled

productInformation.selectedProducts.payments.echeck. subscriptionInformation.mode

productInformation.selectedProducts.payments. payByLink.subscriptionInformation.enabled

productInformation.selectedProducts.payments. payByLink.subscriptionInformation.selfServiceability

productInformation.selectedProducts.payments. payerAuthentication.configurationInformation.configurations.cardTypes.amexSafeKey. currencies.requestorId

productInformation.selectedProducts.payments. payerAuthentication.configurationInformation.configurations.cardTypes.amexSafeKey. currencies.[currency].acquirerId

productInformation.selectedProducts.payments. payerAuthentication.configurationInformation.configurations.cardTypes.amexSafeKey. currencies.[currency].currencyCodes

productInformation.selectedProducts.payments. payerAuthentication.configurationInformation.configurations.cardTypes.amexSafeKey. currencies.[currency].processorMerchantId

productInformation.selectedProducts.payments. payerAuthentication.configurationInformation.configurations.cardTypes.amexSafeKey. enabled

productInformation.selectedProducts.payments. payerAuthentication.configurationInformation.configurations.cardTypes.amexSafeKey. currencies. requestorName

productInformation.selectedProducts.payments. payerAuthentication.configurationInformation.configurations.cardTypes.CB.currencies. [currency].acquirerId

productInformation.selectedProducts.payments. payerAuthentication.configurationInformation.configurations.cardTypes.CB.currencies. [currency].currencyCodes

productInformation.selectedProducts.payments. payerAuthentication.configurationInformation.configurations.cardTypes.CB.currencies. [currency].processorMerchantId

productInformation.selectedProducts.payments. payerAuthentication.configurationInformation.configurations.cardTypes.CB.currencies. requestorId

productInformation.selectedProducts.payments. payerAuthentication.configurationInformation.configurations.cardTypes.CB.currencies. requestorName

productInformation.selectedProducts.payments. payerAuthentication.configurationInformation.configurations.cardTypes.CB.enabled

productInformation.selectedProducts.payments. payerAuthentication.configurationInformation.configuration.cardTypes.currencies. requestorId

productInformation.selectedProducts.payments. payerAuthentication.configurationInformation.configurations.cardTypes. dinersClubInternationalProtectBuy.currencies.[currency].acquirerId

productInformation.selectedProducts.payments. payerAuthentication.configurationInformation.configurations.cardTypes. dinersClubInternationalProtectBuy.currencies.[currency].currencyCodes

productInformation.selectedProducts.payments. payerAuthentication.configurationInformation.configurations.cardTypes. dinersClubInternationalProtectBuy.currencies.[currency].processorMerchantId

productInformation.selectedProducts.payments. payerAuthentication.configurationInformation.configurations.cardTypes. dinersClubInternationalProtectBuy.currencies.requestorId

productInformation.selectedProducts.payments. payerAuthentication.configurationInformation.configurations.cardTypes. dinersClubInternationalProtectBuy.currencies. requestorName

productInformation.selectedProducts.payments. payerAuthentication.configurationInformation.configurations.cardTypes. dinersClubInternationalProtectBuy.enabled

productInformation.selectedProducts.payments. payerAuthentication.configurationInformation.configurations.cardTypes.ELO.currencies. [currency].acquirerId

productInformation.selectedProducts.payments. payerAuthentication.configurationInformation.configurations.cardTypes.ELO.currencies. [currency].currencyCodes

productInformation.selectedProducts.payments. payerAuthentication.configurationInformation.configurations.cardTypes.ELO. currencies.[currency].processorMerchantId

productInformation.selectedProducts.payments. payerAuthentication.configurationInformation.configurations.cardTypes.ELO.currencies. requestorId

productInformation.selectedProducts.payments. payerAuthentication.configurationInformation.configurations.cardTypes.ELO. currencies.requestorName

productInformation.selectedProducts.payments. payerAuthentication.configurationInformation.configurations.cardTypes.ELO.enabled

productInformation.selectedProducts.payments. payerAuthentication.configurationInformation.configurations.cardTypes.jCBJSecure.currencies. requestorId

productInformation.selectedProducts.payments. payerAuthentication.configurationInformation.configurations.cardTypes.jCBJSecure. currencies.[currency].acquirerId

productInformation.selectedProducts.payments. payerAuthentication.configurationInformation.configurations.cardTypes.jCBJSecure. currencies.[currency].currencyCodes

productInformation.selectedProducts.payments. payerAuthentication.configurationInformation.configurations.cardTypes.jCBJSecure. currencies.[currency].processorMerchantId

productInformation.selectedProducts.payments. payerAuthentication.configurationInformation.configurations.cardTypes.jCBJSecure. currencies.requestorName

productInformation.selectedProducts.payments. payerAuthentication.configurationInformation.configurations.cardTypes.jCBJSecure. enabled

productInformation.selectedProducts.payments. payerAuthentication.configurationInformation.configurations.cardTypes.jCBJSecure. securePasswordForJCB

productInformation.selectedProducts.payments. payerAuthentication.configurationInformation.configurations.cardTypes.masterCardSecureCode. currencies.[currency].requestorName

productInformation.selectedProducts.payments. payerAuthentication.configurationInformation.configurations.cardTypes.masterCardSecureCode. currencies.requestorId

productInformation.selectedProducts.payments. payerAuthentication.configurationInformation.configurations.cardTypes.masterCardSecureCode. currencies.[currency].acquirerId

productInformation.selectedProducts.payments. payerAuthentication.configurationInformation.configurations.cardTypes.masterCardSecureCode. currencies.[currency].currencyCodes

productInformation.selectedProducts.payments. payerAuthentication.configurationInformation.configurations.cardTypes.masterCardSecureCode. currencies.[currency].processorMerchantId

productInformation.selectedProducts.payments. payerAuthentication.configurationInformation.configurations.cardTypes. masterCardSecureCode.enabled

productInformation.selectedProducts.payments. payerAuthentication.configurationInformation.configurations.cardTypes.UPI.currencies. [currency].acquirerId

productInformation.selectedProducts.payments. payerAuthentication.configurationInformation.configurations.cardTypes.UPI.currencies. [currency].currencyCodes

productInformation.selectedProducts.payments. payerAuthentication.configurationInformation.configurations.cardTypes.UPI.currencies. [currency].processorMerchantId

productInformation.selectedProducts.payments. payerAuthentication.configurationInformation.configurations.cardTypes.UPI.currencies. requestorId

productInformation.selectedProducts.payments. payerAuthentication.configurationInformation.configurations.cardTypes.UPI.currencies. requestorName

productInformation.selectedProducts.payments. payerAuthentication.configurationInformation.configurations.cardTypes.UPI.enabled

productInformation.selectedProducts.payments. payerAuthentication.configurationInformation.configurations.cardTypes.verifiedByVisa. currencies.requestorId

productInformation.selectedProducts.payments. payerAuthentication.configurationInformation.configurations.cardTypes.verifiedByVisa. currencies.[currency].acquirerId

productInformation.selectedProducts.payments. payerAuthentication.configurationInformation.configurations.cardTypes.verifiedByVisa. currencies.[currency].currencyCodes

productInformation.selectedProducts.payments. payerAuthentication.configurationInformation.configurations.cardTypes.verifiedByVisa. currencies.[currency].processorMerchantId

productInformation.selectedProducts.payments. payerAuthentication.configurationInformation.configurations.cardTypes. verifiedByVisa. currencies.vmid

productInformation.selectedProducts.payments. payerAuthentication.configurationInformation.configurations.cardTypes.verifiedByVisa. enabled

productInformation.selectedProducts.payments. payerAuthentication.configurationInformation.configurations.cardTypes.verifiedByVisa. currencies.[currency].requestorName

productInformation.selectedProducts.payments. payerAuthentication.configurationInformation.templateId

productInformation.selectedProducts.payments. payerAuthentication.subscriptionInformation.enabled

productInformation.selectedProducts.payments. payerAuthentication.subscriptionInformation.selfServiceability

productInformation.selectedProducts.payments. paymentOrchestration.subscriptionInformation.enabled

productInformation.selectedProducts.payments. paymentOrchestration.subscriptionInformation.selfServiceability

productInformation.selectedProducts.payments.payouts. configurationInformation.configurations.pullFunds.acquirerOrganizationId

productInformation.selectedProducts.payments.payouts. configurationInformation.configurations.pullFunds.acquiringBIN

productInformation.selectedProducts.payments.payouts. configurationInformation.configurations.pullFunds.allowCryptoCurrencyPurchase

productInformation.selectedProducts.payments.payouts. configurationInformation.configurations.pullFunds.cardAcceptorId

productInformation.selectedProducts.payments.payouts. configurationInformation.configurations.pullFunds.cardTerminalId

productInformation.selectedProducts.payments.payouts. configurationInformation.configurations.pullFunds.originatorMvv

productInformation.selectedProducts.payments.payouts. configurationInformation.configurations.pullFunds.originatorNameAbbreviation

productInformation.selectedProducts.payments.payouts. configurationInformation.configurations.pushFunds.acquirerCountryCode

productInformation.selectedProducts.payments.payouts. configurationInformation.configurations.pushFunds.acquiringBIN

productInformation.selectedProducts.payments.payouts. configurationInformation.configurations.pushFunds.allowCryptoCurrencyPurchase

productInformation.selectedProducts.payments.payouts. configurationInformation.configurations.pushFunds.financialInstitutionId

productInformation.selectedProducts.payments.payouts. configurationInformation.configurations.pushFunds.nationalReimbursementFee

productInformation.selectedProducts.payments.payouts. configurationInformation.configurations.pushFunds.originatorBusinessApplicationId

productInformation.selectedProducts.payments.payouts. configurationInformation.configurations.pushFunds.originatorPseudoAbaNumber

productInformation.selectedProducts.payments.payouts. configurationInformation.configurations.pushFunds.processorAccount[]. originatorMerchantId

productInformation.selectedProducts.payments.payouts. configurationInformation.configurations.pushFunds.processorAccount[]. originatorTerminalId

productInformation.selectedProducts.payments.payouts. configurationInformation.configurations.pushFunds.processorAccount[]. supportedCurrencies

productInformation.selectedProducts.payments.payouts. subscriptionInformation.enabled

productInformation.selectedProducts.payments.payouts. subscriptionInformation.selfServiceability

productInformation.selectedProducts.payments. recurringBilling.subscriptionInformation.enabled

productInformation.selectedProducts.payments. recurringBilling.subscriptionInformation.selfServiceability

productInformation.selectedProducts.payments. secureAcceptance.configurationInformation.configurations.service. reverseAuthOnAddressVerificationSystemFailure

productInformation.selectedProducts.payments. secureAcceptance.configurationInformation.configurations.service. reverseAuthOnCardVerificationNumberFailure

productInformation.selectedProducts.payments. secureAcceptance.configurationInformation.configurations.service. tokenizationEnabled

productInformation.selectedProducts.payments. secureAcceptance.configurationInformation.templateId

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.displayCreditCards

productInformation.selectedProducts.payments. virtualTerminal.configurationInformation.configurations.cardNotPresent. globalPaymentInformation.paymentInformation.displayCardVerificationValue

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

productInformation. selectedProducts. commerceSolutions. accountUpdater. configurationInformation. configurations. amex. active

Determines whether American Express is actively configured as a card type for Account Updater.

Possible Values

true

false

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "commerceSolutions": {
        "accountUpdater": {
          "configurationInformation": {
            "configurations": {
              "amex": {
                "active": "true"
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.commerceSolutions.accountUpdater. configurationInformation.configurations.amex.active

Product Enablement and Configuration Service API Field:

commerceSolutions.accountUpdater.configurationInformation.configurations.amex.active

productInformation. selectedProducts. commerceSolutions. accountUpdater. configurationInformation. configurations. amex. mode

Determines the type of mode configured on Account Updater for American Express cards.

Possible Values

tokenApi

dailyHarvest

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "commerceSolutions": {
        "accountUpdater": {
          "configurationInformation": {
            "configurations": {
              "amex": {
                "mode": "dailyHarvest"
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Enum

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.commerceSolutions.accountUpdater. configurationInformation.configurations.amex.mode

Product Enablement and Configuration Service API Field:

commerceSolutions.accountUpdater.configurationInformation.configurations.amex.mode

productInformation. selectedProducts. commerceSolutions. accountUpdater. configurationInformation. configurations. amex. seNumber

The American Express card service establishment (SE) number configured for Account Updater.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "commerceSolutions": {
        "accountUpdater": {
          "configurationInformation": {
            "configurations": {
              "amex": {
                "seNumber": "1234567890"
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
String

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.commerceSolutions.accountUpdater. configurationInformation.configurations.amex.seNumber

Product Enablement and Configuration Service API Field:

commerceSolutions.accountUpdater.configurationInformation.configurations.amex.seNumber

productInformation. selectedProducts. commerceSolutions. accountUpdater. configurationInformation. configurations. amex. subscriberId

The subscriber identifier configured for Account Updater with American Express cards.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "commerceSolutions": {
        "accountUpdater": {
          "configurationInformation": {
            "configurations": {
              "amex": {
                "subscriberId": "0123456789"
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
String

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.commerceSolutions.accountUpdater. configurationInformation.configurations.amex.subscriberId

Product Enablement and Configuration Service API Field:

commerceSolutions.accountUpdater.configurationInformation.configurations.amex.subscriberId

productInformation. selectedProducts. commerceSolutions. accountUpdater. configurationInformation. configurations. daysWindow

Interval of days at which Account Updater updates payment information. The default value is

31

.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "commerceSolutions": {
        "accountUpdater": {
          "configurationInformation": {
            "configurations": {
              "daysWindow": "31"
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
String

Minimum Data Length:
1

Maximum Data Length:
3650

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.commerceSolutions.accountUpdater. configurationInformation.configurations.daysWindow

Product Enablement and Configuration Service API Field:

commerceSolutions.accountUpdater.configurationInformation.configurations.daysWindow

productInformation. selectedProducts. commerceSolutions. accountUpdater. configurationInformation. configurations. masterCard. active

Determines whether Mastercard is actively configured as a card type for Account Updater.

Possible Values

true

false

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "commerceSolutions": {
        "accountUpdater": {
          "configurationInformation": {
            "configurations": {
              "masterCard": {
                "active": "true"
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.commerceSolutions.accountUpdater. configurationInformation.configurations.masterCard.active

Product Enablement and Configuration Service API Field:

commerceSolutions.accountUpdater.configurationInformation. configurations.masterCard.active

productInformation. selectedProducts. commerceSolutions. accountUpdater. configurationInformation. configurations. masterCard. interbankCardAssociationNumber

The number that is assigned by Mastercard to a financial institution, third-party processor, or other member to identify the member in a transaction.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "commerceSolutions": {
        "accountUpdater": {
          "configurationInformation": {
            "configurations": {
              "masterCard": {
                "interbankCardAssociationNumber": "12345"
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
String

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.commerceSolutions.accountUpdater. configurationInformation.configurations.masterCard.interbankCardAssociationNumber

Product Enablement and Configuration Service API Field:

commerceSolutions.accountUpdater.configurationInformation. configurations.masterCard.interbankCardAssociationNumber

productInformation. selectedProducts. commerceSolutions. accountUpdater. configurationInformation. configurations. masterCard. merchantId

Mastercard merchant identifier (MID) number that is configured in Account Updater.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "commerceSolutions": {
        "accountUpdater": {
          "configurationInformation": {
            "configurations": {
              "masterCard": {
                "merchantId": "testmerch123"
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
String

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.commerceSolutions.accountUpdater. configurationInformation.configurations.masterCard.merchantId

Product Enablement and Configuration Service API Field:

commerceSolutions.accountUpdater.configurationInformation. configurations.masterCard.merchantId

productInformation. selectedProducts. commerceSolutions. accountUpdater. configurationInformation. configurations. preferredDay

Merchant's preferred day that Account Updater updates payment information.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "commerceSolutions": {
        "accountUpdater": {
          "configurationInformation": {
            "configurations": {
              "preferredDay": "1"
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
String

Minimum Data Length:
1

Maximum Data Length:
28

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.commerceSolutions.accountUpdater. configurationInformation.configurations.preferredDay

Product Enablement and Configuration Service API Field:

commerceSolutions.accountUpdater.configurationInformation.configurations.preferredDay

productInformation. selectedProducts. commerceSolutions. accountUpdater. configurationInformation. templateId

Template identifier that is configured for Account Updater.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "commerceSolutions": {
        "accountUpdater": {
          "configurationInformation": {
            "templateId": "template123"
          }
        }
      }
    }
  }
}

Specifications

Data Type:
String

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.commerceSolutions.accountUpdater. configurationInformation.templateId

Product Enablement and Configuration Service API Field:

commerceSolutions.accountUpdater.configurationInformation.templateId

productInformation. selectedProducts. commerceSolutions. accountUpdater. configurationInformation. configurations. visa. active

Determines whether Visa is actively configured as a card type for Account Updater.

Possible Values

true

false

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "commerceSolutions": {
        "accountUpdater": {
          "configurationInformation": {
            "configurations": {
              "visa": {
                "active": "true"
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.commerceSolutions.accountUpdater. configurationInformation.configurations.visa.active

Product Enablement and Configuration Service API Field:

commerceSolutions.accountUpdater.configurationInformation. configurations.visa.active

productInformation. selectedProducts. commerceSolutions. accountUpdater. configurationInformation. configurations. visa. merchantId

The Visa merchant identifier (MID) number that is configured for Account Updater.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "commerceSolutions": {
        "accountUpdater": {
          "configurationInformation": {
            "configurations": {
              "visa": {
                "merchantId": "testrest"
              }
            }
          }
        }
      }
    }
  }
}

The value of this field must conform to this regular expression:

 ^[0-9]+$

Specifications

Data Type:
String

Minimum Data Length:
1

Maximum Data Length:
11

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.commerceSolutions.accountUpdater. configurationInformation.configurations.visa.merchantId

Product Enablement and Configuration Service API Field:

commerceSolutions.accountUpdater.configurationInformation. configurations.visa.merchantId

productInformation. selectedProducts. commerceSolutions. accountUpdater. configurationInformation. configurations. visa. segmentId

The segment identifier that is assigned by Visa for each group of merchants participating in Account Updater.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "commerceSolutions": {
        "accountUpdater": {
          "configurationInformation": {
            "configurations": {
              "visa": {
                "segmentId": "123456789"
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
String

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.commerceSolutions.accountUpdater. configurationInformation.configurations.visa.segmentId

Product Enablement and Configuration Service API Field:

commerceSolutions.accountUpdater.configurationInformation. configurations.visa.segmentId

productInformation. selectedProducts. commerceSolutions. accountUpdater. subscriptionInformation. enabled

Determines whether subscription information is enabled for Account Updater.

Possible Values

true

false

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "commerceSolutions": {
        "accountUpdater": {
          "subscriptionInformation": {
            "enabled": "true"
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.commerceSolutions.accountUpdater. subscriptionInformation.enabled

Product Enablement and Configuration Service API Field:

commerceSolutions.accountUpdater.subscriptionInformation.enabled

productInformation. selectedProducts. commerceSolutions. accountUpdater. subscriptionInformation. selfServiceability

This field value indicates whether the organization can enable Account Updater using self service.

Possible Values

NOT_SELF_SERVICEABLE

(default)

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "commerceSolutions": {
        "tokenManagement": {
          "subscriptionInformation": {
            "selfServiceability": "NOT_SELF_SERVICEABLE"
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Enum

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.commerceSolutions.accountUpdater. subscriptionInformation.selfServiceability

Product Enablement and Configuration Service API Field:

commerceSolutions.accountUpdater.subscriptionInformation.selfServiceability

productInformation. selectedProducts. commerceSolutions. tokenManagement. configurationInformation. configurations. networkTokenEnrollment. businessInformation. acquirer. acquirerId

The token service provider ID that is used for the token requestor ID (TRID) enrollment for Visa.

You must set this field value to

40010052242

. This is a static value that is used for all clients that are enrolling for a token requestor on Visa Token Service (VTS). This field value must not be replaced by another value.

Syntax

{
  "productInformation": {
    "selectedProducts": {
      "commerceSolutions": {
        "valueAddedServices": {
          "tokenManagement": {
            "configurationInformation": {
              "configurations": {
                "networkTokenEnrollment": {
                  "businessInformation": {
                    "acquirer": {
                      "acquirerId": "40010052242"
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
String

Maximum Data Length:
15

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.commerceSolutions. tokenManagement.configurationInformation.configurations.networkTokenEnrollment. businessInformation.acquirer.acquirerId

Product Enablement and Configuration Service API Field:

commerceSolutions.tokenManagement.configurationInformation. configurations.networkTokenEnrollment.businessInformation.acquirer.acquirerId

productInformation. selectedProducts. commerceSolutions. tokenManagement. configurationInformation. configurations. networkTokenEnrollment. businessInformation. acquirer. acquirerMerchantId

The merchant account organization ID that is used for the token requestor ID (TRID) enrollment for Visa.

Set this field to the merchant account organization ID that is being boarded.

Syntax

{
  "productInformation": {
    "selectedProducts": {
      "commerceSolutions": {
        "valueAddedServices": {
          "tokenManagement": {
            "configurationInformation": {
              "configurations": {
                "networkTokenEnrollment": {
                  "businessInformation": {
                    "acquirer": {
                      "acquirerMerchantId": "acqmerch123"
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
String

Maximum Data Length:
25

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.commerceSolutions. tokenManagement.configurationInformation.configurations.networkTokenEnrollment. businessInformation.acquirer.acquirerMerchantId

Product Enablement and Configuration Service API Field:

commerceSolutions.tokenManagement.configurationInformation. configurations.networkTokenEnrollment.businessInformation.acquirer.acquirerMerchantId

productInformation. selectedProducts. commerceSolutions. tokenManagement. configurationInformation. configurations. networkTokenEnrollment. businessInformation. address. country

The merchant country code that is used for the token requestor ID (TRID) enrollment for Visa.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "commerceSolutions": {
        "valueAddedServices": {
          "tokenManagement": {
            "configurationInformation": {
              "configurations": {
                "networkTokenEnrollment": {
                  "businessInformation": {
                    "address": {
                      "country": "US"
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

The value of this field must conform to this regular expression:

^[À-ÖØ-öø-ǿa-zA-Z0-9().\-_#,;/@$:!% ]{1,}$

Specifications

Data Type:
String

Data Length:
2

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.commerceSolutions. tokenManagement.configurationInformation.configurations.networkTokenEnrollment. businessInformation.address.country

Product Enablement and Configuration Service API Field:

commerceSolutions.tokenManagement.configurationInformation. configurations.networkTokenEnrollment.businessInformation.address.country

productInformation. selectedProducts. commerceSolutions. tokenManagement. configurationInformation. configurations. networkTokenEnrollment. businessInformation. address. locality

The merchant locality name that is used for the token requestor ID (TRID) enrollment for Visa.

Syntax

{
  "productInformation": {
    "selectedProducts": {
      "commerceSolutions": {
        "valueAddedServices": {
          "tokenManagement": {
            "configurationInformation": {
              "configurations": {
                "networkTokenEnrollment": {
                  "businessInformation": {
                    "address": {
                      "locality": "CA"
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

The value of this field must conform to this regular expression:

^[0-9a-zA-Z _\-¡-]+$

Specifications

Data Type:
String

Minimum Data Length:
1

Maximum Data Length:
50

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.commerceSolutions. tokenManagement.configurationInformation.configurations.networkTokenEnrollment. businessInformation.address.locality

Product Enablement and Configuration Service API Field:

commerceSolutions.tokenManagement.configurationInformation. configurations.networkTokenEnrollment.businessInformation.address.locality

productInformation. selectedProducts. commerceSolutions. tokenManagement. configurationInformation. configurations. networkTokenEnrollment. businessInformation. websiteUrl

The merchant website URL that is used for the token requestor ID (TRID) enrollment for Visa.

Syntax

{
  "productInformation": {
    "selectedProducts": {
      "commerceSolutions": {
        "valueAddedServices": {
          "tokenManagement": {
            "configurationInformation": {
              "configurations": {
                "networkTokenEnrollment": {
                  "businessInformation": {
                    "websiteUrl": "http://www.example.com"
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
String

Maximum Data Length:
100

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.commerceSolutions. tokenManagement.configurationInformation.configurations.networkTokenEnrollment. businessInformation.address.websiteUrl

Product Enablement and Configuration Service API Field:

commerceSolutions.tokenManagement.configurationInformation. configurations.networkTokenEnrollment.businessInformation.address.websiteUrl

productInformation. selectedProducts. commerceSolutions. tokenManagement. configurationInformation. configurations. networkTokenEnrollment. businessInformation. doingBusinessAs

The merchant business name that is used for the token requestor ID (TRID) enrollment for Mastercard.

Syntax

{
  "productInformation": {
    "selectedProducts": {
      "commerceSolutions": {
        "valueAddedServices": {
          "tokenManagement": {
            "configurationInformation": {
              "configurations": {
                "networkTokenEnrollment": {
                  "businessInformation": {
                    "doingBusinessAs": "Business Name"
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
String

Minimum Data Length:
1

Maximum Data Length:
60

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.commerceSolutions.tokenManagement. configurationInformation.configurations.networkTokenEnrollment. businessInformation.doingBusinessAs

Product Enablement and Configuration Service API Field:

commerceSolutions.tokenManagement.configurationInformation.configurations. networkTokenEnrollment.businessInformation.doingBusinessAs

productInformation. selectedProducts. commerceSolutions. tokenManagement. configurationInformation. configurations. networkTokenEnrollment. businessInformation. name

The merchant business name that is used for token requestor ID (TRID) enrollment for Visa.

Syntax

{
  "productInformation": {
    "selectedProducts": {
      "commerceSolutions": {
        "valueAddedServices": {
          "tokenManagement": {
            "configurationInformation": {
              "configurations": {
                "networkTokenEnrollment": {
                  "businessInformation": {
                    "name": "Business Name"
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
String

Minimum Data Length:
1

Maximum Data Length:
60

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.commerceSolutions.tokenManagement. configurationInformation.configurations.networkTokenEnrollment.businessInformation.name

Product Enablement and Configuration Service API Field:

commerceSolutions.tokenManagement.configurationInformation.configurations. networkTokenEnrollment.businessInformation.name

productInformation. selectedProducts. commerceSolutions. tokenManagement. configurationInformation. configurations. networkTokenServices. americanExpressTokenService. enableTransactionalTokens

Indicates if the use of American Express network tokens in transactions is enabled or disabled. When this field is set to

true

, Visa network tokens can be used in transactions.

Possible Values

true

false

Syntax

{
  "productInformation": {
    "selectedProducts": {
      "commerceSolutions": {
        "valueAddedServices": {
          "tokenManagement": {
            "configurationInformation": {
              "configurations": {
                "networkTokenServices": {
                  "americanExpressTokenService": {
                    "enableTransactionalTokens": "true"
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.commerceSolutions.tokenManagement. configurationInformation.configurations.networkTokenServices.americanExpressTokenService. enableTransactionalTokens

Product Enablement and Configuration Service API Field:

commerceSolutions.tokenManagement.configurationInformation.configurations. networkTokenServices.americanExpressTokenService.enableTransactionalTokens

productInformation. selectedProducts. commerceSolutions. tokenManagement. configurationInformation. configurations. networkTokenServices. americanExpressTokenService. seNumber

This field is used to assign the American Express service establishment (SE) number that is used for network tokenization into the Token Management Service vault.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "commerceSolutions": {
        "valueAddedServices": {
          "tokenManagement": {
            "configurationInformation": {
              "configurations": {
                "networkTokenServices": {
                  "americanExpressTokenService": {
                    "seNumber": "0123456789"
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

The value of this field must conform to this regular expression:

^[0-9]{11}\z$"

Specifications

Data Type:
String

Data Length:
10

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.commerceSolutions.tokenManagement. configurationInformation.configurations.networkTokenServices. americanExpressTokenService.seNumber

Product Enablement and Configuration Service API Field:

commerceSolutions.tokenManagement.configurationInformation.configurations. networkTokenServices.americanExpressTokenService.seNumber

productInformation. selectedProducts. commerceSolutions. tokenManagement. configurationInformation. configurations. networkTokenServices. americanExpressTokenService. enableService

Indicates if provisioning of new network tokens for American Express is enabled or disabled. When this field is set to

true

, the provisioning of new network tokens for American Express is enabled.

Possible Values

true

false

Syntax

{
  "productInformation": {
    "selectedProducts": {
      "commerceSolutions": {
        "valueAddedServices": {
          "tokenManagement": {
            "configurationInformation": {
              "configurations": {
                "networkTokenServices": {
                  "americanExpressTokenService": {
                    "enableService": "true"
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.commerceSolutions.tokenManagement. configurationInformation.configurations.networkTokenServices.americanExpressTokenService. enableService

Product Enablement and Configuration Service API Field:

commerceSolutions.tokenManagement.configurationInformation.configurations. networkTokenServices.americanExpressTokenService.enableService

productInformation. selectedProducts. commerceSolutions. tokenManagement. configurationInformation. configurations. networkTokenServices. americanExpressTokenService. tokenRequestorId

This field is used to assign an existing token requestor ID (TRID) to aToken Management Service vault for American Express.

Syntax

{
  "productInformation": {
    "selectedProducts": {
      "commerceSolutions": {
        "valueAddedServices": {
          "tokenManagement": {
            "configurationInformation": {
              "configurations": {
                "networkTokenServices": {
                  "americanExpressTokenService": {
                    "tokenRequestorId": "12345678901"
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

The value of this field must conform to this regular expression:

^[0-9]{11}\\z$"

Specifications

Data Type:
String

Data Length:
11

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.commerceSolutions.tokenManagement. configurationInformation.configurations.networkTokenServices. americanExpressTokenService.tokenRequestorId

Product Enablement and Configuration Service API Field:

commerceSolutions.tokenManagement.configurationInformation.configurations. networkTokenServices.americanExpressTokenService.tokenRequestorId

productInformation. selectedProducts. commerceSolutions. tokenManagement. configurationInformation. configurations. networkTokenServices. paymentCredentials. enabled

Indicates if the unmasked network token and cryptogram retrieval service is enabled or disabled. When this field is set to

true

, the unmasked network token and cryptogram retrieval service is enabled.

Possible Values

true

false

Syntax

{
  "productInformation": {
    "selectedProducts": {
      "commerceSolutions": {
        "valueAddedServices": {
          "tokenManagement": {
            "configurationInformation": {
              "configurations": {
                "networkTokenServices": {
                  "paymentCredentials": {
                    "enabled": "true"
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.commerceSolutions.tokenManagement. configurationInformation.configurations.networkTokenServices.paymentCredentials.enabled

Product Enablement and Configuration Service API Field:

commerceSolutions.tokenManagement.configurationInformation.configurations. networkTokenServices.paymentCredentials.enabled

productInformation. selectedProducts. commerceSolutions. tokenManagement. configurationInformation. configurations. networkTokenServices. mastercardDigitalEnablementService. enableTransactionalTokens

Indicates if the use of Mastercard network tokens in transactions is enabled or disabled. When this field is set to

true

, Visa network tokens can be used in transactions.

Possible Values

true

false

Syntax

{
  "productInformation": {
    "selectedProducts": {
      "commerceSolutions": {
        "valueAddedServices": {
          "tokenManagement": {
            "configurationInformation": {
              "configurations": {
                "networkTokenServices": {
                  "mastercardDigitalEnablementService": {
                    "enableTransactionalTokens": "true"
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.commerceSolutions.tokenManagement. configurationInformation.configurations.networkTokenServices. mastercardDigitalEnablementService.enableTransactionalTokens

Product Enablement and Configuration Service API Field:

commerceSolutions.tokenManagement.configurationInformation.configurations. networkTokenServices.mastercardDigitalEnablementService.enableTransactionalTokens

productInformation. selectedProducts. commerceSolutions. tokenManagement. configurationInformation. configurations. networkTokenServices. mastercardDigitalEnablementService. enableService

Indicates if provisioning of new network tokens for Mastercard is enabled or disabled. When this field is set to

true

, the provisioning of new network tokens for Mastercard is enabled.

Possible Values

true

false

Syntax

{
  "productInformation": {
    "selectedProducts": {
      "commerceSolutions": {
        "valueAddedServices": {
          "tokenManagement": {
            "configurationInformation": {
              "configurations": {
                "networkTokenServices": {
                  "mastercardDigitalEnablementService": {
                    "enableService": "true"
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.commerceSolutions.tokenManagement. configurationInformation.configurations.networkTokenServices. mastercardDigitalEnablementService.enableService

Product Enablement and Configuration Service API Field:

commerceSolutions.tokenManagement.configurationInformation.configurations. networkTokenServices.mastercardDigitalEnablementService.enableService

productInformation. selectedProducts. commerceSolutions. tokenManagement. configurationInformation. configurations. networkTokenEnrollment. networkTokenServices. mastercardDigitalEnablementService. enrollment

Indicates if token requestor ID (TRID) enrollment for Mastercard is enabled or disabled. When this field is set to

true

, TRID enrollment is enabled for Mastercard.

Possible Values

true

false

Syntax

{
  "productInformation": {
    "selectedProducts": {
      "commerceSolutions": {
        "valueAddedServices": {
          "tokenManagement": {
            "configurationInformation": {
              "configurations": {
                "networkTokenEnrollment": {
                  "networkTokenServices": {
                    "mastercardDigitalEnablementService": {
                      "enrollment": "true"
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.commerceSolutions.tokenManagement. configurationInformation.configurations.networkTokenServices. mastercardDigitalEnablementService.enrollment

Product Enablement and Configuration Service API Field:

commerceSolutions.tokenManagement.configurationInformation.configurations. networkTokenServices.mastercardDigitalEnablementService.enrollment

productInformation. selectedProducts. commerceSolutions. tokenManagement. configurationInformation. configurations. networkTokenServices. mastercardDigitalEnablementService. tokenRequestorId

This field is used to assign an existing token requestor ID (TRID) to aToken Management Service vault for Mastercard.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "commerceSolutions": {
        "valueAddedServices": {
          "tokenManagement": {
            "configurationInformation": {
              "configurations": {
                "networkTokenServices": {
                  "mastercardDigitalEnablementService": {
                    "tokenRequestorId": "12345678901"
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

The value of this field must conform to this regular expression:

^[0-9]{11}\\z$"

Specifications

Data Type:
String

Data Length:
11

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.commerceSolutions.tokenManagement. configurationInformation.configurations.networkTokenServices. mastercardDigitalEnablementService.tokenRequestorId

Product Enablement and Configuration Service API Field:

commerceSolutions.tokenManagement.configurationInformation.configurations. networkTokenServices.mastercardDigitalEnablementService.tokenRequestorId

productInformation. selectedProducts. commerceSolutions. tokenManagement. configurationInformation. configurations. networkTokenServices. notifications. enabled

Indicates if life-cycle management updates are enabled or disabled for the Token Management Service vault that is being configured.

When this field is set to

true

, life-cycle management updates are enabled for the Token Management Service vault that is being configured.

Possible Values

true

false

Syntax

{
  "productInformation": {
    "selectedProducts": {
      "commerceSolutions": {
        "valueAddedServices": {
          "tokenManagement": {
            "configurationInformation": {
              "configurations": {
                "networkTokenServices": {
                  "notifications": {
                    "enabled": "true"
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.commerceSolutions.tokenManagement. configurationInformation.configurations.networkTokenServices.notifications.enabled

Product Enablement and Configuration Service API Field:

commerceSolutions.tokenManagement.configurationInformation.configurations. networkTokenServices.notifications.enabled

productInformation. selectedProducts. commerceSolutions. tokenManagement. configurationInformation. configurations. networkTokenServices. synchronousProvisioning. enabled

Indicates if the synchronous provisioning service is enabled or disabled. When this field is set to

true

, network token provisioning responses will be returned in real time.

IMPORTANT

The synchronous provisioning feature is intended only for standalone Token Management Service (TMS) merchants and partners, such as Token Management Service aggregators. When you enable this feature for direct merchants, it could result in latency in the authorization response.

Possible Values

true

false

Syntax

{
  "productInformation": {
    "selectedProducts": {
      "commerceSolutions": {
        "valueAddedServices": {
          "tokenManagement": {
            "configurationInformation": {
              "configurations": {
                "networkTokenServices": {
                  "synchronousProvisioning": {
                    "enabled": "false"
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts. commerceSolutions.tokenManagement.configurationInformation.configurations. networkTokenServices.synchronousProvisioning.enabled

Product Enablement and Configuration Service API Field:

commerceSolutions.tokenManagement.configurationInformation.configurations. networkTokenServices.synchronousProvisioning.enabled

productInformation. selectedProducts. commerceSolutions. tokenManagement. configurationInformation. configurations. networkTokenServices. visaTokenService. enableTransactionalTokens

Indicates if the use of Visa network tokens in transactions is enabled or disabled. When this field is set to

true

, Visa network tokens can be used in transactions.

Possible Values

true

false

Syntax

{
  "productInformation": {
    "selectedProducts": {
      "commerceSolutions": {
        "valueAddedServices": {
          "tokenManagement": {
            "configurationInformation": {
              "configurations": {
                "networkTokenServices": {
                  "visaTokenService": {
                    "enableTransactionalTokens": "true"
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.commerceSolutions.tokenManagement. configurationInformation.configurations.networkTokenServices.visaTokenService. enableTransactionalTokens

Product Enablement and Configuration Service API Field:

commerceSolutions.tokenManagement.configurationInformation.configurations. networkTokenServices.visaTokenService.enableTransactionalTokens

productInformation. selectedProducts. commerceSolutions. tokenManagement. configurationInformation. configurations. networkTokenServices. visaTokenService. enableService

Indicates if provisioning of new network tokens for Visa is enabled or disabled. When this field is set to

true

, the provisioning of new network tokens for Visa is enabled.

Possible Values

true

false

Syntax

{
  "productInformation": {
    "selectedProducts": {
      "commerceSolutions": {
        "valueAddedServices": {
          "tokenManagement": {
            "configurationInformation": {
              "configurations": {
                "networkTokenServices": {
                  "visaTokenService": {
                    "enableService": "true"
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.commerceSolutions.tokenManagement. configurationInformation.configurations.networkTokenServices.visaTokenService.enableService

Product Enablement and Configuration Service API Field:

commerceSolutions.tokenManagement.configurationInformation.configurations. networkTokenServices.visaTokenService.enableService

productInformation. selectedProducts. commerceSolutions. tokenManagement. configurationInformation. configurations. networkTokenEnrollment. networkTokenServices. visaTokenService. enrollment

Indicates if token requestor ID (TRID) enrollment for Visa is enabled or disabled. When this field is set to

true

, TRID enrollment is enabled for Visa.

Possible Values

true

false

Syntax

{
  "productInformation": {
    "selectedProducts": {
      "commerceSolutions": {
        "valueAddedServices": {
          "tokenManagement": {
            "configurationInformation": {
              "configurations": {
                "networkTokenEnrollment": {
                  "networkTokenServices": {
                    "visaTokenService": {
                      "enrollment": "true"
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.commerceSolutions.tokenManagement. configurationInformation.configurations.networkTokenServices.visaTokenService.enrollment

Product Enablement and Configuration Service API Field:

commerceSolutions.tokenManagement.configurationInformation.configurations. networkTokenServices.visaTokenService.enrollment

productInformation. selectedProducts. commerceSolutions. tokenManagement. configurationInformation. configurations. networkTokenServices. visaTokenService. relationshipId

This field is used to assign an existing token requestor relationship ID to a Token Management Service vault for Visa.

Syntax

{
  "productInformation": {
    "selectedProducts": {
      "commerceSolutions": {
        "valueAddedServices": {
          "tokenManagement": {
            "configurationInformation": {
              "configurations": {
                "networkTokenServices": {
                  "visaTokenService": {
                    "relationshipId": "123456"
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
String

Minimum Data Length:
1

Maximum Data Length:
100

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.commerceSolutions.tokenManagement. configurationInformation.configurations.networkTokenServices.visaTokenService.relationshipId

Product Enablement and Configuration Service API Field:

commerceSolutions.tokenManagement.configurationInformation.configurations. networkTokenServices.visaTokenService.relationshipId

productInformation. selectedProducts. commerceSolutions. tokenManagement. configurationInformation. configurations. networkTokenServices. visaTokenService. tokenRequestorId

This field is used to assign an existing token requestor ID (TRID) to aToken Management Service vault for Visa.

Syntax

{
  "productInformation": {
    "selectedProducts": {
      "commerceSolutions": {
        "valueAddedServices": {
          "tokenManagement": {
            "configurationInformation": {
              "configurations": {
                "networkTokenServices": {
                  "visaTokenService": {
                    "tokenRequestorId": "12345678901"
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

The value of this field must conform to this regular expression:

^[0-9]{11}\\z$"

Specifications

Data Type:
String

Data Length:
11

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.commerceSolutions.tokenManagement. configurationInformation.configurations.networkTokenServices.visaTokenService.tokenRequestorId

Product Enablement and Configuration Service API Field:

commerceSolutions.tokenManagement.configurationInformation.configurations. networkTokenServices.visaTokenService.tokenRequestorId

productInformation. selectedProducts. commerceSolutions. tokenManagement. configurationInformation. configurations. parentProfileId

The parent profile identifier that is configured for the Token Management Service.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "commerceSolutions": {
        "valueAddedServices": {
          "tokenManagement": {
            "configurationInformation": {
              "configurations": {
                "parentProfileId": ""
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
String

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.commerceSolutions.tokenManagement. configurationInformation.configurations.parentProfileId

Product Enablement and Configuration Service API Field:

commerceSolutions.tokenManagement.configurationInformation.configurations.parentProfileId

productInformation. selectedProducts. commerceSolutions. tokenManagement. configurationInformation. configurations. templateId

The template identifier that is configured for the Token Management Service.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "commerceSolutions": {
        "valueAddedServices": {
          "tokenManagement": {
            "configurationInformation": {
              "configurations": {
                "templateId": "template1234"
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
String

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.commerceSolutions.tokenManagement. configurationInformation.configurations.templateId

Product Enablement and Configuration Service API Field:

commerceSolutions.tokenManagement.configurationInformation.configurations.templateId

productInformation. selectedProducts. commerceSolutions. tokenManagement. configurationInformation. configurations. vault. defaultTokenType

Indicates the default token type for the Token Management Service vault.

Possible Values

CUSTOMER

INSTRUMENT_IDENTIFIER

PAYMENT_INSTRUMENT

Syntax

{
  "productInformation": {
    "selectedProducts": {
      "commerceSolutions": {
        "valueAddedServices": {
          "tokenManagement": {
            "configurationInformation": {
              "configurations": {
                "vault": {
                  "defaultTokenType": "CUSTOMER"
                }
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Enum

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.commerceSolutions.tokenManagement. configurationInformation.configurations.vault.defaultTokenType

Product Enablement and Configuration Service API Field:

commerceSolutions.tokenManagement.configurationInformation.configurations. vault.defaultTokenType

productInformation. selectedProducts. commerceSolutions. tokenManagement. configurationInformation. configurations. vault. location

Indicates where the Token Management Service (TMS) vault and the stored tokens are located.

Possible Values

IDC

: Set to this value for TMS vaults located in the India data center.

GDC

: Set to this value for TMS vaults located in the global data center.

Syntax

{
  "productInformation": {
    "selectedProducts": {
      "commerceSolutions": {
        "valueAddedServices": {
          "tokenManagement": {
            "configurationInformation": {
              "configurations": {
                "vault": {
                  "location": "IDC"
                }
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Enum

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.commerceSolutions.tokenManagement. configurationInformation.configurations.vault.location

Product Enablement and Configuration Service API Field:

commerceSolutions.tokenManagement.configurationInformation.configurations.vault.location

productInformation. selectedProducts. commerceSolutions. tokenManagement. configurationInformation. configurations. vault. sensitivePrivileges. cardNumberMaskingFormat

Indicates which digits of the card number are be unmasked in the Token Management Service vault.

Possible Values

FIRST_6_LAST_4

LAST_4

MASKED

Syntax

{
  "productInformation": {
    "selectedProducts": {
      "commerceSolutions": {
        "valueAddedServices": {
          "tokenManagement": {
            "configurationInformation": {
              "configurations": {
                "vault": {
                  "sensitivePrivileges": {
                    "cardNumberMaskingFormat": "MASKED"
                  }
                }
              }
            }
          }
        }
      }
    }
  }

Specifications

Data Type:
Enum

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.commerceSolutions.tokenManagement. configurationInformation.configurations.vault.sensitivePrivileges.cardNumberMaskingFormat

Product Enablement and Configuration Service API Field:

commerceSolutions.tokenManagement.configurationInformation.configurations. vault.sensitivePrivileges.cardNumberMaskingFormat

productInformation. selectedProducts. commerceSolutions. tokenManagement. configurationInformation. configurations. vault. tokenFormats. customer

Indicates the token format for the customer tokens that are stored in the Token Management Service vault.

Possible Values

16_DIGIT

19_DIGIT

22_DIGIT

32_HEX

Syntax

{
  "productInformation": {
    "selectedProducts": {
      "commerceSolutions": {
        "valueAddedServices": {
          "tokenManagement": {
            "configurationInformation": {
              "configurations": {
                "vault": {
                  "tokenFormats": {
                    "customer": "16_DIGIT"
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Enum

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.commerceSolutions.tokenManagement. configurationInformation.configurations.vault.tokenFormats.customer

Product Enablement and Configuration Service API Field:

commerceSolutions.tokenManagement.configurationInformation.configurations. vault.tokenFormats.customer

productInformation. selectedProducts. commerceSolutions. tokenManagement. configurationInformation. configurations. vault. tokenFormats. instrumentIdentifierBankAccount

Indicates the token format for the instrument identifier tokens for bank accounts that are stored in the Token Management Service vault.

IMPORTANT

Account Updater does not support 22-digit instrument identifier tokens.

Possible Values

16_DIGIT

19_DIGIT

22_DIGIT

32_HEX

Syntax

{
  "productInformation": {
    "selectedProducts": {
      "commerceSolutions": {
        "valueAddedServices": {
          "tokenManagement": {
            "configurationInformation": {
              "configurations": {
                "vault": {
                  "tokenFormats": {
                    "instrumentIdentifierBankAccount": "16_DIGIT"
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Enum

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.commerceSolutions.tokenManagement. configurationInformation.configurations.vault.tokenFormats.instrumentIdentifierBankAccount

Product Enablement and Configuration Service API Field:

commerceSolutions.tokenManagement.configurationInformation.configurations. vault.tokenFormats.instrumentIdentifierBankAccount

productInformation. selectedProducts. commerceSolutions. tokenManagement. configurationInformation. configurations. vault. tokenFormats. instrumentIdentifierCard

Indicates the token format for the instrument identifier tokens for credit cards that are stored in the Token Management Service vault.

IMPORTANT

Account Updater does not support 22-digit instrument identifier tokens.

Possible Values

16_DIGIT

16_DIGIT_LAST_4

19_DIGIT

19_DIGIT_LAST_4

22_DIGIT

32_HEX

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "commerceSolutions": {
        "valueAddedServices": {
          "tokenManagement": {
            "configurationInformation": {
              "configurations": {
                "vault": {
                  "tokenFormats": {
                    "instrumentIdentifierCard": "16_DIGIT"
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Enum

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.commerceSolutions.tokenManagement. configurationInformation.configurations.vault.tokenFormats.instrumentIdentifierCard

Product Enablement and Configuration Service API Field:

commerceSolutions.tokenManagement.configurationInformation.configurations. vault.tokenFormats.instrumentIdentifierCard

productInformation. selectedProducts. commerceSolutions. tokenManagement. configurationInformation. configurations. vault. tokenFormats. paymentInstrument

Indicates the token format for the payment instrument tokens that are stored in the Token Management Service vault.

Possible Values

16_DIGIT

19_DIGIT

22_DIGIT

32_HEX

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "commerceSolutions": {
        "valueAddedServices": {
          "tokenManagement": {
            "configurationInformation": {
              "configurations": {
                "vault": {
                  "tokenFormats": {
                    "paymentInstrument": "16_DIGIT"
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Enum

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.commerceSolutions.tokenManagement. configurationInformation.configurations.vault.tokenFormats.paymentInstrument

Product Enablement and Configuration Service API Field:

commerceSolutions.tokenManagement.configurationInformation.configurations. vault.tokenFormats.paymentInstrument

productInformation. selectedProducts. commerceSolutions. tokenManagement. subscriptionInformation. enabled

Determines whether subscription information is enabled for Token Management Service.

Possible Values

true

false

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "commerceSolutions": {
        "valueAddedServices": {
          "tokenManagement": {
            "subscriptionInformation": {
              "enabled": "true"
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.commerceSolutions.tokenManagement. subscriptionInformation.enabled

Product Enablement and Configuration Service API Field:

commerceSolutions.tokenManagement.subscriptionInformation.enabled

productInformation. selectedProducts. commerceSolutions. tokenManagement. subscriptionInformation. selfServiceability

This field value indicates whether the organization can enable the Token Management Service using self service.

Possible Values

NOT_SELF_SERVICEABLE

(default)

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "commerceSolutions": {
        "valueAddedServices": {
          "tokenManagement": {
            "subscriptionInformation": {
              "selfServiceability": "NOT_SELF_SERVICEABLE"
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Enum

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.commerceSolutions.tokenManagement. subscriptionInformation.selfServiceability

Product Enablement and Configuration Service API Field:

commerceSolutions.tokenManagement.subscriptionInformation.selfServiceability

productInformation. selectedProducts. commerceSolutions. valueAddedServices. reporting. subscriptionInformation. enabled

Determines whether subscription information is enabled for Reporting.

Possible Values

true

false

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "commerceSolutions": {
        "valueAddedServices": {
          "reporting": {
            "subscriptionInformation": {
              "enabled": "true"
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.commerceSolutions.valueAddedServices. reporting.subscriptionInformation.enabled

Product Enablement and Configuration Service API Field:

commerceSolutions.valueAddedServices.reporting.subscriptionInformation.enabled

productInformation. selectedProducts. commerceSolutions. valueAddedServices. reporting. subscriptionInformation. selfServiceability

This field value indicates whether the organization can enable Reporting using self service.

Possible Values

NOT_SELF_SERVICEABLE

(default)

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "commerceSolutions": {
        "valueAddedServices": {
          "reporting": {
            "subscriptionInformation": {
              "selfServiceability": "NOT_SELF_SERVICEABLE"
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Enum

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.commerceSolutions.valueAddedServices. reporting.subscriptionInformation.selfServiceability

Product Enablement and Configuration Service API Field:

commerceSolutions.valueAddedServices.reporting. subscriptionInformation.selfServiceability

productInformation. selectedProducts. commerceSolutions. valueAddedServices. transactionSearch. subscriptionInformation. enabled

Determines whether subscription information is enabled for Transaction Search.

Possible Values

true

false

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "commerceSolutions": {
        "valueAddedServices": {
          "transactionSearch": {
            "subscriptionInformation": {
              "enabled": "true"
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.commerceSolutions.valueAddedServices. transactionSearch.subscriptionInformation.enabled

Product Enablement and Configuration Service API Field:

commerceSolutions.valueAddedServices.transactionSearch. subscriptionInformation.enabled

productInformation. selectedProducts. commerceSolutions. valueAddedServices. transactionSearch. subscriptionInformation. selfServiceability

This field value indicates whether the organization can enable Transaction Search using self service.

Possible Values

NOT_SELF_SERVICEABLE

(default)

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "commerceSolutions": {
        "valueAddedServices": {
          "transactionSearch": {
            "subscriptionInformation": {
              "selfServiceability": "NOT_SELF_SERVICEABLE"
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Enum

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.commerceSolutions.valueAddedServices. transactionSearch.subscriptionInformation.selfServiceability

Product Enablement and Configuration Service API Field:

commerceSolutions.valueAddedServices.transactionSearch. subscriptionInformation.selfServiceability

productInformation. selectedProducts. payments. cardPresentConnect. configurationInformation. configurations. partnerSolutionIdentifier

The solution identifier that is used to associate a partner organization with the onboarded merchant.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardPresentConnect": {
          "configurationInformation": {
            "configurations": {
              "partnerSolutionIdentifier": "partner01"
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
String

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardPresentConnect. configurationInformation.configurations.partnerSolutionIdentifier

Product Enablement and Configuration Service API Field:

payments.cardPresentConnect.configurationInformation. configurations.partnerSolutionIdentifier

productInformation. selectedProducts. payments. cardPresentConnect. configurationInformation. templateId

The template identifier that is configured in Card Present Connect.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardPresentConnect": {
          "configurationInformation": {
            "templateId": "template123"
          }
        }
      }
    }
  }
}

Specifications

Data Type:
String

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardPresentConnect. configurationInformation.templateId

Product Enablement and Configuration Service API Field:

payments.cardPresentConnect.configurationInformation.templateId

productInformation. selectedProducts. payments. cardPresentConnect. subscriptionInformation. enabled

This field indicates if subscription information is enabled or disabled for Card Present Connect.

Possible Values

true

false

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardPresentConnect": {
          "subscriptionInformation": {
            "enabled": "true"
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardPresentConnect. subscriptionInformation.enable

d

Product Enablement and Configuration Service API Field:

payments.cardPresentConnect.subscriptionInformation.enabled

productInformation. selectedProducts. payments. cardPresentConnect. subscriptionInformation. selfServiceability

This field value indicates whether the organization can enable Card Present Connect using self service.

Possible Values

NOT_SELF_SERVICEABLE

(default)

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardPresentConnect": {
          "subscriptionInformation": {
            "selfServiceability": "NOT_SELF_SERVICEABLE"
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Enum

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardPresentConnect. subscriptionInformation.selfServiceability

Product Enablement and Configuration Service API Field:

payments.cardPresentConnect.subscriptionInformation.selfServiceability

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. allowCapturesGreaterThanAuthorizations

If set to

true

, this field indicates that the merchant account is enabled to capture amounts that are greater than the authorization amount.

This field is available for these processors: Chase Paymentech Solutions, Chase Paymentech Tandem, GPX and Visa Platform Connect.

Possible Values

true

false

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
              "common": {
                "allowCapturesGreaterThanAuthorizations": "true"
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API
:

productInformation.selectedProducts.payments.cardProcessing. configurationInformation.configurations.common.allowCapturesGreaterThanAuthorizations

Product Enablement and Configuration Service API
:

payments.cardProcessing. configurationInformation.configurations.common.allowCapturesGreaterThanAuthorization

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. amexVendorCode

The vendor code that is assigned by American Express.

This field is available for these processors: TSYS Acquiring Solutions.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
              "common": {
                "amexVendorCode": "vendor123"
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
String

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardProcessing. configurationInformation.configurations.common.amexVendorCode

Product Enablement and Configuration Service API Field:

payments.cardProcessing. configurationInformation.configurations.common.amexVendorCode

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. creditCardRefundLimitPercent

Percentage refund limit. Over-refunds are blocked when the aggregated refund amount is higher than the percentage that is set for this field.

This field is available for these processors: Chase Paymentech Solutions, GPX, and Visa Platform Connect.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
              "common": {
                "creditCardRefundLimitPercent": "75"
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
String

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardProcessing. configurationInformation.configurations.common.creditCardRefundLimitPercent

Product Enablement and Configuration Service API Field:

payments.cardProcessing.configurationInformation.configurations.common. creditCardRefundLimitPercent

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. defaultAuthTypeCode

Authorization finality indicator. Request value can be in lowercase or capitalized letters.

This field is available for these processors: Barclays, Barclays Merchant Services, Chase Paymentech Solutions, Chase Paymentech Tandem, Elavon Americas, FDMS Nashville, FDC Nashville Global, GPN, GPX, SIX, Streamline, Visa Platform Connect, and TSYS Acquiring Solutions.

Possible Values

FINAL

PRE

UNDEFINED

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
              "common": {
                "defaultAuthTypeCode": "UNDEFINED"
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Enum

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardProcessing. configurationInformation.configurations.common.defaultAuthTypeCode

Product Enablement and Configuration Service API Field:

payments.cardProcessing. configurationInformation.configurations.common.defaultAuthTypeCode

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. domesticMerchantId

The local merchant identifier that is used by merchants in addition to the conventional merchant identifier. This value is sent to the issuer.

This field is available for these processors: Prisma and Visa Platform Connect.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
              "common": {
                "domesticMerchantId": "merchtest1"
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
String

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardProcessing. configurationInformation.configurations.common.domesticMerchantId

Product Enablement and Configuration Service API Field:

payments.cardProcessing. configurationInformation.configurations.common.domesticMerchantId

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. businessCenterCreditCardRefundLimitPercent

Percentage refund limit. This field limits refunds to the percentage that is set in this field value.

This field is available for these processors: GPX and Visa Platform Connect.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
              "common": {
                "creditCardRefundLimitPercent": "100"
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
String

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardProcessing. configurationInformation.configurations.common.businessCenterCreditCardRefundLimitPercent

Product Enablement and Configuration Service API Field:

payments.cardProcessing. configurationInformation.configurations.common.businessCenterCreditCardRefundLimitPercent

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. enableDuplicateMerchantReferenceNumberBlocking

Indicates if duplicate merchant reference numbers are blocked for transactions.

This field is available for these processors: Chase Paymentech Solutions, GPX, and Visa Platform Connect.

Possible Values

true

false

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
              "common": {
                "enableDuplicateMerchantReferenceNumberBlocking": "true"
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardProcessing. configurationInformation.configurations.common.enableDuplicateMerchantReferenceNumberBlocking

Product Enablement and Configuration Service API Field:

payments.cardProcessing. configurationInformation.configurations.common.enableDuplicateMerchantReferenceNumberBlocking

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. enableInterchangeOptimization

When this field is set to

true

, your interchange fees are reduced by using automatic authorization refresh and automatic partial authorization reversal.

This field is available for these processors: Visa Platform Connect.

Possible Values

true

false

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
              "common": {
                "enableInterchangeOptimization": "true"
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardProcessing. configurationInformation.configurations.common.enableInterchangeOptimization

Product Enablement and Configuration Service API Field:

payments.cardProcessing. configurationInformation.configurations.common.enableInterchangeOptimization

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. enablePartialAuth

When this field is set to

true

, it enables merchants to accept partial authorization approvals.

This field is available for these processors: American Express Direct, Chase Paymentech Solutions, Chase Paymentech Tandem, Elavon Americas, GPN, GPX, FDC Nashville Global, FDMS Nashville, Visa Platform Connect, and TSYS Acquiring Solutions.

Possible Values

true

false

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
              "common": {
                "enablePartialAuth": "true"
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardProcessing. configurationInformation.configurations.common.enablePartialAuth

Product Enablement and Configuration Service API Field:

payments.cardProcessing. configurationInformation.configurations.common.enablePartialAuth

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. enableSplitShipment

When this field is set to

true

, it enables merchants to split an order into multiple shipments with multiple captures. This feature is provided by Visa Acceptance Solutions and supports three different scenarios:

Multiple authorizations

Multiple captures

Multiple authorizations with multiple captures

This field is available for these processors: Visa Platform Connect.

Possible Values

true

false

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
              "common": {
                "enableSplitShipment": "true"
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardProcessing. configurationInformation.configurations.common.enableSplitShipment

Product Enablement and Configuration Service API Field:

payments.cardProcessing. configurationInformation.configurations.common.enableSplitShipment

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. foodAndConsumerServiceId

Food and consumer service identifier. This field identifies that the merchant is certified and approved to accept food stamps.

This field is available for this processor: GPX.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
              "common": {
                "foodAndConsumerServiceId": "1234"
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
String

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardPresentConnect.configurationInformation. configurations.common.foodAndConsumerServiceId

Product Enablement and Configuration Service API Field:

payments.cardPresentConnect.configurationInformation.configurations.common.foodAndConsumerServiceId

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. masterCardAssignedId

The identifier that is assigned by Mastercard. This field is the equivalent of merchant verification value (MVV) that is assigned by Visa.

This field is available for these processors: FDC Nashville Global, GPX, and Visa Platform Connect.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
              "common": {
                "masterCardAssignedId": "000"
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
String

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardPresentConnect.configurationInformation. configurations.common.masterCardAssignedId

Product Enablement and Configuration Service API Field:

payments.cardPresentConnect.configurationInformation.configurations.common.masterCardAssignedId

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. merchantCategoryCode

A 4-digit code used to classify the business by the type of goods and services it provides.

This number is assigned by the merchant acquiring bank.

This field is available for these processors: American Express Direct (required), Barclays, Barclays Merchant Services, Chase Paymentech Solutions, Chase Paymentech Tandem, China UnionPay, Credit Mutuel-CIC, Elavon Americas, FDC Nashville Global, GPN, GPX, Prisma, RuPay, TSYS Acquiring Solutions, and Visa Platform Connect.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
              "common": {
                "merchantCategoryCode": "1234"
              }
            }
          }
        }
      }
    }
  }
}

The value for this field must conform to this regular expression:

^[0-9]+$

Specifications

Data Type:
String

Minimum Data Length:
4

Maximum Data Length:
4

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardPresentConnect.configurationInformation. configurations.common.merchantCategoryCode

Product Enablement and Configuration Service API Field:

payments.cardPresentConnect.configurationInformation.configurations.common.merchantCategoryCode

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. merchantDescriptorInformation. city

City for the merchant business location. This value might be displayed on the cardholder’s statement.

This field is available for these processors: American Express Direct, Elavon Americas, RuPay, and TSYS Acquiring Solutions.

Syntax

{
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
              "common": {
                "merchantDescriptorInformation": {
                  "city": "Boston"
                }
              }
            }
          }
        }
      }
    }
  }
}

American Express Direct and RuPay:

The syntax must conform to this regular expression:

^[0-9a-zA-Z\s]+$

TSYS Acquiring Solutions:

The syntax must conform to this regular expression:

%5E%5B0-9a-zA-Z%5D%2B%24

Specifications

Data Type:
String

Minimum Data Length:

Elavon Americas:
0

All other processors:
1

Maximum Data Length:

American Express Direct:
21

All other processors:
13

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardPresentConnect.configurationInformation. configurations.common.merchantDescriptorInformation.city

Product Enablement and Configuration Service API Field:

payments.cardPresentConnect.configurationInformation.configurations. common.merchantDescriptorInformation.city

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. merchantDescriptorInformation. country

Country of origin for the merchant's business.

Use the ISO Alpha-2 country code described in the ISO 3166 standard.

Use the ISO Alpha-3 country code described in the ISO 3166 standard.

For more information, see: iso-3166-country-codes.html

This field is available for these processors: American Express Direct (required), Elavon Americas, SIX, and TSYS Acquiring Solutions.

Syntax

{
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
              "common": {
                "merchantDescriptorInformation": {
                  "country": "CAN"
                }
              }
            }
          }
        }
      }
    }
  }
}

The syntax must conform to this regular expression:

American Express Direct

^[A-Z]+$

All other processors

%5E%5B0-9a-zA-Z%5D%2B%24

Specifications

Data Type:
String

Minimum Data Length:

Elavon Americas:
2

All other processors:
3

Maximum Data Length:

Elavon Americas:
2

All other processors:
3

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardPresentConnect.configurationInformation. configurations.common.merchantDescriptorInformation.country

Product Enablement and Configuration Service API Field:

payments.cardPresentConnect.configurationInformation.configurations. common.merchantDescriptorInformation.country

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. merchantDescriptorInformation. name

Merchant business name.

This name is displayed on the cardholder’s statement. When you include more than one consecutive space, extra spaces are removed. When used with Payer Authentication, this field is the company’s name as it appears to the customer in the issuing bank’s authentication form. This value overrides the value specified by the merchant bank.

This field is available for these processors: American Express Direct (required), Elavon Americas, RuPay, and TSYS Acquiring Solutions.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
              "common": {
                "merchantDescriptorInformation": {
                  "name": "Merchant Name"
                }
              }
            }
          }
        }
      }
    }
  }
}

The syntax must conform to this regular expression:

^[0-9a-zA-Z\s]+$

Specifications

Data Type:
String

Minimum Data Length:
1

Maximum Data Length:
38

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardPresentConnect.configurationInformation. configurations.common.merchantDescriptorInformation.name

Product Enablement and Configuration Service API Field:

payments.cardPresentConnect.configurationInformation.configurations. common.merchantDescriptorInformation.name

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. merchantDescriptorInformation. phone

Merchant phone number.

This field is available for these processors: American Express Direct (required), Elavon Americas, RuPay, and TSYS Acquiring Solutions.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
              "common": {
                "merchantDescriptorInformation": {
                  "phone": "5554327113"
                }
              }
            }
          }
        }
      }
    }
  }
}

The syntax must conform to this regular expression:

^[0-9a-zA-Z\s]+$

Specifications

Data Type:
String

Minimum Data Length:
1

Maximum Data Length:
20

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardPresentConnect.configurationInformation. configurations.common.merchantDescriptorInformation.phone

Product Enablement and Configuration Service API Field:

payments.cardPresentConnect.configurationInformation.configurations. common.merchantDescriptorInformation.phone

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. merchantDescriptorInformation. state

State code or region code of the merchant business location.

Use the standard state, province, and territory codes for the US and Canada. This field is supported only for businesses located in the US or Canada. This value must consist of English characters. This value might be displayed on the cardholder’s statement.

This field is available for these processors: American Express Direct (required), Elavon Americas, RuPay, and TSYS Acquiring Solutions.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
              "common": {
                "merchantDescriptorInformation": {
                  "state": "TX"
                }
              }
            }
          }
        }
      }
    }
  }
}

The syntax must conform to this regular expression:

^[A-Z]+$

Specifications

Data Type:
String

Minimum Data Length:
1

Maximum Data Length:
3

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardPresentConnect.configurationInformation. configurations.common.merchantDescriptorInformation.state

Product Enablement and Configuration Service API Field:

payments.cardPresentConnect.configurationInformation. configurations.common.merchantDescriptorInformation.state

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. merchantDescriptorInformation. street

Street address of the merchant business location.

This value must consist of English characters. This value might be displayed on the cardholder’s statement.

This field is available for these processors: American Express Direct (required), Elavon Americas, and TSYS Acquiring Solutions.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
              "common": {
                "merchantDescriptorInformation": {
                  "street": "123 Main St"
                }
              }
            }
          }
        }
      }
    }
  }
}

The syntax must conform to this regular expression:

^[0-9a-zA-Z\s]+$

Specifications

Data Type:
String

Minimum Data Length:
1

Maximum Data Length:
38

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardPresentConnect.configurationInformation. configurations.common.merchantDescriptorInformation.street

Product Enablement and Configuration Service API Field:

payments.cardPresentConnect.configurationInformation. configurations.common.merchantDescriptorInformation.street

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. merchantDescriptorInformation. url

URL of the merchant website.

This field is available for these processors: American Express Direct and RuPay.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
              "common": {
                "merchantDescriptorInformation": {
                  "url": "http://www.merchwebsite.com"
                }
              }
            }
          }
        }
      }
    }
  }
}

American Express Direct:

The syntax must conform to this regular expression:

^(((ht|f)tp(s?):\/\/[^\.])|www\.)[-a-zA-Z0-9+&@#/%=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]$

RuPay:

The syntax must conform to this regular expression:

%5E%28%28%28ht%7Cf%29tp%28s%3F%29%3A%5C%2F%5C%2F%5B%5E%5C.%5D%29%7Cwww%5C.%29%5B-a-zA-Z0-9%2B%26amp%3B%40%23%2F%25%3D%7E_%7C%21%3A%2C.%3B%5D*%5B-a-zA-Z0-9%2B%26amp%3B%40%23%2F%25%3D%7E_%7C%5D%24

Specifications

Data Type:
String

Minimum Data Length:

American Express Direct:
1

RuPay:
0

Maximum Data Length:

American Express Direct:
40

RuPay:
128

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardPresentConnect.configurationInformation. configurations.common.merchantDescriptorInformation.url

Product Enablement and Configuration Service API Field:

payments.cardPresentConnect.configurationInformation.configurations. common.merchantDescriptorInformation.url

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. merchantDescriptorInformation. zip

Postal code of the merchant business location.

This value might be displayed on the cardholder’s statement.

If your business is located in the US, you can use a 5-digit or 9-digit postal code. A 9-digit postal code must follow this format: [5 digits][dash][4 digits]

Example:
12345-6789

If your business is domiciled in Canada, use a 6-digit postal code. A 6-digit postal code must follow this format: [alpha][numeric][alpha][space] [numeric][alpha][numeric]

Example:
A1B 2C3

This field is available for these processors: American Express Direct (required), Elavon Americas, RuPay, and TSYS Acquiring Solutions.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
              "common": {
                "merchantDescriptorInformation": {
                  "zip": "12345-6789"
                }
              }
            }
          }
        }
      }
    }
  }
}

The syntax must conform to this regular expression:

^[0-9a-zA-Z\s]+$

Specifications

Data Type:
String

Minimum Data Length:
1

Maximum Data Length:
15

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardPresentConnect.configurationInformation. configurations.common.merchantDescriptorInformation.zip

Product Enablement and Configuration Service API Field:

payments.cardPresentConnect.configurationInformation. configurations.common.merchantDescriptorInformation.zip

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. preferCobadgedSecondaryBrand

Indicates the merchant's preference on secondary card brand for routing in the case of co-branded cards.

This field is available for this processor: eftpos.

Possible Values

true

false

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
              "common": {
                "preferCobadgedSecondaryBrand": "true"
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardProcessing.configurationInformation. configurations.common.preferCobadgedSecondaryBrand

Product Enablement and Configuration Service API Field:

payments.cardProcessing.configurationInformation.configurations. common.preferCobadgedSecondaryBrand

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. processLevel3Data

Indicates whether the merchant processes Level III transactions.

This field is available for these processors: Barclays Merchant Services Chase Paymentech Solutions, Chase Paymentech Tandem,FDC Nashville Global, Elavon Americas, and TSYS Acquiring Solutions.

Possible Values

true

false

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
              "common": {
                "processLevel3Data": "true"
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardProcessing.configurationInformation. configurations.common.processLevel3Data

Product Enablement and Configuration Service API Field:

payments.cardProcessing.configurationInformation.configurations. common.processLevel3Data

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. features. cardNotPresent. amexTransactionAdviceAddendum1

Transaction advice addendum field that is used to display descriptive information about a transaction on a customer’s American Express card statement.

This field is available for these processors: American Express Direct, FDC Nashville Global, and TSYS Acquiring Solutions.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
                "features": {
                  "cardNotPresent": {
                    "amexTransactionAdviceAddendum1": "amextaa"
                 }
               }
            }
          }
        }
      }
    }
  }
}

The syntax must conform to this regular expression:

^[0-9a-zA-Z\-\s.]+$

Specifications

Data Type:
String

Minimum Data Length:
1

Maximum Data Length:

American Express Direct and TSYS Acquiring Solutions:
40

FDC Nashville Global
: 23

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardProcessing. configurationInformation.configurations.features.cardNotPresent.amexTransactionAdviceAddendum1

Product Enablement and Configuration Service API Field:

payments.cardProcessing. configurationInformation.configurations.features.cardNotPresent.amexTransactionAdviceAddendum1

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. features. cardNotPresent. ignoreAddressVerificationSystem

Flag for a sale request that indicates whether to allow the capture service to run when the authorization receives a address verification system (AVS) decline.

This field is available for these processors: Barclays, Barclays HISO, Barclays Merchant Services, FDC Nashville Global, GPN, GPX, and Visa Platform Connect.

Possible Values

true

false

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
                "features": {
                  "cardNotPresent": {
                    "ignoreAddressVerificationSystem": "false"
                 }
               }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardPresentConnect.configurationInformation. configurations.features.cardNotPresent.ignoreAddressVerificationSystem

Product Enablement and Configuration Service API Field:

payments.cardPresentConnect.configurationInformation. configurations.features.cardNotPresent.ignoreAddressVerificationSystem

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. features. cardNotPresent. installment. enableInstallment

When set to

true

, this field enables installment plan programs.

This field is available for these processors: American Express Direct, Fiserv, and Vero.

Possible Values

true

false

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
                "features": {
                  "cardNotPresent": {
                    "installment": {
                      "enableInstallment": "true"
                   }
                 }
               }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardPresentConnect.configurationInformation. configurations.features.cardNotPresent.installment.enableInstallment

Product Enablement and Configuration Service API Field:

payments.cardPresentConnect.configurationInformation. configurations.features.cardNotPresent.installment.enableInstallment

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. features. cardNotPresent. installment. installmentPlan

Indicates the type of funding for the installment plan that is associated with the payment.

This field is available for these processors: American Express Direct, Fiserv, and Vero.

Possible Values

issuer

: Issuer-funded installment plan

merchant

: Merchant-funded installment plan

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
                "features": {
                  "cardNotPresent": {
                    "installment": {
                      "installmentPlan": "merchant"
                   }
                 }
               }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Enum

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardPresentConnect.configurationInformation. configurations.features.cardNotPresent.installment.installmentPlan

Product Enablement and Configuration Service API Field:

payments.cardPresentConnect.configurationInformation. configurations.features.cardNotPresent.installment.installmentPlan

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. features. cardNotPresent. processors.[processorName]. enableEmsTransactionRiskScore

Indicates if Mastercard Expert Monitoring Solutions (EMS) is enabled. EMS provides a predictive, behavior-based fraud score in real time during authorizations for card-not-present transactions on cards issued in the US.

This field is available for these processors: GPX and Visa Platform Connect.

Possible Values

true

false

Syntax

  {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
                "features": {
                  "cardNotPresent": {
                    "processors": [
                      "<processor>": {
                        "enableEmsTransactionRiskScore": "true"
                     }
                   ]
                 }
               }
            }
          }
        }
      }
    }
  }
}

<processor>
: The processor that is associated with the merchant account.

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardPresentConnect.configurationInformation. configurations.features.cardNotPresent.processors.[processorName].enableEmsTransactionRiskScore

Product Enablement and Configuration Service API Field:

payments.cardPresentConnect.configurationInformation.configurations. features.cardNotPresent.processors.[processorName].enableEmsTransactionRiskScore

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. features. cardNotPresent. processors.[processorName]. payouts. acquiringInstitutionId

The identifier of the financial institution that is acting as the acquirer of a customer transaction. The acquirer is the member or system user that signed the merchant. This number is typically assigned by Visa.

This field is available for these processors: Visa Platform Connect.

Syntax

  {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
                "features": {
                  "cardNotPresent": {
                    "processors": [
                      "ctv": {
                        "payouts": {
                          "acquiringInstitutionId": "12345"
                       }
                     }
                   ]
                 }
              }
            }
          }
        }
      }
    }
  }
}

<processor>
: The processor that is associated with the merchant account.

Specifications

Data Type:
String

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardPresentConnect.configurationInformation. configurations.features.cardNotPresent.processors.[processorName].payouts.acquiringInstitutionId

Product Enablement and Configuration Service API Field:

payments.cardPresentConnect.configurationInformation.configurations. features.cardNotPresent.processors.[processorName].payouts.acquiringInstitutionId

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. features. cardNotPresent. processors.[processorName]. payouts. businessApplicationId

Payout transaction type. This field is a pass-through
, which means that the value is not verified or modified in any way before it is sent to the processor.

You can provide a business application ID in this field or in your account. When a request includes this field, the value in the field overrides the information in your account. Call customer support to update your account information.

This field is available for these processors: GPX and Visa Platform Connect.

Possible Values

For Payouts transactions on Visa Platform Connect

BB

: Business to business.

CB

: Consumer Bill Payment

FD

: Funds disbursement (general), including:

Commission payments

Digital goods or games

Insurance payments

Loan disbursements

Lottery payouts

Shared economy

Non-government-initiated tax refund services such as tax preparation businesses

GD

: Government disbursement, including:

Government-initiated tax refunds

Government benefit and welfare disbursements

GP

: Gambling payout other than online gambling.

LO

: Loyalty credits and rebates (not supported in European systems).

MD

: Merchant disbursement (acquirers or aggregators settling to merchants).

OG

: Online gambling payout.

PD

: Payroll pension disbursement.

WT

: Wallet transfer.

Possible values:

PP

: Person to person

RP

: Request to pay.

Syntax

  {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
                "features": {
                  "cardNotPresent": {
                    "processors": [
                      "<processor>": {
                        "payouts": {
                          "businessApplicationId": ""
                       }
                     }
                   ]
                 }
               }
            }
          }
        }
      }
    }
  }
}

<processor>
: The processor that is associated with the merchant account.

Specifications

Data Type:
String

Maximum Data Length:
2

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardPresentConnect.configurationInformation. configurations.features.cardNotPresent.processors.[processorName].payouts.businessApplicationId

Product Enablement and Configuration Service API Field:

payments.cardPresentConnect.configurationInformation.configurations. features.cardNotPresent.processors.[processorName].payouts.businessApplicationId

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. features. cardNotPresent. processors.[processorName]. payouts. currencies.[currency]. enabledCnp

Indicates whether the card-not-present transaction is activated for the selected currency.

If both of these fields are set to

null

:

productInformation.selectedProducts.payments.cardProcessing.configurationInformation. configurations.common.features.cardNotPresent.processors.[processorName].payouts.currencies.[currency].enabledCp

productInformation.selectedProducts.payments.cardProcessing.configurationInformation. configurations.common.features.cardNotPresent.processors.[processorName].payouts.currencies.[currency].enabledCnp

Then this field will be set to

true

:

productInformation.selectedProducts.payments.cardProcessing.configurationInformation. configurations.common.features.cardNotPresent.processors.[processorName].payouts.currencies.[currency].enabledCnp

Syntax

  {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
                "features": {
                  "cardNotPresent": {
                    "processors": [
                      "<processor>": {
                        "payouts": {
                          "currencies": [
                            "<currency>": {
                              "enabledCnp": "true"
                           }
                         ]
                       }
                     }
                   ]
                }
              }
            }
          }
        }
      }
    }
  }
}

<processor>
: The processor that is associated with the merchant account.

<currency>
: The currency that is supported by the merchant.

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardPresentConnect.configurationInformation. configurations.features.cardNotPresent.processors.[processorName].payouts.currencies.[currency].enabledCnp

Product Enablement and Configuration Service API Field:

payments.cardPresentConnect.configurationInformation.configurations. features.cardNotPresent.processors.[processorName].payouts.currencies.[currency].enabledCnp

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. features. cardNotPresent. processors.[processorName]. payouts. currencies.[currency]. enabledCp

Indicates whether the card-not-present transaction is activated for the selected currency.

If both of these fields are set to

null

:

productInformation.selectedProducts.payments.cardProcessing.configurationInformation. configurations.common.features.cardNotPresent.processors.[processorName].payouts.currencies.[currency].enabledCp

productInformation.selectedProducts.payments.cardProcessing.configurationInformation. configurations.common.features.cardNotPresent.processors.[processorName].payouts.currencies.[currency].enabledCnp

Then this field will be set to

true

:

productInformation.selectedProducts.payments.cardProcessing.configurationInformation. configurations.common.features.cardNotPresent.processors.[processorName].payouts.currencies.[currency].enabledCp

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
                "features": {
                  "cardNotPresent": {
                    "processors": [
                      "<processor>": {
                        "payouts": {
                          "currencies": [
                            "<currency>": {
                              "enabledCp": "true"
                           }
                         ]
                      }
                    ]
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

<processor>
: The processor that is associated with the merchant account.

<currency>
: The currency that is supported by the merchant.

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardPresentConnect.configurationInformation. configurations.features.cardNotPresent.processors.[processorName].payouts.currencies.[currency].enabledCp

Product Enablement and Configuration Service API Field:

payments.cardPresentConnect.configurationInformation.configurations. features.cardNotPresent.processors.[processorName].payouts.currencies.[currency].enabledCp

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. features. cardNotPresent. processors.[processorName]. payouts. currencies.[currency]. enabled

Indicates which payout currencies are enabled.

Possible Values

true

false

Syntax

  {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
                "features": {
                  "cardNotPresent": {
                    "processors": [
                      "<processor>": {
                        "payouts": {
                          "currencies": [
                            "<currency>": {
                              "enabled": "true"
                           }
                         ]
                       }
                     }
                   ]
                }
              }
            }
          }
        }
      }
    }
  }
}

<processor>
: The processor that is associated with the merchant account.

<currency>
: The currency that is supported by the merchant.

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardPresentConnect.configurationInformation. configurations.features.cardNotPresent.processors.[processorName].payouts.currencies.[currency].enabled

Product Enablement and Configuration Service API Field:

payments.cardPresentConnect.configurationInformation.configurations. features.cardNotPresent.processors.[processorName].payouts.currencies.[currency].enabled

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. features. cardNotPresent. processors.[processorName]. payouts. currencies. [currency]. merchantId

The merchant identifier that is assigned by an acquirer or a processor. This field should not be overridden by any other party.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
                "features": {
                  "cardNotPresent": {
                    "processors": [
                      "<processor>": {
                        "payouts": {
                          "currencies": [
                            "<currency>": {
                              "merchantId": "testmerch"
                           }
                         ]
                       }
                    ]
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

<processor>
: The processor that is associated with the merchant account.

<currency>
: The currency that is supported by the merchant.

The syntax must conform to this regular expression:

^[0-9]+$

Specifications

Data Type:
String

Minimum Data Length:
1

Maximum Data Length:
11

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardPresentConnect.configurationInformation. configurations.features.cardNotPresent.processors.[processorName].payouts.currencies.[currency].merchantId

Product Enablement and Configuration Service API Field:

payments.cardPresentConnect.configurationInformation.configurations. features.cardNotPresent.processors.[processorName].payouts.currencies.[currency].merchantId

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. features. cardNotPresent. processors.[processorName]. payouts. currencies.[currency]. serviceEnablementNumber

The service enablement number (SE number).

A unique 10-digit number assigned by American Express to a merchant that accepts American Express cards that are provided by the acquiring bank. This number might be unique for each currency.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
                "features": {
                  "cardNotPresent": {
                    "processors": [
                      "<processor>": {
                        "payouts": {
                          "currencies": [
                            "<currency>": {
                              "serviceEnablementNumber": "0123456789"
                           }
                         ]
                       }
                    ]
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

<processor>
: The processor that is associated with the merchant account.

<currency>
: The currency that is supported by the merchant.

The value of this field must conform to this regular expression:

 ^[0-9]+$

Specifications

Data Type:
String

Minimum Data Length:
10

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardPresentConnect.configurationInformation. configurations.features.cardNotPresent.processors.[processorName].payouts.currencies.[currency].serviceEnablementNumber

Product Enablement and Configuration Service API Field:

payments.cardPresentConnect.configurationInformation.configurations. features.cardNotPresent.processors.[processorName].payouts.currencies.[currency].serviceEnablementNumber

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. features. cardNotPresent. processors.[processorName]. payouts. currencies.[currency]. terminalId

The terminal ID that is used with the payment processor. Depending on the processor and payment acceptance type, this field value may also be the default terminal ID that is used for card-present and virtual terminal transactions.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
                "features": {
                  "cardNotPresent": {
                    "processors": [
                      "<processor>": {
                        "payouts": {
                          "currencies": [
                            "<currency>": {
                              "terminalId": "018284"
                           }
                         ]
                       }
                    ]
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

<processor>
: The processor that is associated with the merchant account.

<currency>
: The currency that is supported by the merchant.

The value of this field must conform to this regular expression:

 ^[0-9:\-]+$

Specifications

Data Type:
String

Minimum Data Length:
1

Maximum Data Length:
255

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardPresentConnect.configurationInformation. configurations.features.cardNotPresent.processors.[processorName].payouts.currencies.[currency].terminalId

Product Enablement and Configuration Service API Field:

payments.cardPresentConnect.configurationInformation.configurations. features.cardNotPresent.processors.[processorName].payouts.currencies.[currency].terminalId

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. features. cardNotPresent. processors.[processorName]. payouts. currencies.[currency]. terminalIds

The terminal IDs that are used with the payment processor.

This field is available for this processor: Prisma.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
                "features": {
                  "cardNotPresent": {
                    "processors": [
                      "prisma": {
                        "payouts": {
                          "currencies": [
                            "<currency>": {
                              "terminalIds": "190238"
                           }
                         ]
                       }
                    ]
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

<currency>
: The currency that is supported by the merchant.

Specifications

Data Type:
String

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardPresentConnect.configurationInformation. configurations.features.cardNotPresent.processors.[processorName].payouts.currencies.[currency].terminalIds

Product Enablement and Configuration Service API Field:

payments.cardPresentConnect.configurationInformation.configurations. features.cardNotPresent.processors.[processorName]payouts.currencies.[currency].terminalIds

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. features. cardNotPresent. processors.[processorName]. payouts. financialInstitutionId

Financial institution identifier that is used with the payment processor.

This field is available for these processors: GPX and Visa Platform Connect.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
                "features": {
                  "cardNotPresent": {
                    "processors": [
                      "<processor>": {
                        "payouts": {
                          "financialInstitutionId": "01234"
                       }
                     }
                   ]
                }
              }
            }
          }
        }
      }
    }
  }
}

<processor>
: The processor that is associated with the merchant account.

Specifications

Data Type:
String

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardPresentConnect.configurationInformation. configurations.features.cardNotPresent.processors.[processorName].payouts.financialInstitutionId

Product Enablement and Configuration Service API Field:

payments.cardPresentConnect.configurationInformation.configurations. features.cardNotPresent.processors.[processorName].payouts.financialInstitutionId

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. features. cardNotPresent. processors.[processorName]. payouts. merchantAbaNumber

Routing number that is used to identify banks within the US.

This field is available for this processor: Visa Platform Connect.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
                "features": {
                  "cardNotPresent": {
                    "processors": [
                      "ctv": {
                        "payouts": {
                          "merchantAbaNumber": "123456789"
                       }
                     }
                   ]
                 }
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
String

Data Length:
9

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardPresentConnect.configurationInformation. configurations.features.cardNotPresent.processors.[processorName].payouts.merchantAbaNumber

Product Enablement and Configuration Service API Field:

payments.cardPresentConnect.configurationInformation.configurations. features.cardNotPresent.processors.[processorName].payouts.merchantAbaNumber

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. features. cardNotPresent. processors.[processorName]. payouts. merchantId

The merchant identifier (MID) that is configured for payouts.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
              "common": {
                "features": {
                  "cardNotPresent": {
                    "processors": [
                      "<processor>": {
                        "payouts": {
                          "merchantId": "testrest"
                        }
                      }
                    ]
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

<processor>
: The processor that is associated with the merchant account.

The value of this field must conform to this regular expression:

 ^[0-9]+$

Specifications

Data Type:
String

Minimum Data Length:
1

Maximum Data Length:
11

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardPresentConnect.configurationInformation. configurations.features.cardNotPresent.processors.[processorName].payouts.merchantId

Product Enablement and Configuration Service API Field:

payments.cardPresentConnect.configurationInformation.configurations. features.cardNotPresent.processors.[processorName].payouts.merchantId

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. features. cardNotPresent. processors.[processorName]. payouts. networkOrder

The order of the networks in which Visa should make routing decisions.

This field is available for this processor: Visa Platform Connect.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
                "features": {
                  "cardNotPresent": {
                    "processors": [
                      "<processor>": {
                        "payouts": {
                          "networkOrder": "GUFV"
                       }
                     }
                   ]
                }
              }
            }
          }
        }
      }
    }
  }
}

<processor>
: The processor that is associated with the merchant account.

Specifications

Data Type:
String

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardPresentConnect.configurationInformation. configurations.features.cardNotPresent.processors.[processorName].payouts.networkOrder

Product Enablement and Configuration Service API Field:

payments.cardPresentConnect.configurationInformation.configurations. features.cardNotPresent.processors.[processorName].payouts.networkOrder

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. features. cardNotPresent. processors.[processorName]. payouts. reimbursementCode

The code that indicates how a payout transaction is reimbursed.

This field is available for this processor: Visa Platform Connect.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
                "features": {
                  "cardNotPresent": {
                    "processors": [
                      "<processor>": {
                        "payouts": {
                          "reimbursementCode": "05"
                       }
                     }
                   ]
                }
              }
            }
          }
        }
      }
    }
  }
}

<processor>
: The processor that is associated with the merchant account.

Specifications

Data Type:
String

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardPresentConnect.configurationInformation. configurations.features.cardNotPresent.processors.[processorName].payouts.reimbursementCode

Product Enablement and Configuration Service API Field:

payments.cardPresentConnect.configurationInformation.configurations. features.cardNotPresent.processors.[processorName].payouts.reimbursementCode

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. features. cardNotPresent. processors.[processorName]. payouts. terminalId

The terminal ID that is used with the payment processor.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
              "common": {
                "features": {
                  "cardNotPresent": {
                    "processors": [
                      "<processor>": {
                        "payouts": {
                          "terminalId": "01234"
                        }
                      }
                    ]
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

<processor>
: The processor that is associated with the merchant account.

The value of this field must conform to this regular expression:

 ^[0-9:\-]+$

Specifications

Data Type:
String

Minimum Data Length:
1

Maximum Data Length:
255

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardPresentConnect.configurationInformation. configurations.features.cardNotPresent.processors.[processorName].payouts.terminalId

Product Enablement and Configuration Service API Field:

payments.cardPresentConnect.configurationInformation.configurations. features.cardNotPresent.processors.[processorName].payouts.terminalId

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. features. cardNotPresent. processors.[processorName]. prestigiousPropertyIndicator

Indicator of prestigious property.

This field is available for this processor: Visa Platform Connect.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
                "features": {
                  "cardNotPresent": {
                    "processors": [
                      "<processor>": {
                        "prestigiousPropertyIndicator": "01"
                     }
                   ]
                 }
               }
            }
          }
        }
      }
    }
  }
}

<processor>
: The processor that is associated with the merchant account.

Specifications

Data Type:
String

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardPresentConnect.configurationInformation. configurations.features.cardNotPresent.processors.[processorName].prestigiousPropertyIndicator

Product Enablement and Configuration Service API Field:

payments.cardPresentConnect.configurationInformation.configurations. features.cardNotPresent.processors.[processorName].prestigiousPropertyIndicator

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. features. cardNotPresent. processors.[processorName]. relaxAddressVerificationSystemAllowExpiredCard

When set to

true

, this field allows transactions to use an expired card.

This field is available for these processors: American Express Direct, Barclays HISO, CB2A, Chase Paymentech Solutions, GPN, GPX, Elavon Americas, FDC Nashville Global, RuPay, SIX, and Visa Platform Connect.

Possible Values

true

false

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
                "features": {
                  "cardNotPresent": {
                    "processors": [
                      "<processor>": {
                        "relaxAddressVerificationSystemAllowExpiredCard": "true"
                     }
                   ]
                 }
               }
            }
          }
        }
      }
    }
  }
}

<processor>
: The processor that is associated with the merchant account.

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardPresentConnect.configurationInformation. configurations.features.cardNotPresent.processors.[processorName].relaxAddressVerificationSystemAllowExpiredCard

Product Enablement and Configuration Service API Field:

payments.cardPresentConnect.configurationInformation.configurations. features.cardNotPresent.processors.[processorName].relaxAddressVerificationSystemAllowExpiredCard

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. features. cardNotPresent. processors.[processorName]. relaxAddressVerificationSystemAllowZipWithoutCountry

When set to

true

, this field allows transactions that include a zip code without country.

This field is available for these processors: American Express Direct, Barclays HISO, Chase Paymentech Solutions, GPN, GPX, Elavon Americas, FDC Nashville Global, RuPay, Visa Platform Connect

Possible Values

true

false

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
                "features": {
                  "cardNotPresent": {
                    "processors": [
                      "<processor>": {
                        "relaxAddressVerificationSystemAllowZipWithoutCountry": "true"
                     }
                   ]
                 }
              }
            }
          }
        }
      }
    }
  }
}

<processor>
: The processor that is associated with the merchant account.

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardPresentConnect.configurationInformation. configurations.features.cardNotPresent.processors.[processorName].relaxAddressVerificationSystemAllowZipWithoutCountry

Product Enablement and Configuration Service API Field:

payments.cardPresentConnect.configurationInformation.configurations. features.cardNotPresent.processors.[processorName].relaxAddressVerificationSystemAllowZipWithoutCountry

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. features. cardNotPresent. processors.[processorName]. relaxAddressVerificationSystem

Enables you to submit the payment transaction without one or more of the billing to or card expiration fields.

This field is available for these processors: American Express Direct, Barclays HISO, CB2A, Chase Paymentech Solutions, Credit Mutuel-CIC, Elavon Americas, FDC Nashville Global, Fiserv, GPN, GPX, SIX, Vero, and Visa Platform Connect.

Possible Values

true

false

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
                "features": {
                  "cardNotPresent": {
                    "processors": [
                      "<processor>": {
                        "relaxAddressVerificationSystem": "true"
                     }
                   ]
                 }
               }
            }
          }
        }
      }
    }
  }
}

<processor>
: The processor that is associated with the merchant account.

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardPresentConnect.configurationInformation. configurations.features.cardNotPresent.processors.[processorName].relaxAddressVerificationSystem

Product Enablement and Configuration Service API Field:

payments.cardPresentConnect.configurationInformation.configurations. features.cardNotPresent.processors.[processorName].relaxAddressVerificationSystem

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. features. cardNotPresent. visaStraightThroughProcessingOnly

Indicates if a merchant is enabled for straight through processing - B2B invoice payments.

This field is available for these processors: FDC Nashville Global, GPX, TSYS Acquiring Solutions, and Visa Platform Connect.

Possible Values

true

false

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
                "features": {
                  "cardNotPresent": {
                    "visaStraightThroughProcessingOnly": "true"
                 }
               }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardPresentConnect.configurationInformation. configurations.features.cardNotPresent.visaStraightThroughProcessingOnly

Product Enablement and Configuration Service API Field:

payments.cardPresentConnect.configurationInformation.configurations. features.cardNotPresent.visaStraightThroughProcessingOnly

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. features. cardPresent. enableTerminalIdLookup

Used for card-present and virtual terminal transactions for terminal ID lookup.

This field is available for these processors: GPX.

Possible Values

true

false

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
               "features": {
                 "cardPresent": {
                   "enableTerminalIdLookup": "true"
                 }
               }
             }
           }
         }
      }
    }
  }
}

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardPresentConnect.configurationInformation. configurations.features.cardPresent.enableTerminalIdLookup

Product Enablement and Configuration Service API Field:

payments.cardPresentConnect.configurationInformation.configurations. features.cardPresent.enableTerminalIdLookup

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. features. cardPresent. processors.[processorName]. defaultPointOfSaleTerminalId

The identifier of the default terminal that is used for card-present and virtual terminal transactions.

This field is available for these processors: American Express Direct, Chase Paymentech Solutions, GPX, and Visa Platform Connect

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
               "features": {
                 "cardPresent": {
                   "processors": [
                     "<processor>": {
                       "defaultPointOfSaleTerminalId": "terminal1234"
                     }
                   ]
                 }
               }
            }
          }
        }
      }
    }
  }
}

<processor>
: The processor that is associated with the merchant account.

The value of this field must conform to this regular expression:

^[0-9:\-]+$

Specifications

Data Type:
String

Maximum Data Length:
1

Maximum Data Length:
255

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardPresentConnect.configurationInformation. configurations.features.cardPresent.processors.[processorName].defaultPointOfSaleTerminalId

Product Enablement and Configuration Service API Field:

payments.cardPresentConnect.configurationInformation.configurations. features.cardPresent.processors.[processorName].defaultPointOfSaleTerminalId

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. features. cardPresent. processors.[processorName]. disablePointOfSaleTerminalIdValidation

Indicates if terminal ID validation is disabled.

This field is available for this processor: Visa Platform Connect.

Possible Values

true

false

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
                "features": {
                  "cardPresent": {
                    "processors": [
                      "ctv": {
                        "disablePointOfSaleTerminalIdValidation": "true"
                     }
                   ]
                 }
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardPresentConnect.configurationInformation. configurations.features.cardPresent.processors.[processorName].disablePointOfSaleTerminalIdValidation

Product Enablement and Configuration Service API Field:

payments.cardPresentConnect.configurationInformation.configurations. features.cardPresent.processors.[processorName].disablePointOfSaleTerminalIdValidation

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. features. cardPresent. processors.[processorName]. enablePinTranslation

Enables Visa Acceptance Solutions PIN translation for online PIN transactions. You must exchange PIN keys with Visa Acceptance Solutions to use this feature.

This field is available for this processor: Visa Platform Connect.

Possible Values

true

false

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
                "features": {
                  "cardPresent": {
                    "processors": [
                      "<processor>": {
                        "enablePinTranslation": "true"
                     }
                   ]
                 }
               }
            }
          }
        }
      }
    }
  }
}

<processor>
: The processor that is associated with the merchant account.

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardPresentConnect.configurationInformation. configurations.features.cardPresent.processors.[processorName].enablePinTranslation

Product Enablement and Configuration Service API Field:

payments.cardPresentConnect.configurationInformation.configurations. features.cardPresent.processors.[processorName].enablePinTranslation

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. features. cardPresent. processors.[processorName]. financialInstitutionId

Acquirer institution identifier that is used for PIN debit transactions.

This field is available for these processors: GPX and Visa Platform Connect.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
                "features": {
                  "cardPresent": {
                    "processors": [
                      "<processor>": {
                        "financialInstitutionId": "01234"
                     }
                   ]
                 }
              }
            }
          }
        }
      }
    }
  }
}

<processor>
: The processor that is associated with the merchant account.

Specifications

Data Type:
String

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardPresentConnect.configurationInformation. configurations.features.cardPresent.processors.[processorName].financialInstitutionId

Product Enablement and Configuration Service API Field:

payments.cardPresentConnect.configurationInformation.configurations. features.cardPresent.processors.[processorName].financialInstitutionId

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. features. cardPresent. processors. [processorName]. pinDebitNetworkOrder

Order of the networks in which Visa should make routing decisions.

This field is available for these processors: GPX and Visa Platform Connect.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
                "features": {
                  "cardPresent": {
                    "processors": [
                      "<processor>": {
                        "pinDebitNetworkOrder": "04"
                     }
                   ]
                 }
               }
            }
          }
        }
      }
    }
  }
}

<processor>
: The processor that is associated with the merchant account.

Specifications

Data Type:
String

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardPresentConnect.configurationInformation. configurations.features.cardPresent.processors.[processorName].pinDebitNetworkOrder

Product Enablement and Configuration Service API Field:

payments.cardPresentConnect.configurationInformation.configurations. features.cardPresent.processors.[processorName].pinDebitNetworkOrder

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. features. cardPresent. processors.[processorName]. pinDebitReimbursementCode

PIN debit transaction reimbursement code for a certain type of interchange program.

This field is available for these processors: GPX and Visa Platform Connect.

Possible Values

Y

: SMS supermarket

Z

: SMS general merchant

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
                "features": {
                  "cardPresent ": {
                    "processors": [
                      "<processor>": {
                        "pinDebitReimbursementCode": "Z"
                     }
                   ]
                 }
               }
            }
          }
        }
      }
    }
  }
}

<processor>
: The processor that is associated with the merchant account.

Specifications

Data Type:
Enum

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardPresentConnect.configurationInformation. configurations.features.cardPresent.processors.[processorName].pinDebitReimbursementCode

Product Enablement and Configuration Service API Field:

payments.cardPresentConnect.configurationInformation.configurations. features.cardPresent.processors.[processorName].pinDebitReimbursementCode

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. features. cardPresent. processors.[processorName]. pointOfSaleTerminalIds

A comma separated list of all possible terminal IDs that the merchant is likely to send.

For retail transactions, the value must be validated before the merchant sends the terminal ID using the API.

This field is available for this processor: Visa Platform Connect.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
                "features": {
                  "cardNotPresent": {
                    "processors": [
                      "<processor>": {
                        "pointOfSaleTerminalIds": "01234", "12345"
                     }
                   ]
                 }
              }
            }
          }
        }
      }
    }
  }
}

<processor>
: The processor associated with the merchant account.

The value of this field must conform to this regular expression:

^[0-9:\-]+$

Specifications

Data Type:
String

Minimum Data Length:
1

Maximum Data Length:
255

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardPresentConnect.configurationInformation. configurations.features.cardPresent.processors.[processorName].pointOfSaleTerminalIds

Product Enablement and Configuration Service API Field:

payments.cardPresentConnect.configurationInformation.configurations. features.cardPresent.processors.[processorName].pointOfSaleTerminalIds

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. processors. [processorName]. abaNumber

Routing number that is used to identify banks within the US.

This field is available for this processor: GPX.

Syntax

  {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
              "common": {
                "processors": [
                  "<processor>": {
                    "abaNumber": "123456789"
                  }
                ]
              }
            }
          }
        }
      }
    }
  }
}

<processor>
: The processor that is associated with the merchant account.

Specifications

Data Type:
String

Data Length:
9

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardProcessing.configurationInformation. configurations.common.processors.[processorName].abaNumber

Product Enablement and Configuration Service API Field:

payments.cardProcessing.configurationInformation.configurations. common.processors.[processorName].abaNumber

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. processors.[processorName]. acquirer.interbankCardAssociationId

The number assigned by Mastercard to banks to identify the member in transactions.

This field is available for these processors: GPX and Visa Platform Connect.

Syntax

  {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
              "common": {
                "processors": [
                  "<processor>": {
                    "acquirer": {
                      "interbankCardAssociationId": "0125"
                    }
                  }
                ]
              }
            }
          }
        }
      }
    }
  }
}

<processor>
: The processor that is associated with the merchant account.

Specifications

Data Type:
String

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardProcessing.configurationInformation. configurations.common.processors.[processorName].acquirer.interbankCardAssociationId

Product Enablement and Configuration Service API Field:

payments.cardProcessing.configurationInformation.configurations.common. processors.[processorName].acquirer.interbankCardAssociationId

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. processors. [processorName]. acquirer. countryCode

Two-character ISO country or reason code of the acquirer.

This field is available for these processors: China UnionPay, eftpos, GPX, Prisma, RuPay, and Visa Platform Connect.

Syntax

  {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
              "common": {
                "processors": [
                  "<processor>": {
                    "acquirer": {
                      "countryCode": "US"
                    }
                  }
                ]
              }
            }
          }
        }
      }
    }
  }
}

<processor>
: The processor that is associated with the merchant account.

Specifications

Data Type:
String

Data Length:
2

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardProcessing.configurationInformation. configurations.common.processors.[processorName].acquirer.countryCode

Product Enablement and Configuration Service API Field:

payments.cardProcessing.configurationInformation.configurations.common. processors.[processorName].acquirer.countryCode

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. processors. [processorName]. acquirer. discoverInstitutionId

The identifier assigned by Discover that is used to identify the acquirer.

This field is available for these processors: GPX and Visa Platform Connect.

Syntax

  {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
              "common": {
                "processors": [
                  "<processor>": {
                    "acquirer": {
                      "discoverInstitutionId": "012"
                    }
                  }
                ]
              }
            }
          }
        }
      }
    }
  }
}

<processor>
: The processor that is associated with the merchant account.

Specifications

Data Type:
String

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardProcessing.configurationInformation. configurations.common.processors.[processorName].acquirer.discoverInstitutionId

Product Enablement and Configuration Service API Field:

payments.cardProcessing.configurationInformation.configurations.common. processors.[processorName].acquirer.discoverInstitutionId

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. processors. [processorName]. acquirer. fileDestinationBin

The BIN where the capture file is sent. This field must contain a valid BIN.

This field is available for these processors: GPX and Visa Platform Connect.

Syntax

  {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
              "common": {
                "processors": [
                  "<processor>": {
                    "acquirer": {
                      "fileDestinationBin": "12345678"
                    }
                  }
                ]
              }
            }
          }
        }
      }
    }
  }
}

<processor>
: The processor that is associated with the merchant account.

Specifications

Data Type:
String

Maximum Data Length:
8

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardProcessing.configurationInformation. configurations.common.processors.[processorName].acquirer.fileDestinationBin

Product Enablement and Configuration Service API Field:

payments.cardProcessing.configurationInformation.configurations.common. processors.[processorName].acquirer.fileDestinationBin

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. processors. [processorName]. acquirer. institutionId

Identifier of the acquirer. This number is usually assigned by Visa.

This field is available for these processors: American Express Direct, CB2A, Credit Mutuel-CIC, China UnionPay, eftpos, GPX, SIX, and Visa Platform Connect.

Syntax

  {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
              "common": {
                "processors": [
                  "<processor>": {
                    "acquirer": {
                      "institutionId": "1111"
                    }
                  }
                ]
              }
            }
          }
        }
      }
    }
  }
}

<processor>
: The processor that is associated with the merchant account.

The value of this field must conform to the regular expression format:

^[0-9]+$

Specifications

Data Type:
String

Minimum Data Length:
1

Maximum Data Length:
13

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardProcessing.configurationInformation. configurations.common.processors.[processorName].acquirer.institutionId

Product Enablement and Configuration Service API Field:

payments.cardProcessing.configurationInformation.configurations.common. processors.[processorName].acquirer.institutionId

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. processors.[processorName]. acquirerMerchantId

Merchant identifier that is assigned by the acquirer.

This field is available for these processors: RuPay, SIX, and Visa Platform Connect.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
              "common": {
                "processors": [
                  "<processor>": {
                    "acquirerMerchantId": "testacquirerid"
                  }
                ]
              }
            }
          }
        }
      }
    }
  }
}

<processor>
: The processor that is associated with the merchant account.

Specifications

Data Type:
String

Minimum Data Length:
1

Maximum Data Length:
11

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardProcessing.configurationInformation. configurations.common.processors.[processorName].acquirer.acquirerMerchantId

Product Enablement and Configuration Service API Field:

payments.cardProcessing.configurationInformation.configurations.common. processors.[processorName].acquirer.acquirerMerchantId

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. processors.[processorName]. amexTransactionAdviceAddendum1

American Express advice addendum field. This field is used to display descriptive information about a transaction on customer’s American Express card statement.

This field is available for these processors: American Express Direct, FDC Nashville Global and TSYS Acquiring Solutions.

Syntax

{
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
              "common": {
                "processors": [
                  "<processor>": {
                    "amexTransactionAdviceAddendum1": ""
                  }
                ]
              }
            }
          }
        }
      }
    }
  }
}

<processor>
: The processor that is associated with the merchant account.

The value of this field must conform to the regular expression format:

^[0-9a-zA-Z\-\s.]+$

Specifications

Data Type:
String

Minimum Data Length:
1

Maximum Data Length:
40

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardProcessing.configurationInformation. configurations.common.processors.[processorName].amexTransactionAdviceAddendum1

Product Enablement and Configuration Service API Field:

payments.cardProcessing.configurationInformation.configurations.common. processors.[processorName].amexTransactionAdviceAddendum1

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. processors.[processorName]. avsFormat

Enables Enhanced Address Verification Service (AVS)/Automated Address Verification Plus (AAV+).

This field is available for this processor: American Express Direct.

Possible Values

basic

: Standard address verification system. When a processor supports AVS for a transaction’s card type, the issuing bank uses AVS to confirm that the customer has provided the correct billing address. When a customer provides incorrect information, the transaction might be fraudulent.

basic + name

: Enhanced address verification system. Consists of the standard AVS functionality plus verification of these additional fields:

orderInformation.billTo.firstName

orderInformation.billTo.lastName

basic + name + shipto

: Automated address verification plus. Consists of the Enhanced AVS functionality and verification of some additional fields. AAV+ is intended for merchants that deliver physical goods to a different address than the billing address. AAV+ verifies the additional fields only when the standard and Enhanced AVS tests pass first. These additional fields verified for AAV+:

orderInformation.billTo.phoneNumber

(American Express Direct only)

orderInformation.shipTo.address1

orderInformation.shipTo.country

orderInformation.shipTo.firstName

orderInformation.shipTo.lastName

orderInformation.shipTo.phoneNumber

orderInformation.shipTo.postalCode

Syntax

{
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
              "common": {
                "processors": [
                  "<processor>": {
                    "avsFormat": "basic"
                  }
                ]
              }
            }
          }
        }
      }
    }
  }
}

<processor>
: The processor that is associated with the merchant account.

Specifications

Data Type:
Enum

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardProcessing.configurationInformation. configurations.common.processors.[processorName].avsFormat

Product Enablement and Configuration Service API Field:

payments.cardProcessing.configurationInformation.configurations. common.processors.[processorName].avsFormat

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. processors.[processorName]. bankNumber

6-digit agent bank number provided by acquirer.

This field is available for this processor: TSYS Acquiring Solutions

Syntax

{
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
              "common": {
                "processors": [
                  "<processor>": {
                    "bankNumber": "123456"
                  }
                ]
              }
            }
          }
        }
      }
    }
  }
}

<processor>
: The processor that is associated with the merchant account.

Specifications

Data Type:
String

Data Length:
6

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardProcessing.configurationInformation. configurations.common.processors.[processorName].bankNumber

Product Enablement and Configuration Service API Field:

payments.cardProcessing.configurationInformation.configurations.common. processors.[processorName].bankNumber

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. processors.[processorName]. batchGroup

The processing batch group provided to the merchant.

Batch groups can be specified using the following values:

Timezone

Merchant deadlines

Large merchants (top 10)

Merchants with service level agreements

This field is available for these processors: American Express Direct, Barclays Merchant ServicesChina UnionPay, FDC Nashville Global, FDMS Nashville, TSYS Acquiring Solutions, Vero, and Visa Platform Connect.

Syntax

{
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
              "common": {
                "processors": [
                  "<processor>": {
                    "batchGroup": "<Timezone>"
                  }
                ]
              }
            }
          }
        }
      }
    }
  }
}

<processor>
: The processor that is associated with the merchant account.

<Timezone>
: The timezone associated with the transaction. It is a processor-specific value.

Specifications

Data Type:
Enum

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardProcessing.configurationInformation. configurations.common.processors.[processorName].batchGroup

Product Enablement and Configuration Service API Field:

payments.cardProcessing.configurationInformation.configurations.common. processors.[processorName].batchGroup

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. processors.[processorName]. businessApplicationId

Indicates the type of money transfer used in the transaction.

This field is available for these processors: GPX and Visa Platform Connect.

Syntax

  {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
              "common": {
                "processors": [
                  "<processor>": {
                    "businessApplicationId": "PP"
                  }
                ]
              }
            }
          }
        }
      }
    }
  }
}

<processor>
: The processor that is associated with the merchant account.

Specifications

Data Type:
String

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardProcessing.configurationInformation. configurations.common.processors.[processorName].businessApplicationId

Product Enablement and Configuration Service API Field:

payments.cardProcessing.configurationInformation.configurations.common. processors.[processorName].businessApplicationId

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. processors.[processorName]. chainNumber

6-digit chain number provided by acquirer.

This field is available for this processor: TSYS Acquiring Solutions

Syntax

{
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
              "common": {
                "processors": [
                  "<processor>": {
                    "chainNumber": "123456"
                  }
                ]
              }
            }
          }
        }
      }
    }
  }
}

<processor>
: The processor that is associated with the merchant account.

Specifications

Data Type:
String

Data Length:
6

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardProcessing.configurationInformation. configurations.common.processors.[processorName].chainNumber

Product Enablement and Configuration Service API Field:

payments.cardProcessing.configurationInformation.configurations.common. processors.[processorName].chainNumber

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. processors.[processorName]. currencies.[currency]. enabled

Currencies available for processing by the specified processor.

This field is available for these processors: American Express Direct, Barclays Merchant Services, China UnionPay, FDC Nashville Global, FDMS Nashville, TSYS Acquiring Solutions, Vero, and Visa Platform Connect.

For card-not-present applications, you may enable multiple currencies. For card-present only applications, only one currency can be processed by the ready terminal.

For China UnionPay, eftpos, and Visa Platform Connect processors, use the actual processor name in each request.

Possible Values

true

false

Syntax

{
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
              "common": {
                "processors": [
                  "<processor>": {
                    "currencies": [
                      "<currency>": {
                        "enabled": "true"
                      }
                    ]
                  }
                ]
              }
            }
          }
        }
      }
    }
  }
}

<processor>
: The processor that is associated with the merchant account.

<currency>
: The currency that is supported by the merchant.

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardProcessing.configurationInformation. configurations.common.processors.[processorName].currencies.[currency].enabled

Product Enablement and Configuration Service API Field:

payments.cardProcessing.configurationInformation.configurations.common. processors.[processorName].currencies.[currency].enabled

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. processors.[processorName]. currencies.[currency]. merchantId

Merchant identifier assigned by an acquirer or a processor. This field should not be overridden by any other party.

This field is available for these processors: Barclays Merchant Services, China UnionPay, eftpos, Elavon Americas, FDC Nashville Global, and Visa Platform Connect.

Syntax

{
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
              "common": {
                "processors": [
                  "<processor>": {
                    "currencies": [
                      "<currency>": {
                        "merchantId": "testrest"
                      }
                    ]
                  }
                ]
              }
            }
          }
        }
      }
    }
  }
}

<processor>
: The processor that is associated with the merchant account.

<currency>
: The currency that is supported by the merchant account.

The value of this field must conform to this regular expression:

^[0-9a-zA-Z]+$

Specifications

Data Type:
String

Minimum Data Length:
1

Maximum Data Length:
11

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardProcessing.configurationInformation. configurations.common.processors.[processorName].currencies.[currency].merchantId

Product Enablement and Configuration Service API Field:

payments.cardProcessing.configurationInformation.configurations.common. processors.[processorName].currencies.[currency].merchantId

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. processors.[processorName]. currencies.[currency]. serviceEnablementNumber

The service enablement number (SE number).

A unique ten-digit number assigned by American Express to a merchant that accepts American Express cards that are provided by the acquiring bank. This number might be unique for each currency.

This field is available for these processors: American Express Direct, Barclays, China UnionPay, FDC Nashville Global, FDMS Nashville, TSYS Acquiring Solutions, Vero, and Visa Platform Connect.

For card-not-present applications, you may enable multiple currencies. For card-present-only applications, only one currency can be processed by the ready terminal.

For China UnionPay, eftpos, and Visa Platform Connect processors, use the actual processor name in each request.

Syntax

{
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
              "common": {
                "processors": [
                  "<processor>": {
                    "currencies": [
                      "<currency>": {
                        "serviceEnablementNumber": "1234567890"
                      }
                    ]
                  }
                ]
              }
            }
          }
        }
      }
    }
  }
}

<processor>
: The processor that is associated with the merchant account.

<currency>
: The currency that is supported by the merchant.

The value of this field must conform to this regular expression:

^[0-9]+$

Specifications

Data Type:
String

Minimum Data Length:
10

Maximum Data Length:
10

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardProcessing.configurationInformation. configurations.common.processors.[processorName].currencies.[currency].serviceEnablementNumber

Product Enablement and Configuration Service API Field:

payments.cardProcessing.configurationInformation.configurations.common. processors.[processorName].currencies.[currency].serviceEnablementNumber

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. processors.[processorName]. currencies.[currency]. terminalId

The Terminal ID (TID) used for your payments processor. Depending on the processor and payment acceptance type, this field may also be the default Terminal ID used for card-present and virtual terminal transactions.

This field is available for these processors: FDC Nashville Global, Elavon Americas, Visa Platform Connect, and RuPay.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
              "common": {
                "processors": [
                  "<processor>": {
                    "currencies": [
                      "<currency>": {
                        "terminalId": ""
                      }
                    ]
                  }
                ]
              }
            }
          }
        }
      }
    }
  }
}

<processor>
: The processor that is associated with the merchant account.

<currency>
: The currency that is supported by the merchant.

The value of this field must conform to this regular expression:

 ^[0-9:\-]+$

Specifications

Data Type:
String

Minimum Data Length:
1

Maximum Data Length:
255

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardProcessing.configurationInformation. configurations.common.processors.[processorName].currencies.[currency].terminalId

Product Enablement and Configuration Service API Field:

payments.cardProcessing.configurationInformation.configurations. common.processors.[processorName].currencies.[currency].terminalId

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. processors.[processorName]. currencies.[currency]. terminalIds

The Terminal ID (TID) used for your payments processor. Depending on the processor and payment acceptance type, this field may also be the default Terminal ID used for card-present and virtual terminal transactions.

This field is available for this processor: Barclays Merchant Services and Prisma.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
              "common": {
                "processors": [
                  "prisma": {
                    "currencies": [
                      "<currency>": {
                        "terminalIds": ""
                      }
                    ]
                  }
                ]
              }
            }
          }
        }
      }
    }
  }
}

<currency>
: The currency that is supported by the merchant.

Barclays Merchant Services
: The value of this field must conform to the regular expression format:

^[0-9:\-]+$

Specifications

Data Type:
String

Minimum Data Length:
1

Maximum Data Length:
255

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardProcessing.configurationInformation. configurations.common.processors.[processorName].currencies.[currency].terminalIds

Product Enablement and Configuration Service API Field:

payments.cardProcessing.configurationInformation.configurations.common. processors.[processorName].currencies.[currency].terminalIds

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. processors.[processorName]. defaultPointOfSaleTerminalId

Allows the reversal of unused funds after a void transaction.

Enabling this feature allows merchants to meet the Visa mandate requiring merchants to release unused funds set aside during an authorization request.

This field is available for these processors: American Express Direct, Elavon Americas, SIX, Visa Platform Connect, and CB2A.

Syntax

{
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
              "common": {
                "processors": [
                  "<processor>": {
                    "defaultPointOfSaleTerminalId": "terminal123"
                  }
                ]
              }
            }
          }
        }
      }
    }
  }
}

<processor>
: The processor that is associated with the merchant account.

The value of this field must conform to this regular expression:

 ^[0-9:\-]+$

Specifications

Data Type:
String

Minimum Data Length:
1

Maximum Data Length:
255

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardProcessing.configurationInformation.configurations.common.processors.[processorName].defaultPointOfSaleTerminalId

Product Enablement and Configuration Service API Field:

payments.cardProcessing.configurationInformation.configurations.common.processors.[processorName].defaultPointOfSaleTerminalId

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. processors.[processorName]. enableAutoAuthReversalAfterVoid

Allows the reversal of unused funds after a void transaction.

Enabling this feature allows merchants to meet the Visa mandate that requires merchants to release unused funds that are set aside during an authorization request.

This field is available for these processors: American Express Direct, CB2A, Elavon Americas, SIX, and Visa Platform Connect.

Possible Values

true

false

Syntax

{
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
              "common": {
                "processors": [
                  "<processor>": {
                    "enableAutoAuthReversalAfterVoid": "true"
                  }
                ]
              }
            }
          }
        }
      }
    }
  }
}

<processor>
: The processor that is associated with the merchant account.

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardProcessing.configurationInformation. configurations.common.processors.[processorName].enableAutoAuthReversalAfterVoid

Product Enablement and Configuration Service API Field:

payments.cardProcessing.configurationInformation.configurations.common. processors.[processorName].enableAutoAuthReversalAfterVoid

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. processors.[processorName]. enableCreditAuth

Enables credit authorization which reduces refund chargebacks and prevents customers from seeing the online update for credits that are otherwise offline settlements.

Possible Values

true

false

Syntax

{
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
              "common": {
                "processors": [
                  "<processor>": {
                    "enableCreditAuth": "true"
                  }
                ]
              }
            }
          }
        }
      }
    }
  }
}

<processor>
: The processor that is associated with the merchant account.

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardProcessing.configurationInformation. configurations.common.processors.[processorName].enableCreditAuth

Product Enablement and Configuration Service API Field:

payments.cardProcessing.configurationInformation.configurations.common. processors.[processorName].enableCreditAuth

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. processors.[processorName]. enableCVVResponseIndicator

This field indicates the eftpos merchant's choice of receiving CVV processing response in return.

This field is available for this processor: eftpos

Possible Values

true

false

Syntax

{
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
              "common": {
                "processors": [
                  "eftpos": {
                    "enableCVVResponseIndicator": "true"
                  }
                ]
              }
            }
          }
        }
      }
    }
  }
}

<processor>
: The processor that is associated with the merchant account.

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardProcessing.configurationInformation. configurations.common.processors.[processorName].enableCVVResponseIndicator

Product Enablement and Configuration Service API Field:

payments.cardProcessing.configurationInformation.configurations.common. processors.[processorName].enableCVVResponseIndicator

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. processors.[processorName]. enableDynamicCurrencyConversion

Enable or disable dynamic currency conversion for a merchant.

Possible Values

true

false

Syntax

{
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
              "common": {
                "processors": [
                  "<processor>": {
                    "enableDynamicCurrencyConversion": "true"
                  }
                ]
              }
            }
          }
        }
      }
    }
  }
}

<processor>
: The processor that is associated with the merchant account.

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardProcessing.configurationInformation.configurations.common.processors.[processorName].enableDynamicCurrencyConversion

Product Enablement and Configuration Service API Field:

payments.cardProcessing.configurationInformation.configurations.common.processors.[processorName].enableDynamicCurrencyConversion

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. processors.[processorName]. enableExpresspayPanTranslation

When this field is set to

true

, authorization responses from American Express expresspay transactions include the primary account number (PAN) and expiration date of the card.

This field is available for this processor: American Express Direct

Possible Values

true

false

Syntax

{
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
              "common": {
                "processors": [
                  "<amexdirect>": {
                    "enableExpresspayPanTranslation": "true"
                  }
                ]
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardProcessing.configurationInformation. configurations.common.processors.[processorName].enableExpresspayPanTranslation

Product Enablement and Configuration Service API Field:

payments.cardProcessing.configurationInformation.configurations.common. processors.[processorName].enableExpresspayPanTranslation

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. processors.[processorName]. enableLevel2

When this field is set to

true

, it indicates that the merchant will send level II data for American Express cards.

This field is available for this processor: American Express Direct

Possible Values

true

false

Syntax

{
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
              "common": {
                "processors": [
                  "<amexdirect>": {
                    "enableLevel2": "true"
                  }
                ]
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardProcessing.configurationInformation. configurations.common.processors.[processorName].enableLevel2

Product Enablement and Configuration Service API Field:

payments.cardProcessing.configurationInformation.configurations.common. processors.[processorName].enableLevel2

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. processors.[processorName]. enableLeastCostRouting

When this field is set to

true

, it indicates that least cost routing is enabled.

This field is available for these processors: China UnionPay and eftpos.

Possible Values

true

false

Syntax

{
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
              "common": {
                "processors": [
                  "<processor>": {
                    "enableLeastCostRouting": "true"
                  }
                ]
              }
            }
          }
        }
      }
    }
  }
}

<processor>
: The processor that is associated with the merchant account.

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardProcessing.configurationInformation. configurations.common.processors.[processorName].enableLeastCostRouting

Product Enablement and Configuration Service API Field:

payments.cardProcessing.configurationInformation.configurations.common. processors.[processorName].enableLeastCostRouting

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. processors.[processorName]. enableLongTransRefNo

American Express Direct-specific merchant configuration value that determines what length of reference number will be generated by Visa Acceptance Solutions if the merchant does not pass in a

reconciliationID

. This field can be either nine digits or a unique twelve-character reference number. It can be a combination of alpha, numeric and special characters, or binary data in hexadecimal.

This field is available for these processors: American Express Direct

Possible Values

true

false

Syntax

{
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
              "common": {
                "processors": [
                  "<amexdirect>": {
                    "enableLongTransRefNo": "true"
                  }
                ]
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardProcessing.configurationInformation. configurations.common.processors.[processorName].enableLongTransRefNo

Product Enablement and Configuration Service API Field:

payments.cardProcessing.configurationInformation.configurations.common. processors.[processorName].enableLongTransRefNo

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. processors.[processorName]. enableMultiCurrencyProcessing

Indicates if multiple-currency processing is supported.

This field is available for this processor: Barclays Merchant Services

Possible Values

true

false

Syntax

{
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
              "common": {
                "processors": [
                  "<barclays>": {
                    "enableMultiCurrencyProcessing": "true"
                  }
                ]
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardProcessing.configurationInformation. configurations.common.processors.[processorName].enableMultiCurrencyProcessing

Product Enablement and Configuration Service API Field:

payments.cardProcessing.configurationInformation.configurations.common. processors.[processorName].enableMultiCurrencyProcessing

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. processors.[processorName]. enableMultiLineItems

Enables offer/line item details to be included instead of sending one line item, and a grand total. For example, offer0, offer1...offerN.

This field is available for these processors: American Express Direct and Elavon Americas.

Possible Values

true

false

Syntax

{
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
              "common": {
                "processors": [
                  "<processor>": {
                    "enableMultiLineItems": "true"
                  }
                ]
              }
            }
          }
        }
      }
    }
  }
}

<processor>
: The processor that is associated with the merchant account.

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardProcessing.configurationInformation. configurations.common.processors.[processorName].enableMultiLineItems

Product Enablement and Configuration Service API Field:

payments.cardProcessing.configurationInformation.configurations.common. processors.[processorName].enableMultiLineItems

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. processors.[processorName]. enableMultipleTransactionAdviceAddendum

When this field is set to

true

, it enables multiple transaction advice addendum fields. This field is used to display descriptive information about a transaction on a customer’s American Express card statement.

This field is available for this processor: American Express Direct.

Possible Values

true

false

Syntax

{
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
              "common": {
                "processors": [
                  "<amexdirect>": {
                    "enableMultipleTransactionAdviceAddendum": "true"
                  }
                ]
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardProcessing.configurationInformation. configurations.common.processors.[processorName].enableMultipleTransactionAdviceAddendum

Product Enablement and Configuration Service API Field:

payments.cardProcessing.configurationInformation.configurations.common. processors.[processorName].enableMultipleTransactionAdviceAddendum

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. processors.[processorName]. enableTransactionReferenceNumber

When this field is set to

true

, it indicates that the merchant can send in the transaction reference number.

This field is available for these processors: CB2A, Chase Paymentech Solutions, China UnionPay, eftpos, Elavon Americas, Fiserv, FDC Nashville Global, SIX, Vero, and Visa Platform Connect

Possible Values

true

false

Syntax

{
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
              "common": {
                "processors": [
                  "<processor>": {
                    "enableTransactionReferenceNumber": "true"
                  }
                ]
              }
            }
          }
        }
      }
    }
  }
}

<processor>
: The processor that is associated with the merchant account.

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardProcessing.configurationInformation. configurations.common.processors.[processorName].enableTransactionReferenceNumber

Product Enablement and Configuration Service API Field:

payments.cardProcessing.configurationInformation.configurations.common. processors.[processorName].enableTransactionReferenceNumber

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. processors.[processorName]. paymentTypes.[paymentType]. currencies.[currency]. enabled

Indicates the currencies enabled for processing by the specified processor and payment type.

Possible Values

true

false

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
              "common": {
                "processors": [
                  "<processor>": {
                    "paymentTypes": [
                      "<paymentType>": {
                        "currencies": [
                          "<currency>": {
                            "enabled": "true"
                         }
                       ]
                      }
                    ]
                  }
                ]
              }
            }
          }
        }
      }
    }
  }
}

<processor>
: The processor that is associated with the merchant account.

<currency>
: The currency that is supported by the merchant.

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardProcessing.configurationInformation. configurations.common.processors.[processorName].paymentTypes.[paymentType].currencies.[currency].enabled

Product Enablement and Configuration Service API Field:

payments.cardProcessing.configurationInformation.configurations.common. processors.[processorName].paymentTypes.[paymentType].currencies.[currency].enabled

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. processors.[processorName]. paymentTypes.[paymentType]. currencies.[currency]. merchantId

Merchant ID that is assigned by an acquirer or a processor. This field should not be overridden by any other party.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
              "common": {
                "processors": [
                  "<processor>": {
                    "paymentTypes": [
                      "<paymentType>": {
                        "currencies": [
                          "<currency>": {
                            "merchantId": "testrest"
                          }
                        ]
                      }
                    ]
                  }
                ]
              }
            }
          }
        }
      }
    }
  }
}

<processor>
: The processor that is associated with the merchant account.

<paymentType>
: The payment type associated with the merchant account.

<currency>
: The currency that is supported by the merchant.

The value of this field must conform to the regular expression format:

^[0-9a-zA-Z]+$

Specifications

Data Type:
String

Minimum Data Length:
1

Maximum Data Length:
15

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardProcessing.configurationInformation. configurations.common.processors.[processorName].paymentTypes.[paymentType].currencies.[currency].merchantId

Product Enablement and Configuration Service API Field:

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]. serviceEnablementNumber

Service enablement number (SE Number) is a unique 10-digit number assigned by American Express to a merchant that accepts American Express cards. This number may be unique for each currency depending on how the processor is set up for the merchant.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
              "common": {
                "processors": [
                  "<processor>": {
                    "paymentTypes": [
                      "<paymentType>": {
                        "currencies": [
                          "<currency>": {
                            "serviceEnablementNumber": "0123456789"
                          }
                        ]
                      }
                    ]
                  }
                ]
              }
            }
          }
        }
      }
    }
  }
}

<processor>
: The processor that is associated with the merchant account.

<paymentType>
: The payment type associated with the merchant account.

<currency>
: The currency that is supported by the merchant.

The value of this field must conform to this regular expression:

^[0-9]+$

Specifications

Data Type:
String

Data Length:
10

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardProcessing.configurationInformation. configurations.common.processors.[processorName].paymentTypes.[paymentType].currencies.[currency].serviceEnablementNumber

Product Enablement and Configuration Service API Field:

payments.cardProcessing.configurationInformation.configurations.common. processors.[processorName].paymentTypes.[paymentType].currencies.[currency].serviceEnablementNumber

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. processors.[processorName]. paymentTypes.[paymentType]. enabled

Enables the specified payment type.

Possible Values

Possible payment type values:

American Express Direct
:

AMERICAN_EXPRESS

JCB

Barclays HISO
:

CUP

DINERS_CLUB

DISCOVER

JCB

MAESTRO_INTERNATIONAL

MASTERCARD

SWITCH_SOLO

VISA

VISA_ELECTRON

Barclays Merchant Services
:

DINERS_CLUB

DISCOVER

JCB

MAESTRO_INTERNATIONAL

MASTERCARD

SWITCH_SOLO

VISA

Possible values for each payment type:

true

false

Syntax

{
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
              "common": {
                "processors": [
                  "<processor>": {
                    "paymentType": [
                      "<paymentType>": {
                        "enabled": "true"
                      }
                    ]
                  }
                ]
              }
            }
          }
        }
      }
    }
  }
}

<processor>
: The processor that is associated with the merchant account.

<paymentType>
: The card types that can be processed with the merchant account.

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardProcessing.configurationInformation. configurations.common.processors.[processorName].paymentTypes.[paymentType].enabled

Product Enablement and Configuration Service API Field:

payments.cardProcessing.configurationInformation.configurations.common. processors.[processorName].paymentTypes.[paymentType].enabled

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. processors[]. paymentTypes[]. serviceEnablementNumber

The service enablement number (SE Number).

A unique ten-digit number assigned by American Express to a merchant that accepts American Express cards provided by the aquiring bank. This number may be unique for each currency.

This field is available for the following processors: American Express Direct, Barclays, China UnionPay, FDC Nashville Global, FDMS Nashville, TSYS Acquiring Solutions, Vero, Visa Platform Connect.

The following payment types can be used:

AMERICAN_EXPRESS

DINERS_CLUB

DISCOVER

JCB

MASTERCARD

PIN_DEBIT

VISA

Syntax

{
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
              "common": {
                "processors": [
                  "<processor>": {
                    "paymentType": [
                      "<paymentType>": {
                        "serviceEnablementNumber": "1234567890"
                      }
                    ]
                  }
                ]
              }
            }
          }
        }
      }
    }
  }
}

<processor>
: The processor associated with the merchant account.

<paymentType>
: The card types that can be processed with the merchant account.

The value of this field must conform to the regular expression format:

^[0-9]+$

Specifications

Data Type:
String

Mapping Information

No corresponding fields..

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. processors.[processorName]. enablePosNetworkSwitching

When this field is set to

true

, it enables POS network switching. POS network switching or alternate routing mean that a merchant can process PIN Debit transactions without a PIN.

This field is available for this processor: FDC Nashville Global.

Possible Values

true

false

Syntax

{
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
              "common": {
                "processors": [
                  "<fdiglobal>": {
                    "enablePosNetworkSwitching": "true"
                  }
                ]
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardProcessing.configurationInformation. configurations.common.processors.[processorName].enablePosNetworkSwitching

Product Enablement and Configuration Service API Field:

payments.cardProcessing.configurationInformation.configurations.common. processors.[processorName].enablePosNetworkSwitching

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. processors.[processorName]. quasiCash

Indicates if quasi-cash transactions are enabled. A quasi-cash transaction is a cash-like transaction for the sale of items that are directly convertible to cash. Examples of quasi-cash include casino gaming chips, money orders, and wire transfers.

This field is available for these processors: Barclays Merchant Services GPX, TSYS Acquiring Solutions and Visa Platform Connect.

Possible Values

Possible values for each currency:

true

false

Syntax

{
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
              "common": {
                "processors": [
                  "<processor>": {
                    "quasiCash": "true"
                  }
                ]
              }
            }
          }
        }
      }
    }
  }
}

<processor>
: The processor that is associated with the merchant account.

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardProcessing.configurationInformation. configurations.common.processors.[processorName].quasiCash

Product Enablement and Configuration Service API Field:

payments.cardProcessing.configurationInformation.configurations.common. processors.[processorName].quasiCash

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. processors.[processorName]. sendAmexLevel2Data

Indicates if the merchant will send Level II data for American Express cards.

This field is available for this processor: TSYS Acquiring Solutions.

Possible Values

Possible values for each currency:

true

false

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
              "common": {
                "processors": [
                  "vital": {
                    "sendAmexLevel2Data": "true"
                  }
                ]
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardProcessing.configurationInformation. configurations.common.processors.[processorName].sendAmexLevel2Data

Product Enablement and Configuration Service API Field:

payments.cardProcessing.configurationInformation.configurations.common. processors.[processorName].sendAmexLevel2Data

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. processors.[processorName]. settlementCurrency

Indicates the merchant's settlement currency.

Use a 3-character ISO currency code.

This field is available for these processors: Streamline andTSYS Acquiring Solutions.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
              "common": {
                "processors": [
                  "<processor>": {
                    "settlementCurrency": "USD"
                  }
                ]
              }
            }
          }
        }
      }
    }
  }
}

<processor>
: The processor that is associated with the merchant account.

Specifications

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
              "common": {
                "processors": [
                  "vital": {
                    "softDescriptorType": "2"
                  }
                ]
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Enum

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardProcessing.configurationInformation. configurations.common.processors.[processorName].softDescriptorType

Product Enablement and Configuration Service API Field:

payments.cardProcessing.configurationInformation.configurations.common. processors.[processorName].softDescriptorType

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. processors.[processorName]. storeID

4-digit number used to identify a specific merchant store location within the member systems.

This field is available for these processors: TSYS Acquiring Solutions.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
              "common": {
                "processors": [
                  "vital": {
                    "storeID": "1234"
                  }
                ]
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
String

Data Length:
4

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardProcessing.configurationInformation. configurations.common.processors.[processorName].storeID

Product Enablement and Configuration Service API Field:

payments.cardProcessing.configurationInformation.configurations.common. processors.[processorName].storeID

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. processors. [processorName]. travelAgencyCode

The travel agency code. This field applies only if an airline ticket was issued by a travel agency.

This field is available for these processors: TSYS Acquiring Solutions.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
              "common": {
                "processors": [
                  "vital": {
                    "travelAgencyCode": "1234"
                  }
                ]
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
String

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardProcessing.configurationInformation. configurations.common.processors.[processorName].travelAgencyCode

Product Enablement and Configuration Service API Field:

payments.cardProcessing.configurationInformation.configurations.common. processors.[processorName].travelAgencyCode

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. processors. [processorName]. travelAgencyName

Travel agency name. This field applies only if an airline ticket was issued by travel agency.

This field is available for these processors: TSYS Acquiring Solutions.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
              "common": {
                "processors": [
                  "vital": {
                    "travelAgencyName": "Test Travel Agency"
                  }
                ]
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
String

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardProcessing.configurationInformation. configurations.common.processors.[processorName].travelAgencyName

Product Enablement and Configuration Service API Field:

payments.cardProcessing.configurationInformation.configurations.common. processors.[processorName].travelAgencyName

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. processors.[processorName]. vitalNumber

Identifier provided by TSYS Acquiring Solutions. The leading V must be replaced by a 7. For example, replace

V1234567

with

71234567

.

This field is available for these processors: TSYS Acquiring Solutions.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
              "common": {
                "processors": [
                  "vital": {
                    "vitalNumber": "71234567"
                  }
                ]
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
String

Data Length:
8

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardProcessing.configurationInformation. configurations.common.processors.[processorName].vitalNumber

Product Enablement and Configuration Service API Field:

payments.cardProcessing.configurationInformation.configurations.common. processors.[processorName].vitalNumber

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. sicCode

The 4-digit Standard Industrial Classification (SIC) code that categorizes the industries that companies belong to based on their business activities. SIC codes were mostly replaced by the 6-digit North American Industry Classification System (NAICS).

This field is available for these processors: GPX and Visa Platform Connect.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
              "common": {
                "sicCode": "0123"
              }
            }
          }
        }
      }
    }
  }
}

<processor>
: The processor that is associated with the merchant account.

Specifications

Data Type:
String

Data Length:
4

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardProcessing.configurationInformation. configurations.common.sicCode

Product Enablement and Configuration Service API Field:

payments.cardProcessing.configurationInformation.configurations.common.sicCode

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. subMerchantBusinessName

Sub-merchant's business name.

This field is available for this processor: American Express Direct.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
              "common": {
                "subMerchantBusinessName": "Submerchant Business"
              }
            }
          }
        }
      }
    }
  }
}

The value of this field must conform to this regular expression:

^[0-9a-zA-Z\-\_\,\s.]+$

Specifications

Data Type:
String

Minimum Data Length:
1

Maximum Data Length:
37

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardProcessing.configurationInformation. configurations.common.subMerchantBusinessName

Product Enablement and Configuration Service API Field:

payments.cardProcessing.configurationInformation.configurations.common. subMerchantBusinessName

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. subMerchantId

The ID assigned to the sub-merchant.

This field is available for these processors: American Express Direct.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
              "common": {
                "subMerchantId": "submerchid"
              }
            }
          }
        }
      }
    }
  }
}

<processor>
: The processor that is associated with the merchant account.

The value of this field must conform to this regular expression:

^[0-9a-zA-Z\-\_\,\s.]+$

Specifications

Data Type:
String

Minimum Data Length:
1

Maximum Data Length:
20

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardProcessing.configurationInformation. configurations.common.subMerchantId

Product Enablement and Configuration Service API Field:

payments.cardProcessing.configurationInformation.configurations.common.subMerchantId

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. visaDelegatedAuthenticationId

The identifier that is provided to merchants who opt for Visa’s delegated authorization program.

This field is available for these processors: Visa Platform Connect.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
              "common": {
                "visaDelegatedAuthenticationId": "0123"
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
String

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardProcessing.configurationInformation. configurations.common.visaDelegatedAuthenticationId

Product Enablement and Configuration Service API Field:

payments.cardProcessing.configurationInformation.configurations.common. visaDelegatedAuthenticationId

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. processors. [processorName]. acquirer

Merchant's acquiring bank.

Syntax

{
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
              "common": {
                "processors": [
                  "<processor>": {
                    "acquirer": "acquiringBank"
                  }
                ]
              }
            }
          }
        }
      }
    }
  }
}

<processor>
: The processor that is associated with the merchant account.

The value of this field must conform to the regular expression format:

^[0-9a-zA-Z]+$

Specifications

Data Type:
String

Minimum Data Length:
1

Maximum data Length:
15

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardProcessing.configurationInformation. configurations.common.processors.[processorName].acquirer

Product Enablement and Configuration Service API Field:

payments.cardProcessing.configurationInformation.configurations.common. processors.[processorName].acquirer

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. processors.[processorName]. allowMerchantDescriptorOverride

Enables a partner to enable or disable merchant descriptor values.

This field is available for these processors: China UnionPay, eftpos, and Visa Platform Connect.

Possible Values

true

false

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
              "common": {
                "processors": [
                  "<processor>": {
                    "allowMerchantDescriptorOverride": "true"
                  }
                ]
              }
            }
          }
        }
      }
    }
  }
}

<processor>
: The processor that is associated with the merchant account.

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardProcessing.configurationInformation. configurations.common.processors.[processorName].allowMerchantDescriptorOverride

Product Enablement and Configuration Service API Field:

payments.cardProcessing.configurationInformation.configurations.common. processors.[processorName].allowMerchantDescriptorOverride

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. processors.[processorName]. allowMultipleBills

If field it set to

true

, it enables a merchant to allow multiple captures for a single authorization transaction.

This field is available for these processors: American Express Direct, Chase Paymentech Tandem GPX, Visa Platform Connect.

Possible Values

true

false

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
              "common": {
                "processors": [
                  "<processor>": {
                    "allowMultipleBills": "true"
                  }
                ]
              }
            }
          }
        }
      }
    }
  }
}

<processor>
: The processor that is associated with the merchant account.

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardProcessing.configurationInformation. configurations.common.processors.[processorName].allowMultipleBills

Product Enablement and Configuration Service API Field:

payments.cardProcessing.configurationInformation.configurations.common. processors.[processorName].allowMultipleBills

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. processors.[processorName]. enhancedData

Enhanced data available for airline transactions.

This field is available for these processors: American Express Direct, Barclays Merchant Services, Elavon Americas, FDC Nashville Global, GPX, TSYS Acquiring Solutions and Visa Platform Connect.

Possible Values

enabled

disabled

ignored

required

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
              "common": {
                "processors": [
                  "<processor>": {
                    "enhancedData": "enabled"
                  }
                ]
              }
            }
          }
        }
      }
    }
  }
}

<processor>
: The processor that is associated with the merchant account.

Specifications

Data Type:
Enum

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardProcessing.configurationInformation. configurations.common.processors.[processorName].enhancedData

Product Enablement and Configuration Service API Field:

payments.cardProcessing.configurationInformation.configurations.common. processors.[processorName].enhancedData

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. processors.[processorName]. fireSafetyIndicator

When this field is set to

true

, it indicates that the merchant is compliant with the Hotel and Motel Fire Safety Act of 1990.

This field is available for these processors: GPX and Visa Platform Connect.

Possible Values

true

false

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
              "common": {
                "processors": [
                  "<processor>": {
                    "fireSafetyIndicator": "true"
                  }
                ]
              }
            }
          }
        }
      }
    }
  }
}

<processor>
: The processor that is associated with the merchant account.

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardProcessing.configurationInformation. configurations.common.processors.[processorName].fireSafetyIndicator

Product Enablement and Configuration Service API Field:

payments.cardProcessing.configurationInformation.configurations.common. processors.[processorName].fireSafetyIndicator

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. processors.[processorName]. industryCode

Field that is used to identify the industry type of the merchant submitting the authorization request.

This field is available for these processors: Elavon Americas, RuPay and TSYS Acquiring Solutions.

Possible Values

0

: Unknown or unsure

A

: Auto rental (EMV supported)

B

: Bank/financial institution (EMV supported)

D

: Direct marketing

F

: Food/restaurant (EMV supported)

G

: Grocery store/super market (EMV supported)

H

: Hotel (EMV supported)

L

: Limited amount terminal (EMV supported)

O

: Oil company/automated fueling system (EMV supported)

P

: Passenger transport (EMV supported)

R

: Retail (EMV supported)

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
              "common": {
                "processors": [
                  "<processor>": {
                    "industryCode": "0"
                  }
                ]
              }
            }
          }
        }
      }
    }
  }
}

<processor>
: The processor that is associated with the merchant account.

Specifications

Data Type:
Enum

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardProcessing.configurationInformation. configurations.common.processors.[processorName].industryCode

Product Enablement and Configuration Service API Field:

payments.cardProcessing.configurationInformation.configurations.common. processors.[processorName].industryCode

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. processors.[processorName]. merchantId

The merchant ID that is provided by the acquirer or processor.

This field is available for these processors: Barclays HISO, Barclays Merchant Services, and Elavon Americas.

Syntax

{
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
              "common": {
                "processors": [
                  "<processor>": {
                    "merchantId": "merchant2345"
                  }
                ]
              }
            }
          }
        }
      }
    }
  }
}

<processor>
: The processor that is associated with the merchant account.

The value of this field must conform to the regular expression format:

^[0-9a-zA-Z]+$

Specifications

Data Type:
String

Minimum Data Length:
1

Maximum Data Length:

Barclays HISO:
15

Barclays Merchant Services:
11

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardProcessing.configurationInformation. configurations.common.processors.[processorName].merchantId

Product Enablement and Configuration Service API Field:

payments.cardProcessing.configurationInformation.configurations.common. processors.[processorName].merchantId

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. processors.[processorName]. merchantBinNumber

6-digit acquirer bank identification number (BIN).

This field is available for these processors: TSYS Acquiring Solutions.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
              "common": {
                "processors": [
                  "vital": {
                    "merchantBinNumber": "123456"
                  }
                ]
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
String

Data Length:
6

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardProcessing.configurationInformation. configurations.common.processors.[processorName].merchantBinNumber

Product Enablement and Configuration Service API Field:

payments.cardProcessing.configurationInformation.configurations.common. processors.[processorName].merchantBinNumber

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. processors.[processorName]. merchantLocationNumber

5-digit merchant location number. Unless otherwise specified by merchant’s bank or processor, this field should default to

00001

.

This field is available for the following processors: TSYS Acquiring Solutions.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
              "common": {
                "processors": [
                  "vital": {
                    "merchantLocationNumber": "00001"
                  }
                ]
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
String

Data Length:
5

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardProcessing.configurationInformation. configurations.common.processors.[processorName].merchantLocationNumber

Product Enablement and Configuration Service API Field:

payments.cardProcessing.configurationInformation.configurations.common. processors.[processorName].merchantLocationNumber

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. processors.[processorName]. merchantTier

Defines the type of merchant. The numeric merchant tier value is assigned by eftpos.

This field is available for these processors: eftpos.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
              "common": {
                "processors": [
                  "eftpos": {
                    "merchantTier": "01"
                  }
                ]
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
String

Minimum Data Length:
3

Maximum Data Length:
3

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardProcessing.configurationInformation. configurations.common.processors.[processorName].merchantTier

Product Enablement and Configuration Service API Field:

payments.cardProcessing.configurationInformation.configurations.common. processors.[processorName].merchantTier

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. processors.[processorName]. sicCode

Standard Industrial Classification (SIC) code is a 4-digit code that categorizes the industry that the company belongs to based on their business activities. SIC codes were mostly replaced by the 6-digit North American Industry Classification System (NAICS).

This field is available for these processors: GPX and Visa Platform Connect.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
              "common": {
                "processors": [
                  "<processor>": {
                    "sicCode": "1234"
                  }
                ]
              }
            }
          }
        }
      }
    }
  }
}

<processor>
: The processor that is associated with the merchant account.

Specifications

Data Type:
String

Data Length:
4

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardProcessing.configurationInformation. configurations.common.processors.[processorName].sicCode

Product Enablement and Configuration Service API Field:

payments.cardProcessing.configurationInformation.configurations.common. processors.[processorName].sicCode

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. common. processors.[processorName]. terminalId

Terminal ID used with the payment processor. Depending on the processor and payment acceptance type, this may also be the default terminal ID used for card-present and virtual terminal transactions.

This field is available for this processors: Barclays HISO.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
              "common": {
                "processors": [
                  "<processor>": {
                    "terminalId": "merchant2345"
                  }
                ]
              }
            }
          }
        }
      }
    }
  }
}

<processor>
: The processor that is associated with the merchant account.

The value of this field must conform to the regular expression format:

^[0-9a-zA-Z]+$

Specifications

Data Type:
String

Minimum Data Length:
1

Maximum Data Length:
16

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardProcessing.configurationInformation. configurations.common.processors.[processorName].terminalId

Product Enablement and Configuration Service API Field:

payments.cardProcessing.configurationInformation.configurations.common. processors.[processorName].terminalId

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. features. cardNotPresent. processors.[processorName]. relaxAddressVerificationSystem

Enables merchants to accept e-commerce transactions without the Address Verification System (AVS) feature.

These parameters are established by the merchant through their service provider.

This field is available for these processors: American Express Direct, Barclays HISO, CB2A, Chase Paymentech Solutions, Credit Mutuel-CIC, FDC Nashville Global, Fiserv, GPN, RuPay, SIX, Vero, and Visa Platform Connect.

Syntax

{
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
              "features": {
                "cardNotPresent":{
                  "processors": [
                    "<processor>": {
                      "relaxAddressVerificationSystem": "true"
                    }
                  ]
                }
              }
            }
          }
        }
      }
    }
  }
}

<processor>
: The processor that is associated with the merchant account.

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardProcessing.configurationInformation.configurations.common.processors.[processorName].paymentTypes.[paymentType].enable

Product Enablement and Configuration Service API Field:

payments.cardProcessing.configurationInformation.configurations.common.processors.[processorName].paymentTypes.[paymentType].enabled

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. features. cardNotPresent. processors.[processorName]. relaxAddressVerificationSystemAllowExpiredCard

Allows merchants to accept card-not-present and e-commerce transactions with expired cards.

This field is available for these processors: American Express Direct, Barclays HISO, CB2A, Chase Paymentech Solutions, FDC Nashville Global, GPN, RuPay, SIX, and Visa Platform Connect.

Syntax

{
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
              "features": {
                "cardNotPresent":{
                  "processors": [
                    "<processor>": {
                      "relaxAddressVerificationSystemAllowExpiredCard": "true"
                    }
                  ]
                }
              }
            }
          }
        }
      }
    }
  }
}

<processor>
: The processor that is associated with the merchant account.

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardProcessing.configurationInformation.configurations.common.processors.[processorName].paymentTypes.[paymentType].enable

Product Enablement and Configuration Service API Field:

payments.cardProcessing.configurationInformation.configurations.common.processors.[processorName].paymentTypes.[paymentType].enabled

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. features. cardNotPresent. processors.[processorName]. relaxAddressVerificationSystemAllowZipWithoutCountry

Enables merchants to accept e-commerce transactions without the Address Verification System (AVS) and allows transactions with just the ZIP code and country code.

This field is available for these processors: American Express Direct, Barclays HISO, Chase Paymentech Solutions, FDC Nashville Global, Elavon Americas, RuPay, and Visa Platform Connect.

Syntax

{
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
              "features": {
                "cardNotPresent":{
                  "processors": [
                    "<processor>": {
                      "relaxAddressVerificationSystemAllowZipWithoutCountry": "true"
                    }
                  ]
                }
              }
            }
          }
        }
      }
    }
  }
}

<processor>
: The processor that is associated with the merchant account.

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardProcessing.configurationInformation.configurations.common.processors.[processorName].paymentTypes.[paymentType].enable

Product Enablement and Configuration Service API Field:

payments.cardProcessing.configurationInformation.configurations.common.processors.[processorName].paymentTypes.[paymentType].enabled

productInformation. selectedProducts. payments. cardProcessing. configurationInformation. configurations. features. cardPresent. processors.[processorName]. defaultPointOfSaleTerminalId

Default terminal ID used with card-present transactions.

This field is available for these processors: American Express Direct, Chase Paymentech Solutions, and Visa Platform Connect.

Syntax

{
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "configurationInformation": {
            "configurations": {
              "features": {
                "cardPresent":{
                  "processors": [
                    "<processor>": {
                      "defaultPointOfSaleTerminalId": "terminal"
                    }
                  ]
                }
              }
            }
          }
        }
      }
    }
  }
}

<processor>
: The processor that is associated with the merchant account.

The field's value must conform to the following regular expression format:

^[0-9a-zA-Z]+$

Specifications

Data Type:
String

Minimum Field Length:
1

Maximum Field Length:
8

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardProcessing.configurationInformation.configurations.common.processors.[processorName].paymentTypes.[paymentType].enable

Product Enablement and Configuration Service API Field:

payments.cardProcessing.configurationInformation.configurations.common.processors.[processorName].paymentTypes.[paymentType].enabled

productInformation. selectedProducts. payments. cardProcessing. subscriptionInformation. enabled

Indicates whether a subscription to the payments service is enabled for card processing.

Possible Values

true

false

Syntax

{
"productInformation": {
  "selectedProducts": {
    "payments": {
      "cardProcessing": {
       "subscriptionInformation": {
         "enabled": "true"
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardProcessing. subscriptionInformation.enabled

Product Enablement and Configuration Service API Field:

payments.cardProcessing.subscriptionInformation.enabled

productInformation. selectedProducts. payments. cardProcessing. subscriptionInformation. features. cardNotPresent. enabled

Indicates whether card-not-present features are enabled for card processing.

Possible Values

true

false

Syntax

{
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "subscriptionInformation": {
            "features": {
              "cardNotPresent": {
                "enabled": "true"
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardProcessing. subscriptionInformation.enable

Product Enablement and Configuration Service API Field:

payments.cardProcessing.subscriptionInformation.enabled

productInformation. selectedProducts. payments. cardProcessing. subscriptionInformation. features. cardPresent. enabled

Indicates whether card-present features are enabled for card processing.

Possible Values

true

false

Syntax

{
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cardProcessing": {
          "subscriptionInformation": {
            "features": {
              "cardPresent": {
                "enabled": "true"
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cardProcessing. subscriptionInformation.features.cardPresent.enable

Product Enablement and Configuration Service API Field:

payments.cardProcessing.subscriptionInformation.features. cardPresent.enabled

productInformation. selectedProducts. payments. customerInvoicing. subscriptionInformation. enabled

Determines if subscription information is enabled for Customer Invoicing.

Possible Values

true

false

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "customerInvoicing": {
          "subscriptionInformation": {
            "enabled": "true"
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.customerInvoicing. subscriptionInformation.enabled

Product Enablement and Configuration Service API Field:

payments.customerInvoicing.subscriptionInformation.enabled

productInformation. selectedProducts. payments. customerInvoicing. subscriptionInformation. selfServiceability

This field value indicates whether the organization can enable Customer Invoicing using self service.

Possible Values

NOT_SELF_SERVICEABLE

(default)

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "customerInvoicing": {
          "subscriptionInformation": {
            "selfServiceability": "NOT_SELF_SERVICEABLE"
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Enum

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.customerInvoicing. subscriptionInformation.selfServiceability

Product Enablement and Configuration Service API Field:

payments.customerInvoicing.subscriptionInformation.selfServiceability

productInformation. selectedProducts. payments. cybsReadyTerminal. subscriptionInformation. enabled

Determines if subscription information is enabled for Visa Acceptance Solutions Ready Terminals.

Possible Values

true

false

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cybsReadyTerminal": {
          "subscriptionInformation": {
            "enabled": "true"
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cybsReadyTerminal. subscriptionInformation.enabled

Product Enablement and Configuration Service API Field:

payments.cybsReadyTerminal.subscriptionInformation.enabled

productInformation. selectedProducts. payments. cybsReadyTerminal. subscriptionInformation. selfServiceability

This field value indicates whether the organization can enable Visa Acceptance Solutions Ready Terminals using self service.

Possible Values

NOT_SELF_SERVICEABLE

(default)

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "cybsReadyTerminal": {
          "subscriptionInformation": {
            "selfServiceability": "NOT_SELF_SERVICEABLE"
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Enum

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.cybsReadyTerminal. subscriptionInformation.selfServiceability

Product Enablement and Configuration Service API Field:

payments.cybsReadyTerminal.subscriptionInformation.selfServiceability

productInformation. selectedProducts. payments. differentialFee. subscriptionInformation. enabled

Determines if subscription information is enabled for Differential Fees.

Possible Values

true

false

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "differentialFee": {
          "subscriptionInformation": {
            "enabled": "true"
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.differentialFee. subscriptionInformation.enabled

Product Enablement and Configuration Service API Field:

payments.differentialFee.subscriptionInformation.enabled

productInformation. selectedProducts. payments. differentialFee. subscriptionInformation. features. surcharge. enabled

Determines if subscription information is enabled for Differential Fee surcharges.

Possible Values

true

false

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "differentialFee": {
          "subscriptionInformation": {
            "features": {
              "surcharge": {
                "enabled": "true"
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.differentialFee. subscriptionInformation.features.surcharge.enabled

Product Enablement and Configuration Service API Field:

payments.differentialFee.subscriptionInformation.features.surcharge.enabled

productInformation. selectedProducts. payments. differentialFee. subscriptionInformation. selfServiceability

This field value indicates whether the organization can enable Differential Fees using self service.

Possible Values

NOT_SELF_SERVICEABLE

(default)

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "differentialFee": {
          "subscriptionInformation": {
            "selfServiceability": "NOT_SELF_SERVICEABLE"
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Enum

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.differentialFee. subscriptionInformation.selfServiceability

Product Enablement and Configuration Service API Field:

payments.differentialFee.subscriptionInformation.selfServiceability

productInformation. selectedProducts. payments. digitalPayments. subscriptionInformation. enabled

Determines if subscription information is enabled for Digital Payments.

Possible Values

true

false

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "digitalPayments": {
          "subscriptionInformation": {
            "enabled": "true"
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.digitalPayments. subscriptionInformation.enabled

Product Enablement and Configuration Service API Field:

payments.digitalPayments.subscriptionInformation.enabled

productInformation. selectedProducts. payments. digitalPayments. subscriptionInformation. features[]. enabled

Determines if subscription information is enabled for Digital Payment features.

Possible Values

true

false

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "differentialFee": {
          "subscriptionInformation": {
            "features": [
              "enabled": "true"
            ]
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.digitalPayments. subscriptionInformation.features[].enabled

Product Enablement and Configuration Service API Field:

payments.digitalPayments.subscriptionInformation.features[].enabled

productInformation. selectedProducts. payments. digitalPayments. subscriptionInformation. selfServiceability

This field value indicates whether the organization can enable Digital Payments using self service.

Possible Values

NOT_SELF_SERVICEABLE

(default)

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "digitalPayments": {
          "subscriptionInformation": {
            "selfServiceability": "NOT_SELF_SERVICEABLE"
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Enum

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.digitalPayments. subscriptionInformation.selfServiceability

Product Enablement and Configuration Service API Field:

payments.digitalPayments.subscriptionInformation.selfServiceability

productInformation. selectedProducts. payments. echeck. configurationInformation. configurations. common. accountHolderName

Name on the merchant's bank account. The field value must be in ASCII format (Hex 20 to Hex 7E).

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "echeck": {
          "configurationInformation": {
            "configurations": {
              "common": {
                "accountHolderName": "Matt Smith"
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
String

Minimum Data Length:
0

Maximum Data Length:
22

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.echeck. configurationInformation.configurations.common.accountHolderName

Product Enablement and Configuration Service API Field:

payments.echeck.configurationInformation.configurations.common.accountHolderName

productInformation. selectedProducts. payments. echeck. configurationInformation. configurations. common. accountNumber

The account number that is configured for the merchant's bank account.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "echeck": {
          "configurationInformation": {
            "configurations": {
              "common": {
                "accountNumber": "11112222333344445"
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
String

Minimum Data Length:
0

Maximum Data Length:
17

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.echeck. configurationInformation.configurations.common.accountNumber

Product Enablement and Configuration Service API Field:

payments.echeck.configurationInformation.configurations.common.accountNumber

productInformation. selectedProducts. payments. echeck. configurationInformation. configurations. common. accountRoutingNumber

US account routing number for the merchant's bank account.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "echeck": {
          "configurationInformation": {
            "configurations": {
              "common": {
                "accountRoutingNumber": "123456789"
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
String

Minimum Data Length:
0

Maximum Data Length:
9

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.echeck. configurationInformation.configurations.common.accountRoutingNumber

Product Enablement and Configuration Service API Field:

payments.echeck.configurationInformation.configurations.common.accountRoutingNumber

productInformation. selectedProducts. payments. echeck. configurationInformation. configurations. common. accountType

The account type of the merchant's bank account.

Possible Values

checking

savings

corporatechecking

corporatesavings

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "echeck": {
          "configurationInformation": {
            "configurations": {
              "common": {
                "accountType": "checking"
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Enum

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.echeck. configurationInformation.configurations.common.accountType

Product Enablement and Configuration Service API Field:

payments.echeck.configurationInformation.configurations.common.accountType

productInformation. selectedProducts. payments. echeck. configurationInformation. configurations. common. processors.[processorName]. batchGroup

Batch group of the capture request that is sent to the payment processor.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "echeck": {
          "configurationInformation": {
            "configurations": {
              "common": {
                "processors": [
                  "<processor>": {
                    "batchGroup": "<Timezone>"
                  }
                ]
              }
            }
          }
        }
      }
    }
  }
}

<processor>
: The processor that is associated with the merchant account.

Specifications

Data Type:
String

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.echeck. configurationInformation.configurations.common.processors.[processorName].batchGroup

Product Enablement and Configuration Service API Field:

payments.echeck.configurationInformation.configurations. common.processors.[processorName].batchGroup

productInformation. selectedProducts. payments. echeck. configurationInformation. configurations. common. processors.[processorName]. companyEntryDescription

Merchant-defined description of the company entry. For example,

PAYROLL

,

GAS BILL

,

INS PREM

.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "echeck": {
          "configurationInformation": {
            "configurations": {
              "common": {
                "processors": [
                  "<processor>": {
                    "companyEntryDescription": "PAYROLL"
                  }
                ]
              }
            }
          }
        }
      }
    }
  }
}

<processor>
: The processor that is associated with the merchant account.

Specifications

Data Type:
String

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.echeck. configurationInformation.configurations.common.processors.[processorName].companyEntryDescription

Product Enablement and Configuration Service API Field:

payments.echeck.configurationInformation.configurations. common.processors.[processorName].companyEntryDescription

productInformation. selectedProducts. payments. echeck. configurationInformation. configurations. common. processors.[processorName]. companyId

The company identifier that is assigned to a merchant by the acquiring bank.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "echeck": {
          "configurationInformation": {
            "configurations": {
              "common": {
                "processors": [
                  "<processor>": {
                    "companyId": ""
                  }
                ]
              }
            }
          }
        }
      }
    }
  }
}

<processor>
: The processor that is associated with the merchant account.

Specifications

Data Type:
String

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.echeck. configurationInformation.configurations.common.processors.[processorName].companyId

Product Enablement and Configuration Service API Field:

payments.echeck.configurationInformation.configurations. common.processors.[processorName].companyId

productInformation. selectedProducts. payments. echeck. configurationInformation. configurations. common. processors.[processorName]. setCompletedState

This field value determines when transactions are automatically updated to a completed state. When this field is set to

true

, Visa Acceptance Solutions will automatically update transactions to a completed status after a set number of days after the transaction comes through and if no failure notification is received. When set to

false

, Visa Acceptance Solutions will not update transaction status.

Possible Values

true

false

(default)

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "echeck": {
          "configurationInformation": {
            "configurations": {
              "common": {
                "processors": [
                  "<processor>": {
                    "setCompletedState": "false"
                  }
                ]
              }
            }
          }
        }
      }
    }
  }
}

<processor>
: The processor that is associated with the merchant account.

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.echeck. configurationInformation.configurations.common.processors.[processorName].setCompletedState

Product Enablement and Configuration Service API Field:

payments.echeck.configurationInformation.configurations. common.processors.[processorName].setCompletedState

productInformation. selectedProducts. payments. echeck. configurationInformation. configurations. underwriting. enableCredits

Indicates if credits are enabled.

Possible Values

true

false

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "echeck": {
          "configurationInformation": {
            "configurations": {
              "underwriting": {
                "enableCredits": "true"
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.echeck. configurationInformation.configurations.underwriting.enableCredits

Product Enablement and Configuration Service API Field:

payments.echeck.configurationInformation.configurations. underwriting.enableCredits

productInformation. selectedProducts. payments. echeck. configurationInformation. configurations. underwriting. enableHold

Determines whether Visa Acceptance Solutions has placed the merchant on a funding hold.

This field will often be set to

true

for new merchants until the risk team has completed additional verification of their first transaction. The field value is switched to

false

when underwriting review is completed.

Possible Values

true

false

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "echeck": {
          "configurationInformation": {
            "configurations": {
              "underwriting": {
                "enableHold": "true"
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.echeck. configurationInformation.configurations.underwriting.enableHold

Product Enablement and Configuration Service API Field:

payments.echeck.configurationInformation.configurations.underwriting.enableHold

productInformation. selectedProducts. payments. echeck. configurationInformation. configurations. underwriting. holdingDays

The number of days funds will be held before it will be deposited into merchant account. The default value is

7

.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "echeck": {
          "configurationInformation": {
            "configurations": {
              "underwriting": {
                "holdingDays": "7"
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
String

Data Length:
3

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.echeck. configurationInformation.configurations.underwriting.holdingDays

Product Enablement and Configuration Service API Field:

payments.echeck.configurationInformation.configurations.underwriting.holdingDays

productInformation. selectedProducts. payments. echeck. configurationInformation. configurations. underwriting. monthlyTotalTransactionAmountLimit

Monthly maximum total transaction amount.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "echeck": {
          "configurationInformation": {
            "configurations": {
              "underwriting": {
                "monthlyTotalTransactionAmountLimit": "100000.00"
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
String

Data Length:
12

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.echeck. configurationInformation.configurations.underwriting. monthlyTotalTransactionAmountLimit

Product Enablement and Configuration Service API Field:

payments.echeck.configurationInformation.configurations. underwriting.monthlyTotalTransactionAmountLimit

productInformation. selectedProducts. payments. echeck. configurationInformation. configurations. underwriting. riskReserveMethod

The method for establishing a reserve balance.

Possible Values

fixed

: For a Fixed Risk Reserve, the reserve balance is established by either:

A receipt of a lump sum deposit from a merchant.

Withholding funds at a reserve rate established for the account from each batch settlement until the reserve balance is equal to a set reserve target. A Fixed Reserve may also be established by a combination of lump sum deposit and withholding of settlement funds.

none

(default): Most merchants do not have a reserve attached to their account so the default field value would be

none

.

rolling

: Established by withholding from a merchant’s available settlement funds at a reserve rate and no reserve target is specified. Each amount withheld is retained for a specified number of reserve holding days and then released back to the merchant.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "echeck": {
          "configurationInformation": {
            "configurations": {
              "underwriting": {
                "riskReserveMethod": "none"
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Enum

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.echeck. configurationInformation.configurations.underwriting.riskReserveMethod

Product Enablement and Configuration Service API Field:

payments.echeck.configurationInformation.configurations. underwriting.riskReserveMethod

productInformation. selectedProducts. payments. echeck. configurationInformation. configurations. underwriting. riskReserveRate

The percentage rate at which risk funds are withheld from each eCheck.Net batch settlement.

Use this field when

productInformation.selectedProducts.payments.echeck.configurationInformation.configurations.underwriting.riskReserveMethod

is set to

fixed

or

rolling

.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "echeck": {
          "configurationInformation": {
            "configurations": {
              "underwriting": {
                "riskReserveRate": "10"
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
String

Minimum Data Length:
1

Maximum Data Length:
3

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.echeck. configurationInformation.configurations.underwriting.riskReserveRate

Product Enablement and Configuration Service API Field:

payments.echeck.configurationInformation.configurations. underwriting.riskReserveRate

productInformation. selectedProducts. payments. echeck. configurationInformation. configurations. underwriting. riskReserveTargetAmount

The maximum dollar amount that can be held in Risk Reserve for a Fixed Reserve. Once risk withholdings reach the Reserve Target established for the eCheck.Net account, a portion of available funds will be deposited to the merchant’s bank account. Use this field when the field

productInformation.selectedProducts.payments.echeck.configurationInformation.configurations.underwriting.riskReserveMethod

is set to

fixed

.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "echeck": {
          "configurationInformation": {
            "configurations": {
              "underwriting": {
                "riskReserveTargetAmount": "100000.00"
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
String

Data Length:
12

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.echeck. configurationInformation.configurations.underwriting.riskReserveTargetAmount

Product Enablement and Configuration Service API Field:

payments.echeck.configurationInformation.configurations. underwriting.riskReserveTargetAmount

productInformation. selectedProducts. payments. echeck. configurationInformation. configurations. underwriting. solutionOrganizationId

The organization identifier of the configured solution.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "echeck": {
          "configurationInformation": {
            "configurations": {
              "underwriting": {
                "solutionOrganizationId": "cybs_echeck"
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
String

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.echeck. configurationInformation.configurations.underwriting.solutionOrganizationId

Product Enablement and Configuration Service API Field:

payments.echeck.configurationInformation.configurations. underwriting.solutionOrganizationId

productInformation. selectedProducts. payments. echeck. configurationInformation. configurations. underwriting. standardEntryClassCodes

The standard entry class codes of the initiated transaction.

Possible Values

You can use each of these values or a combination of values:

CCD

: Cash concentration or disbursement (CCD) is a charge or refund against a business checking account. One-time or recurring CCD transactions are fund transfers to or from a corporate entity. A standing authorization is required for recurring transactions.

PPD

: Prearranged payment and deposit entry (PPD) is a charge or refund against a customer’s checking or savings account. PPD entries originate when payment and deposit terms between the merchant and the customer are prearranged. A written authorization from the customer is required for one-time transactions and a written standing authorization is required for recurring transactions.

TEL

: Telephone-initiated entry (TEL) is a one-time charge against a customer’s checking or savings account. TEL transactions originate when a business relationship between the merchant and the customer already exists. If a relationship does not exist, then TEL transactions can originate when the customer initiates a telephone call to the merchant. Payment authorization is obtained from the customer by telephone.

WEB

: Internet-initiated entry (WEB) is a charge against a customer’s checking or savings account. One-time or recurring WEB transactions are originated through the internet. Payment authorization is also obtained from the customer through the internet.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "echeck": {
          "configurationInformation": {
            "configurations": {
              "underwriting": {
                "standardEntryClassCodes": "WEB"
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Enum

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.echeck. configurationInformation.configurations.underwriting.standardEntryClassCodes

Product Enablement and Configuration Service API Field:

payments.echeck.configurationInformation.configurations. underwriting.standardEntryClassCodes

productInformation. selectedProducts. payments. echeck. configurationInformation. configurations. underwriting. transactionAmountLimit

Maximum total transaction amount for each individual transaction. For example, the merchant is limited to processing transactions under $100. Transaction amount limit must be in USD.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "echeck": {
          "configurationInformation": {
            "configurations": {
              "underwriting": {
                "transactionAmountLimit": "100"
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
String

Data Length:
12

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.echeck. configurationInformation.configurations.underwriting.transactionAmountLimit

Product Enablement and Configuration Service API Field:

payments.echeck.configurationInformation.configurations. underwriting.transactionAmountLimit

productInformation. selectedProducts. payments. echeck. configurationInformation. templateId

The template identifier that is configured for echeck.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "echeck": {
          "configurationInformation": {
            "templateId": "echeck_template"
          }
        }
      }
    }
  }
}

Specifications

Data Type:
String

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.echeck. configurationInformation.templateId

Product Enablement and Configuration Service API Field:

payments.echeck.configurationInformation.templateId

productInformation. selectedProducts. payments. echeck. subscriptionInformation. enabled

Determines if subscription information is enabled for echeck payments.

Possible Values

true

false

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "echeck": {
          "subscriptionInformation": {
            "enabled": "true"
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.echeck. subscriptionInformation.enabled

Product Enablement and Configuration Service API Field:

payments.echeck.subscriptionInformation.enabled

productInformation. selectedProducts. payments. echeck. subscriptionInformation. mode

Indicates what mode the product is expected to behave at boarding and transaction flows. For example,

acquirer

or

gateway

.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "echeck": {
          "subscriptionInformation": {
            "mode": "acquirer"
          }
        }
      }
    }
  }
}

Specifications

Data Type:
String

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.echeck.subscriptionInformation.mode

Product Enablement and Configuration Service API Field:

payments.echeck.subscriptionInformation.mode

productInformation. selectedProducts. payments. payByLink. subscriptionInformation. enabled

Determines if subscription information is enabled for Pay by Link payments.

Possible Values

true

false

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "digitalPayments": {
          "subscriptionInformation": {
            "enabled": "true"
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.payByLink. subscriptionInformation.enabled

Product Enablement and Configuration Service API Field:

payments.payByLink.subscriptionInformation.enabled

productInformation. selectedProducts. payments. payByLink. subscriptionInformation. selfServiceability

This field value indicates whether the organization can enable Pay by Link payments using self service.

Possible Values

NOT_SELF_SERVICEABLE

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "payByLink": {
          "subscriptionInformation": {
            "selfServiceability": "NOT_SELF_SERVICEABLE"
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Enum

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.payByLink. subscriptionInformation.selfServiceability

Product Enablement and Configuration Service API Field:

payments.payByLink.subscriptionInformation.selfServiceability

productInformation. selectedProducts. payments. payerAuthentication. configurationInformation. configurations. cardTypes. amexSafeKey. currencies. requestorId

This field is the requestor ID value assigned by a 3-D Secure directory server. It is used with 3-D Secure 2.0. When this field is passed in the request, it overrides the requestor ID value that is configured on the merchant's profile.

Syntax

  {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "payerAuthentication": {
          "configurationInformation": {
            "configurations": {
              "cardTypes": {
                "amexSafeKey": {
                    "currencies": {
                      "requestorId": "01234567891111
                    {
                  {
                }
              }
            }
          }
        }
      }
    }
  }

<currency>
: The currency that is supported by the merchant.

The value of this field must conform to this regular expression:

^[a-zA-Z0-9]{6,20}$

Specifications

Data Type:
String

Maximum Data Length:
35

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configurations.cardTypes.amexSafeKey.currencies.requestorId

Product Enablement and Configuration Service API Field:

payments.payerAuthentication.configurationInformation.configurations. cardTypes.amexSafeKey.currencies.requestorId

productInformation. selectedProducts. payments. payerAuthentication. configurationInformation. configurations. cardTypes. amexSafeKey. currencies. [currency]. acquirerId

The acquirer ID value, often referred to as the acquirer BIN, that is specific to an acquirer and configured for American Express SafeKey. The value is created by Cardinal in their system and the acquirer may not know that the acquirer ID is different from their acquiring BIN.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "payerAuthentication": {
          "configurationInformation": {
            "configurations": {
              "cardTypes": {
                "amexSafeKey": {
                  "currencies": [
                    <currency>:
                     "acquirerId": "acquirer_amexsafekey"
                  ]
                }
              }
            }
          }
        }
      }
    }
  }
}

<currency>
: The currency that is supported by the merchant.

The value of this field must conform to this regular expression:

^[a-zA-Z0-9]{6,20}$

Specifications

Data Type:
String

Minimum Data Length:
6

Maximum Data Length:
20

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configurations.cardTypes.amexSafeKey.currencies.[currency].acquirerId

Product Enablement and Configuration Service API Field:

payments.payerAuthentication.configurationInformation.configurations. cardTypes.amexSafeKey.currencies.[currency].acquirerId

productInformation. selectedProducts. payments. payerAuthentication. configurationInformation. configurations. cardTypes. amexSafeKey. currencies. [currency]. currencyCodes

The ISO standard numerical currency code of the currency that is configured for the merchant for American Express SafeKey. For information on ISO currency codes, see the ISO Country Currency Codes website.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "payerAuthentication": {
          "configurationInformation": {
            "configurations": {
              "cardTypes": {
                "amexSafeKey": {
                  "currencies": [
                    {
                      <currency>:
                       "currencyCodes": ["ALL, "978"]
                    }
                  ]
                }
              }
            }
          }
        }
      }
    }
  }
}

<currency>
: The currency that is supported by the merchant.

Specifications

Data Type:
String

Data Length:
3

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configurations.cardTypes.amexSafeKey.currencies.[currency].currencyCodes

Product Enablement and Configuration Service API Field:

payments.payerAuthentication.configurationInformation.configurations. cardTypes.amexSafeKey.currencies.[currency].currencyCodes

productInformation. selectedProducts. payments. payerAuthentication. configurationInformation. configurations. cardTypes. amexSafeKey. currencies. [currency]. processorMerchantId

Merchant identifier assigned by your acquiring bank and configured for American Express SafeKey. This merchant ID should also be used by your bank to register your account to the card scheme Directory Server for processing Payer Authentication services.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "payerAuthentication": {
          "configurationInformation": {
            "configurations": {
              "cardTypes": {
                "amexSafeKey": {
                  "currencies": [
                    <currency>:
                     "processorMerchantId": "procmerchantid"
                  ]
                }
              }
            }
          }
        }
      }
    }
  }
}

<currency>
: The currency that is supported by the merchant.

The value of this field must conform to this regular expression:

^[a-zA-Z0-9]{6,35}$

Specifications

Data Type:
String

Minimum Data Length:
6

Maximum Data Length:
35

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configurations.cardTypes.amexSafeKey.currencies.[currency].processorMerchantId

Product Enablement and Configuration Service API Field:

payments.payerAuthentication.configurationInformation.configurations. cardTypes.amexSafeKey.currencies.[currency].processorMerchantId

productInformation. selectedProducts. payments. payerAuthentication. configurationInformation. configurations. cardTypes. amexSafeKey. enabled

Determines if American Express SafeKey is an enabled card type for Payer Authentication.

Possible Values

true

false

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "payerAuthentication": {
          "configurationInformation": {
            "configurations": {
              "cardTypes": {
                "amexSafeKey": {
                  "enabled": "true"
                }
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configurations.cardTypes.amexSafeKey.enabled

Product Enablement and Configuration Service API Field:

payments.payerAuthentication.configurationInformation.configurations. cardTypes.amexSafeKey.enabled

productInformation. selectedProducts. payments. payerAuthentication. configurationInformation. configurations. cardTypes. amexSafeKey. currencies. requestorName

This field is the 3-D Secure requestor name value that is assigned by the directory server.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "payerAuthentication": {
          "configurationInformation": {
            "configurations": {
              "cardTypes": {
                "amexSafeKey": {
                  "currencies": {
                     "requestorName": "name"
                     }
                  ]
                }
              }
            }
          }
        }
      }
    }
  }

<currency>
: The currency that is supported by the merchant.

The value of this field must conform to this regular expression:

^[a-zA-Z0-9]{6,20}$

Specifications

Data Type:
String

Maximum Data Length:
40

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configurations.cardTypes.amexSafeKey.currencies.requestorName

Product Enablement and Configuration Service API Field:

payments.payerAuthentication.configurationInformation.configurations. cardTypes.amexSafeKey.currencies.requestorName

productInformation. selectedProducts. payments. payerAuthentication. configurationInformation. configurations. cardTypes. CB. currencies. [currency]. acquirerId

The acquirer ID value, often referred to as the acquirer BIN, that is specific to an acquirer and configured for Cartes Bancaires. The value is created by Cardinal in their system and the acquirer may not know that the acquirer ID is different from their acquiring BIN.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "payerAuthentication": {
          "configurationInformation": {
            "configurations": {
              "cardTypes": {
                "CB": {
                  "currencies": [
                    <currency>:
                     "acquirerId": "acquirer_cb"
                  ]
                }
              }
            }
          }
        }
      }
    }
  }
}

<currency>
: The currency that is supported by the merchant.

The value of this field must conform to this regular expression:

^[a-zA-Z0-9]{6,20}$

Specifications

Data Type:
String

Minimum Data Length:
6

Maximum Data Length:
20

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configurations.cardTypes.CB.currencies.[currency].acquirerId

Product Enablement and Configuration Service API Field:

payments.payerAuthentication.configurationInformation.configurations. cardTypes.CB.currencies.[currency].acquirerId

productInformation. selectedProducts. payments. payerAuthentication. configurationInformation. configurations. cardTypes. CB. currencies. [currency]. currencyCodes

The ISO standard numerical currency code of the currency that is configured for the merchant for Cartes Bancaires. For information on ISO currency codes, see the ISO Country Currency Codes website.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "payerAuthentication": {
          "configurationInformation": {
            "configurations": {
              "cardTypes": {
                "CB": {
                  "currencies": [
                    {
                      <currency>:
                       "currencyCodes": ["ALL, "978"]
                    }
                  ]
                }
              }
            }
          }
        }
      }
    }
  }
}

<currency>
: The currency that is supported by the merchant.

Specifications

Data Type:
String

Data Length:
3

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configurations.cardTypes.CB.currencies.[currency].currencyCodes

Product Enablement and Configuration Service API Field:

payments.payerAuthentication.configurationInformation.configurations. cardTypes.CB.currencies.[currency].currencyCodes

productInformation. selectedProducts. payments. payerAuthentication. configurationInformation. configurations. cardTypes. CB. currencies. [currency]. processorMerchantId

Merchant identifier assigned by your acquiring bank and configured for Cartes Bancaires. This merchant ID should also be used by your bank to register your account to the card scheme Directory Server for processing Payer Authentication services.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "payerAuthentication": {
          "configurationInformation": {
            "configurations": {
              "cardTypes": {
                "CB": {
                  "currencies": [
                    <currency>:
                     "processorMerchantId": "procmerchantid"
                  ]
                }
              }
            }
          }
        }
      }
    }
  }
}

<currency>
: The currency that is supported by the merchant.

The value of this field must conform to this regular expression:

^[a-zA-Z0-9]{6,35}$

Specifications

Data Type:
String

Minimum Data Length:
6

Maximum Data Length:
35

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configurations.cardTypes.CB.currencies.[currency].processorMerchantId

Product Enablement and Configuration Service API Field:

payments.payerAuthentication.configurationInformation.configurations. cardTypes.CB.currencies.[currency].processorMerchantId

productInformation. selectedProducts. payments. payerAuthentication. configurationInformation. configurations. cardTypes. CB. currencies. requestorId

This field is the requestor ID value assigned by a 3-D Secure directory server. It is used with 3-D Secure 2.0. When this field is passed in the request, it overrides the requestor ID value that is configured on the merchant's profile. CB refers to the Cartes Bancaires card type.

Syntax

  {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "payerAuthentication": {
          "configurationInformation": {
            "configurations": {
              "cardTypes": {
                "CB": {
                    "currencies": {
                      "requestorId": "01234567891111
                    {
                  {
                }
              }
            }
          }
        }
      }
    }
  }

<currency>
: The currency that is supported by the merchant.

The value of this field must conform to this regular expression:

^[a-zA-Z0-9]{6,20}$

Specifications

Data Type:
String

Data Length:
14

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configurations.cardTypes.CB.currencies.requestorId

Product Enablement and Configuration Service API Field:

payments.payerAuthentication.configurationInformation.configurations. cardTypes.CB.currencies.requestorId

productInformation. selectedProducts. payments. payerAuthentication. configurationInformation. configurations. cardTypes. CB. currencies. requestorName

This field is the 3-D Secure requestor name value that is assigned by the directory server for a Cartes Bancaires card.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "payerAuthentication": {
          "configurationInformation": {
            "configurations": {
              "cardTypes": {
                "CB": {
                  "currencies": 
                     "requestorName": "name"
                     }
                  ]
                }
              }
            }
          }
        }
      }
    }
  }

<currency>
: The currency that is supported by the merchant.

The value of this field must conform to this regular expression:

^[a-zA-Z0-9]{6,20}$

Specifications

Data Type:
String

Maximum Data Length:
40

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configurations.cardTypes.CB.currencies.requestorName

Product Enablement and Configuration Service API Field:

payments.payerAuthentication.configurationInformation.configurations. cardTypes.CB.currencies.requestorName

productInformation. selectedProducts. payments. payerAuthentication. configurationInformation. configurations. cardTypes. CB. enabled

Determines if Cartes Bancaires is an enabled card type for Payer Authentication.

Possible Values

true

false

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "payerAuthentication": {
          "configurationInformation": {
            "configurations": {
              "cardTypes": {
                "CB": {
                  "enabled": "true"
                }
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configurations.cardTypes.CB.enabled

Product Enablement and Configuration Service API Field:

payments.payerAuthentication.configurationInformation.configurations. cardTypes.CB.enabled

productInformation. selectedProducts. payments. payerAuthentication. configurationInformation. configuration. cardTypes. currencies. requestorId

This field is for 3-D Secure 2.0 and the value is a Directory Server assigned 3-D Secure requestor ID. If this field is passed in request, it will override the requestor ID value that is configured on the merchant's profile.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "payerAuthentication": {
          "configurationInformation": {
            "configuration": {
              "cardTypes": {
                "CB": {
                  "requestorId": "01234567891111"
                }
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
String

Data Length:
14

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configuration.cardTypes.currencies.requestorId

Product Enablement and Configuration Service API Field:

payments.payerAuthentication.configurationInformation.configuration. cardTypes.currencies.requestorId

productInformation. selectedProducts. payments. payerAuthentication. configurationInformation. configurations. cardTypes. dinersClubInternationalProtectBuy. currencies. [currency]. acquirerId

The acquirer ID value, often referred to as the acquirer BIN, that is specific to an acquirer and configured for Diners Club International ProtectBuy. The value is created by Cardinal in their system and the acquirer may not know that the acquirer ID is different from their acquiring BIN.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "payerAuthentication": {
          "configurationInformation": {
            "configurations": {
              "cardTypes": {
                "dinersClubInternationalProtectBuy": {
                  "currencies": [
                    <currency>:
                     "acquirerId": "acquirer_diners"
                  ]
                }
              }
            }
          }
        }
      }
    }
  }
}

<currency>
: The currency that is supported by the merchant.

The value of this field must conform to this regular expression:

^[a-zA-Z0-9]{6,20}$

Specifications

Data Type:
String

Minimum Data Length:
6

Maximum Data Length:
20

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configurations.cardTypes.dinersClubInternationalProtectBuy. currencies.[currency].acquirerId

Product Enablement and Configuration Service API Field:

payments.payerAuthentication.configurationInformation.configurations. cardTypes.dinersClubInternationalProtectBuy.currencies.[currency].acquirerId

productInformation. selectedProducts. payments. payerAuthentication. configurationInformation. configurations. cardTypes. dinersClubInternationalProtectBuy. currencies. [currency]. currencyCodes

The ISO standard numerical currency code of the currency that is configured for the merchant for Diners Club International ProtectBuy. For information on ISO currency codes, see the ISO Country Currency Codes website.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "payerAuthentication": {
          "configurationInformation": {
            "configurations": {
              "cardTypes": {
                "dinersClubInternationalProtectBuy": {
                  "currencies": [
                    {
                      <currency>:
                       "currencyCodes": ["ALL, "978"]
                    }
                  ]
                }
              }
            }
          }
        }
      }
    }
  }
}

<currency>
: The currency that is supported by the merchant.

Specifications

Data Type:
String

Data Length:
3

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configurations.cardTypes.dinersClubInternationalProtectBuy. currencies.[currency].currencyCodes

Product Enablement and Configuration Service API Field:

payments.payerAuthentication.configurationInformation.configurations. cardTypes.dinersClubInternationalProtectBuy.currencies.[currency].currencyCodes

productInformation. selectedProducts. payments. payerAuthentication. configurationInformation. configurations. cardTypes. dinersClubInternationalProtectBuy. currencies. [currency]. processorMerchantId

Merchant identifier assigned by your acquiring bank and configured for Diners Club International ProtectBuy. This merchant ID should also be used by your bank to register your account to the card scheme Directory Server for processing Payer Authentication services.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "payerAuthentication": {
          "configurationInformation": {
            "configurations": {
              "cardTypes": {
                "dinersClubInternationalProtectBuy": {
                  "currencies": [
                    <currency>:
                     "processorMerchantId": "procmerchantid"
                  ]
                }
              }
            }
          }
        }
      }
    }
  }
}

<currency>
: The currency that is supported by the merchant.

The value of this field must conform to this regular expression:

^[a-zA-Z0-9]{6,35}$

Specifications

Data Type:
String

Minimum Data Length:
6

Maximum Data Length:
35

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configurations.cardTypes.dinersClubInternationalProtectBuy. currencies.[currency].processorMerchantId

Product Enablement and Configuration Service API Field:

payments.payerAuthentication.configurationInformation.configurations. cardTypes.dinersClubInternationalProtectBuy.currencies.[currency].processorMerchantId

productInformation. selectedProducts. payments. payerAuthentication. configurationInformation. configurations. cardTypes. dinersClubInternationalProtectBuy. currencies. requestorId

This field is the requestor ID value assigned by a 3-D Secure directory server. It is used with 3-D Secure 2.0. When this field is passed in the request, it overrides the requestor ID value that is configured on the merchant's profile.

Syntax

  {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "payerAuthentication": {
          "configurationInformation": {
            "configurations": {
              "cardTypes": {
                "dinersClubInternationalProtectBuy": {
                    "currencies": {
                      "requestorId": "01234567891111
                    {
                  {
                }
              }
            }
          }
        }
      }
    }
  }

<currency>
: The currency that is supported by the merchant.

The value of this field must conform to this regular expression:

^[a-zA-Z0-9]{6,20}$

Specifications

Data Type:
String

Maximum Data Length:
35

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configurations.cardTypes.dinersClubInternationalProtectBuy.currencies.requestorId

Product Enablement and Configuration Service API Field:

payments.payerAuthentication.configurationInformation.configurations. cardTypes.dinersClubInternationalProtectBuy.currencies.requestorId

productInformation. selectedProducts. payments. payerAuthentication. configurationInformation. configurations. cardTypes. dinersClubInternationalProtectBuy. currencies. requestorName

This field is the 3-D Secure requestor name value that is assigned by the directory server.

Syntax

  {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "payerAuthentication": {
          "configurationInformation": {
            "configurations": {
              "cardTypes": {
                "dinersClubInternationalProtectBuy": {
                  "currencies": {
                     "requestorName": "name"
                     }
                  ]
                }
              }
            }
          }
        }
      }
    }
  }

<currency>
: The currency that is supported by the merchant.

The value of this field must conform to this regular expression:

^[a-zA-Z0-9]{6,20}$

Specifications

Data Type:
String

Maximum Data Length:
40

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configurations.cardTypes.dinersClubInternationalProtectBuy.currencies.requestorName

Product Enablement and Configuration Service API Field:

payments.payerAuthentication.configurationInformation.configurations. cardTypes.dinersClubInternationalProtectBuy.currencies.requestorName

productInformation. selectedProducts. payments. payerAuthentication. configurationInformation. configurations. cardTypes. dinersClubInternationalProtectBuy. enabled

Determines if Diners Club International ProtectBuy is an enabled card type for Payer Authentication.

Possible Values

true

false

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "payerAuthentication": {
          "configurationInformation": {
            "configurations": {
              "cardTypes": {
                "dinersClubInternationalProtectBuy": {
                  "enabled": "true"
                }
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configurations.cardTypes.dinersClubInternationalProtectBuy. enabled

Product Enablement and Configuration Service API Field:

payments.payerAuthentication.configurationInformation.configurations. cardTypes.dinersClubInternationalProtectBuy.enabled

productInformation. selectedProducts. payments. payerAuthentication. configurationInformation. configurations. cardTypes. ELO. currencies. [currency]. acquirerId

The acquirer ID value, often referred to as the acquirer BIN, that is specific to an acquirer and configured for Elo. The value is created by Cardinal in their system and the acquirer may not know that the acquirer ID is different from their acquiring BIN.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "payerAuthentication": {
          "configurationInformation": {
            "configurations": {
              "cardTypes": {
                "ELO": {
                  "currencies": [
                    <currency>:
                     "acquirerId": "acquirer_elo"
                  ]
                }
              }
            }
          }
        }
      }
    }
  }
}

<currency>
: The currency that is supported by the merchant.

The value of this field must conform to this regular expression:

^[a-zA-Z0-9]{6,20}$

Specifications

Data Type:
String

Minimum Data Length:
6

Maximum Data Length:
20

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configurations.cardTypes.ELO.currencies.[currency].acquirerId

Product Enablement and Configuration Service API Field:

payments.payerAuthentication.configurationInformation.configurations. cardTypes.ELO.currencies.[currency].acquirerId

productInformation. selectedProducts. payments. payerAuthentication. configurationInformation. configurations. cardTypes. ELO. currencies. [currency]. currencyCodes

The ISO standard numerical currency code of the currency that is configured for the merchant for ELO. For information on ISO currency codes, see the ISO Country Currency Codes website.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "payerAuthentication": {
          "configurationInformation": {
            "configurations": {
              "cardTypes": {
                "ELO": {
                  "currencies": [
                    {
                      <currency>:
                       "currencyCodes": ["ALL, "978"]
                    }
                  ]
                }
              }
            }
          }
        }
      }
    }
  }
}

<currency>
: The currency that is supported by the merchant.

Specifications

Data Type:
String

Data Length:
3

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configurations.cardTypes.ELO.currencies.[currency].currencyCodes

Product Enablement and Configuration Service API Field:

payments.payerAuthentication.configurationInformation.configurations. cardTypes.ELO.currencies.[currency].currencyCodes

productInformation. selectedProducts. payments. payerAuthentication. configurationInformation. configurations. cardTypes. ELO. currencies.[currency]. processorMerchantId

Merchant identifier assigned by your acquiring bank and configured for ELO. This merchant ID should also be used by your bank to register your account to the card scheme Directory Server for processing Payer Authentication services.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "payerAuthentication": {
          "configurationInformation": {
            "configurations": {
              "cardTypes": {
                "ELO": {
                  "currencies": [
                    <currency>:
                     "processorMerchantId": "procmerchantid"
                  ]
                }
              }
            }
          }
        }
      }
    }
  }
}

<currency>
: The currency that is supported by the merchant.

The value of this field must conform to this regular expression:

^[a-zA-Z0-9]{6,35}$

Specifications

Data Type:
String

Minimum Data Length:
6

Maximum Data Length:
35

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configurations.cardTypes.ELO.currencies.[currency].processorMerchantId

Product Enablement and Configuration Service API Field:

payments.payerAuthentication.configurationInformation.configurations. cardTypes.ELO.currencies.[currency].processorMerchantId

productInformation. selectedProducts. payments. payerAuthentication. configurationInformation. configurations. cardTypes. ELO. currencies. requestorId

This field is the requestor ID value assigned by a 3-D Secure directory server. It is used with 3-D Secure 2.0. When this field is passed in the request, it overrides the requestor ID value that is configured on the merchant's profile.

Syntax

  {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "payerAuthentication": {
          "configurationInformation": {
            "configurations": {
              "cardTypes": {
                "ELO": {
                    "currencies": {
                      "requestorId": "01234567891111
                    {
                  {
                }
              }
            }
          }
        }
      }
    }
  }

<currency>
: The currency that is supported by the merchant.

The value of this field must conform to this regular expression:

^[a-zA-Z0-9]{6,20}$

Specifications

Data Type:
String

Maximum Data Length:
35

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configurations.cardTypes.ELO.currencies.requestorId

Product Enablement and Configuration Service API Field:

payments.payerAuthentication.configurationInformation.configurations. cardTypes.ELO.currencies.requestorId

productInformation. selectedProducts. payments. payerAuthentication. configurationInformation. configurations. cardTypes.ELO. currencies. requestorName

This field is the 3-D Secure requestor name value that is assigned by the directory server.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "payerAuthentication": {
          "configurationInformation": {
            "configurations": {
              "cardTypes": {
                "ELO": {
                  "currencies": {
                     "requestorName": "name"
                     }
                  ]
                }
              }
            }
          }
        }
      }
    }
  }
}

<currency>
: The currency that is supported by the merchant.

The value of this field must conform to this regular expression:

^[a-zA-Z0-9]{6,20}$

Specifications

Data Type:
String

Maximum Data Length:
40

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configurations.cardTypes.ELO.currencies.requestorName

Product Enablement and Configuration Service API Field:

payments.payerAuthentication.configurationInformation.configurations. cardTypes.ELO.currencies.requestorName

productInformation. selectedProducts. payments. payerAuthentication. configurationInformation. configurations. cardTypes. ELO. enabled

Determines if ELO is an enabled card type for Payer Authentication.

Possible Values

true

false

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "payerAuthentication": {
          "configurationInformation": {
            "configurations": {
              "cardTypes": {
                "ELO": {
                  "enabled": "true"
                }
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configurations.cardTypes.ELO.enabled

Product Enablement and Configuration Service API Field:

payments.payerAuthentication.configurationInformation.configurations. cardTypes.ELO.enabled

productInformation. selectedProducts. payments. payerAuthentication. configurationInformation. configurations. cardTypes. jCBJSecure. currencies. requestorId

This field is the requestor ID value assigned by a 3-D Secure directory server. It is used with 3-D Secure 2.0. When this field is passed in the request, it overrides the requestor ID value that is configured on the merchant's profile.

Syntax

  {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "payerAuthentication": {
          "configurationInformation": {
            "configurations": {
              "cardTypes": {
                "jCBJSecure": {
                    "currencies": {
                      "requestorId": "01234567891111
                    {
                  {
                }
              }
            }
          }
        }
      }
    }
  }
}

<currency>
: The currency that is supported by the merchant.

The value of this field must conform to this regular expression:

^[a-zA-Z0-9]{6,20}$

Specifications

Data Type:
String

Maximum Data Length:
35

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configurations.cardTypes.jCBJSecure.currencies.requestorId

Product Enablement and Configuration Service API Field:

payments.payerAuthentication.configurationInformation.configurations. cardTypes.jCBJSecure.currencies.requestorId

productInformation. selectedProducts. payments. payerAuthentication. configurationInformation. configurations. cardTypes. jCBJSecure. currencies. [currency]. acquirerId

The acquirer ID value, often referred to as the acquirer BIN, that is specific to an acquirer and configured for JCB J/Secure. The value is created by Cardinal in their system and the acquirer may not know that the acquirer ID is different from their acquiring BIN.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "payerAuthentication": {
          "configurationInformation": {
            "configurations": {
              "cardTypes": {
                "jCBJSecure": {
                  "currencies": [
                    <currency>:
                     "acquirerId": "acquirer_jcbjs"
                  ]
                }
              }
            }
          }
        }
      }
    }
  }
}

<currency>
: The currency that is supported by the merchant.

The value of this field must conform to this regular expression:

^[a-zA-Z0-9]{6,20}$

Specifications

Data Type:
String

Minimum Data Length:
6

Maximum Data Length:
20

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configurations.cardTypes.jCBJSecure. currencies.[currency].acquirerId

Product Enablement and Configuration Service API Field:

payments.payerAuthentication.configurationInformation.configurations. cardTypes.jCBJSecure.currencies.[currency].acquirerId

productInformation. selectedProducts. payments. payerAuthentication. configurationInformation. configurations. cardTypes. jCBJSecure. currencies. [currency]. currencyCodes

The ISO standard numerical currency code of the currency that is configured for the merchant for JCB J/Secure. For information on ISO currency codes, see the ISO Country Currency Codes website.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "payerAuthentication": {
          "configurationInformation": {
            "configurations": {
              "cardTypes": {
                "jCBJSecure": {
                  "currencies": [
                    {
                      <currency>:
                       "currencyCodes": ["ALL, "978"]
                    }
                  ]
                }
              }
            }
          }
        }
      }
    }
  }
}

<currency>
: The currency that is supported by the merchant.

Specifications

Data Type:
String

Data Length:
3

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configurations.cardTypes.jCBJSecure. currencies.[currency].currencyCodes

Product Enablement and Configuration Service API Field:

payments.payerAuthentication.configurationInformation.configurations. cardTypes.jCBJSecure.currencies.[currency].currencyCodes

productInformation. selectedProducts. payments. payerAuthentication. configurationInformation. configurations. cardTypes. jCBJSecure. currencies. [currency]. processorMerchantId

Merchant identifier assigned by your acquiring bank and configured for JCB J/Secure. This merchant ID should also be used by your bank to register your account to the card scheme Directory Server for processing Payer Authentication services.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "payerAuthentication": {
          "configurationInformation": {
            "configurations": {
              "cardTypes": {
                "jCBJSecure": {
                  "currencies": [
                    <currency>:
                     "processorMerchantId": "procmerchantid"
                  ]
                }
              }
            }
          }
        }
      }
    }
  }
}

<currency>
: The currency that is supported by the merchant.

The value of this field must conform to this regular expression:

^[a-zA-Z0-9]{6,35}$

Specifications

Data Type:
String

Minimum Data Length:
6

Maximum Data Length:
35

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configurations.cardTypes.jCBJSecure. currencies.[currency].processorMerchantId

Product Enablement and Configuration Service API Field:

payments.payerAuthentication.configurationInformation.configurations. cardTypes.jCBJSecure.currencies.[currency].processorMerchantId

productInformation. selectedProducts. payments. payerAuthentication. configurationInformation. configurations. cardTypes. jCBJSecure. currencies. requestorName

This field is the 3-D Secure requestor name value that is assigned by the directory server.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "payerAuthentication": {
          "configurationInformation": {
            "configurations": {
              "cardTypes": {
                "JCBSecure": {
                  "currencies":{
                     "requestorName": "name"
                     }
                  ]
                }
              }
            }
          }
        }
      }
    }
  }

<currency>
: The currency that is supported by the merchant.

The value of this field must conform to this regular expression:

^[a-zA-Z0-9]{6,20}$

Specifications

Data Type:
String

Maximum Data Length:
40

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configurations.cardTypes.jCBJSecure.currencies.requestorName

Product Enablement and Configuration Service API Field:

payments.payerAuthentication.configurationInformation.configurations. cardTypes.jCBJSecure.currencies.requestorName

productInformation. selectedProducts. payments. payerAuthentication. configurationInformation. configurations. cardTypes. jCBJSecure. enabled

Determines if JCB J/Secure is an enabled card type for Payer Authentication.

Possible Values

true

false

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "payerAuthentication": {
          "configurationInformation": {
            "configurations": {
              "cardTypes": {
                "jCBJSecure": {
                  "enabled": "true"
                }
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configurations.cardTypes.jCBJSecure.enabled

Product Enablement and Configuration Service API Field:

payments.payerAuthentication.configurationInformation.configurations. cardTypes.jCBJSecure.enabled

productInformation. selectedProducts. payments. payerAuthentication. configurationInformation. configurations. cardTypes. jCBJSecure. securePasswordForJCB

J/Secure currency password for the Japan Credit Bureau.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "payerAuthentication": {
          "configurationInformation": {
            "configurations": {
              "cardTypes": {
                "jCBJSecure": {
                  "securePasswordForJCB": "pword123"
                }
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
String

Minimum Data Length:
0

Maximum Data Length:
8

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configurations.cardTypes.jCBJSecure.securePasswordForJCB

Product Enablement and Configuration Service API Field:

payments.payerAuthentication.configurationInformation.configurations. cardTypes.jCBJSecure.securePasswordForJCB

productInformation. selectedProducts. payments. payerAuthentication. configurationInformation. configurations. cardTypes. masterCardSecureCode. currencies.[currency]. requestorName

This field is the 3-D Secure requestor name value that is assigned by the directory server.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "payerAuthentication": {
          "configurationInformation": {
            "configurations": {
              "cardTypes": {
                "masterCardSecureCode": {
                  "currencies": [
                                {
                                "currencyCodes": ["ALL, "978"]
                     "requestorName": "name"
                     }
                  ]
                }
              }
            }
          }
        }
      }
    }
  }
}

<currency>
: The currency that is supported by the merchant.

The value of this field must conform to this regular expression:

^[a-zA-Z0-9]{6,20}$

Specifications

Data Type:
String

Maximum Data Length:
40

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configurations.cardTypes.masterCardSecureCode.currencies.[currency].requestorName

Product Enablement and Configuration Service API Field:

payments.payerAuthentication.configurationInformation.configurations. cardTypes.masterCardSecureCode.currencies.[currency].requestorName

productInformation. selectedProducts. payments. payerAuthentication. configurationInformation. configurations. cardTypes. masterCardSecureCode. currencies. requestorId

This field is the requestor ID value assigned by a 3-D Secure directory server. It is used with 3-D Secure 2.0. When this field is passed in the request, it overrides the requestor ID value that is configured on the merchant's profile.

Syntax

  {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "payerAuthentication": {
          "configurationInformation": {
            "configurations": {
              "cardTypes": {
                "masterCardSecureCode": {
                    "currencies": {
                      "requestorId": "01234567891111
                    {
                  {
                }
              }
            }
          }
        }
      }
    }
  }

<currency>
: The currency that is supported by the merchant.

The value of this field must conform to this regular expression:

^[a-zA-Z0-9]{6,20}$

Specifications

Data Type:
String

Maximum Data Length:
35

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configurations.cardTypes.masterCardSecureCode.currencies.requestorId

Product Enablement and Configuration Service API Field:

payments.payerAuthentication.configurationInformation.configurations. cardTypes.masterCardSecureCode.currencies.requestorId

productInformation. selectedProducts. payments. payerAuthentication. configurationInformation. configurations. cardTypes. masterCardSecureCode. currencies. [currency]. acquirerId

The acquirer ID value, often referred to as the acquirer BIN, that is specific to an acquirer and configured for Mastercard Secure Code. The value is created by Cardinal in their system and the acquirer may not know that the acquirer ID is different from their acquiring BIN.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "payerAuthentication": {
          "configurationInformation": {
            "configurations": {
              "cardTypes": {
                "masterCardSecureCode": {
                  "currencies": [
                    <currency>:
                     "acquirerId": "acquirer_mcsc"
                  ]
                }
              }
            }
          }
        }
      }
    }
  }
}

<currency>
: The currency that is supported by the merchant.

The value of this field must conform to this regular expression:

^[a-zA-Z0-9]{6,20}$

Specifications

Data Type:
String

Minimum Data Length:
6

Maximum Data Length:
20

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configurations.cardTypes.masterCardSecureCode. currencies.[currency].acquirerId

Product Enablement and Configuration Service API Field:

payments.payerAuthentication.configurationInformation.configurations. cardTypes.masterCardSecureCode.currencies.[currency].acquirerId

productInformation. selectedProducts. payments. payerAuthentication. configurationInformation. configurations. cardTypes. masterCardSecureCode. currencies. [currency]. currencyCodes

The ISO standard numerical currency code of the currency that is configured for the merchant for Mastercard Secure Code. For information on ISO currency codes, see the ISO Country Currency Codes website.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "payerAuthentication": {
          "configurationInformation": {
            "configurations": {
              "cardTypes": {
                "masterCardSecureCode": {
                  "currencies": [
                    {
                      <currency>:
                       "currencyCodes": ["ALL, "978"]
                    }
                  ]
                }
              }
            }
          }
        }
      }
    }
  }
}

<currency>
: The currency that is supported by the merchant.

Specifications

Data Type:
String

Data Length:
3

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configurations.cardTypes.masterCardSecureCode. currencies.[currency].currencyCodes

Product Enablement and Configuration Service API Field:

payments.payerAuthentication.configurationInformation.configurations. cardTypes.masterCardSecureCode.currencies.[currency].currencyCodes

productInformation. selectedProducts. payments. payerAuthentication. configurationInformation. configurations. cardTypes. masterCardSecureCode. currencies.[currency]. processorMerchantId

Merchant identifier assigned by your acquiring bank and configured for Mastercard SecureCode. This merchant ID should also be used by your bank to register your account to the card scheme Directory Server for processing Payer Authentication services.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "payerAuthentication": {
          "configurationInformation": {
            "configurations": {
              "cardTypes": {
                "masterCardSecureCode": {
                  "currencies": [
                    <currency>:
                     "processorMerchantId": "procmerchantid"
                  ]
                }
              }
            }
          }
        }
      }
    }
  }
}

<currency>
: The currency that is supported by the merchant.

The value of this field must conform to this regular expression:

^[a-zA-Z0-9]{6,35}$

Specifications

Data Type:
String

Minimum Data Length:
6

Maximum Data Length:
35

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configurations.cardTypes.masterCardSecureCode. currencies.[currency].processorMerchantId

Product Enablement and Configuration Service API Field:

payments.payerAuthentication.configurationInformation.configurations. cardTypes.masterCardSecureCode.currencies.[currency].processorMerchantId

productInformation. selectedProducts. payments. payerAuthentication. configurationInformation. configurations. cardTypes. masterCardSecureCode. enabled

Determines if Mastercard SecureCode is an enabled card type for Payer Authentication.

Possible Values

true

false

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "payerAuthentication": {
          "configurationInformation": {
            "configurations": {
              "cardTypes": {
                "masterCardSecureCode": {
                  "enabled": "true"
                }
              }
            }
          }
        }
      }
    }
  }
}

<processor>
: The processor that is associated with the merchant account.

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configurations.cardTypes.masterCardSecureCode.enabled

Product Enablement and Configuration Service API Field:

payments.payerAuthentication.configurationInformation.configurations. cardTypes.masterCardSecureCode.enabled

productInformation. selectedProducts. payments. payerAuthentication. configurationInformation. configurations. cardTypes. UPI. currencies. [currency]. acquirerId

The acquirer ID value, often referred to as the acquirer BIN, that is specific to an acquirer and configured for UPI. The value is created by Cardinal in their system and the acquirer may not know that the acquirer ID is different from their acquiring BIN.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "payerAuthentication": {
          "configurationInformation": {
            "configurations": {
              "cardTypes": {
                "UPI": {
                  "currencies": [
                    <currency>:
                     "acquirerId": "acquirer_upi"
                  ]
                }
              }
            }
          }
        }
      }
    }
  }
}

<currency>
: The currency that is supported by the merchant.

The value of this field must conform to this regular expression:

^[a-zA-Z0-9]{6,20}$

Specifications

Data Type:
String

Minimum Data Length:
6

Maximum Data Length:
20

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configurations.cardTypes.UPI. currencies.[currency].acquirerId

Product Enablement and Configuration Service API Field:

payments.payerAuthentication.configurationInformation.configurations. cardTypes.UPI.currencies.[currency].acquirerId

productInformation. selectedProducts. payments. payerAuthentication. configurationInformation. configurations. cardTypes. UPI. currencies. [currency]. currencyCodes

The ISO standard numerical currency code of the currency that is configured for the merchant for UPI. For information on ISO currency codes, see the ISO Country Currency Codes website.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "payerAuthentication": {
          "configurationInformation": {
            "configurations": {
              "cardTypes": {
                "UPI": {
                  "currencies": [
                    {
                      <currency>:
                       "currencyCodes": ["ALL, "978"]
                    }
                  ]
                }
              }
            }
          }
        }
      }
    }
  }
}

<currency>
: The currency that is supported by the merchant.

Specifications

Data Type:
String

Minimum Data Length:
3

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configurations.cardTypes.UPI. currencies.[currency].currencyCodes

Product Enablement and Configuration Service API Field:

payments.payerAuthentication.configurationInformation.configurations. cardTypes.UPI.currencies.[currency].currencyCodes

productInformation. selectedProducts. payments. payerAuthentication. configurationInformation. configurations. cardTypes. UPI. currencies. [currency]. processorMerchantId

Merchant identifier assigned by your acquiring bank and configured for UPI. This merchant ID should also be used by your bank to register your account to the card scheme Directory Server for processing Payer Authentication services.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "payerAuthentication": {
          "configurationInformation": {
            "configurations": {
              "cardTypes": {
                "UPI": {
                  "currencies": [
                    <currency>:
                     "processorMerchantId": "procmerchantid"
                  ]
                }
              }
            }
          }
        }
      }
    }
  }
}

<currency>
: The currency that is supported by the merchant.

The value of this field must conform to this regular expression:

^[a-zA-Z0-9]{6,35}$

Specifications

Data Type:
String

Minimum Data Length:
6

Maximum Data Length:
35

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configurations.cardTypes.UPI. currencies.[currency].processorMerchantId

Product Enablement and Configuration Service API Field:

payments.payerAuthentication.configurationInformation.configurations. cardTypes.UPI.currencies.[currency].processorMerchantId

productInformation. selectedProducts. payments. payerAuthentication. configurationInformation. configurations. cardTypes. UPI. currencies. requestorId

This field is the requestor ID value assigned by a 3-D Secure directory server. It is used with 3-D Secure 2.0. When this field is passed in the request, it overrides the requestor ID value that is configured on the merchant's profile.

Syntax

  {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "payerAuthentication": {
          "configurationInformation": {
            "configurations": {
              "cardTypes": {
                "UPI": {
                    "currencies": {
                      "requestorId": "01234567891111
                    {
                  {
                }
              }
            }
          }
        }
      }
    }
  }

<currency>
: The currency that is supported by the merchant.

The value of this field must conform to this regular expression:

^[a-zA-Z0-9]{6,20}$

Specifications

Data Type:
String

Maximum Data Length:
35

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configurations.cardTypes.UPI.currencies.requestorId

Product Enablement and Configuration Service API Field:

payments.payerAuthentication.configurationInformation.configurations. cardTypes.UPI.currencies.requestorId

productInformation. selectedProducts. payments. payerAuthentication. configurationInformation. configurations. cardTypes. UPI. currencies. requestorName

This field is the 3-D Secure requestor name value that is assigned by the directory server.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "payerAuthentication": {
          "configurationInformation": {
            "configurations": {
              "cardTypes": {
                "UPI": {
                  "currencies": {
                     "requestorName": "name"
                     }
                  ]
                }
              }
            }
          }
        }
      }
    }
  }

<currency>
: The currency that is supported by the merchant.

The value of this field must conform to this regular expression:

^[a-zA-Z0-9]{6,20}$

Specifications

Data Type:
String

Maximum Data Length:
40

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configurations.cardTypes.UPI.currencies.requestorName

Product Enablement and Configuration Service API Field:

payments.payerAuthentication.configurationInformation.configurations. cardTypes.UPI.currencies.requestorName

productInformation. selectedProducts. payments. payerAuthentication. configurationInformation. configurations. cardTypes. UPI. enabled

Determines if UPI is an enabled card type for Payer Authentication.

Possible Values

true

false

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "payerAuthentication": {
          "configurationInformation": {
            "configurations": {
              "cardTypes": {
                "UPI": {
                  "enabled": "true"
                }
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configurations.cardTypes.UPI.enabled

Product Enablement and Configuration Service API Field:

payments.payerAuthentication.configurationInformation.configurations. cardTypes.UPI.enabled

productInformation. selectedProducts. payments. payerAuthentication. configurationInformation. configurations. cardTypes. verifiedByVisa. currencies. requestorId

This field is the requestor ID value assigned by a 3-D Secure directory server. It is used with 3-D Secure 2.0. When this field is passed in the request, it overrides the requestor ID value that is configured on the merchant's profile.

Syntax

  {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "payerAuthentication": {
          "configurationInformation": {
            "configurations": {
              "cardTypes": {
                "verifiedByVisa": {
                    "currencies": {
                      "requestorId": "01234567891111
                    {
                  {
                }
              }
            }
          }
        }
      }
    }
  }

<currency>
: The currency that is supported by the merchant.

The value of this field must conform to this regular expression:

^[a-zA-Z0-9]{6,20}$

Specifications

Data Type:
String

Maximum Data Length:
35

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configurations.cardTypes.verifiedByVisa.currencies.requestorId

Product Enablement and Configuration Service API Field:

payments.payerAuthentication.configurationInformation.configurations. cardTypes.verifiedByVisa.currencies.requestorId

productInformation. selectedProducts. payments. payerAuthentication. configurationInformation. configurations. cardTypes. verifiedByVisa. currencies. [currency]. acquirerId

The acquirer ID value, often referred to as the acquirer BIN, that is specific to an acquirer and configured for Verified by Visa. The value is created by Cardinal in their system and the acquirer may not know that the acquirer ID is different from their acquiring BIN.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "payerAuthentication": {
          "configurationInformation": {
            "configurations": {
              "cardTypes": {
                "verifiedByVisa": {
                  "currencies": [
                    {
                      <currency>:
                       "acquirerId": "acquirer_vbv"
                    }
                  ]
                }
              }
            }
          }
        }
      }
    }
  }
}

<currency>
: The currency that is supported by the merchant.

The value of this field must conform to this regular expression:

^[a-zA-Z0-9]{6,20}$

Specifications

Data Type:
String

Minimum Data Length:
6

Maximum Data Length:
20

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configurations.cardTypes.verifiedByVisa. currencies.[currency].acquirerId

Product Enablement and Configuration Service API Field:

payments.payerAuthentication.configurationInformation.configurations. cardTypes.verifiedByVisa.currencies.[currency].acquirerId

productInformation. selectedProducts. payments. payerAuthentication. configurationInformation. configurations. cardTypes. verifiedByVisa. currencies. [currency]. currencyCodes

The ISO standard numerical currency code of the currency that is configured for the merchant for Verified by Visa. For information on ISO currency codes, see the ISO Country Currency Codes website.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "payerAuthentication": {
          "configurationInformation": {
            "configurations": {
              "cardTypes": {
                "verifiedByVisa": {
                  "currencies": [
                    {
                      <currency>:
                       "currencyCodes": ["ALL, "978"]
                    }
                  ]
                }
              }
            }
          }
        }
      }
    }
  }
}

<currency>
: The currency that is supported by the merchant.

Specifications

Data Type:
String

Data Length:
3

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configurations.cardTypes.verifiedByVisa. currencies.[currency].currencyCodes

Product Enablement and Configuration Service API Field:

payments.payerAuthentication.configurationInformation.configurations. cardTypes.verifiedByVisa.currencies.[currency].currencyCodes

productInformation. selectedProducts. payments. payerAuthentication. configurationInformation. configurations. cardTypes. verifiedByVisa. currencies. [currency]. processorMerchantId

Merchant identifier assigned by your acquiring bank and configured for Verified by Visa. This merchant ID should also be used by your bank to register your account to the card scheme Directory Server for processing Payer Authentication services.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "payerAuthentication": {
          "configurationInformation": {
            "configurations": {
              "cardTypes": {
                "verifiedByVisa": {
                  "currencies": [
                    <currency>:
                     "processorMerchantId": "procmerchantid"
                  ]
                }
              }
            }
          }
        }
      }
    }
  }
}

<currency>
: The currency that is supported by the merchant.

The value of this field must conform to this regular expression:

^[a-zA-Z0-9]{6,35}$

Specifications

Data Type:
String

Minimum Data Length:
6

Maximum Data Length:
35

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configurations.cardTypes.verifiedByVisa. currencies.[currency].processorMerchantId

Product Enablement and Configuration Service API Field:

payments.payerAuthentication.configurationInformation.configurations. cardTypes.verifiedByVisa.currencies.[currency].processorMerchantId

productInformation. selectedProducts. payments. payerAuthentication. configurationInformation. configurations. cardTypes. verifiedByVisa. currencies. vmid

This field value is the merchant ID that is assigned by Visa.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "payerAuthentication": {
          "configurationInformation": {
            "configurations": {
              "cardTypes": {
                "verifiedByVisa": 
                  "currencies": {
                    "vmid": "Visa merchant ID"
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
String

Maximum Data Length:
35

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configurations.cardTypes.verifiedByVisa.currencies.vmid

Product Enablement and Configuration Service API Field:

payments.payerAuthentication.configurationInformation.configurations. cardTypes.currencies.verifiedByVisa.currencies.vmid

productInformation. selectedProducts. payments. payerAuthentication. configurationInformation. configurations. cardTypes. verifiedByVisa. enabled

Determines if Verified by Visa is an enabled card type for Payer Authentication.

Possible Values

true

false

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "payerAuthentication": {
          "configurationInformation": {
            "configurations": {
              "cardTypes": {
                "verifiedByVisa": {
                  "enabled": "true"
                }
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configurations.cardTypes.verifiedByVisa.enabled

Product Enablement and Configuration Service API Field:

payments.payerAuthentication.configurationInformation.configurations. cardTypes.verifiedByVisa.enabled

productInformation. selectedProducts. payments. payerAuthentication. configurationInformation. configurations. cardTypes. verifiedByVisa. currencies.[currency]. requestorName

This field is the 3-D Secure requestor name value that is assigned by the directory server.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "payerAuthentication": {
          "configurationInformation": {
            "configurations": {
              "cardTypes": {
                "verifiedByVisa": {
                  "currencies": [
                                {
                                "currencyCodes": ["ALL, "978"]
                     "requestorName": "name"
                     }
                  ]
                }
              }
            }
          }
        }
      }
    }
  }
}

<currency>
: The currency that is supported by the merchant.

The value of this field must conform to this regular expression:

^[a-zA-Z0-9]{6,20}$

Specifications

Data Type:
String

Maximum Data Length:
40

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.configurations.cardTypes.verifiedByVisa.currencies.[currency].requestorName

Product Enablement and Configuration Service API Field:

payments.payerAuthentication.configurationInformation.configurations. cardTypes.verifiedByVisa.currencies.[currency].requestorName

productInformation. selectedProducts. payments. payerAuthentication. configurationInformation. templateId

The template identifier that is configured for Payer Authentication.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "payerAuthentication": {
          "configurationInformation": {
            "templateId": "template_pa"
          }
        }
      }
    }
  }
}

Specifications

Data Type:
String

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.payerAuthentication. configurationInformation.templateId

Product Enablement and Configuration Service API Field:

payments.payerAuthentication.configurationInformation.templateId

productInformation. selectedProducts. payments. payerAuthentication. subscriptionInformation. enabled

Indicates if subscription information is enabled for Payer Authentication.

Possible Values

true

false

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "payerAuthentication": {
          "subscriptionInformation": {
            "enabled": "true"
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.payerAuthentication. subscriptionInformation.enabled

Product Enablement and Configuration Service API Field:

payments.payerAuthentication.subscriptionInformation.enabled

productInformation. selectedProducts. payments. payerAuthentication. subscriptionInformation. selfServiceability

This field value indicates whether the organization can enable Payer Authentication using self service.

Possible Values

NOT_SELF_SERVICEABLE

(default)

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "payerAuthentication": {
          "subscriptionInformation": {
            "selfServiceability": "NOT_SELF_SERVICEABLE"
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Enum

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.payerAuthentication. subscriptionInformation.selfServiceability

Product Enablement and Configuration Service API Field:

payments.payerAuthentication.subscriptionInformation.selfServiceability

productInformation. selectedProducts. payments. paymentOrchestration. subscriptionInformation. enabled

Indicates if subscription information is enabled for Service Orchestration.

Possible Values

true

false

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "paymentOrchestration": {
          "subscriptionInformation": {
            "enabled": "true"
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.paymentOrchestration. subscriptionInformation.enabled

Product Enablement and Configuration Service API Field:

payments.paymentOrchestration.subscriptionInformation.enabled

productInformation. selectedProducts. payments. paymentOrchestration. subscriptionInformation. selfServiceability

This field value indicates whether the organization can enable Service Orchestration using self service.

Possible Values

NOT_SELF_SERVICEABLE

(default)

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "paymentOrchestration": {
          "subscriptionInformation": {
            "selfServiceability": "NOT_SELF_SERVICEABLE"
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Enum

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.paymentOrchestration. subscriptionInformation.selfServiceability

Product Enablement and Configuration Service API Field:

payments.paymentOrchestration.subscriptionInformation.selfServiceability

productInformation. selectedProducts. payments. payouts. configurationInformation. configurations. pullFunds. acquirerOrganizationId

Acquirer organization ID that is configured for Payouts. The organization must be a valid organization with an

organizationInformation.type

field value of

acquirer

.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "payouts": {
          "configurationInformation": {
            "configurations": {
              "pullFunds": {
                "acquirerOrganizationId": "acq_org_123"
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
String

Minimum Data Length:
1

Maximum Data Length:
50

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.payouts.configurationInformation. configurations.pullFunds.acquirerOrganizationId

Product Enablement and Configuration Service API Field:

payments.payouts.configurationInformation.configurations.pullFunds.acquirerOrganizationId

productInformation. selectedProducts. payments. payouts. configurationInformation. configurations. pullFunds. acquiringBIN

Identifies the financial institution acting as the acquirer of the pull funds Payouts transaction. The acquirer is the client or system user that signed the originator or installed the unattended cardholder-activated environment. When a processing center operates for multiple acquirers, this code is for the individual client or system user and not a code for the center.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "payouts": {
          "configurationInformation": {
            "configurations": {
              "pullFunds": {
                "acquiringBIN": "123456"
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
String

Minimum Data Length:
6

Maximum Data Length:
11

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.payouts.configurationInformation. configurations.pullFunds.acquiringBIN

Product Enablement and Configuration Service API Field:

payments.payouts.configurationInformation.configurations.pullFunds.acquiringBIN

productInformation. selectedProducts. payments. payouts. configurationInformation. configurations. pullFunds. allowCryptoCurrencyPurchase

When set to

true

, this configuration allows a pull funds transaction to be flagged for cryptocurrency funds transfer.

Possible Values

true

false

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "payouts": {
          "configurationInformation": {
            "configurations": {
              "pullFunds": {
                "allowCryptoCurrencyPurchase": "true"
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.payouts.configurationInformation. configurations.pullFunds.allowCryptoCurrencyPurchase

Product Enablement and Configuration Service API Field:

payments.payouts.configurationInformation.configurations. pullFunds.allowCryptoCurrencyPurchase

productInformation. selectedProducts. payments. payouts. configurationInformation. configurations. pullFunds. cardAcceptorId

A unique identifier number for the originator of transfers that is unique to the processor or acquirer.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "payouts": {
          "configurationInformation": {
            "configurations": {
              "pullFunds": {
                "cardAcceptorId": "card_acc_1"
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
String

Minimum Data Length:
1

Maximum Data Length:
15

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.payouts.configurationInformation. configurations.pullFunds.cardAcceptorId

Product Enablement and Configuration Service API Field:

payments.payouts.configurationInformation.configurations.pullFunds.cardAcceptorId

productInformation. selectedProducts. payments. payouts. configurationInformation. configurations. pullFunds. cardTerminalId

The code that identifies a terminal at the card acceptor location. This field is used in all messages related to a transaction. When you are sending transactions from a card-not-present environment, use the same value for all transactions.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "payouts": {
          "configurationInformation": {
            "configurations": {
              "pullFunds": {
                "cardTerminalId": "12345678"
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
String

Minimum Data Length:
1

Maximum Data Length:
8

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.payouts.configurationInformation. configurations.pullFunds.cardTerminalId

Product Enablement and Configuration Service API Field:

payments.payouts.configurationInformation.configurations.pullFunds.cardTerminalId

productInformation. selectedProducts. payments. payouts. configurationInformation. configurations. pullFunds. originatorMvv

The merchant verification value (MVV) is used to identify originators that participate in a variety of programs. The MVV is unique to the merchant.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "payouts": {
          "configurationInformation": {
            "configurations": {
              "pullFunds": {
                "originatorMvv": "0123456789"
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
String

Data Length:
10

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.payouts.configurationInformation. configurations.pullFunds.originatorMvv

Product Enablement and Configuration Service API Field:

payments.payouts.configurationInformation.configurations.pullFunds.originatorMvv

productInformation. selectedProducts. payments. payouts. configurationInformation. configurations. pullFunds. originatorNameAbbreviation

The abbreviation for the originator name.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "payouts": {
          "configurationInformation": {
            "configurations": {
              "pullFunds": {
                "originatorNameAbbreviation": "orig"
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
String

Minimum Data Length:
1

Maximum Data Length:
4

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.payouts.configurationInformation. configurations.pullFunds.originatorNameAbbreviation

Product Enablement and Configuration Service API Field:

payments.payouts.configurationInformation.configurations. pullFunds.originatorNameAbbreviation

productInformation. selectedProducts. payments. payouts. configurationInformation. configurations. pushFunds. acquirerCountryCode

Country code of the acquirer.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "payouts": {
          "configurationInformation": {
            "configurations": {
               "pushFunds": {
                "acquirerCountryCode": "US"
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
String

Minimum Data Length:
0

Data Length:
3

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.payouts.configurationInformation. configurations.pushFunds.acquirerCountryCode

Product Enablement and Configuration Service API Field:

payments.payouts.configurationInformation.configurations.pushFunds.acquirerCountryCode

productInformation. selectedProducts. payments. payouts. configurationInformation. configurations. pushFunds. acquiringBIN

Identifies the financial institution acting as the acquirer of the push funds Payouts transaction. The acquirer is the client or system user that signed the originator or installed the unattended cardholder-activated environment.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "payouts": {
          "configurationInformation": {
            "configurations": {
              "pushFunds": {
                "acquiringBIN": "123456"
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
String

Minimum Data Length:
6

Maximum Data Length:
11

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.payouts.configurationInformation. configurations.pushFunds.acquiringBIN

Product Enablement and Configuration Service API Field:

payments.payouts.configurationInformation.configurations.pushFunds.acquiringBIN

productInformation. selectedProducts. payments. payouts. configurationInformation. configurations. pushFunds. allowCryptoCurrencyPurchase

When set to

true

, this configuration allows a push funds transaction to be flagged for cryptocurrency funds transfer.

Possible Values

true

false

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "payouts": {
          "configurationInformation": {
            "configurations": {
              "pushFunds": {
                "allowCryptoCurrencyPurchase": "true"
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.payouts.configurationInformation. configurations.pushFunds.allowCryptoCurrencyPurchase

Product Enablement and Configuration Service API Field:

payments.payouts.configurationInformation.configurations.pushFunds. allowCryptoCurrencyPurchase

productInformation. selectedProducts. payments. payouts. configurationInformation. configurations. pushFunds. financialInstitutionId

Identifier of the financial institution.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "payouts": {
          "configurationInformation": {
            "configurations": {
              "pushFunds": {
                "financialInstitutionId": "V101"
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
String

Data Length:
4

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.payouts.configurationInformation. configurations.pushFunds.financialInstitutionId

Product Enablement and Configuration Service API Field:

payments.payouts.configurationInformation.configurations.pushFunds.financialInstitutionId

productInformation. selectedProducts. payments. payouts. configurationInformation. configurations. pushFunds. nationalReimbursementFee

Reimbursement fee for a National Settlement transaction.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "payouts": {
          "configurationInformation": {
            "configurations": {
              "pushFunds": {
                "nationalReimbursementFee": "1"
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
String

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.payouts.configurationInformation. configurations.pushFunds.nationalReimbursementFee

Product Enablement and Configuration Service API Field:

payments.payouts.configurationInformation.configurations.pushFunds.nationalReimbursementFee

productInformation. selectedProducts. payments. payouts. configurationInformation. configurations. pushFunds. originatorBusinessApplicationId

Identifier of the type of transaction. For example, person-to-person, online gaming, or funds dispersement,

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "payouts": {
          "configurationInformation": {
            "configurations": {
              "pushFunds": {
                "originatorBusinessApplicationId": "PP"
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
String

Minimum Data Length:
0

Maximum Data Length:
3

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.payouts.configurationInformation. configurations.pushFunds.originatorBusinessApplicationId

Product Enablement and Configuration Service API Field:

payments.payouts.configurationInformation.configurations. pushFunds.originatorBusinessApplicationId

productInformation. selectedProducts. payments. payouts. configurationInformation. configurations. pushFunds. originatorPseudoAbaNumber

Number that uniquely identifies the originator when they sign up to send push payment gateway transactions. After enrollment, an originator will get a single pseudo-value that is assigned by Visa. The other networks will assign their own unique values for the originator.

This field is supported only in US for domestic transactions involving the push payments gateway service.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "payouts": {
          "configurationInformation": {
            "configurations": {
              "pushFunds": {
                "originatorPseudoAbaNumber": "1"
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
String

Minimum Data Length:
0

Maximum Data Length:
9

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.payouts.configurationInformation. configurations.pushFunds.originatorPseudoAbaNumber

Product Enablement and Configuration Service API Field:

payments.payouts.configurationInformation.configurations.pushFunds. originatorPseudoAbaNumber

productInformation. selectedProducts. payments. payouts. configurationInformation. configurations. pushFunds. processorAccount[]. originatorMerchantId

Merchant identifier of the transaction originator.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "payouts": {
          "configurationInformation": {
            "configurations": {
              "pushFunds": {
                "processorAccount": [
                  "originatorMerchantId": "orig_merch"
                ]
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
String

Minimum Data Length:
0

Maximum Data Length:
15

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.payouts.configurationInformation. configurations.pushFunds.processorAccount[]. originatorMerchantId

Product Enablement and Configuration Service API Field:

payments.payouts.configurationInformation.configurations.pushFunds.processorAccount[]. originatorMerchantId

productInformation. selectedProducts. payments. payouts. configurationInformation. configurations. pushFunds. processorAccount[]. originatorTerminalId

Terminal identifier of the transaction originator.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "payouts": {
          "configurationInformation": {
            "configurations": {
              "pushFunds": {
                "processorAccount": [
                  "originatorTerminalId": "orig_terminal"
                ]
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
String

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.payouts.configurationInformation. configurations.pushFunds.processorAccount[]. originatorTerminalId

Product Enablement and Configuration Service API Field:

payments.payouts.configurationInformation.configurations.pushFunds.processorAccount[]. originatorTerminalId

productInformation. selectedProducts. payments. payouts. configurationInformation. configurations. pushFunds. processorAccount[]. supportedCurrencies

The ISO standard currency codes that are supported by the payment processor. For information on ISO currency codes, see the ISO Country Currency Codes website.

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "payouts": {
          "configurationInformation": {
            "configurations": {
              "pushFunds": {
                "processorAccount": [
                  "supportedCurrencies": "USD"
                ]
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
String

Data Length:
3

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.payouts.configurationInformation. configurations.pushFunds.processorAccount[]. supportedCurrencies

Product Enablement and Configuration Service API Field:

payments.payouts.configurationInformation.configurations.pushFunds.processorAccount[]. supportedCurrencies

productInformation. selectedProducts. payments. payouts. subscriptionInformation. enabled

Indicates if subscription information is enabled for Payouts.

Possible Values

true

false

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "payouts": {
          "subscriptionInformation": {
            "enabled": "true"
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.payouts.subscriptionInformation.enabled

Product Enablement and Configuration Service API Field:

payments.payouts.subscriptionInformation.enabled

productInformation. selectedProducts. payments. payouts. subscriptionInformation. selfServiceability

This field value indicates whether the organization can enable Payouts using self service.

Possible Values

NOT_SELF_SERVICEABLE

(default)

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "payouts": {
          "subscriptionInformation": {
            "selfServiceability": "NOT_SELF_SERVICEABLE"
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Enum

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.payouts. subscriptionInformation.selfServiceability

Product Enablement and Configuration Service API Field:

payments.payouts.subscriptionInformation.selfServiceability

productInformation. selectedProducts. payments. recurringBilling. subscriptionInformation. enabled

Indicates if subscription information is enabled for Recurring Billing.

Possible Values

true

false

Syntax

{
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "recurringBilling": {
          "subscriptionInformation": {
            "enabled": "true"
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.recurringBilling. subscriptionInformation.enabled

Product Enablement and Configuration Service API Field:

payments.recurringBilling.subscriptionInformation.enabled

productInformation. selectedProducts. payments. recurringBilling. subscriptionInformation. selfServiceability

This field value indicates whether the organization can enable Recurring Billing using self service.

Possible Values

NOT_SELF_SERVICEABLE

(default)

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "recurringBilling": {
          "subscriptionInformation": {
            "selfServiceability": "NOT_SELF_SERVICEABLE"
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Enum

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.recurringBilling. subscriptionInformation.selfServiceability

Product Enablement and Configuration Service API Field:

payments.recurringBilling.subscriptionInformation.selfServiceability

productInformation. selectedProducts. payments. secureAcceptance. configurationInformation. configurations. service. reverseAuthOnAddressVerificationSystemFailure

Indicates if an approved authorization that fails address verification system (AVS) should be reversed. If this field is set to

true

, an approved authorization that fails AVS should be automatically reversed.

Possible Values

true

false

Syntax

{
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "secureAcceptance": {
          "configurationInformation": {
            "configurations": {
              "service": {
                "reverseAuthOnAddressVerificationSystemFailure": "true"
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.secureAcceptance.configurationInformation. configurations.service.reverseAuthOnAddressVerificationSystemFailure

Product Enablement and Configuration Service API Field:

payments.secureAcceptance.configurationInformation.configurations.service. reverseAuthOnAddressVerificationSystemFailure

productInformation. selectedProducts. payments. secureAcceptance. configurationInformation. configurations. service. reverseAuthOnCardVerificationNumberFailure

This field indicates if an authorization that fails card verification number (CVN) should be reversed. If this field is set to

true

, an approved authorization that fails CVN should be automatically reversed.

Possible Values

true

false

Syntax

{
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "secureAcceptance": {
          "configurationInformation": {
            "configurations": {
              "service": {
                "reverseAuthOnCardVerificationNumberFailure": "true"
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.secureAcceptance.configurationInformation. configurations.service.reverseAuthOnCardVerificationNumberFailure

Product Enablement and Configuration Service API Field:

payments.secureAcceptance.configurationInformation.configurations.service. reverseAuthOnCardVerificationNumberFailure

productInformation. selectedProducts. payments. secureAcceptance. configurationInformation. configurations. service. tokenizationEnabled

Indicates if tokenization is enabled for Secure Acceptance transactions. When this field is set to

true

, the transacting MID must be enabled and configured for tokenization.

Possible Values

true

false

Syntax

{
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "secureAcceptance": {
          "configurationInformation": {
            "configurations": {
              "service": {
                "tokenizationEnabled": "true"
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.secureAcceptance.configurationInformation. configurations.service.tokenizationEnabled

Product Enablement and Configuration Service API Field:

payments.secureAcceptance.configurationInformation.configurations.service. tokenizationEnabled

productInformation. selectedProducts. payments. secureAcceptance. configurationInformation. templateId

The template identifier that is configured for Secure Acceptance.

Syntax

{
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "secureAcceptance": {
          "configurationInformation": {
            "templateId": "sa_temp"
          }
        }
      }
    }
  }
}

Specifications

Data Type:
String

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.secureAcceptance. configurationInformation.templateId

Product Enablement and Configuration Service API Field:

payments.secureAcceptance.configurationInformation.templateId

productInformation. selectedProducts. payments. secureAcceptance. subscriptionInformation. enabled

This field value determines if subscription information is enabled for Secure Acceptance.

Possible Values

true

false

Syntax

{
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "secureAcceptance": {
          "subscriptionInformation": {
            "enabled": "true"
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.secureAcceptance. subscriptionInformation.enabled

Product Enablement and Configuration Service API Field:

payments.secureAcceptance.subscriptionInformation.enabled

productInformation. selectedProducts. payments. secureAcceptance. subscriptionInformation. selfServiceability

This field value indicates whether the organization can enable Secure Acceptance using self service.

Possible Values

NOT_SELF_SERVICEABLE

(default)

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "secureAcceptance": {
          "subscriptionInformation": {
            "selfServiceability": "NOT_SELF_SERVICEABLE"
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Enum

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.secureAcceptance. subscriptionInformation.selfServiceability

Product Enablement and Configuration Service API Field:

payments.secureAcceptance.subscriptionInformation.selfServiceability

productInformation. selectedProducts. payments. tax. subscriptionInformation. enabled

This field value determines if subscription information is enabled for the Tax product.

Possible Values

true

false

Syntax

{
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "tax": {
          "subscriptionInformation": {
            "enabled": "true"
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.tax. subscriptionInformation.enabled

Product Enablement and Configuration Service API Field:

payments.tax.subscriptionInformation.enabled

productInformation. selectedProducts. payments. tax. subscriptionInformation. selfServiceability

This field value indicates if the organization can enable the Tax product using self service.

Possible Values

NOT_SELF_SERVICEABLE

(default)

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "tax": {
          "subscriptionInformation": {
            "selfServiceability": "NOT_SELF_SERVICEABLE"
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Enum

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.tax. subscriptionInformation.selfServiceability

Product Enablement and Configuration Service API Field:

payments.tax.subscriptionInformation.selfServiceability

productInformation. selectedProducts. payments. unifiedCheckout. subscriptionInformation. enabled

This field value determines if subscription information is enabled for Unified Checkout payments.

Possible Values

true

false

Syntax

{
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "unifiedCheckout": {
          "subscriptionInformation": {
            "enabled": "true"
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.unifiedCheckout. subscriptionInformation.enabled

Product Enablement and Configuration Service API Field:

payments.unifiedCheckout.subscriptionInformation.enabled

productInformation. selectedProducts. payments. unifiedCheckout. subscriptionInformation. selfServiceability

This field value indicates whether the organization can enable Unified Checkout using self service.

Possible Values

NOT_SELF_SERVICEABLE

(default)

Syntax

 {
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "unifiedCheckout": {
          "subscriptionInformation": {
            "selfServiceability": "NOT_SELF_SERVICEABLE"
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Enum

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.unifiedCheckout. subscriptionInformation.selfServiceability

Product Enablement and Configuration Service API Field:

payments.unifiedCheckout.subscriptionInformation.selfServiceability

productInformation. selectedProducts. payments. virtualTerminal. configurationInformation. configurations. cardNotPresent. globalPaymentInformation. basicInformation. defaultPaymentType

Default payment type that is configured for card-not-present Virtual Terminal transactions.

Possible Values

CREDIT_CARD

ECHECK

Syntax

{
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "virtualTerminal": {
          "configurationInformation": {
            "configurations": {
              "cardNotPresent": {
                "globalPaymentInformation": {
                  "basicInformation": {
                    "defaultPaymentType": "CREDIT_CARD"
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Enum

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.virtualTerminal. configurationInformation.configurations.cardNotPresent.globalPaymentInformation.basicInformation.defaultPaymentType

Product Enablement and Configuration Service API Field:

payments.virtualTerminal.configurationInformation.configurations. cardNotPresent.globalPaymentInformation.basicInformation.defaultPaymentType

productInformation. selectedProducts. payments. virtualTerminal. configurationInformation. configurations. cardNotPresent. globalPaymentInformation. basicInformation. defaultTransactionType

Default transaction type that is configured for card-not-present Virtual Terminal transactions.

Possible Values

AUTHORIZATION

SALE

Syntax

{
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "virtualTerminal": {
          "configurationInformation": {
            "configurations": {
              "cardNotPresent": {
                "globalPaymentInformation": {
                  "basicInformation": {
                    "defaultTransactionType": "AUTHORIZATION"
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Enum

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.virtualTerminal. configurationInformation.configurations.cardNotPresent.globalPaymentInformation.basicInformation. defaultTransactionType

Product Enablement and Configuration Service API Field:

payments.virtualTerminal.configurationInformation.configurations. cardNotPresent.globalPaymentInformation.basicInformation.defaultTransactionType

productInformation. selectedProducts. payments. virtualTerminal. configurationInformation. configurations. cardNotPresent. globalPaymentInformation. basicInformation. displayInternet

When this field is set to

true

, card-not-present Virtual Terminal transactions that include the field

processingInformation.commerceIndicator

with the value

internet

are displayed.

Possible Values

true

false

Syntax

{
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "virtualTerminal": {
          "configurationInformation": {
            "configurations": {
              "cardNotPresent": {
                "globalPaymentInformation": {
                  "basicInformation": {
                    "displayInternet": "true"
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.virtualTerminal. configurationInformation.configurations.cardNotPresent.globalPaymentInformation.basicInformation. displayInternet

Product Enablement and Configuration Service API Field:

payments.virtualTerminal.configurationInformation.configurations. cardNotPresent.globalPaymentInformation.basicInformation.displayInternet

productInformation. selectedProducts. payments. virtualTerminal. configurationInformation. configurations. cardNotPresent. globalPaymentInformation. basicInformation. displayMoto

When this field is set to

true

, card-not-present Virtual Terminal transactions that include the field

processingInformation.commerceIndicator

with the value

moto

are displayed.

Possible Values

true

false

Syntax

{
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "virtualTerminal": {
          "configurationInformation": {
            "configurations": {
              "cardNotPresent": {
                "globalPaymentInformation": {
                  "basicInformation": {
                    "displayMoto": "true"
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.virtualTerminal. configurationInformation.configurations.cardNotPresent.globalPaymentInformation.basicInformation. displayMoto

Product Enablement and Configuration Service API Field:

payments.virtualTerminal.configurationInformation.configurations. cardNotPresent.globalPaymentInformation.basicInformation.displayMoto

productInformation. selectedProducts. payments. virtualTerminal. configurationInformation. configurations. cardNotPresent. globalPaymentInformation. basicInformation. displayRetail

When this field is set to

true

, card-not-present Virtual Terminal transactions that include the field

processingInformation.commerceIndicator

with the value

retail

are displayed.

Possible Values

true

false

Syntax

{
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "virtualTerminal": {
          "configurationInformation": {
            "configurations": {
              "cardNotPresent": {
                "globalPaymentInformation": {
                  "basicInformation": {
                    "displayRetail": "true"
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.virtualTerminal. configurationInformation.configurations.cardNotPresent.globalPaymentInformation.basicInformation. displayRetail

Product Enablement and Configuration Service API Field:

payments.virtualTerminal.configurationInformation.configurations. cardNotPresent.globalPaymentInformation.basicInformation.displayRetail

productInformation. selectedProducts. payments. virtualTerminal. configurationInformation. configurations. cardNotPresent. globalPaymentInformation. merchantDefinedDataFields. displayMerchantDefinedData1

When this field is set to

true

, the

merchantDefinedData1

field is displayed for card-not-present Virtual Terminal transactions.

Possible Values

true

false

Syntax

{
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "virtualTerminal": {
          "configurationInformation": {
            "configurations": {
              "cardNotPresent": {
                "globalPaymentInformation": {
                  "merchantDefinedDataFields": {
                    "displayMerchantDefinedData1": "false"
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.virtualTerminal. configurationInformation.configurations.cardNotPresent.globalPaymentInformation.merchantDefinedDataFields. displayMerchantDefinedData1

Product Enablement and Configuration Service API Field:

payments.virtualTerminal.configurationInformation.configurations. cardNotPresent.globalPaymentInformation.merchantDefinedDataFields.displayMerchantDefinedData1

productInformation. selectedProducts. payments. virtualTerminal. configurationInformation. configurations. cardNotPresent. globalPaymentInformation. merchantDefinedDataFields. displayMerchantDefinedData2

When this field is set to

true

, the

merchantDefinedData2

field is displayed for card-not-present Virtual Terminal transactions.

Possible Values

true

false

Syntax

{
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "virtualTerminal": {
          "configurationInformation": {
            "configurations": {
              "cardNotPresent": {
                "globalPaymentInformation": {
                  "merchantDefinedDataFields": {
                    "displayMerchantDefinedData2": "false"
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.virtualTerminal. configurationInformation.configurations.cardNotPresent.globalPaymentInformation.merchantDefinedDataFields. displayMerchantDefinedData2

Product Enablement and Configuration Service API Field:

payments.virtualTerminal.configurationInformation.configurations. cardNotPresent.globalPaymentInformation.merchantDefinedDataFields.displayMerchantDefinedData2

productInformation. selectedProducts. payments. virtualTerminal. configurationInformation. configurations. cardNotPresent. globalPaymentInformation. merchantDefinedDataFields. displayMerchantDefinedData3

When this field is set to

true

, the

merchantDefinedData3

field is displayed for card-not-present Virtual Terminal transactions.

Possible Values

true

false

Syntax

{
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "virtualTerminal": {
          "configurationInformation": {
            "configurations": {
              "cardNotPresent": {
                "globalPaymentInformation": {
                  "merchantDefinedDataFields": {
                    "displayMerchantDefinedData3": "false"
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.virtualTerminal. configurationInformation.configurations.cardNotPresent.globalPaymentInformation.merchantDefinedDataFields. displayMerchantDefinedData3

Product Enablement and Configuration Service API Field:

payments.virtualTerminal.configurationInformation.configurations. cardNotPresent.globalPaymentInformation.merchantDefinedDataFields.displayMerchantDefinedData3

productInformation. selectedProducts. payments. virtualTerminal. configurationInformation. configurations. cardNotPresent. globalPaymentInformation. merchantDefinedDataFields. displayMerchantDefinedData4

When this field is set to

true

, the

merchantDefinedData4

field is displayed for card-not-present Virtual Terminal transactions.

Possible Values

true

false

Syntax

{
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "virtualTerminal": {
          "configurationInformation": {
            "configurations": {
              "cardNotPresent": {
                "globalPaymentInformation": {
                  "merchantDefinedDataFields": {
                    "displayMerchantDefinedData4": "false"
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.virtualTerminal. configurationInformation.configurations.cardNotPresent.globalPaymentInformation.merchantDefinedDataFields. displayMerchantDefinedData4

Product Enablement and Configuration Service API Field:

payments.virtualTerminal.configurationInformation.configurations. cardNotPresent.globalPaymentInformation.merchantDefinedDataFields.displayMerchantDefinedData4

productInformation. selectedProducts. payments. virtualTerminal. configurationInformation. configurations. cardNotPresent. globalPaymentInformation. merchantDefinedDataFields. displayMerchantDefinedData5

When this field is set to

true

, the

merchantDefinedData5

field is displayed for card-not-present Virtual Terminal transactions.

Possible Values

true

false

Syntax

{
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "virtualTerminal": {
          "configurationInformation": {
            "configurations": {
              "cardNotPresent": {
                "globalPaymentInformation": {
                  "merchantDefinedDataFields": {
                    "displayMerchantDefinedData5": "false"
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.virtualTerminal. configurationInformation.configurations.cardNotPresent.globalPaymentInformation.merchantDefinedDataFields. displayMerchantDefinedData5

Product Enablement and Configuration Service API Field:

payments.virtualTerminal.configurationInformation.configurations. cardNotPresent.globalPaymentInformation.merchantDefinedDataFields.displayMerchantDefinedData5

productInformation. selectedProducts. payments. virtualTerminal. configurationInformation. configurations. cardNotPresent. globalPaymentInformation. merchantDefinedDataFields. merchantDefinedData1DisplayOnReceipt

When this field is set to

true

, the

merchantDefinedData1

field is displayed on the receipt for card-not-present Virtual Terminal transactions.

Possible Values

true

false

Syntax

{
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "virtualTerminal": {
          "configurationInformation": {
            "configurations": {
              "cardNotPresent": {
                "globalPaymentInformation": {
                  "merchantDefinedDataFields": {
                    "merchantDefinedData1DisplayOnReceipt": "false"
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.virtualTerminal. configurationInformation.configurations.cardNotPresent.globalPaymentInformation.merchantDefinedDataFields. merchantDefinedData1DisplayOnReceipt

Product Enablement and Configuration Service API Field:

payments.virtualTerminal.configurationInformation.configurations. cardNotPresent.globalPaymentInformation.merchantDefinedDataFields.merchantDefinedData1DisplayOnReceipt

productInformation. selectedProducts. payments. virtualTerminal. configurationInformation. configurations. cardNotPresent. globalPaymentInformation. merchantDefinedDataFields. merchantDefinedData2DisplayOnReceipt

When this field is set to

true

, the

merchantDefinedData2

field is displayed on the receipt for card-not-present Virtual Terminal transactions.

Possible Values

true

false

Syntax

{
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "virtualTerminal": {
          "configurationInformation": {
            "configurations": {
              "cardNotPresent": {
                "globalPaymentInformation": {
                  "merchantDefinedDataFields": {
                    "merchantDefinedData2DisplayOnReceipt": "false"
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.virtualTerminal. configurationInformation.configurations.cardNotPresent.globalPaymentInformation.merchantDefinedDataFields. merchantDefinedData2DisplayOnReceipt

Product Enablement and Configuration Service API Field:

payments.virtualTerminal.configurationInformation.configurations. cardNotPresent.globalPaymentInformation.merchantDefinedDataFields.merchantDefinedData2DisplayOnReceipt

productInformation. selectedProducts. payments. virtualTerminal. configurationInformation. configurations. cardNotPresent. globalPaymentInformation. merchantDefinedDataFields. merchantDefinedData3DisplayOnReceipt

When this field is set to

true

, the

merchantDefinedData3

field is displayed on the receipt for card-not-present Virtual Terminal transactions.

Possible Values

true

false

Syntax

{
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "virtualTerminal": {
          "configurationInformation": {
            "configurations": {
              "cardNotPresent": {
                "globalPaymentInformation": {
                  "merchantDefinedDataFields": {
                    "merchantDefinedData3DisplayOnReceipt": "false"
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.virtualTerminal. configurationInformation.configurations.cardNotPresent.globalPaymentInformation.merchantDefinedDataFields. merchantDefinedData3DisplayOnReceipt

Product Enablement and Configuration Service API Field:

payments.virtualTerminal.configurationInformation.configurations. cardNotPresent.globalPaymentInformation.merchantDefinedDataFields.merchantDefinedData3DisplayOnReceipt

productInformation. selectedProducts. payments. virtualTerminal. configurationInformation. configurations. cardNotPresent. globalPaymentInformation. merchantDefinedDataFields. merchantDefinedData4DisplayOnReceipt

When this field is set to

true

, the

merchantDefinedData4

field is displayed on the receipt for card-not-present Virtual Terminal transactions.

Possible Values

true

false

Syntax

{
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "virtualTerminal": {
          "configurationInformation": {
            "configurations": {
              "cardNotPresent": {
                "globalPaymentInformation": {
                  "merchantDefinedDataFields": {
                    "merchantDefinedData4DisplayOnReceipt": "false"
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.virtualTerminal. configurationInformation.configurations.cardNotPresent.globalPaymentInformation.merchantDefinedDataFields. merchantDefinedData4DisplayOnReceipt

Product Enablement and Configuration Service API Field:

payments.virtualTerminal.configurationInformation.configurations. cardNotPresent.globalPaymentInformation.merchantDefinedDataFields.merchantDefinedData4DisplayOnReceipt

productInformation. selectedProducts. payments. virtualTerminal. configurationInformation. configurations. cardNotPresent. globalPaymentInformation. merchantDefinedDataFields. merchantDefinedData5DisplayOnReceipt

When this field is set to

true

, the

merchantDefinedData5

field is displayed on the receipt for card-not-present Virtual Terminal transactions.

Possible Values

true

false

Syntax

{
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "virtualTerminal": {
          "configurationInformation": {
            "configurations": {
              "cardNotPresent": {
                "globalPaymentInformation": {
                  "merchantDefinedDataFields": {
                    "merchantDefinedData5DisplayOnReceipt": "false"
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.virtualTerminal. configurationInformation.configurations.cardNotPresent.globalPaymentInformation.merchantDefinedDataFields. merchantDefinedData5DisplayOnReceipt

Product Enablement and Configuration Service API Field:

payments.virtualTerminal.configurationInformation.configurations. cardNotPresent.globalPaymentInformation.merchantDefinedDataFields.merchantDefinedData5DisplayOnReceipt

productInformation. selectedProducts. payments. virtualTerminal. configurationInformation. configurations. cardNotPresent. globalPaymentInformation. merchantDefinedDataFields. requireMerchantDefinedData1

When this field is set to

true

, the

merchantDefinedData1

field is required for card-not-present Virtual Terminal transactions.

Possible Values

true

false

Syntax

{
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "virtualTerminal": {
          "configurationInformation": {
            "configurations": {
              "cardNotPresent": {
                "globalPaymentInformation": {
                  "merchantDefinedDataFields": {
                    "requireMerchantDefinedData1": "false"
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.virtualTerminal. configurationInformation.configurations.cardNotPresent.globalPaymentInformation.merchantDefinedDataFields. requireMerchantDefinedData1

Product Enablement and Configuration Service API Field:

payments.virtualTerminal.configurationInformation.configurations. cardNotPresent.globalPaymentInformation.merchantDefinedDataFields.requireMerchantDefinedData1

productInformation. selectedProducts. payments. virtualTerminal. configurationInformation. configurations. cardNotPresent. globalPaymentInformation. merchantDefinedDataFields. requireMerchantDefinedData2

When this field is set to

true

, the

merchantDefinedData2

field is required for card-not-present Virtual Terminal transactions.

Possible Values

true

false

Syntax

{
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "virtualTerminal": {
          "configurationInformation": {
            "configurations": {
              "cardNotPresent": {
                "globalPaymentInformation": {
                  "merchantDefinedDataFields": {
                    "requireMerchantDefinedData2": "false"
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.virtualTerminal. configurationInformation.configurations.cardNotPresent.globalPaymentInformation.merchantDefinedDataFields. requireMerchantDefinedData2

Product Enablement and Configuration Service API Field:

payments.virtualTerminal.configurationInformation.configurations. cardNotPresent.globalPaymentInformation.merchantDefinedDataFields.requireMerchantDefinedData2

productInformation. selectedProducts. payments. virtualTerminal. configurationInformation. configurations. cardNotPresent. globalPaymentInformation. merchantDefinedDataFields. requireMerchantDefinedData3

When this field is set to

true

the

merchantDefinedData3

field is required for card-not-present Virtual Terminal transactions.

Possible Values

true

false

Syntax

{
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "virtualTerminal": {
          "configurationInformation": {
            "configurations": {
              "cardNotPresent": {
                "globalPaymentInformation": {
                  "merchantDefinedDataFields": {
                    "requireMerchantDefinedData3": "false"
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.virtualTerminal. configurationInformation.configurations.cardNotPresent.globalPaymentInformation.merchantDefinedDataFields. requireMerchantDefinedData3

Product Enablement and Configuration Service API Field:

payments.virtualTerminal.configurationInformation.configurations. cardNotPresent.globalPaymentInformation.merchantDefinedDataFields.requireMerchantDefinedData3

productInformation. selectedProducts. payments. virtualTerminal. configurationInformation. configurations. cardNotPresent. globalPaymentInformation. merchantDefinedDataFields. requireMerchantDefinedData4

When this field is set to

true

the

merchantDefinedData4

field is required for card-not-present Virtual Terminal transactions.

Possible Values

true

false

Syntax

{
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "virtualTerminal": {
          "configurationInformation": {
            "configurations": {
              "cardNotPresent": {
                "globalPaymentInformation": {
                  "merchantDefinedDataFields": {
                    "requireMerchantDefinedData4": "false"
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.virtualTerminal. configurationInformation.configurations.cardNotPresent.globalPaymentInformation.merchantDefinedDataFields. requireMerchantDefinedData4

Product Enablement and Configuration Service API Field:

payments.virtualTerminal.configurationInformation.configurations. cardNotPresent.globalPaymentInformation.merchantDefinedDataFields.requireMerchantDefinedData4

productInformation. selectedProducts. payments. virtualTerminal. configurationInformation. configurations. cardNotPresent. globalPaymentInformation. merchantDefinedDataFields. requireMerchantDefinedData5

When this field is set to

true

, the

merchantDefinedData5

field is required for card-not-present Virtual Terminal transactions.

Possible Values

true

false

Syntax

{
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "virtualTerminal": {
          "configurationInformation": {
            "configurations": {
              "cardNotPresent": {
                "globalPaymentInformation": {
                  "merchantDefinedDataFields": {
                    "requireMerchantDefinedData5": "false"
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.virtualTerminal. configurationInformation.configurations.cardNotPresent.globalPaymentInformation.merchantDefinedDataFields. requireMerchantDefinedData5

Product Enablement and Configuration Service API Field:

payments.virtualTerminal.configurationInformation.configurations. cardNotPresent.globalPaymentInformation.merchantDefinedDataFields.requireMerchantDefinedData5

productInformation. selectedProducts. payments. virtualTerminal. configurationInformation. configurations. cardNotPresent. globalPaymentInformation. paymentInformation. acceptedCardTypes

Array of accepted card types that are configured for card-not-present Virtual Terminal transactions.

Possible Values

AMEX

CARTASI

CARTE_BLANCHE

CARTE_SBANCAIRES

DANKORT

DELTA

DINERS_CLUB

DISCOVER

ELO

ENROUTE

GE_MONEY_UK_CARD

HIPER_CARD

JAL

JCB

LASER

MAESTRO_INTERNATIONAL

MASTER_CARD

SWITCH_SOLO

VISA

VISA_ELECTRON

Syntax

{
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "virtualTerminal": {
          "configurationInformation": {
            "configurations": {
              "cardNotPresent": {
                "globalPaymentInformation": {
                  "paymentInformation": {
                    "acceptedCardTypes": "VISA"
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Enum

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.virtualTerminal. configurationInformation.configurations.cardNotPresent.globalPaymentInformation.paymentInformation. acceptedCardTypes

Product Enablement and Configuration Service API Field:

payments.virtualTerminal.configurationInformation.configurations. cardNotPresent.globalPaymentInformation.paymentInformation.acceptedCardTypes

productInformation. selectedProducts. payments. virtualTerminal. configurationInformation. configurations. cardNotPresent. globalPaymentInformation. paymentInformation. displayBillPayment

When this field is set to

true

, the bill payment is displayed for card-not-present Virtual Terminal transactions.

Possible Values

true

false

Syntax

{
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "virtualTerminal": {
          "configurationInformation": {
            "configurations": {
              "cardNotPresent": {
                "globalPaymentInformation": {
                  "paymentInformation": {
                    "displayBillPayment": "true"
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.virtualTerminal. configurationInformation.configurations.cardNotPresent.globalPaymentInformation.paymentInformation. displayBillPayment

Product Enablement and Configuration Service API Field:

payments.virtualTerminal.configurationInformation.configurations. cardNotPresent.globalPaymentInformation.paymentInformation.displayBillPayment

productInformation. selectedProducts. payments. virtualTerminal. configurationInformation. configurations. cardNotPresent. globalPaymentInformation. paymentInformation. displayCreditCards

When this field is set to

true

, credit cards are displayed for card-not-present Virtual Terminal transactions.

Possible Values

true

false

Syntax

{
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "virtualTerminal": {
          "configurationInformation": {
            "configurations": {
              "cardNotPresent": {
                "globalPaymentInformation": {
                  "paymentInformation": {
                    "displayCreditCards": "true"
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.virtualTerminal. configurationInformation.configurations.cardNotPresent.globalPaymentInformation.paymentInformation. displayCreditCards

Product Enablement and Configuration Service API Field:

payments.virtualTerminal.configurationInformation.configurations. cardNotPresent.globalPaymentInformation.paymentInformation.displayCreditCards

productInformation. selectedProducts. payments. virtualTerminal. configurationInformation. configurations. cardNotPresent. globalPaymentInformation. paymentInformation. displayCardVerificationValue

Array of card types to display card verification values (CVV) for card-not-present Virtual Terminal transactions.

Possible Values

AMEX

CARTASI

CARTE_BLANCHE

CARTE_SBANCAIRES

DANKORT

DELTA

DINERS_CLUB

DISCOVER

ELO

ENROUTE

GE_MONEY_UK_CARD

HIPER_CARD

JAL

JCB

LASER

MAESTRO_INTERNATIONAL

MASTER_CARD

SWITCH_SOLO

VISA

VISA_ELECTRON

Syntax

{
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "virtualTerminal": {
          "configurationInformation": {
            "configurations": {
              "cardNotPresent": {
                "globalPaymentInformation": {
                  "paymentInformation": {
                    "displayCardVerificationValue": "VISA"
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Enum

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.virtualTerminal. configurationInformation.configurations.cardNotPresent.globalPaymentInformation.paymentInformation. displayCardVerificationValue

Product Enablement and Configuration Service API Field:

payments.virtualTerminal.configurationInformation.configurations. cardNotPresent.globalPaymentInformation.paymentInformation.displayCardVerificationValue

productInformation. selectedProducts. payments. virtualTerminal. configurationInformation. configurations. cardNotPresent. globalPaymentInformation. paymentInformation. displayDebtIndicator

When this field is set to

true

, the debt indicator is displayed for card-not-present Virtual Terminal transactions.

Possible Values

true

false

Syntax

{
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "virtualTerminal": {
          "configurationInformation": {
            "configurations": {
              "cardNotPresent": {
                "globalPaymentInformation": {
                  "paymentInformation": {
                    "displayDebtIndicator": "true"
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.virtualTerminal. configurationInformation.configurations.cardNotPresent.globalPaymentInformation.paymentInformation. displayDebtIndicator

Product Enablement and Configuration Service API Field:

payments.virtualTerminal.configurationInformation.configurations. cardNotPresent.globalPaymentInformation.paymentInformation.displayDebtIndicator

productInformation. selectedProducts. payments. virtualTerminal. configurationInformation. configurations. cardNotPresent. globalPaymentInformation. paymentInformation. displayEchecks

When this field is set to

true

, echecks are displayed for card-not-present Virtual Terminal transactions.

Possible Values

true

false

Syntax

{
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "virtualTerminal": {
          "configurationInformation": {
            "configurations": {
              "cardNotPresent": {
                "globalPaymentInformation": {
                  "paymentInformation": {
                    "displayEchecks": "true"
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.virtualTerminal. configurationInformation.configurations.cardNotPresent.globalPaymentInformation.paymentInformation. displayEchecks

Product Enablement and Configuration Service API Field:

payments.virtualTerminal.configurationInformation.configurations. cardNotPresent.globalPaymentInformation.paymentInformation.displayEchecks

productInformation. selectedProducts. payments. virtualTerminal. configurationInformation. configurations. cardNotPresent. globalPaymentInformation. paymentInformation. displayFirstName

When this field is set to

true

, the first name is displayed for card-not-present Virtual Terminal transactions.

Possible Values

true

false

Syntax

{
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "virtualTerminal": {
          "configurationInformation": {
            "configurations": {
              "cardNotPresent": {
                "globalPaymentInformation": {
                  "paymentInformation": {
                    "displayFirstName": "true"
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.virtualTerminal. configurationInformation.configurations.cardNotPresent.globalPaymentInformation.paymentInformation. displayFirstName

Product Enablement and Configuration Service API Field:

payments.virtualTerminal.configurationInformation.configurations. cardNotPresent.globalPaymentInformation.paymentInformation.displayFirstName

productInformation. selectedProducts. payments. virtualTerminal. configurationInformation. configurations. cardNotPresent. globalPaymentInformation. paymentInformation. displayIgnoreECheckAvsCheckbox

When this field is set to

true

, the ignore echeck AVS checkbox is displayed for card-not-present Virtual Terminal transactions.

Possible Values

true

false

Syntax

{
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "virtualTerminal": {
          "configurationInformation": {
            "configurations": {
              "cardNotPresent": {
                "globalPaymentInformation": {
                  "paymentInformation": {
                    "displayIgnoreECheckAvsCheckbox": "true"
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.virtualTerminal. configurationInformation.configurations.cardNotPresent.globalPaymentInformation.paymentInformation. displayIgnoreECheckAvsCheckbox

Product Enablement and Configuration Service API Field:

payments.virtualTerminal.configurationInformation.configurations. cardNotPresent.globalPaymentInformation.paymentInformation.displayIgnoreECheckAvsCheckbox

productInformation. selectedProducts. payments. virtualTerminal. configurationInformation. configurations. cardNotPresent. globalPaymentInformation. paymentInformation. displayLastName

When this field is set to

true

, the last name is displayed for card-not-present Virtual Terminal transactions.

Possible Values

true

false

Syntax

{
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "virtualTerminal": {
          "configurationInformation": {
            "configurations": {
              "cardNotPresent": {
                "globalPaymentInformation": {
                  "paymentInformation": {
                    "displayLastName": "true"
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.virtualTerminal. configurationInformation.configurations.cardNotPresent.globalPaymentInformation.paymentInformation. displayLastName

Product Enablement and Configuration Service API Field:

payments.virtualTerminal.configurationInformation.configurations. cardNotPresent.globalPaymentInformation.paymentInformation.displayLastName

productInformation. selectedProducts. payments. virtualTerminal. configurationInformation. configurations. cardNotPresent. globalPaymentInformation. paymentInformation. enableEchecks

Determines if echecks are enabled for card-not-present Virtual Terminal transactions.

Possible Values

true

false

Syntax

{
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "virtualTerminal": {
          "configurationInformation": {
            "configurations": {
              "cardNotPresent": {
                "globalPaymentInformation": {
                  "paymentInformation": {
                    "enableEchecks": "true"
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.virtualTerminal. configurationInformation.configurations.cardNotPresent.globalPaymentInformation.paymentInformation. enableEchecks

Product Enablement and Configuration Service API Field:

payments.virtualTerminal.configurationInformation.configurations. cardNotPresent.globalPaymentInformation.paymentInformation.enableEchecks

productInformation. selectedProducts. payments. virtualTerminal. configurationInformation. configurations. cardNotPresent. globalPaymentInformation. paymentInformation. firstNameRequired

When this field is set to

true

, the first name is required for card-not-present Virtual Terminal transactions.

Possible Values

true

false

Syntax

{
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "virtualTerminal": {
          "configurationInformation": {
            "configurations": {
              "cardNotPresent": {
                "globalPaymentInformation": {
                  "paymentInformation": {
                    "firstNameRequired": "true"
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.virtualTerminal. configurationInformation.configurations.cardNotPresent.globalPaymentInformation.paymentInformation. firstNameRequired

Product Enablement and Configuration Service API Field:

payments.virtualTerminal.configurationInformation.configurations. cardNotPresent.globalPaymentInformation.paymentInformation.firstNameRequired

productInformation. selectedProducts. payments. virtualTerminal. configurationInformation. configurations. cardNotPresent. globalPaymentInformation. paymentInformation. lastNameRequired

When this field is set to

true

, the last name is required for card-not-present Virtual Terminal transactions.

Possible Values

true

false

Syntax

{
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "virtualTerminal": {
          "configurationInformation": {
            "configurations": {
              "cardNotPresent": {
                "globalPaymentInformation": {
                  "paymentInformation": {
                    "lastNameRequired": "true"
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Boolean

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.virtualTerminal. configurationInformation.configurations.cardNotPresent.globalPaymentInformation.paymentInformation. lastNameRequired

Product Enablement and Configuration Service API Field:

payments.virtualTerminal.configurationInformation.configurations. cardNotPresent.globalPaymentInformation.paymentInformation.lastNameRequired

productInformation. selectedProducts. payments. virtualTerminal. configurationInformation. configurations. cardNotPresent. globalPaymentInformation. paymentInformation. requireCardVerificationValue

Array of card types that require card verification values (CVV) for card-not-present Virtual Terminal transactions.

Possible Values

AMEX

CARTASI

CARTE_BLANCHE

CARTE_SBANCAIRES

DANKORT

DELTA

DINERS_CLUB

DISCOVER

ELO

ENROUTE

GE_MONEY_UK_CARD

HIPER_CARD

JAL

JCB

LASER

MAESTRO_INTERNATIONAL

MASTER_CARD

SWITCH_SOLO

VISA

VISA_ELECTRON

Syntax

{
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "virtualTerminal": {
          "configurationInformation": {
            "configurations": {
              "cardNotPresent": {
                "globalPaymentInformation": {
                  "paymentInformation": {
                    "requireCardVerificationValue": "VISA"
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

Specifications

Data Type:
Enum

Mapping Information

Boarding Registration Service API Field:

productInformation.selectedProducts.payments.virtualTerminal. configurationInformation.configurations.cardNotPresent.globalPaymentInformation.paymentInformation. requireCardVerificationValue

Product Enablement and Configuration Service API Field:

payments.virtualTerminal.configurationInformation.configurations. cardNotPresent.globalPaymentInformation.paymentInformation.requireCardVerificationValue

promotionInformation

These fields provide promotion information.

Specifications

Data Type:
Numeric

Data Length:
12

Mapping Information

REST API Field:

promotionInformation.discountApplied

SCMP API Field:

promotion_discount_applied

Simple Order API Field:

promotion_discountApplied

recipientInformation. accountId

Identifier for the recipient’s account.

This field is a pass-through, which means that the value is not verified or modified in any way before it is sent to the processor. If the field is not required for the transaction, it is not forwarded to the processor. For Account Funding Transactions (AFT), set the full recipient’s account number. For debt repayment, set the value to the first six, and last four digits of the recipient’s account number.

This field is only available for these processors:

Barclays

FDC Nashville Global

First Data Merchant Solutions

LloydsTSB Cardnet International

Specifications

Data Type:
String

Data Length:
10

Barclays: 34 for Visa, 50 for Mastercard

FDC Nashville Global: 20

First Data Merchant Solutions: 20

LloydsTSB Cardnet International: 20

Mapping Information

REST API Field:

recipientInformation.accountId

SCMP API Field:

recipient_account_id

Simple Order API Field:

recipient_accountID

recipientInformation. accountType

Identifies the recipient’s account type.

This field is required with Mastercard for Account Funding Transactions (AFTs).

This field is currently supported only for processors that support AFTs.

Barclays: Possible values are:
00
: Other
01
: Routing transit number (RTN) + Bank Account Number (BAN)
02
: International bank account number (IBAN)
03
: Card account
06
: Bank account number (BAN) + Bank identification code (BIC), also known as a SWIFT code
FDC Nashville Global: Possible values are:

00
: Other
01
: Routing transit number (RTN) + Bank account number (BAN)
02
: International bank account number (IBAN)
03
: Card account
04
: Email
05
: Phone number
06
: Bank account number (BAN) + Bank identification code (BIC), also known as a SWIFT code
07
: Wallet ID
08
: Social media ID
First Data Merchant Solutions, LloydsTSB Cardnet International, and Streamline: Possible values:

00
: Other
01
: Routing transit number (RTN) + Bank account number (BAN)
02
: International bank account number (IBAN)
03
: Card account
04
: Email
05
: Phone number
06
: Bank account number (BAN) + Bank identification code (BIC), also known as a SWIFT code
07
: Wallet ID
08
: Social media ID

Specifications

Data Type:
String

Data Length:
2

Mapping Information

REST API Field:

recipientInformation.accounttype

SCMP API Field:

recipient_account_type

Simple Order API Field:

recipient_accountType

recipientInformation. address1

The street address of the recipient.

This field is available for these processors:

Barclays

FDC Compass

FDC Nashville Global

First Data Merchant Solutions

LloydsTSB Cardnet International

Visa Platform Connect

Barclays: This field is only available for Account Funding Transactions (AFT) for Barclays with Mastercard. Values must be in alphanumeric and special characters must be in ASCII format.
FDC Nashville Global: The only special characters allowed in the value are
'
,
and
space
.
First Data Merchant Solutions and LloydsTSB Cardnet International: Required only with Visa in Canada for AFTs.
Streamline: Required only with Visa in Canada and US cross-border for AFTs.
Visa Platform Connect: The value for this field corresponds to this data in the TC 33 capture file:
Record: CP09 TCR5
Position: 5-103
Field: Account Owner Address Line 1
The TC 33 capture file contains information about the payments and credits that a merchant submits to Visa Acceptance Solutions. The processor creates the TC 33 capture file at the end of the day and sends it to the merchant’s acquirer. The acquirer uses this information to facilitate end-of-day clearing processing with payment networks.

Specifications

Data Type:
String

Data Length:
50

Mapping Information

REST API Field:

recipientInformation.address1

SCMP API Field:

recipient_address

Simple Order API Field:

recipient_address

recipientInformation. address2

The second line of the recipient's street address.

Specifications

Data Type:
String

Data Length:
50

Mapping Information

REST API Field:

recipientInformation.address2

Simple Order API Field:

recipient_address2

recipientInformation. administrativeArea

State or province of the recipient.

First Data Merchant Solutions and LloydsTSB Cardnet International: Required with Visa when the
recipientInformation.country
field value is Canada for Account Funding Transactions (AFT).
Streamline: Required for Canada and US cross-border for Account Funding Transactions (AFT).

Specifications

Data Type:
String

Data Length:
2

Mapping Information

REST API Field:

recipientInformation.administrativeArea

SCMP API Field:

recipient_state

Simple Order API Field:

recipient_state

recipientInformation. buildingNumber

Building number of the recipient.

Specifications

Data Type:
String

Data Length:
19

Mapping Information

REST API Field:

recipientInformation.buildingNumber

Simple Order API Field:

recipient_buildingNumber

recipientInformation. country

The country associated with the address of the recipient.

Use the two-character ISO country code. .

This field is available only on these processors:

Barclays

FDC Compass

FDC Nashville Global

First Data Merchant Solutions

LloydsTSB Cardnet International

Streamline

Visa Platform Connect

Barclays: Required only with Mastercard.
FDC Nashville Global: Required with Mastercard for domestic funding transactions when the transaction is a subsequent and cross-border funds transfer.; Values without special characters or spaces will be rejected for AFTs.
Streamline: Required for Canada and US cross-border transactions.
Visa Platform Connect: The value for this field corresponds to the following data in the TC 33 capture file:
Record: CP09 TCR5
Position: 132-134
Field: Account Owner Country Code

The TC 33 capture file contains information about the payments and credits that a merchant submits to Visa Acceptance Solutions. The processor creates the TC 33 capture file at the end of the day and sends it to the merchant’s acquirer. The acquirer uses this information to facilitate end-of-day clearing processing with payment networks.

Specifications

Data Type:
String

Data Length:
2

Barclays: 2 or 3 using the ISO-3166 format

FDC Nashville Global: 2 for US or Canada. Not required for all other countries.

First Data Merchant Solutions: 3

LloydsTSB Cardnet International: 3

Streamline: 3

Mapping Information

REST API Field:

recipientInformation.country

SCMP API Field:

recipient_country

Simple Order API Field:

recipient_country

recipientInformation. countryOfBirth

Recipient’s country of birth.

This field is a pass-through. Before the AFT or OCT request message is sent to the processor, the field content is verified to contain 10 alphanumeric special characters without spaces. However, the value represented by that string is not verified or modified.

If the field is not required for the transaction, Visa Acceptance Solutions does not forward the request to the issuing bank.

Specifications

Data Type:
String

Data Length:
10 maximum

Format:
Alphanumeric special characters without spaces.

Mapping Information

REST API Field:

recipientInformation.countryOfBirth

SCMP API Field:

recipient_country_of_birth

Simple Order API Field:

recipient_countryOfBirth

recipientInformation. dateOfBirth

Recipient’s date of birth.

This field is a pass-through, which means that it is verified that the value is eight numeric characters but otherwise the value represented by that stringis not verified or modified in any way before it is sent to the processor. If the field is not required for the transaction, it is not forwarded to the processor.

Specifications

Data Type:
String

Data Length:
8

Format:

For FDC Compass,

yyyyMMDD

For Visa Platform Connect, Tag 92 contains the account owner date of birth as ccyymmdd where:

cc is the century:

01

-

99

yy is the year:

00

-

99

mm is the month:

01

-

12

dd is the day:

01

-

31

Mapping Information

REST API Field:

recipientInformation.dateOfBirth

SCMP API Field:

recipient_date_of_birth

Simple Order API Field:

recipient_dateOfBirth

recipientInformation. email

Recipient’s email address.

This field is a pass-through. Before the AFT or OCT request message is sent to the processor, the field content is verified to contain 150 alphafnumeric special characters without spaces. However, the value represented by that string is not verified or modified.

If the field is not required for the transaction, Visa Acceptance Solutions does not forward the request to the issuing bank.

Specifications

Data Type:
String with numbers only

Data Length:
150 maximum

Format:
Alphanumeric special characters without spaces.

Mapping Information

REST API Field:

recipientInformation.email

SCMP API Field:

recipient_email

Simple Order API Field:

recipient_email

recipientInformation. firstName

First name of the recipient.

The value for this field corresponds to this data in the TC 33 capture file:

Record: CP09 TCR4

Position: 5-39

Field: Account Owner Name-Given

The TC 33 capture file contains information about the payments and credits that a merchant submits to Visa Acceptance Solutions. The processor creates the TC 33 capture file at the end of the day and sends it to the merchant’s acquirer. The acquirer uses this information to facilitate end-of-day clearing processing with payment networks.

This field is available only on these processors:

Barclays

FDC Nashville Global

First Data Merchant Solutions

LloydsTSB Cardnet International

, Streamline

Visa Platform Connect

Barclays: For Mastercard Payment of Winnings (indicated when you set the
processingInformation.refundOptions.reason
field to
pow
), the value in the
orderInformation.billTo.firstName
field is used by default as the first name of the Mastercard Payment of Winnings
credit
recipient. You can use this field to override the default setting.; For an Account Funding Transaction (AFT), this field must be alphanumeric and special characters must be in ASCII format. The value must the concatenated value of fields
recipientInformation.firstName
,
recipientInformation.middleName
, and
recipientInformation.lastName
, and must not exceed 30 characters for Visa transactions and 35 characters for Mastercard.
FDC Nashville Global: Required with Mastercard for AFTs. Required with Visa for intra-European Economic Area (EEA), including UK and Gibraltar, and EU international transactions. Optional with Visa for domestic EU AFTs.; The only special characters allowed in the value are
'
,
and
space
.
First Data Merchant Solutions and LloydsTSB Cardnet International: For a Visa AFT, this field must be alpha characters only. You must not exceed 30 characters for the concatenated value of
senderInformation.firstName
,
senderInformation.middleName
, and
senderInformation.lastName
fields.

Specifications

Data Type:
String

Data Length:
35

Barclays: See field description.

First Data Merchant Solutions: See field description.

LloydsTSB Cardnet International: See field description.

Mapping Information

REST API Field:

recipientInformation.firstName

SCMP API Field:

recipient_firstname

Simple Order API Field:

recipient_firstName

recipientInformation. lastName

Recipient’s last name.

This field is a pass-through, which means that the value is not verified or modified in any way before it is sent to the processor. If the field is not required for the transaction, it is not forwarded to the processor.

The value for this field corresponds to this data in the TC 33 capture file:

Record: CP09 TCR4

Position: 5-39

Field: Account Owner Last Name

The TC 33 capture file contains information about the payments and credits that a merchant submits to Visa Acceptance Solutions. The processor creates the TC 33 capture file at the end of the day and sends it to the merchant’s acquirer. The acquirer uses this information to facilitate end-of-day clearing processing with payment networks.

This field is available only on these processors:

Barclays

FDC Nashville Global

LloydsTSB Cardnet International

First Data Merchant Solutions

Streamline

Visa Platform Connect

Barclays: For Mastercard Payment of Winnings, (indicated when you set the
processingInformation.refundOptions.reason
field to
pow
), the value in the
orderInformation.billTo.lastName
field is used by default as the last name of the Mastercard Payment of Winnings
credit
recipient. You can use this field to override the default setting.; For an Account Funding Transaction (AFT), this field must be alphanumeric and special characters must be in ASCII format. The value must the concatenated value of fields
recipientInformation.firstName
,
recipientInformation.middleName
, and
recipientInformation.lastName
, and must not exceed 30 characters for Visa transactions and 35 characters for Mastercard.

FDC Nashville Global: Required with Mastercard for AFTs. Required with Visa for intra-European Economic Area (EEA), including UK and Gibraltar, and EU international transactions. Optional with Visa for domestic EU AFTs.; The only special characters allowed in the value are
'
,
and
space
.

LloydsTSB Cardnet International and First Data Merchant Solutions: For a Visa AFT, this field must be alpha characters only. You must not exceed 30 characters for the concatenated value of
senderInformation.firstName
,
senderInformation.middleName
, and
senderInformation.lastName
fields.

Specifications

Data Type:
String

Data Length

For UK processors: 6

For other processors: 35

Barclays: See field description.

First Data Merchant Solutions: See field description.

LloydsTSB Cardnet International: See field description.

Mapping Information

REST API Field:

recipientInformation.lastName

SCMP API Field:

recipient_lastname

Simple Order API Field:

recipient_lastName

recipientInformation. locality

The city of the recipient.

This field is available only on these processors:

FDC Compass

LloydsTSB Cardnet International

First Data Merchant Solutions

Streamline

Visa Platform Connect

Visa Platform Connect: The value for this field corresponds to this data in the TC 33 capture file:
Record: CP09 TCR5
Position: 104-128
Field: Account Owner City Name

The TC 33 capture file contains information about the payments and credits that a merchant submits to Visa Acceptance Solutions. The processor creates the TC 33 capture file at the end of the day and sends it to the merchant’s acquirer. The acquirer uses this information to facilitate end-of-day clearing processing with payment networks.

First Data Merchant Solutions and LloydsTSB Cardnet International: Required with Visa when the
recipientInformation.country
field value is Canada.

Specifications

Data Type:
String

Data Length:
25

Mapping Information

REST API Field:

recipientInformation.locality

SCMP API Field:

recipient_city

Simple Order API Field:

recipient_city

recipientInformation. middleInitial

Middle initial of the recipient.

This field is available only on the FDC Compass processor.

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

recipientInformation.middleInitial

SCMP API Field:

recipient_middleinitial

Simple Order API Field:

recipient_middleInitial

recipientInformation. middleName

Middle name of the recipient.

The value for this field corresponds to the following data in the TC 33 capture file:

Record: CP09 TCR4

Position: 40-74

Field: Account Owner Middle Name

The TC 33 capture file contains information about the payments and credits that a merchant submits to Visa Acceptance Solutions. The processor creates the TC 33 capture file at the end of the day and sends it to the merchant’s acquirer. The acquirer uses this information to facilitate end-of-day clearing processing with payment networks.

This field is available only on these processors:

Barclays

FDC Nashville Global

First Data Merchant Solutions

LloydsTSB Cardnet International

Streamline

Visa Platform Connect

Barclays: For an Account Funding Transaction (AFT), this field must be alphanumeric and special characters must be in ASCII format. The value must the concatenated value of fields
recipientInformation.firstName
,
recipientInformation.middleName
, and
recipientInformation.lastName
, and must not exceed 30 characters for Visa transactions and 35 characters for Mastercard.

FDC Nashville Global: Required with Visa for AFTs. Required with Visa for intra-European Economic Area (EEA), including UK and Gibraltar, and EU international transactions. Optional for domestic EU AFTs and with Mastercard.; The only special characters allowed in the value are
'
,
and
space
.

First Data Merchant Solutions and LloydsTSB Cardnet International: For a Visa AFT, this field must be alpha characters only. You must not exceed 30 characters for the concatenated value of
senderInformation.firstName
,
senderInformation.middleName
, and
senderInformation.lastName
fields.

Streamline: Required with Visa AFTs for Canada and US cross-border, and Visa AFTs for South Africa issuer cross-border.

Specifications

Data Type:
String

Data Length:
35

First Data Merchant Solutions: See field description.

LloydsTSB Cardnet International: See field description.

Mapping Information

REST API Field:

recipientInformation.middleName

SCMP API Field:

recipient_middlename

Simple Order API Field:

recipient_middleName

recipientInformation. nationality

Recipient’s nationality.

This field is a pass-through. Before the AFT or OCT request message is sent to the processor, the field content is verified to contain 10 alphanumeric special characters without spaces. However, the value represented by that string is not verified or modified.

If the field is not required for the transaction, Visa Acceptance Solutions does not forward the request to the issuing bank.

Visa Platform Connect: The value must be the standard three character ISO 3166 alpha country code. For more information, see ISO 3166 Country Codes.

Specifications

Data Type:
String with numbers only

Data Length:
10 maximum

Visa Platform Connect: 3

Format:
Alphanumeric special characters without spaces.

Mapping Information

REST API Field:

recipientInformation.nationality

SCMP API Field:

recipient_nationality

Simple Order API Field:

recipient_nationality

recipientInformation. occupation

Recipient’s occupation.

This field is a pass-through. Before the AFT or OCT request message is sent to the processor, the field content is verified to contain 50 alphanumeric characters without spaces. However, the value represented by that string is not verified or modified.

If the field is not required for the transaction, Visa Acceptance Solutions does not forward the request to the issuing bank.

Specifications

Data Type:
String

Data Length:
50 maximum

Format:
Alphanumeric characters. No spaces.

Mapping Information

REST API Field:

recipientInformation.occupation

SCMP API Field:

recipient_occupation

Simple Order API Field:

recipient_occupation

recipientInformation. phoneNumber

Phone number of the recipient.

This field is available only on these processors:

FDC Compass

FDC Nashville Global

Specifications

Data Type:
String with numbers only

Data Length:
20

Mapping Information

REST API Field:

recipientInformation.phoneNumber

SCMP API Field:

recipient_phone_number

Simple Order API Field:

recipient_phoneNumber

recipientInformation. postalCode

Partial postal code for the recipient’s address.

Example
: If the postal code is NN5 7SG, the value for this field should be the first part of the postal code:

NN5

.

This field is a pass-through, which means that the value is not verified or modified in any way before it is sent to the processor. If the field is not required for the transaction, it is not forwarded to the processor.

This field is available only on these processors:

FDC Compass

FDC Nashville Global

Streamline

Visa Platform Connect

Streamline: Required for Canada and US cross-border Account Funding Transactions (AFT).
Visa Platform Connect: The value for this field corresponds to the following data in the TC 33 capture file:
Record: CP09 TCR5
Position: 129-131
Field: Account Owner Subdivision Code Major

The TC 33 capture file contains information about the payments and credits that a merchant submits to Visa Acceptance Solutions. The processor creates the TC 33 capture file at the end of the day and sends it to the merchant’s acquirer. The acquirer uses this information to facilitate end-of-day clearing processing with payment networks.

Specifications

Data Type:
String

Data Length:
10

Mapping Information

REST API Field:

recipientInformation.postalCode

SCMP API Field:

recipient_postal_code

Simple Order API Field:

recipient_postalCode

recipientInformation. streetName

Street name of the recipient.

Specifications

Data Type:
String

Data Length:
50

Mapping Information

REST API Field:

recipientInformation.streetName

Simple Order API Field:

recipient_streetName

reconciliationID

Reference number for the transaction.

You can use this value to reconcile Visa Acceptance Solutions reports with processor reports.

This value is not returned for all processors.

Syntax

This syntax is used with this field:

{
  "reconciliationId": [ReferenceNumber]
}

Specifications

Data Type:
String

Data Length:

FDC Nashville Global:
8

Other processors:
60

Mapping Information

REST API Field:

reconciliationID

SCMP API Fields:

ap_auth_trans_ref_no

ap_auth_reversal_trans_ref_no

ap_capture_trans_ref_no

ap_check_status_trans_ref_no

ap_refund_trans_ref_no

ap_sales_trans_ref_no

auth_reversal_trans_ref_no

auth_trans_ref_no

bill_trans_ref_no

credit_trans_ref_no

dcc_reference_number

ecp_credit_ref_no

incremental_auth_trans_ref_no

oct_trans_ref_no

pin_debit_credit_trans_ref_no

pin_debit_purchase_trans_ref_no

pin_debit_reversal_trans_ref_no

Simple Order API Fields:

apAuthReply_reconciliationID

apAuthReversalReply_reconciliationID

apCaptureReply_reconciliationID

apCheckStatusReply_reconciliationID

apRefundReply_reconciliationID

apSaleReply_reconciliationID

ccAuthReply_reconciliationID

ccAuthReversalReply_reconciliationID

ccCaptureReply_reconciliationID

ccCaptureService_reconciliationID

ccCreditReply_reconciliationID

ccIncrementalAuthReply_reconciliationID

dcc_referenceNumber

ecCreditReply_reconciliationID

octReply_reconciliationID

pinDebitCreditReply_reconciliationID

pinDebitPurchaseReply_reconciliationID

pinDebitReversalReply_reconciliationID

recurringPaymentInformation

These fields provide recurring payment information.

recurringPaymentInformation.amountType

recurringPaymentInformation.endDate

recurringPaymentInformation.frequency

recurringPaymentInformation.maximumAmount

recurringPaymentInformation.numberOfPayments

recurringPaymentInformation.occurrence

recurringPaymentInformation.originalPurchaseDate

recurringPaymentInformation.referenceNumber

recurringPaymentInformation.type

recurringPaymentInformation.validationIndicator

recurringPaymentInformation. amountType

Indicates whether the recurring payment amount agreed to by the cardholder is a fixed amount or variable amount.

Required for all recurring transactions from Saudi Arabia merchants. Visa Acceptance Solutions forwards this value to Saudi Payment when received from the merchant.

This field is required for recurring payments using cards issued in India.

This field is available only for Mastercard on the Visa Platform Connect processor.

Possible values:

0

: Fixed amount recurring payment.

1

: Recurring payment with maximum amount.

India-specific possible amounts:

1

: Recurring payment with fixed amount.

2

: Recurring payment with maximum amount.

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

recurringPaymentInformation.amountType

SCMP API Field:

recurring_amount_type

Simple Order API Field:

recurring_amountType

recurringPaymentInformation. endDate

The date after which no further recurring authorizations should be performed.

Format:
yyyyMMDD.

Specifications

Data Type:
String

Data Length:
10

Mapping Information

REST API Field:

recurringPaymentInformation.endDate

SCMP API Field:

pa_recurring_end_date

Simple Order API Field:

payerAuthEnrollService_recurringEndDate

recurringPaymentInformation. frequency

Integer value indicating the minimum number of days between recurring authorizations.

A frequency of monthly is indicated by the value 28. Multiple of 28 days will be used to indicate months.

Example
: 6 months = 168

Example values accepted (31 days):

31

031

0031

Specifications

Data Type:
Integer

Data Length:
4

Mapping Information

REST API Field:

recurringPaymentInformation.frequency

SCMP API Field:

pa_recurring_frequency

Simple Order API Field:

payerAuthEnrollService_recurringFrequency

recurringPaymentInformation. maximumAmount

Maximum amount cardholder has agreed to for a recurring payment.

This field is required for recurring payments using cards issued in India.

This field is available only for Mastercard transactions on the Visa Platform Connect processor.

Specifications

Data Type:
String

Data Length:
12

Mapping Information

REST API Field:

recurringPaymentInformation.maximumAmount

SCMP API Field:

auth_recurring_maximum_amount

Simple Order API Field:

recurring_maximumAmount

recurringPaymentInformation. numberOfPayments

Total number of payments for the duration of the recurring subscription.

This field is required for recurring payments using cards issued in India.

This field is available only for Mastercard transactions on the Visa Platform Connect processor.

Possible values range from

01

to

99

.

Specifications

Data Type:
String

Data Length:
2

Mapping Information

REST API Field:

recurringPaymentInformation.numberOfPayments

SCMP API Fields:

pa_installment_total_count

recurring_number_of_payments

Simple Order API Fields:

payerAuthEnrollService_installmentTotalCount

recurring_numberOfPayments

recurringPaymentInformation. occurrence

Indicates how often a recurring payment occurs.

This field is required for recurring payments using cards issued in India.

This field is available only for Mastercard transactions on the Visa Platform Connect processor.

Possible values:

01

: Daily

02

: Bi-weekly

03

: Weekly

04

: 10 Days

05

: Every 2 weeks

06

: Monthly

07

: 2 months

08

: 3 months

09

: Quarterly

10

: Half-yearly

11

: Annually

12

: Unscheduled

Specifications

Data Type:
String

Data Length:
2

Mapping Information

REST API Field:

recurringPaymentInformation.occurrence

SCMP API Field:

recurring_occurrence

Simple Order API Field:

recurring_occurrence

recurringPaymentInformation. originalPurchaseDate

Date of original purchase. Required for recurring transactions.

If this field is empty, the current date is used.

Specifications

Data Type:
String

Data Length:
17

Mapping Information

REST API Field:

recurringPaymentInformation.originalPurchaseDate

SCMP API Field:

pa_recurring_original_purchase_date

Simple Order API Field:

payerAuthEnrollService_recurringOriginalPurchaseDate

recurringPaymentInformation. referenceNumber

Unique reference number for the recurring payment transaction.

This field is required for recurring payments using cards issued in India.

This field is available only for Mastercard transactions on the Visa Platform Connect processor.

Specifications

Data Type:
String

Data Length:
35

Mapping Information

REST API Field:

recurringPaymentInformation.referenceNumber

SCMP API Field:

recurring_reference_number

Simple Order API Field:

recurring_referenceNumber

recurringPaymentInformation. type

Indicates the type of recurring payment.

This field is required for recurring payments using cards issued in India

and for eftpos cards in Australia

.

Possible values:

1

: Registration or first transaction

2

: Subsequent transaction

3

: Modification

4

: Cancellation

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

recurringPaymentInformation.type

SCMP API Field:

recurring_type

Simple Order API Field:

recurring_type

recurringPaymentInformation. validationIndicator

Contains a value that indicates whether a recurring payment transaction has been validated offline during registration.

This field is required for recurring payments using cards issued in India.

This field is available only for Mastercard transactions on the Visa Platform Connect processor.

Possible values:

0

: Not validated.

1

: Validated.

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

recurringPaymentInformation.validationIndicator

SCMP API Field:

recurring_validation_indicator

Simple Order API Field:

recurring_validationIndicator

refundAmountDetails

These fields provide refund amount information.

refundAmountDetails.currency

refundAmountDetails.refundAmount

refundAmountDetails. currency

Currency used in the transaction.

Use a three-character ISO currency code. For a list of ISO currency codes, see ISO Standard Currency Codes.

Authorization Reversal or Capture Services: Use the same currency that was used for the authorization.
PIN Debit Reversal Service: Use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.
Dynamic Currency Conversion (DCC) with a Third-Party Provider: Use the customer’s billing currency.

: For Mastercard installment payments in Peru, the value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCR5
Position: 108-110
Field: Financing Currency

Specifications

Data Type:
String

Data Length:
3

Mapping Information

REST API Fields:

orderInformation.amountDetails.currency

creditAmountDetails.currency

refundAmountDetails.currency

reversalAmountDetails.currency

SCMP API Field:

currency

Simple Order API Field:

purchaseTotals_currency

refundAmountDetails. refundAmount

Amount refunded to the cardholder.

Specifications

Data Type:
String

Data Length:
15

Mapping Information

REST API Fields:

creditAmountDetails.creditAmount

refundAmountDetails.refundAmount

SCMP API Field:

credit_credit_amount

Simple Order API Field:

ccCreditReply_amount

registrationInformation

These fields provide registration information.

registrationInformation.boardingFlow

registrationInformation.boardingPackageId

registrationInformation.mode

registrationInformation.salesRepId

registrationInformation. boardingFlow

Determines the boarding flow for this registration.

Visa Acceptance Solutions recommends setting this field to

ENTERPRISE

in order to enforce node-by-node boarding. If the field is not set, the field is set to the default value, which corresponds to the value included in the boarding package.

To add a new product or configure a product that has failed, use the

ADDPRODUCT

workflow.

Possible Values

ADDPRODUCT

ENTERPRISE

SMB

Syntax

{
  "registrationInformation": {
    "boardingFlow": [
      "ENTERPRISE" 
      ]
    }
}

Specifications

Data Type:
Enum

Mapping Information

No corresponding fields.

registrationInformation. boardingPackageId

Boarding package identifier.

Syntax

{
  "registrationInformation": {
    "boardingPackageId": "1004001"
  }
}

Specifications

Data Type:
String

Maximum Length:
60

Mapping Information

No corresponding fields.

registrationInformation. mode

Status of the boarding registration.

Possible Values

COMPLETE

(default)

PARTIAL

Syntax

{
  "registrationInformation": {
    "mode": "COMPLETE"
  }
}

Specifications

Data Type:
Enum

Mapping Information

No corresponding fields.

registrationInformation. salesRepId

Sales representative identifier for the boarding registration.

Syntax

{
  "registrationInformation": {
    "salesRepId": "salesrep123"
  }
}

Specifications

Data Type:
String

Maximum Length:
60

Mapping Information

No corresponding fields.

replacementReason

Reason for replacement of the terminal.

The reason is recorded only if the

statusChangeReason

field is set to

Replaced

.

Valid Values:

Chip Read Error

Compromised

Incorrect Key Injection

Incorrect Password

Power Issue

Suspected Tampering

Tampered

Terminal Error

Other

Specifications

Data Type:
Enum of string

Data Length:
Pre-defined values

Mapping Information

REST API Field:

replacementReason

SCMP API Field:
No corresponding field

Simple Order API Field:
No corresponding field

replacementSerialNumber

The new serial number for the terminal that replaces the current one.

The reason is recorded only if the

statusChangeReason

field is set to

Replaced

.

Specifications

Data Type:
String

Data Length:
64

Mapping Information

REST API Field:

replacementSerialNumber

SCMP API Field:
No corresponding field

Simple Order API Field:
No corresponding field

retrieveBinDetails

Indicates if you want to retrieve BIN details in a Token Management Service (TMS) request. When this field is set to

true

, BIN details are included in a TMS response.

Possible Values

true

false

Specifications

Data Type:
Boolean

Mapping Information

REST API Field:

retrieveBinDetails

SCMP API Field:
No corresponding field

Simple Order API Field:
No corresponding field

reversalAmountDetails

These fields provide reversal amount details.

reversalAmountDetails.currency

reversalAmountDetails.originalTransactionAmount

reversalAmountDetails.reversedAmount

reversalAmountDetails. currency

Currency used in the transaction.

Use a three-character ISO currency code. For a list of ISO currency codes, see ISO Standard Currency Codes.

Authorization Reversal or Capture Services: Use the same currency that was used for the authorization.
PIN Debit Reversal Service: Use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.
Dynamic Currency Conversion (DCC) with a Third-Party Provider: Use the customer’s billing currency.
: For Mastercard installment payments in Peru, the value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCR5
Position: 108-110
Field: Financing Currency

Specifications

Data Type:
String

Data Length:
3

Mapping Information

REST API Fields:

orderInformation.amountDetails.currency

creditAmountDetails.currency

refundAmountDetails.currency

reversalAmountDetails.currency

SCMP API Field:

currency

Simple Order API Field:

purchaseTotals_currency

reversalAmountDetails. originalTransactionAmount

Amount of the original transaction.

Specifications

Data Type:
String

Data Length:
15

Mapping Information

REST API Fields:

reversalAmountDetails.originalTransactionAmount

voidAmountDetails.originalTransactionAmount

SCMP API Field:

original_transaction_amount

Simple Order API Field:

originalTransaction_amount

reversalAmountDetails. reversedAmount

Amount that was reversed.

Specifications

Data Type:
String

Data Length:
15

Mapping Information

REST API Field:

reversalAmountDetails.reversedAmount

SCMP API Field:

auth_reversal_amount

Simple Order API Field:

ccAuthReversalReply_amount

reversalInformation

These fields provide reversal information.

reversalInformation.amountDetails.currency

reversalInformation.amountDetails.totalAmount

reversalInformation.reason

reversalInformation. amountDetails.currency

Currency used in the transaction.

Use a three-character ISO currency code.

For authorization reversal or capture services, you must use the same currency that was used for the authorization.

For the PIN debit reversal service, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing.

When using Dynamic Currency Conversion (DCC) with a Third-Party Provider:, use the customer’s billing currency.

Visa Platform Connect: For Mastercard installment payments in Peru, the value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCR5
Position: 108-110
Field: Financing Currency

Specifications

Data Type:
String

Data Length:
3

Mapping Information

REST API Fields:

orderInformation.amountDetails.currency

creditAmountDetails.currency

refundAmountDetails.currency

reversalAmountDetails.currency

reversalInformation.amountDetails.currency

SCMP API Fields:

auth_request_currency

currency

pin_debit_purchase_request_currency

Simple Order API Fields:

ccAuthReply_requestCurrency

pinDebitPurchaseReply_requestCurrency

purchaseTotals_currency

reversalInformation. amountDetails.totalAmount

Grand total for the order.

If your request includes line items, do not include this field in your request.

This value cannot be negative. You can include a decimal point (.), but you cannot include any other special characters. The amount is truncated to the correct number of decimal places.

IMPORTANT

Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths.

Dynamic Currency Conversions: When this field is used in a request with Dynamic Currency Conversion, this field value must be denominated in the customer's billing currency.
Original Credit Transactions (OCT): The amount must be less than or equal to 50,000 USD. Amount limits differ depending on limitations imposed by your acquirer in addition to local laws and regulations. Contact your acquirer for more information.
PIN Debit Transactions: If the transaction includes a cash-back amount, that amount must be included in this total amount. If the transaction includes a surcharge amount, that amount must be included in this total amount.
Zero Amount Authorizations: If your processor supports zero amount authorizations, you can set this field to
0
for the authorization to verify whether the card is lost or stolen.
: The value for this field corresponds to the following data in the TC 33 capture file:
OCT Account Type: CP01 TCR0 Position 48-51
OCT Amount Sign: CP01 TCR0 Position 52

The TC 33 capture file contains information about the payments and credits that a merchant submits to Visa Acceptance Solutions. The processor creates the TC 33 capture file at the end of the day and sends it to the merchant’s acquirer. The acquirer uses this information to facilitate end-of-day clearing processing with payment networks.

Specifications

Data Type:
String

Data Length:

Comercio Latino:
19

Other processors:
15

Mapping Information

REST API Fields:

orderInformation.amountDetails.totalAmount

reversalInformation.amountDetails.totalAmount

SCMP API Field:

grand_total_amount

Simple Order API Field:

purchaseTotals_grandTotalAmount

Processor Field Names

The following list provides the Level II/Level III processor field name for each processor that supports Level II or Level III data.

Chase Paymentech Solutions:
Does not apply

FDC Compass:
Does not apply

FDC Nashville Global:
Does not apply

OmniPay Direct:
Line Item Total

:
Amount

TSYS Acquiring Solutions:
Does not apply

reversalInformation. reason

Reason for the authorization reversal.

Set the value for this field to

34

, which indicates suspected fraud.

This field is ignored for processors that do not support this value.

Specifications

Data Type:
String

Data Length:
3

Mapping Information

REST API Field:

reversalInformation.reason

SCMP API Field:

auth_reversal_reason

Simple Order API Field:

ccAuthReversalService_reversalReason

senderInformation

These fields provide sender information.

senderInformation.account.fundsSource

senderInformation.account.number

senderInformation.accountType

senderInformation.address1

senderInformation.administrativeArea

senderInformation.countryCode

senderInformation.dateOfBirth

senderInformation.firstName

senderInformation.identificationNumber

senderInformation.lastName

senderInformation.locality

senderInformation.middleInitial

senderInformation.middleName

senderInformation.name

senderInformation.personalIdType

senderInformation.phoneNumber

senderInformation.postalCode

senderInformation.referenceNumber

senderInformation.type

senderInformation. account.fundsSource

Source of funds.

This field is available only on these processors:

Barclays

Chase Paymentech Solutions

FDC Compass

FDC Nashville Global

Streamline

Visa Platform Connect

These processors have specific requirements:

Barclays: For Mastercard Payment of Winnings (indicated when you set the
processingInformation.refundOptions.reason
field to
pow
), you can use this field if you need to provide your merchant source of funds to process a Mastercard Payment of Winnings
credit
.; Possible values for processing a Mastercard Payment of Winnings
credit
:
00
: Other
01
: RTN + bank account
02
: International bank account number (IBAN)
03
: Card account
04
: Email
05
: Phone number
06
: Bank account number (BAN) + bank identification code (BIC)
07
: Wallet ID
08
: Social network ID
Chase Paymentech Solutions: Possible values:
01
: Credit card
02
: Debit card
03
: Prepaid card
04
: Cash
05
: Debit or deposit account that is not linked to a Visa card. Includes checking accounts, savings accounts, and proprietary debit or ATM card accounts.
06
: Credit account that is not linked to a Visa card. Includes credit cards and proprietary lines of credit.; For a credit card bill payment, set this field to
02
,
03
,
04
, or
05
.
FDC Compass: Possible values:
01
: Credit card
02
: Debit card
03
: Prepaid card
04
: Deposit account
05
: Debit or deposit account that is not linked to a Visa card. Includes checking accounts, savings accounts, proprietary debit or ATM card accounts, and digital wallet accounts.
06
: Credit account that is not linked to a Visa card. Includes credit cards and proprietary lines of credit.; For a funds disbursement, set this field to
04
to indicate that the originator used a deposit account to fund the disbursement.; For a credit card bill payment, set this field to
02
,
03
,
04
, or
05
.
FDC Nashville Global: Possible values:
01
: Credit card
02
: Debit card
03
: Prepaid card
04
: Deposit account
06
: Cash
Streamline: Possible values:
01
: Credit card
02
: Debit card
03
: Prepaid card
04
: Deposit account
05
: Mobile money accountDebit or deposit
06
: Cash
07
: Other
V5
: Debit or deposit access other than those linked to the cardholders’ scheme
V6
: Credit accounts other than those linked to the cardholder’s scheme
Visa Platform Connect: Possible values:
01
: Credit card
02
: Debit card
03
: Prepaid card
04
: Cash
05
: Debit or deposit account that is not linked to a Visa card. Includes checking accounts, savings accounts, proprietary debit or ATM card accounts, and digital wallet accounts.
06
: Credit account that is not linked to a Visa card. Includes credit cards and proprietary lines of credit.; For a funds disbursement, set this field to
05
to indicate that the originator funded the disbursement using a checking account, savings account, proprietary debit or ATM card account, or digital wallet account.; For a credit card bill payment, set this field to
02
,
03
,
04
, or
05
.

Specifications

Data Type:
String with numbers only

Data Length:
2

Mapping Information

REST API Field:

senderInformation.account.fundsSource

SCMP API Field:

sender_source_of_funds

Simple Order API Field:

sender_sourceOfFunds

senderInformation. account.number

The account number of the entity funding the transaction. The value for this field can be a payment card account number or bank account number.

For Account Funding Transactions (AFTs), the value for this field is the account number of the recipient account being funded. Include this tag only if either

senderInformation.referenceNumber

or

senderInformation.account.number

is present. If you do not include this tag,

senderInformation.referenceNumber

must be present and contain a reference number for the recipient account.

In cross-border AFTs, include the account number of the recipient account being funded. This requirement applies specifically to cross-border money transfer AFTs.

Domestic AFTs are optional.

For Europe Domestic and intra-EEA cross-border transactions, include the recipient account number in domestic and intra-EEA money transfer AFTs.

This field is available only for these processors:

Barclays

Chase Paymentech Solutions

FDC Compass

FDC Nashville Global

LloydsTSB Cardnet International

First Data Merchant Solutions

Streamline

Visa Platform Connect

Barclays: For Mastercard Payment of Winnings (indicated when you set the
processingInformation.refundOptions.reason
field to
pow
), you can use this field if you need to provide your merchant account number to process a Mastercard Payment of Winnings
credit
.
FDC Nashville Global: Required with Visa in the EU for Account Funding Transactions (AFT).; Values without special characters or spaces will be rejected for AFTs.

Specifications

Data Type:
String with numbers only

Data Length:
20

LloydsTSB Cardnet International: 33

First Data Merchant Solutions: 33

Mapping Information

REST API Field:

senderInformation.account.number

SCMP API Field:

sender_account_number

Simple Order API Field:

sender_accountNumber

senderInformation. accountType

Identifies the sender’s account type.

This field is only available for FDC Nashville Global and Streamline when processing Account Funding Transactions (AFT).

Possible values are:

00

: Other

01

: Routing transit number (RTM) and bank account

02

: IBAN

03

: Card accountubnuccccervl00881847

04

: Email

05

: Phone number

06

: Bank account number (BAN) and Bank identification number code (BIC)

07

: Wallet ID

08

: Social network ID

Specifications

Data Type:
String

Data Length:
2

Mapping Information

REST API Field:

senderInformation.accounttype

SCMP API Field: No corresponding field.

Simple Order API Field: No corresponding field.

senderInformation. address1

Street address of sender.

This field is available only on these processors:

Barclays

FDC Compass

FDC Nashville Global

LloydsTSB Cardnet International

First Data Merchant Solutions

Streamline

Visa Platform Connect

Barclays: For Mastercard Payment of Winnings (indicated when you set the
processingInformation.refundOptions.reason
field to
pow
), the street name in your merchant configuration on the Visa Acceptance Solutions platform is used by default as your default street address in a Mastercard Payment of Winnings
credit
request. You can use this field to override the default setting.; For Account Funding Transactions (AFT), values must be in alphanumeric and special characters must be in ASCII format.
FDC Compass and Visa Platform Connect: For a funds disbursement, the value is the address of the originator sending the funds disbursement.

LloydsTSB Cardnet International and First Data Merchant Solutions: Required with Visa for AFTs.

FDC Nashville Global: Required with Visa AFTs into and out of Canada with the address of the person or entity.; The only special characters allowed in the value are
'
,
and
space
.

Specifications

Data Type:
String

Data Length:
50

Barclays: 35 (alphanumeric only)

Streamline: 35 (alphanumeric only)

Mapping Information

REST API Field:

senderInformation.address1

SCMP API Field:

sender_address

Simple Order API Field:

sender_address

senderInformation. administrativeArea

State of sender.

This field is available only on these processors:

Barclays

Chase Paymentech Solutions

FDC Nashville Global

FDC Compass

First Data Merchant Solutions

LloydsTSB Cardnet International

Visa Platform Connect

First Data Merchant Solutions and LloydsTSB Cardnet International: Required with Visa when the
senderInformation.country
field value is Canada and the US for Account Funding Transactions (AFT).
FDC Nashville Global: Required with Visa AFTs in Canada and US.

Specifications

Data Type:
String

Data Length:
2

Barclays: 2 for US or Canada. Not required for all other countries.

Mapping Information

REST API Field:

senderInformation.administrativeArea

SCMP API Field:

sender_state

Simple Order API Field:

sender_state

senderInformation. countryCode

Country of sender.

For a Funds Disbursement
, the value is the country of the originator sending the funds disbursement. Always use the ISO-3166 format. See ISO Standard Country Codes.

This field is available only on these processors:

Barclays

First Data Merchant Solutions

FDC Compass

FDC Nashville Global

LloydsTSB Cardnet International

Streamline

Visa Platform Connect

Barclays: For Mastercard Payment of Winnings (indicated when you set the
processingInformation.refundOptions.reason
field to
pow
), the merchant country in your merchant configuration on the Visa Acceptance Solutions platform is used by default as your default country code in a Mastercard Payment of Winnings
credit
request. You can use this field to override the default setting.; When processing Account Funding Transactions (AFT) with Visa, enter a valid two or three character country code.

First Data Merchant Solutions and LloydsTSB Cardnet International: Required with Visa for AFTs.

FDC Nashville Global: Required with Visa AFTs into and out of Canada.; Values without special characters or spaces will be rejected for AFTs.

Specifications

Data Type:
String

Data Length:
2

Barclays: 2 or 3

FDC Nashville Global: 2 for US or Canada. Not required for all other countries.

First Data Merchant Solutions: 3

LloydsTSB Cardnet International: 3

Streamline: 3

Mapping Information

REST API Field:

senderInformation.countryCode

SCMP API Field:

sender_country

Simple Order API Field:

sender_country

senderInformation. dateOfBirth

Date of birth of the sender.

This field is available only on the FDC Compass processor.

Format
: YYYMMDD

Before sending this value to the processor, Visa Acceptance Solutions reformats it to the FDC Compass format: MMDDyyyy.

Specifications

Data Type:
String with numbers only

Data Length:
8

Mapping Information

REST API Field:

senderInformation.dateOfBirth

SCMP API Field:

sender_date_of_birth

Simple Order API Field:

sender_dateOfBirth

senderInformation. firstName

First name of sender when the sender is an individual.

This field is available only on these processors:

Barclays

Chase Paymentech Solutions

FDC Nashville Global

FDC Compass

LloydsTSB Cardnet International

First Data Merchant Solutions

Streamline

Visa Platform Connect

These processors have specific requirements:

Barclays: For Mastercard Payment of Winnings (indicated when you set the
processingInformation.refundOptions.reason
field to
pow
), the merchant name in your merchant configuration on the Visa Acceptance Solutions platform is used by default as your merchant first name in a Mastercard Payment of Winnings
credit
request. You can use this field to override the default setting.

For an Account Funding Transactions (AFT), this field must be alphanumeric and special characters must be in ASCII format. You must not exceed 30 characters for the concatenated value of
senderInformation.firstName
,
senderInformation.middleName
, and
senderInformation.lastName
fields.
Chase Paymentech Solutions: When the sender is a business or government entity, use the
senderInformation.name
field.
FDC Nashville Global: Required with Visa AFTs.; The only special characters allowed in the value are
'
,
and
space
.
First Data Merchant Solutions and LloydsTSB Cardnet International: Required with Visa for AFTs.
Visa Platform Connect: This field is required for Original Credit Transactions (OCTs) when the sender is an individual. It is supported only for Mastercard transactions that use the Payouts services.; The value for this field corresponds to this data in the TC 33 capture file:

Record: CP09 TCR3
Position: 5-39
Field: Account Owner Name-Given

Specifications

Data Type:
String

Data Length:
35

Barclays: See field description.

First Data Merchant Solutions: 25

LloydsTSB Cardnet International: 25

Visa Platform Connect: 30

Mapping Information

REST API Field:

senderInformation.firstName

SCMP API Field:

sender_firstname

Simple Order API Field:

sender_firstName

senderInformation. identificationNumber

Acquirer-populated value associated with the

senderInformation.personalIdType

request field, which identifies the personal ID type of the sender.

Specifications

Data Type:
String

Data Length:
2

Mapping Information

REST API Field:

senderInformation.identificationNumber

SCMP API Field:

sender_identification_number

Simple Order API Field:

sender_identificationNumber

senderInformation. lastName

Last name of sender when the sender is an individual.

The TC 33 capture file contains information about the payments and credits that a merchant submits to Visa Acceptance Solutions. The processor creates the TC 33 capture file at the end of the day and sends it to the merchant’s acquirer. The acquirer uses this information to facilitate end-of-day clearing processing with payment networks.

This field is available only on these processors:

Barclays

Chase Paymentech Solutions

FDC Compass

First Data Merchant Solutions

LloydsTSB Cardnet International

Streamline

Visa Platform Connect

These processors have specific requirements:

Barclays: For a Mastercard Payment of Winnings (indicated when you set the
processingInformation.refundOptions.reason
field to
pow
), you can use this field to specify a merchant last name in a Mastercard Payment of Winnings
credit
request.; For an Account Funding Transactions (AFT), this field must be alphanumeric and special characters must be in ASCII format. You must not exceed 30 characters for the concatenated value of
senderInformation.firstName
,
senderInformation.middleName
, and
senderInformation.lastName
fields.
Chase Paymentech Solutions: When the sender is a business or government entity, use the
senderInformation.name
field.; This field is required for Original Credit Transactions (OCTs) when the sender is a when the sender is an individual. It is supported only for Mastercard transactions that use the Payouts.
FDC Nashville Global: Required with Visa AFTs.; The only special characters allowed in the value are
'
,
and
space
.
LloydsTSB Cardnet International and First Data Merchant Solutions: Required with Visa for AFTs.
Visa Platform Connect: The value for this field corresponds to this data in the TC 33 capture file.

Record: CP09 TCR3
Position: 75-109
Field: Account Owner Last Name

Specifications

Data Type:
String

Data Length:
35

Barclays: See field description.

First Data Merchant Solutions: 25

LloydsTSB Cardnet International: 25

Mapping Information

REST API Field:

senderInformation.lastName

SCMP API Field:

sender_lastname

Simple Order API Field:

sender_lastName

senderInformation. locality

City of sender.

For a Funds Disbursement, the value is the city of the originator sending the funds disbursement.

This field is available only on these processors:

Barclays

Chase Paymentech Solutions

FDC Compass

FDC Nashville Global

First Data Merchant Solutions

LloydsTSB Cardnet International

Streamline

Visa Platform Connect

Barclays: For a Mastercard Payment of Winnings (indicated when you set the
processingInformation.refundOptions.reason
field to
pow
), the merchant city in your merchant configuration on the Visa Acceptance Solutions platform is used by default as your merchant city in a Mastercard Payment of Winnings
credit
request. You can use this field to override the default setting.; For an Account Funding Transactions (AFT), the value must be in alphanumeric and special characters must be in ASCII format.
FDC Nashville Global: Required with Visa AFTs into and out of Canada for cross-border money and non-money transfers.
First Data Merchant Solutions and LloydsTSB Cardnet International: Required with Visa for AFTs.

Specifications

Data Type:
String

Data Length:
25

First Data Merchant Solutions: 24

LloydsTSB Cardnet International: 24

Mapping Information

REST API Field:

senderInformation.locality

SCMP API Field:

sender_city

Simple Order API Field:

sender_city

senderInformation. middleInitial

Middle initial of sender when the sender is an individual. When the sender is a business or government entity, use the

senderInformation.name

field instead.

This field is available only on the Barclays, FDC Compass, FDC Nashville Global, First Data Merchant Solutions, LloydsTSB Cardnet, OmniPay Direct, and Streamline processors.

For Barclays processor: When you process Account Funding Transactions (AFT) with Visa, this field must be alphanumeric. You must not exceed 30 characters for the concatenated value of
senderInformation.firstName
,
senderInformation.middleName
, and
senderInformation.lastName
fields.

Specifications

Data Type:
String

Data Length:
1

Barclays: See field description.

FDC Nashville Global, Streamline: 35

First Data Merchant Solutions, LloydsTSB Cardnet, OmniPay Direct: 25

Mapping Information

REST API Field:

senderInformation.middleInitial

SCMP API Field:

sender_middleinitial

Simple Order API Field:

sender_middleInitial

senderInformation. middleName

Middle name of sender when the sender is an individual. When the sender is a business or government entity, use the

senderInformation.name

field instead.

This field is available only on these processors:

Barclays

FDC Nashville Global

Visa Platform Connect

The value for this field corresponds to the following data in the TC 33 capture file:

Record: CP09 TCR3

Position: 40-74

Field: Account Owner Middle Name

The TC 33 capture file contains information about the payments and credits that a merchant submits to Visa Acceptance Solutions. The processor creates the TC 33 capture file at the end of the day and sends it to the merchant’s acquirer. The acquirer uses this information to facilitate end-of-day clearing processing with payment networks.

Barclays: For an Account Funding Transactions (AFT), this field must be alphanumeric and special characters must be in ASCII format. You must not exceed 30 characters for the concatenated value of
senderInformation.firstName
,
senderInformation.middleName
, and
senderInformation.lastName
fields.
FDC Nashville Global: Required with Visa AFTs.; The only special characters allowed in the value are
'
,
and
space
.

Specifications

Data Type:
String

Data Length:
35

Barclays: See field description.

Mapping Information

REST API Field:

senderInformation.middleName

SCMP API Field:

sender_middlename

Simple Order API Field:

sender_middleName

senderInformation. name

Name of the sender.

This field is available only on these processors:

Chase Paymentech Solutions

FDC Compass

FDC Nashville Global

Visa Platform Connect

These processors have specific requirements:

Chase Paymentech Solutions: This field is required for original credit transactions (OCTs) when the sender is a when the sender is a business or government entity. It is supported only for Mastercard card transactions that use the Payouts services.
FDC Nashville Global: This field contains the sender business, government, non-government name, or Visa payer name.

When this field is present in a transaction, the
senderInformation.firstName
,
senderInformation.middleInitial
,
senderInformation.middleName
, and
senderInformation.lastName
fields should not be present in the transaction.
Visa Platform Connect: This value is the first name of the originator sending the funds disbursement.

Specifications

Data Type:
String

Data Length

FDC Compass: 24

Chase Paymentech Solutions: 30

Visa Platform Connect: 30

Mapping Information

REST API Field:

senderInformation.name

SCMP API Field:

sender_name

Simple Order API Field:

sender_name

senderInformation. personalIdType

Type of sender identification.

This field is only available for FDC Nashville Global and Visa Platform Connect

Possible values:

ARNB:

Alien registration number

BTHD:

Date of birth

CPNY:

Company registration number

CUID:

Customer identification (unspecified)

DRLN:

Driver's license

EMAL:

Email

LAWE:

Law enforcement identification

MILI:

Military identification

NTID:

National identification

PASN:

Passport number

PHON:

Phone number

PRXY:

Proxy identification

SSNB:

Social security number

TRVL:

Travel identification (non-passport)

TXIN:

Tax identification

When this field is set to

TXIN

, you must indicate the type of tax identifier by including the

senderInformation.type

API field in the authorization message.

FDC Nashville Global: Recommended with Visa for Account Funding Transactions (AFT).
Visa Platform Connect: This field is required to use the Payouts OCT service aggregator support for Visa Platform Connect

Specifications

Data Type:
String

Data Length:
4

Mapping Information

REST API Field:

senderInformation.personalIdType

SCMP API Field:

sender_personal_id_type

Simple Order API Field:

sender_personalIDType

senderInformation. phoneNumber

Phone number of the sender.

This field is available only on the FDC Compass and FDC Nashville Global processors.

For Merchant Disbursement this value is your business phone number.

Specifications

Data Type:
String with numbers only

Data Length:
20

Mapping Information

REST API Field:

senderInformation.phoneNumber

SCMP API Field:

sender_phone_number

Simple Order API Field:

sender_phoneNumber

senderInformation. postalCode

Postal code of sender.

Specifications

Data Type:
String

Data Length:
10

Mapping Information

REST API Field:

senderInformation.postalCode

SCMP API Field:

sender_postal_code

Simple Order API Field:

sender_postalCode

senderInformation. referenceNumber

Reference number generated by you that uniquely identifies the sender.

First Data Merchant Solutions and LloydsTSB Cardnet International: Required with Visa for Account Funding Transactions (AFT).
FDC Nashville Global: Values without special characters or spaces will be rejected for AFTs.

Specifications

Data Type:
String

Data Length:
19

FDC Nashville Global: 15 for Visa and 19 for Mastercard

First Data Merchant Solutions: 16

LloydsTSB Cardnet International:16 for Visa

Mapping Information

REST API Field:

senderInformation.referenceNumber

SCMP API Field:

sender_reference_number

Simple Order API Field:

sender_referenceNumber

senderInformation. type

Type of tax identifier (business or individual) when Tag 9F20 IDType (the

senderInformation.personalIdType

field) contains the value

TXIN

(tax identification).

Possible values:

B

: Business tax ID

I

: Individual tax ID

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

senderInformation.type

SCMP API Field:

sender_type

Simple Order API Field:

sender_type

serialNumber

Serial number of the terminal.

IMPORTANT

After the serial number is set, it cannot be changed. To get this value, contact Visa Acceptance Solutions customer support.

Specifications

Data Type:
String

Data Length:
64

Mapping Information

REST API Field:

serialNumber

SCMP API Field:
No corresponding field

Simple Order API Field:
No corresponding field

sessionInformation

These fields provide session information.

sessionInformation.secureToken

sessionInformation. secureToken

Secure token for the session.

Specifications

Data Type:
String

Data Length:

Mapping Information

REST API Field:

sessionInformation.secureToken

Simple Order API Field:
No corresponding field.

shippedDateInUTC

Date in UTC that the terminal was shipped.

Format
: yyyy-MM-DDThh:mm:ssZ

To get this value, contact Visa Acceptance Solutions customer support.

Example
:

2021-08-11T22:47:57Z

equals August 11, 2021, at 22:47:57 (10:47:57 p.m.). The T separates the date and the time. The Z indicates UTC.

Specifications

Data Type:
String (date time)

Data Length:
Pre-defined format length

Mapping Information

REST API Field:

shippedDateInUTC

SCMP API Field:
No corresponding field

Simple Order API Field:
No corresponding field

shippingTrackingNumber

Tracking number from the shipping carrier.

To get this value, contact Visa Acceptance Solutions customer support.

Specifications

Data Type:
String

Data Length:
128

Mapping Information

REST API Field:

shippingTrackingNumber

SCMP API Field:
No corresponding field

Simple Order API Field:
No corresponding field

source

The type of card that is used to provision a Token Management Service network tokenized card.

Possible Values

ISSUER

ON_FILE

TOKEN

Specifications

Data Type:
Enum

Mapping Information

REST API Field:

source

SCMP API Field:
No corresponding field

Simple Order API Field:
No corresponding field

status

Request Description

The status of the terminal. To set the status field as

Active

, you must set the

paymentProcessor

,

terminalId

, and

serialNumber

fields. For terminals that have an

Active

status, the

statusChangeReason

field is set to

In Production

.

Possible values:

Active

Inactive

Response Description

The status of the plan, subscription, or submitted transaction.

Valid values :

ACTIVE

CANCELLED

DELINQUENT

EXPIRED

PENDING

REVERSED

SUSPENDED

Specifications

Data Type:
Enum

Data Length:
Pre-defined values

Mapping Information

REST API Field:

status

SCMP API Field:
No corresponding field.

Simple Order API Field:
Use the

decision

field to determine the response status.

statusChangeReason

Reason for change in status of the terminal.

Valid values:

Broken/Damaged

: Terminal is broken; does not work.

End of Life

: Terminal is not supported any more.

In Production

: Terminal is active.

Lost/Stolen

: Terminal is lost or stolen.

Other

: Terminal is inactive. (default)

Pending Setup

: Terminal has not been set up.

Replaced

: Terminal has been replaced.

Returned

: Terminal has been returned.

Specifications

Data Type:
Enum of string

Data Length:
Pre-defined values

Mapping Information

REST API Field:

statusChangeReason

SCMP API Field:
No corresponding field

Simple Order API Field:
No corresponding field

stepUpOptions

These fields provide information for step-up authentication options.

stepUpOptions.id

stepUpOptions.method

stepUpOptions.platformType

stepUpOptions.requestPayload

stepUpOptions.source

stepUpOptions.subMethod

stepUpOptions.value

stepUpOptions. id

The identifier of the authentication step-up method.

Specifications

Data Type:
String

Data Length:
96

Mapping Information

REST API Field:

stepUpOptions.id

Simple Order API Field:
No corresponding field.

stepUpOptions. method

Authentication step-up method.

Possible values:

APP_TO_APP

CUSTOMER_SERVICE

OTP_EMAIL

OTP_ONLINE_BANKING

OTP_SMS

OUTBOUND_CALL

Specifications

Data Type:
Enum

Mapping Information

REST API Field:

stepUpOptions.method

Simple Order API Field:
No corresponding field.

stepUpOptions. platformType

Authentication step-up platform type. Include this field when the

stepUpOptions.method

field is set to

APP_TO_APP

.

Possible values:

iOS

ANDROID

WINDOWS

WEB

When you set this field value to

WEB

and the

stepUpOptions.method

field is set to

APP_TO_APP

, then the token requestor has opted in to 3-D Secure Web Step-Up.

Specifications

Data Type:
Enum

Mapping Information

REST API Field:

stepUpOptions.platformType

Simple Order API Field:
No corresponding field.

stepUpOptions. requestPayload

Authentication step-up request payload.

Specifications

Data Type:
String

Data Length:
96

Mapping Information

REST API Field:

stepUpOptions.requestPayload

Simple Order API Field:
No corresponding field.

stepUpOptions. source

Authentication step-up source. For example, if

stepUpOptions.method

is set to

OTP_EMAIL

, then

stepUpOptions.source

is the email address of the issuer that is sending the authentication code.

Specifications

Data Type:
String

Data Length:
1024

Mapping Information

REST API Field:

stepUpOptions.source

Simple Order API Field:
No corresponding field.

stepUpOptions. subMethod

Authentication step-up sub-method.

Possible value:

3DS

Specifications

Data Type:
Enum

Mapping Information

REST API Field:

stepUpOptions.subMethod

Simple Order API Field:
No corresponding field.

stepUpOptions. value

Authentication step-up value. For example, if

stepUpOptions.method

is set to

OTP_EMAIL

, then

stepUpOptions.value

is the email address of the cardholder that is receiving the authentication code.

Specifications

Data Type:
String

Data Length:
64

Mapping Information

REST API Field:

stepUpOptions.value

Simple Order API Field:
No corresponding field.

subscriptionInformation

These fields provide subscription information.

subscriptionInformation.name

subscriptionInformation.startDate

subscriptionInformation. name

The subscription name.

Specifications

Data Type:
String

Data Length:
100

Mapping Information

REST API Field:

subscriptionInformation.name

SCMP API Field:
No corresponding field.

Simple Order API Field:
No corresponding field.

subscriptionInformation. startDate

The start date of the subscription.

Format:
yyyy-MM-dd

Specifications

Data Type:
String

Data Length:
10

Mapping Information

REST API Field:

subscriptionInformation.startDate

SCMP API Field:
No corresponding field.

Simple Order API Field:
No corresponding field.

submitTimeUTC

Time when the service was requested in Coordinated Universal Time (UTC).

Specifications

Type:
String

Length:
20

Mapping Information

REST API Field:

submitTimeUTC

SCMP API Fields:

auth_auth_time

auth_reversal_request_time

bill_bill_request_time

credit_credit_request_time

ecp_credit_submit_time

ecp_debit_submit_time

incremental_auth_time

oct_request_time

pin_debit_credit_time

pin_debit_purchase_time

pin_debit_reversal_time

void_void_request_time

Simple Order API Fields:

ccAuthReply_authorizedDateTime

ccAuthReversalReply_requestDateTime

ccCaptureReply_requestDateTime

ccCreditReply_requestDateTime

ccIncrementalAuthReply_authorizedDateTime

ecCreditReply_requestDateTime

ecDebitReply_requestDateTime

octReply_requestDateTime

pinDebitCreditReply_dateTime

pinDebitPurchaseReply_dateTime

pinDebitReversalReply_dateTime

voidReply_requestDateTime

targetOrigins

The target origin of the website on which you will be launching Unified Checkout/Microform is defined by the scheme (protocol), hostname (domain), and port number (if used).

You must use https://hostname (unless you use http://localhost)

Wildcards are NOT supported. Ensure that subdomains are included.

Any valid top-level domain is supported (Such as .com, .co.uk, and .gov.br)

Examples:

https://example.com

https://subdomain.example.com

https://example.com:8080

If you are embedding within multiple nested iframes you need to specify the origins of all the browser contexts used, for example:

targetOrigins: [
"https://example.com",
"https://basket.example.com",
"https://ecom.example.com"
]

Specifications

Data Type:
String

Data Length:

Mapping Information

REST API Field:

targetOrigins

Simple Order API Field:
No corresponding field.

taxInformation

These fields provide tax information.

taxInformation.commitIndicator

taxInformation.dateOverrideReason

taxInformation.nexus

taxInformation.noNexus

taxInformation.refundIndicator

taxInformation.reportingDate

taxInformation.showTaxPerLineItem

taxInformation. commitIndicator

This is a request and a response field. In a request, this field indicates whether this is a committed tax transaction. In a response, this field is an echo commit action you receive.

Request Field

For a committed tax transaction, the status in the Tax Detail Report is “Committed.” For an uncommitted tax transaction, the status in the Tax Detail Report is “Uncommitted.”

Possible values:

true

: This is a committed tax transaction.

false

(default): This is not a committed tax transaction.

Response Field

Possible values:

Specifications

Data Type:
String

Data Length:
5

Mapping Information

REST API Field:

taxInformation.commitIndicator

SCMP API Field:

tax_commit_indicator

Simple Order API Fields:

taxReply_commitIndicator

taxService_commitIndicator

taxInformation. dateOverrideReason

When a past or future date is specified in

orderInformation.invoiceDetails.invoiceDate

, provide the reason for that for audit purposes.

Typical reasons include:

Return

Layaway

Imported

Specifications

Data Type:
String

Data Length:
255

Mapping Information

REST API Field:

taxInformation.dateOverrideReason

SCMP API Field:

tax_date_override_reason

Simple Order API Field:

taxService_dateOverrideReason

taxInformation. nexus

List of states or provinces in which merchandise is taxable.

Do not use both the

taxInformation.nexus

and

taxInformation.noNexus

fields in your request. The default value for

taxInformation.nexus

is all states.

Use the state, province, or territory codes for the US and Canada. Use a single space to separate each code in the list.

When you indicate you do not have nexus in the destination state, jurisdiction level fields are left blank in the Tax Detail Report.

Specifications

Data Type:
String

Data Length:
no limit

Mapping Information

REST API Field:

taxInformation.nexus

SCMP API Field:

nexus

Simple Order API Field:

taxService_nexus

taxInformation. noNexus

List of states or provinces in which merchandise is not taxable.

Do not use both the

taxInformation.nexus

and

taxInformation.noNexus

fields in your request. The default value for

taxInformation.nexus

is all states.

Use the state, province, or territory codes for the US and Canada. Use a single space to separate each code in the list.

When you indicate you do not have nexus in the destination state, jurisdiction level fields are left blank in the Tax Detail Report.

Specifications

Data Type:
String

Data Length:
No limit

Mapping Information

REST API Field:

taxInformation.noNexus

SCMP API Field:

no_nexus

Simple Order API Field:

taxService_noNexus

taxInformation. refundIndicator

In a request, this field indicates whether this is a refund tax transaction. In a response, this field is an echo refund action you receive.

Indicates whether this is a refund tax transaction.

For a refund tax transaction, amounts in the Tax Detail Report are negative.

Possible values:

true

: This is a refund tax transaction.

false

(default): This is not a refund tax transaction.

Specifications

Data Type:
String

Data Length:
5

Mapping Information

REST API Field:

taxInformation.refundIndicator

SCMP API Field:

tax_refund_indicator

Simple Order API Fields:

taxReply_refundIndicator

taxService_refundIndicator

taxInformation. reportingDate

Reporting date for the transaction.

This value is included in the Tax Detail Report. When you do not include this field in the request, the reporting date is set to the current date.

Format:
yyyyMMdd

Specifications

Data Type:
String

Data Length:
8

Mapping Information

REST API Field:

taxInformation.reportingDate

SCMP API Field:

tax_reporting_date

Simple Order API Field:

taxService_reportingDate

taxInformation. showTaxPerLineItem

Whether or not to display tax amounts for each offer.

This field can contain one of the following values:

yes

: Display tax amounts for each offer.

no

(default): Do not display tax amounts for each offer.

Specifications

Data Type:
String

Data Length:
3

Mapping Information

REST API Field:

taxInformation.showTaxPerLineItem

SCMP API Field:

show_tax_per_offer

Simple Order API Field:
No corresponding field

teBagSerialNumber

Serial number of the tamper-evident bag used for shipping the terminal.

To get this value, contact Visa Acceptance Solutions customer support.

Specifications

Data Type:
String

Data Length:
64

Mapping Information

REST API Field:

teBagSerialNumber

SCMP API Field:
No corresponding field

Simple Order API Field:
No corresponding field

ticketNumbers

Optional ticket number to track the state of the terminal.

Specifications

Data Type:
String

Data Length:
128

Mapping Information

REST API Field:

ticketNumbers

SCMP API Field:
No corresponding field

Simple Order API Field:
No corresponding field

tokenInformation

These fields provide token information.

tokenInformation.additionalInformation

tokenInformation.instrumentIdentifierNew

tokenInformation.jti

tokenInformation.networkTokenOption

tokenInformation.transientTokenJwt

tokenInformation. additionalInformation

This value indicates whether the transaction is eligible for token services. It is sent only for transactions processed by SMCC.

Possible values:

0

: Does not apply.

1

: Eligible for token services.

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

tokenInformation.additionalInformation

SCMP API Field:

additional_token_response_information

Simple Order API Field:

additionalToken_responseInformation

tokenInformation. instrumentIdentifierNew

Indicates whether the tokenized credential already exists as an Instrument Identifier or is a new credential.

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

tokenInformation.instrumentIdentifierNew

SCMP API Field:

pay_subscription_create_instrument_identifier_new

Simple Order API Field:

paySubscriptionCreateReply_instrumentIdentifierNew

tokenInformation. jti

Unique, time-limited identifier for the Token Management Service (TMS) transient token.

The 64 hexadecimal value representing captured payment credentials, including sensitive authentication data (SAD).

The

tokenInformation.jti

field expires after 24 hours.

Use this ID in place of the payment data in a service request. When you include this value in your request, many of the fields that are normally required for an authorization or capture are not required.

BIN Lookup Service: When you send multiple fields in the
paymentInformation[]
and
tokenInformation[]
objects, BIN Lookup processes fields in the
paymentInformation[]
object first, and then it processes fields in the
tokenInformation[]
object.

Specifications

Data Type:
String

Data Length:
64

Mapping Information

REST API Field:

tokenInformation.jti

SCMP API Field:

transient_token

Simple Order API Field:

tokenSource_transientToken

tokenInformation. networkTokenOption

Indicates whether Visa Acceptance Solutions should use a payment network token that is associated with a TMS token for an authorization.

Possible values:

ignore

: Use a tokenized card number for an authorization, even if the TMS token has an associated payment network token.

prefer

: Use an associated payment network token for an authorization if the TMS token has one; otherwise, use the tokenized card number.

Specifications

Data Type:
String

Data Length:
6

Mapping Information

REST API Field:

tokenInformation.networkTokenOption

SCMP API Field:

tms_network_token_option

Simple Order API Field:

tokenSource_networkTokenOption

tokenInformation. transientTokenJwt

Unique identifier for the Flex API transient token.

The transient token encoded as a JSON Web Token (JWT) generated by the Flex API or Unified Checkout checkout.

BIN Lookup Service: When you send multiple fields in the
paymentInformation[]
and
tokenInformation[]
objects, BIN Lookup processes fields in the
paymentInformation[]
object first, and then it processes fields in the
tokenInformation[]
object.

Specifications

Data Type:
String

Data Length:
32

Mapping Information

No corresponding fields.

tokenizedCard. source

The indicator for how the card information was acquired for creating the token.

Possible values:

ISSUER

: Card information was submitted by an issuing bank.

ONFILE

: Card information was submitted by a PAN.

TOKEN

: Card information was submitted by a tokenized card.

Specifications

Data Type:
String

Data Length:
6

Mapping Information

REST API Field:

tokenizedCard.source

Simple Order API Field:
No corresponding field.

totalCount

The total number of plans created by the merchant.

Specifications

Data Type:
Integer

Data Length:
36

Mapping Information

REST API Field:
:

totalCount

SCMP API Field:
No corresponding field.

Simple Order API Field:
No corresponding field.

transactionType

The type of transaction for the payment credentials that are returned by the Token Management Service.

Possible values:

AFT

: Account funding transaction. This value is supported for Visa card types and the

paymentCredentialType

field must be set to

CRYPTOGRAM

.

Specifications

Data Type:
Enum

Mapping Information

REST API Field:
:

transactionType

Simple Order API Field:
No corresponding field.

transientTokenResponseOptions. includeCardPrefix

Specifies the flexible truncated card number response to Microform Integration and Unified Checkout.

Use this field to choose your preferred card number prefix length:

For a 6-digit prefix length, do not include this field.

For an 8-digit prefix length, set this field to

true

.

For no prefix at all, set this field to

false

.

These conditions apply:

8-digit card number prefixes only apply to Discover, JCB, Mastercard, UnionPay, and Visa brands with 16-digit card numbers or longer.

Any card with fewer than 16-digit numbers will return a 6-digit prefix, even when this field is set to

true

.

Any card brand other than Discover, JCB, Mastercard, UnionPay, or Visa will return a 6-digit prefix, even when this field is set to

true

.

If any card brand is co-branded with Discover, JCB, Mastercard, UnionPay, or Visa, an 8-digit prefix will be returned if this field is set to

true

.

IMPORTANT

If your application does not require a card number prefix for routing or identification purposes, set this field to

false

. Doing so minimizes your exposure to sensitive personal data.

Specifications

Data Type:
Boolean

Mapping Information

REST API Field:
:

transientTokenResponseOptions. includeCardPrefix

SCMP API Field:
No corresponding field.

Simple Order API Field:
No corresponding field.

travelInformation

These fields provide travel information.

travelInformation.actualFinalDestination

travelInformation.actualFinalDestination.city

travelInformation.actualFinalDestination.country

travelInformation.actualFinalDestination.latitude

travelInformation.actualFinalDestination.longitude

travelInformation.agency.code

travelInformation.agency.name

travelInformation.autoRental. adjustedAmountIndicator

travelInformation.autoRental.adjustedAmount

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.locationId

travelInformation.autoRental. rentalAddress.location

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.locationId

travelInformation.autoRental. returnAddress.location

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

travelInformation.completeRoute

travelInformation.departureTime

travelInformation.duration

travelInformation.journeyType

travelInformation.legs[].departureDate

travelInformation.legs[].destination

travelInformation.legs[].origination

travelInformation.lodging.additionalDiscountAmount

travelInformation.lodging.adjustmentAmount

travelInformation.lodging.audioVisualCost

travelInformation.lodging.banquetCost

travelInformation.lodging.businessCenterCost

travelInformation.lodging.cashDisbursementCost

travelInformation.lodging.checkInDate

travelInformation.lodging.checkOutDate

travelInformation.lodging.conferenceRoomCost

travelInformation.lodging.corporateClientCode

travelInformation.lodging.customerServicePhoneNumber

travelInformation.lodging.earlyCheckOutCost

travelInformation.lodging.foodAndBeverageCost

travelInformation.lodging.giftShopCost

travelInformation.lodging.gratuityAmount

travelInformation.lodging.guestName

travelInformation.lodging.healthClubCost

travelInformation.lodging.internetAccessCost

travelInformation.lodging.laundryCost

travelInformation.lodging.loungeBarCost

travelInformation.lodging.miniBarCost

travelInformation.lodging.miscellaneousCost

travelInformation.lodging.movieCost

travelInformation.lodging.nonRoomCost

travelInformation.lodging.nonRoomTaxAmount

travelInformation.lodging.numberOfGuests

travelInformation.lodging.numberOfRooms

travelInformation.lodging.phoneCost

travelInformation.lodging.prepaidCost

travelInformation.lodging.restaurantCost

travelInformation.lodging.roomBedType

travelInformation.lodging.room[].dailyRate

travelInformation.lodging.roomLocation

travelInformation.lodging.room[].numberOfNights

travelInformation.lodging.roomRateType

travelInformation.lodging.roomServiceCost

travelInformation.lodging.roomTaxAmount

travelInformation.lodging.roomTaxType

travelInformation.lodging.smokingPreference

travelInformation.lodging.specialProgramCode

travelInformation.lodging.totalTaxAmount

travelInformation.lodging.transportationCost

travelInformation.lodging.valetParkingCost

travelInformation.numberOfPassengers

travelInformation.passengers.firstName

travelInformation.passengers.lastName

travelInformation.transit.airline.ancillaryInformation.connectedTicketNumber

travelInformation.transit.airline.ancillaryInformation. creditReasonIndicator

travelInformation.transit.airline.ancillaryInformation.passengerName

travelInformation.transit.airline.ancillaryInformation.service[].categoryCode

travelInformation.transit.airline.ancillaryInformation.service[].subCategoryCode

travelInformation.transit.airline.ancillaryInformation.ticketNumber

travelInformation.transit.airline.arrivalDate

travelInformation.transit.airline.carrierName

travelInformation.transit.airline.clearingCount

travelInformation.transit.airline.clearingSequence

travelInformation.transit.airline.creditReasonIndicator

travelInformation.transit.airline.customerCode

travelInformation.transit.airline.documentType

travelInformation.transit.airline.electronicTicketIndicator

travelInformation.transit.airline.legs[].arrivalTime

travelInformation.transit.airline.legs[].arrivalTimeMeridian

travelInformation.transit.airline.legs[].carrierCode

travelInformation.transit.airline.legs[].class

travelInformation.transit.airline.legs[].conjunctionTicket

travelInformation.transit.airline.legs[].couponNumber

travelInformation.transit.airline.legs[].departureTimeMeridian

travelInformation.transit.airline.legs[].departureTime

travelInformation.transit.airline.legs[].departureDate

travelInformation.transit.airline.legs[].destinationAirportCode

travelInformation.transit.airline.legs[].endorsementsRestrictions

travelInformation.transit.airline.legs[].exchangeTicketNumber

travelInformation.transit.airline.legs[].fareBasis

travelInformation.transit.airline.legs[].feeAmount

travelInformation.transit.airline.legs[].flightNumber

travelInformation.transit.airline.legs[].originatingAirportCode

travelInformation.transit.airline.legs[].stopoverIndicator

travelInformation.transit.airline.legs[].taxAmount

travelInformation.transit.airline.legs[].totalFareAmount

travelInformation.transit.airline.numberOfPassengers

travelInformation.transit.airline.passengerName

travelInformation.transit.airline.planNumber

travelInformation.transit.airline.purchaseType

travelInformation.transit.airline.reservationSystemCode

travelInformation.transit.airline.restrictedTicketIndicator

travelInformation.transit.airline.restrictedTicketDescription

travelInformation.transit.airline.ticketChangeIndicator

travelInformation.transit.airline.ticketIssueDate

travelInformation.transit.airline.ticketIssuer.address

travelInformation.transit.airline.ticketIssuer. code

travelInformation.transit.airline.ticketIssuer.locality

travelInformation.transit.airline.ticketNumber

travelInformation.transit.airline.totalClearingAmount

travelInformation.transit.airline.totalFeeAmount

travelInformation.transit.exchangeTicketAmount

travelInformation.transit.airline. exchangeTicketFeeAmount

travelInformation. actualFinalDestination

Use to specify the airport code for the actual final destination of the trip.

This code is usually three digits long, for example: SFO = San Francisco. Do not use the colon (:) or the dash (-).

For example, if the route is

SFO-LAX:LAX-MCT:MCT-BLR:BLR-MCT:MCT-LAX:LAX-SFO

, the actual final destination might be

BLR

(

SFO

is the last destination only because this is a round trip.)

Specifications

Data Type:
String

Data Length:
3

Mapping Information

REST API Field:

travelInformation.actualFinalDestination

SCMP API Field:

decision_manager_travel_actual_final_destination

Simple Order API Field:

decisionManager_travelData_actualFinalDestination

travelInformation. actualFinalDestination.city

City of the actual final destination.

For example, if the route is

SFO-LAX:LAX-MCT:MCT-BLR:BLR-MCT:MCT-LAX:LAX-SFO

, the actual final destination is

BLR

(

SFO

is the last destination only because this is a round trip).

The value must be included as a destination in the

travelInformation.completeRoute

field in order to be present in the response along with the corresponding city, country, and geographical details.

Specifications

Data Type:
String

Data Length:
90

Mapping Information

REST API Field:

travelInformation.actualFinalDestination.city

SCMP API Field:

decision_travel_actual_final_destination_city

Simple Order API Field:

International Air Transport Association (IATA) code for the travel agency that made the reservation.

Specifications

Data Type:
String

Data Length:
8

Mapping Information

REST API Field:

travelInformation.agency.code

SCMP API Fields:

airline_agent_code

lodging_travel_agency_code

Simple Order API Fields:

airlineData_agentCode

lodgingData_travelAgencyCode

travelInformation. agency.name

Name of the travel agency that made the reservation.

Specifications

Data Type:
String

Data Length:
25

Mapping Information

REST API Field:

travelinformation.agency.name

SCMP API Fields:

airline_agent_name

lodging_travel_agency_name

Simple Order API Fields:

airlineData_agentName

lodgingData_travelAgencyName

travelInformation. autoRental. adjustedAmount

The value for this field is the adjustment to the total amount specified in the auto rental agreement.

For the authorization service, this field is supported only for American Express.

For the capture service, this field is supported only for Mastercard and American Express.

MasterCard: This field is optional.

American Express: This field is required if the adjustment code field is included in the request; otherwise, this field is optional.

Specifications

Data Type:
String

Data Length:

Mastercard: 9

American Express: 8

Mapping

REST Field Name:

travelInformation.autoRental.adjustedAmount

SCMP Field Name:

auto_rental_adjustment_cost

Simple Order Field Name:

autoRentalData_adjustmentCost

travelInformation. autoRental. adjustedAmountIndicator

This field value is the adjusted amount code that indicates whether charges were incurred after the vehicle was returned. The code also indicates the type of charge.

Possible values for Mastercard and Discover:

A

: Drop-off charges

B

: Delivery charge

C

: Parking expenses

D

: Extra hours

E

: Violations

X

: More than one of the above charges

Possible values for American Express:

This field contains an audit indicator code signifying that an adjustment was made to a rental agreement (for mileage, fuel, auto damage, etc.). It indicates whether the cardholder was notified of the adjustment.

Possible value for the authorization service:

A

(default): Adjustment amount was greater than 0 (zero).

Possible values for the capture service:

X

: Multiple adjustments.

Y

: One adjustment; the cardholder was notified.

Z

(default): One adjustment; the cardholder was not notified. This value is the default if the request does not include this field and includes an adjustment amount greater than 0 (zero).

Specifications

Data Type:
String

Data Length:
1

Mapping

REST Field Name:

travelInformation.autoRental.adjustedAmountIndicator

SCMP Field Name:

auto_rental_adjustment_code

Simple Order Field Name:

autoRentalData_adjustmentCode

travelInformation. autoRental. affiliateName

This value is the name of the travel agency that made the vehicle rental reservation if the agency is an affiliate.

Specifications

Data Type:
String

Data Length:
25

Mapping

REST Field Name:

travelInformation.autoRental.affiliateName

SCMP Field Name:
No corresponding field.

Simple Order Field Name:
No corresponding field.

travelInformation. autoRental. agreementNumber

travelInformation.autoRental.corporateClientCode

SCMP Field Name:

cutomer_corporate_client_code

Simple Order Field Name:

autoRental_corporateClientCode

travelInformation. autoRental. customerName

This field value is the name of the individual making the rental agreement.

This field is required for the authorization service by Visa, Mastercard, and American Express.

For the capture service, this field is supported only for Mastercard. This field is optional, but it is required to get the best rate.

Specifications

Data Type:
String

Data Length:
20

Mapping

REST Field Name:

travelInformation.autoRental.customerName

SCMP Field Name:

auto_rental_renter_name

Simple Order Field Name:

autoRentalData_renterName

travelInformation. autoRental. customerServicePhoneNumber

This field value is the customer service telephone number.

Include the area code, exchange, and number.

This field is supported only for Mastercard and American Express.

Mastercard: This field is required to get the best rate.

American Express: This field is required.

Specifications

Data Type:
String

Data Length:
10

Mapping

REST Field Name:

travelInformation.autoRental.customerServicePhoneNumber

SCMP Field Name:

auto_rental_customer_service_phone_number

Simple Order Field Name:

autoRentalData_customerServicePhoneNumber

travelInformation. autoRental. dailyRentalRate

This field value is the daily auto rental rate that is charged.

This field is supported only for Mastercard and American Express.

Mastercard: This field is required to get the best rate.

American Express: This field is optional but recommended.

Specifications

Data Type:
String

Data Length:
9

Mapping

REST Field Name:

travelInformation.autoRental.dailyRentalRate

SCMP Field Name:

auto_rental_daily_rate

Simple Order Field Name:

autoRentalData_dailyRate

travelInformation. autoRental. distanceTraveled

This field value is the total number of miles driven by the customer.

This field is supported only for Mastercard and American Express. This field is optional for the capture service.

Specifications

Data Type:
Integer

Data Length:
4

Mapping

REST Field Name:

travelInformation.autoRental.distanceTraveled

SCMP Field Name:

auto_rental_miles_traveled

Simple Order Field Name:

autoRentalData_milesTraveled

travelInformation. autoRental. distanceUnit

SCMP Field Name:

auto_rental_extra_charge

Simple Order Field Name:

autoRentalData_extraCharge

travelInformation. autoRental. extraMileageCharge

This value is the charge incurred for mileage that the driver accrues beyond the basic rental agreement.

This field is supported only for Visa. This field is optional for the authorization service or the capture service but is recommended.

Specifications

Data Type:
String

Data Length:
12

Mapping

REST Field Name:

travelInformation.autoRental.extraMileageCharge

SCMP Field Name:

auto_rental_mileage_cost

Simple Order Field Name:

autoRentalData_mileageCost

travelInformation. autoRental. fuelCharges

This field value records any extra gasoline charges that extend beyond the basic rental agreement.

This field is supported only for Visa. This field is optional for the authorization and capture services but is recommended.

Specifications

Data Type:
String

Data Length:
12

Mapping

REST Field Name:

travelInformation.autoRental.fuelCharges

SCMP Field Name:

auto_rental_gas_cost

Simple Order Field Name:

autoRentalData_gasCost

travelInformation. autoRental. gpsCharge

This field value is the amount charged for renting a Global Positioning Service (GPS) device.

Specifications

Data Type:
String

Data Length:
12

Mapping

REST Field Name:

travelInformation.autoRental.gpsCharge

SCMP Field Name:

auto_rental_gps_charge

Simple Order Field Name:

autoRentalData_gpsCharge

travelInformation. autoRental. insuranceAmount

This field value is the amount charged for insurance.

This field is supported only for Mastercard and American Express. This field is optional but is recommended for the capture service.

Specifications

Data Type:
String

Data Length:
9

Mapping

REST Field Name:

travelInformation.autoRental.insuranceAmount

SCMP Field Name:

auto_rental_insurance_cost

Simple Order Field Name:

autoRentalData_insuranceCost

travelInformation. autoRental. insuranceIndicator

This value indicates whether insurance was purchased from the rental agency.

This field is supported by Mastercard and Discover.

Possible values:

REST and Simple Order APIs:

true

: Insurance was purchased.

false

: Insurance was not purchased.

SCMP API:

Y

: Insurance was purchased.

N

: Insurance was not purchased.

Specifications

Data Type:

REST: Boolean

This indicator notes that the individual did not show up after making a reservation for a vehicle or lodging.

Possible values:

REST and Simple Order APIs:

true

: No show

false

: Show

SCMP API:

Y

: No show

N

: Show

Possible values that are used by Mastercard and Discover:

true

: Show

false

: No show

Specifications

Data Type:

REST: Boolean

SCMP: String

This value is the additional amount charged for a one-way rental agreement.

This field is supported only for Visa.

Specifications

Data Type:
String

Data Length:
12

Mapping

REST Field Name:

travelInformation.autoRental.oneWayDropOffAmount

SCMP Field Name:

auto_rental_one_way_cost

Simple Order Field Name:

autoRentalData_oneWayCost

travelInformation. autoRental. otherCharges

This value is the total amount for all charges not covered in other fields.

Specifications

Data Type:
String

Data Length:
12

Mapping

REST Field Name:

travelInformation.autoRental.otherCharges

SCMP Field Name:

auto_rental_other_charges

Simple Order Field Name:

autoRentalData_otherCharges

travelInformation. autoRental. parkingViolationCharge

travelInformation. autoRental. ratePerMile

This value is the agency code, address, and phone number, that identifies the location where the vehicle was rented. The merchant creates this unique ID and provides it.

For the capture service, this field is supported only for Mastercard and American Express.

Mastercard: This field is required to get the best rate.

American Express: This field is required.

Specifications

Data Type:
String

Data Length:

10

Mapping

REST Field Name:

travelInformation.autoRental.rentalAddress.locationId

SCMP Field Name:

auto_rental_location_id

Simple Order Field Name:

autoRentalData_rentalLocationID

travelInformation. autoRental. rentalAddress.postalCode

This value is the postal code of the address where the vehicle is rented.

Specifications

Data Type:
String

Data Length:
10

Mapping

REST Field Name:

travelInformation.autoRental. rentalAddress.postalCode

SCMP Field Name:
No corresponding field.

Simple Order Field Name:
No corresponding field.

travelInformation. autoRental. rentalAddress.state

This value is the state in which the vehicle was rented. Use one of the State, Province, and Territory Codes for the United States and Canada.

For the authorization service, this field is supported for Visa, Mastercard, and American Express.

For the capture service, this field is supported only for Mastercard and American Express.

Specifications

Data Type:
String

Data Length:
2

Mapping

REST Field Name:

travelInformation.autoRental.rentalAddress.state

SCMP Field Name:

auto_rental_pick_up_state

Simple Order Field Name:

autoRentalData_pickUpState

travelInformation. autoRental. rentalDateTime

This value is the date and time the vehicle was picked up from the rental agency.

Format: yyyy-MM-dd HH-mm-ss z

This field is supported for Visa, Mastercard, and American Express.

For the authorization service, this field is required.

For the capture service:

Visa and American Express: This field is required.

Mastercard: This field is required to get the best rate.

Specifications

Data Type:
String

Data Length:
19

Mapping

REST Field Name:

travelInformation.autoRental.rentalDateTime

SCMP Field Name:

auto_rental_pick_up_time

Simple Order Field Name:

autoRentalData_pickUpTime

travelInformation. autoRental. returnAddress.address1

This value is the street address of the location where the vehicle is returned.

Specifications

Data Type:
String

Data Length:
26

Mapping

REST Field Name:

travelInformation.autoRental.returnAddress.address1

SCMP Field Name:

auto_rental_return_location_id

Simple Order Field Name:

autoRentalData_returnLocationID

travelInformation. autoRental. returnAddress.city

This value is the city where the vehicle was returned to the rental agency.

For the authorization service, this field is supported for Visa, Mastercard, and American Express. It is optional but recommended.

For the capture service, this field is supported only for Mastercard and American Express.

Mastercard: This field is required to get the best rate.

American Express: This field is required.

Specifications

Data Type:
String

Data Length:
18

Mapping

REST Field Name:

travelInformation.autoRental.returnAddress.city

SCMP Field Name:

auto_rental_return_city

Simple Order Field Name:

autoRentalData_returnCity

travelInformation. autoRental. returnAddress.country

This value is the country where the vehicle was returned to the rental agency.

Use one of the two-character ISO Standard Country Codes.

For the authorization service, this field is supported only for American Express. It is optional but recommended.

For the capture service, this field is supported only for Mastercard and American Express.

Mastercard: This field is required to get the best rate.

American Express: This field is required.

Specifications

Data Type:
String

Data Length:
3

Mapping

REST Field Name:

travelInformation.autoRental.returnAddress.country

SCMP Field Name:

auto_rental_return_country

Simple Order Field Name:

autoRentalData_returnCountry

travelInformation. autoRental. returnAddress.location

This value is the location where the taxi passenger was dropped off or where the rental vehicle was returned.

Specifications

Data Type:
String

Data Length:
38

Mapping

REST Field Name:

travelInformation.autoRental.returnAddress.location

SCMP Field Name:

auto_rental_return_location

Simple Order Field Name:

autoRentalData_returnLocation

travelInformation. autoRental. returnAddress.locationId

Simple Order Field Name:

autoRentalData_returnstate

travelInformation. autoRental. returnDateTime

This value is the date on which the vehicle was returned to the rental agency.

Format: MMDDYYYY

This field is supported for Visa, Mastercard, and American Express.

For the authorization service, this field is required.

For the capture service:

Visa and American Express: This field is required.

Mastercard: This field is required to get the best rate.

Specifications

Data Type:
String

Data Length:
20

Mapping

REST Field Name:

travelInformation.autoRental.returnDateTime

SCMP Field Name:

auto_rental_return_date

Simple Order Field Name:

autoRentalData_returnDate

travelInformation. autoRental. specialProgramCode

This value is the program code that identifies special circumstances.

Examples of special circumstances are frequent renter
or no show
status for the renter.

Possible values:

0

: Not applicable (default)

1

: Frequent renter

2

: No show

For the authorization service, this field is supported only for Visa.

For the capture service, this field is supported for Visa, Mastercard, and American Express.

The program code for special circumstances applies to the card transaction or the cardholder.

Specifications

Data Type:
String

Data Length:
1

Mapping

REST Field Name:

travelInformation.autoRental.specialProgramCode

SCMP Field Name:

auto_rental_special_ program_code

Simple Order Field Name:

autoRentalData_specialProgramCode

travelInformation. autoRental. taxDetails.amount

This value is the total amount of tax charged for the vehicle rental.

Specifications

Data Type:
String

Data Length:
12

Mapping

REST Field Name:

travelInformation.autoRental.taxDetails.amount

SCMP Field Name:

auto_rental_tax_amount

Simple Order Field Name:

autoRentalData_taxAmount

travelInformation. autoRental. taxDetails.applied

This field indicates whether any tax is included in the request.

Possible values:

REST and Simple Order APIs:

true

: Tax is included in the request.

false

: Tax is not included in the request.

SCMP API:

Y

: Tax is included in the request.

N

: Tax is not included in the request.

Specifications

Data Type:

REST: Boolean

SCMP: String

Simple Order: String

Data Length:

SCMP: 1

Simple Order: 5

Mapping

REST Field Name:

travelInformation.autoRental.taxDetails.applied

SCMP Field Name:

auto_rental_tax_indicator

Simple Order Field Name:

autoRentalData_taxIndicator

travelInformation. autoRental. taxDetails.exemptionCode

This value indicates whether the goods or services are exempt from tax. This field is a pass-through value. CyberSource does not verify or modify the value before sending it to the processor.

Specifications

Data Type:
String

Data Length:
1

Mapping

REST Field Name:

travelInformation.autoRental.taxDetails.exemptionCode

SCMP Field Name:

auto_rental_tax_status_indicator

Simple Order Field Name:

autoRentalData_taxStatusIndicator

travelInformation. autoRental. taxDetails.rate

This value is the percentage used to calculate the tax.

The value is the rate of the value added tax (VAT) or other tax for the order. For example,

0.04

(4%).

Possible values:

0.01

to

0.99

(1% to 99%)

Only whole percentage values are accepted. Values with additional decimal places are truncated.

Specifications

Data Type:
Number

Data Length:
6

Mapping

REST Field Name:

travelInformation.autoRental.taxDetails.rate

SCMP Field Name:

auto_rental_tax_rate

Simple Order Field Name:

autoRentalData_taxRate

travelInformation. autoRental. taxDetails.taxSummary

This value is a summary of all tax types.

For example,

Auto-rental city and tste taxes

.

Specifications

Data Type:
String

Data Length:
12

Mapping

REST Field Name:

travelInformation.autoRental.taxDetails.taxSummary

SCMP Field Name:

auto_rental_tax_summary

Simple Order Field Name:

autoRentalData_taxSummary

travelInformation. autoRental. taxDetails.taxType

This value is the types of taxes that the rental agency applies to the rental agreement.

Some examples include tourist tax, airport tax, and rental tax.

This list is comma delimited. For example:

rental,VAT

.

Specifications

Data Type:
String

Data Length:
10

Mapping

REST Field Name:

travelInformation.autoRental.taxDetails.taxType

SCMP Field Name:

auto_rental_tax_type

Simple Order Field Name:

autoRentalData_taxType

travelInformation. autoRental. timePeriod

This value indicates the time period during which the vehicle rental rate applies.

Possible values:

Daily

Weekly

Monthly

Specifications

Data Type:
String

Data Length:
7

Mapping

REST Field Name:

travelInformation.autoRental.timePeriod

SCMP Field Name:

auto_rental_time_period

Simple Order Field Name:

autoRentalData_timePeriod

travelInformation. autoRental. towingCharge

This field value is the amount charged to tow the rental vehicle.

Specifications

Data Type:
Number

Data Length:
12

Mapping

REST Field Name:

travelInformation.autoRental.towingCharge

SCMP Field Name:

auto_rental_towing_charge

Simple Order Field Name:

autoRentalData_towingCharge

travelInformation. autoRental. vehicleClass

This value is the classification of the rented vehicle.

This field is supported only for Mastercard and American Express.

Mastercard: This field is required to get the best rate.

American Express: This is field is optional but is recommended.

Possible values:

Auto Rental IDs
American Express	Mastercard	Description
0001	0001	Mini
0002	0002	Subcompact
0003	0003	Economy
0004	0004	Compact
0005	0005	Midsize
0006	0006	Intermediate
0007	0007	Standard
0008	0008	Full size
0009	0009	Luxury
0010	0010	Premium
0011	0011	Minivan
0012	0012	12-passenger van
0013	0013	Moving van
0014	0014	15-passenger van
0015	0015	Cargo van
0016	0016	12-foot truck
0017	0017	20-foot truck
0018	0018	24-foot truck
0019	0019	26-foot truck
0020	0020	Moped
0021	0021	Stretch
0022	0022	Regular
0023	0023	Unique
0024	0024	Exotic
0025	0025	Small/medium truck
0026	0026	Large truck
0027	0027	Small SUV
0028	0028	Medium SUV
0029	0029	Large SUV
0030	0030	Exotic SUV
0031	―	Four wheel drive
0032	―	Special
9999	9999	Miscellaneous

Specifications

Data Type:
String

Data Length:
4

Mapping

REST Field Name:

travelInformation.autoRental.vehicleClass

SCMP Field Name:

auto_rental_class_code

Simple Order Field Name:

autoRentalData_classCode

travelInformation. autoRental. vehicleIdentificationNumber

The vehicle identification number (VIN) is assigned by the manufacturer to the vehicle.

Specifications

Data Type:
String

Data Length:
20

Mapping

REST Field Name:

travelInformation.autoRental.vehicleIdentificationNumber

SCMP Field Name:

auto_rental_vehicle_identification_number

Simple Order Field Name:

autoRentalData_vehicleIdentificationNumber

travelInformation. autoRental. vehicleMake

This field value is the make of the vehicle being rented. For example,

Chevrolet

,

Fiat

, or

Ford

.

Specifications

Data Type:
String

Data Length:
10

Mapping

REST Field Name:

travelInformation.autoRental.vehicleMake

SCMP Field Name:

auto_rental_vehicle_make

Simple Order Field Name:

autoRentalData_vehicleMake

travelInformation. autoRental. vehicleModel

This field value is the model of the vehicle being rented. For example,

Cavalier

or

Focus

.

Specifications

Data Type:
String

Data Length:
10

Mapping

REST Field Name:

travelInformation.autoRental.vehicleModel

SCMP Field Name:

auto_rental_vehicle_model

Simple Order Field Name:

autoRentalData_vehicleModel

travelInformation. autoRental. weeklyRate

This field contains the amount charged for a seven-day rental period.

The

travelInformation.autoRental.timePeriod

field that specifies the time period for the vehicle rental (when used) must contain the value

Weekly

.

Specifications

Data Type:
Number

Data Length:
12

Mapping

REST Field Name:

travelInformation.autoRental.weeklyRate

SCMP Field Name:

auto_rental_weekly_rental_rate

Simple Order Field Name:

autoRentalData_weeklyRentalRate

travelInformation. completeRoute

Concatenation of individual travel legs in the format ORIG1-DEST1[:ORIG2-DEST2...:ORIGn-DESTn]

or example:

SFO-JFK:JFK-LHR:LHR-CDG

.

In your request, send either the complete route or the individual legs (_leg#_orig
and _leg#_dest
). If you send all the fields, the value of _complete_route
takes precedence over that of the _leg#
fields.

Specifications

Data Type:
String

Data Length:
255

Mapping Information

REST API Field:

travelInformation.completeRoute

SCMP API Field:

decision_manager_travel_complete_route

Simple Order API Field:

decisionManager_travelData_completeRoute

travelInformation. departureTime

Departure date and time of the first leg of the trip.

Use one of the following formats:

yyyy-MM-dd HH:mm z

yyy-MM-dd hh:mm a z

yyyy-MM-dd hh:mma z

HH = hour in 24-hour format

hh = hour in 12-hour format

a = a.m. or p.m. (case insensitive)

z = time zone of the departing flight, for example: If the airline is based in city A, but the flight departs from city B, z is the time zone of city B at the time of departure.

IMPORTANT

For travel information, use GMT or offset from GMT.

2020-03-20 11:30 pm GMT

2020-03-20 11:30 pm GMT-05:00

The format must follow the example when specifying an offset from GMT. Insert no spaces between the time zone and the offset.

Specifications

Data Type
: Date Time

Data Length
: 28

Mapping Information

REST API Field:

travelInformation.departureTime

SCMP API Field:

decision_manager_travel_departure_time

Simple Order API Field:

decisionManager_travelData_departureDateTime

travelInformation. duration

Number of days of the auto rental or lodging rental.

Auto rental: This field is supported for Visa, Mastercard, and American Express.
IMPORTANT

If this field is not included when the
processingInformation.industryDataType
field is set to
auto_rental
, the transaction is declined.
Lodging: For a lodging deposit, the value for this field specifies the number of days covered by the advance payment. Possible values:
01
through
99
.; IMPORTANT

If this field is not included when the
processingInformation.industryDataType
field is set to
lodging
, the transaction is declined.

Specifications

Data Type:
String

Data Length:
2

Mapping Information

REST API Field:

travelInformation.duration

SCMP API Field:

duration

Simple Order API Fields:

ccAuthService_duration

ccIncrementalAuthService_duration

travelInformation. journeyType

Type of travel, for example

one way

or

round trip

.

Specifications

Data Type:
String

Data Length:
32

Mapping Information

REST API Field:

travelInformation.journeyType

SCMP API Field:

decision_manager_travel_journey_type

Simple Order API Field:

decisionManager_travelData_journeyType

travelInformation. legs[]. departureDate

Departure date and time of each leg of the trip.

For example, if route is

SFO-JFK: JFK-LHR: LHR-MUM

, then

SFO-JFK

is leg 0 and LHR-MUM is leg2.

The leg number can be a positive integer from 0 to N. The departure time in leg N+1 must be higher than the departure time in leg N.

Use one of the following shared formats:

yyyy-MM-dd HH:mm z

yyy-MM-dd hh:mm a z

yyyy-MM-dd hh:mma z

HH = hour in 24-hour format

hh = hour in 12-hour format

a = a.m. or p.m. (case insensitive)

z = time zone of the departing flight, for example: If the airline is based in city A, but the flight departs from city B, z is the time zone of city B at the time of departure.

IMPORTANT

For travel information, use GMT or offset from GMT.

2020-03-20 11:30 pm GMT

2020-03-20 11:30 pm GMT-05:00

When specifying an offset from GMT, the format must be exactly as specified in the example. Insert no spaces between the time zone and the offset.

Specifications

Data Type:
Date Time

Data Length:
25

Mapping Information

REST API Field:

travelInformation.legs.[].departureDate

SCMP API Field:

decision_manager_travel_legnum_departure_time

Simple Order API Field:

decisionManager_travelData_leg_#_departureDateTime

travelInformation. legs[]. destination

Specifies the destination for each leg of the trip using the three digit airport code.

For example,

decision_manager_travel_leg0_dest = SFO

decision_manager_travel_leg1_dest = SFO

IMPORTANT

In your request, send either the complete route or the individual legs (_leg#_orig
and _leg#_dest
). If you send all the fields, the complete route takes precedence over the individual legs.

Specifications

Data Type:
String

Data Length:
3

Mapping Information

REST API Field:

travelInformation.legs.[].destination

SCMP API Field:

decision_manager_travel_legnum_destination

Simple Order API Field:

decisionManager_travelData_leg_#_destination

travelInformation. legs[]. origination

Specifies the origniation for each leg of the trip using the three digit airport code.

For example: SFO = San Francisco. Do not use the colon (:) or the dash (-). The leg number can be a positive integer from 0 to N. For example,

decision_manager_travel_leg0_dest = SFO

decision_manager_travel_leg1_dest = SFO

IMPORTANT

In your request, send either the complete route or the individual legs (_leg#_orig
and _leg#_dest
). If you send all the fields, the complete route takes precedence over the individual legs.

Specifications

Data Type:
String

Data Length:
3

Mapping Information

REST API Field:

travelInformation.legs.[].origination

SCMP API Field:

decision_manager_travel_legnum_orig

Simple Order API Field:

decisionManager_travelData_leg_#_origin

travelInformation.lodging. additionalDiscountAmount

Amount of an additional coupon or discount.

Specifications

Data Type:
String

Data Length:
12

Mapping Information

Data Length:
12

Mapping Information

REST API Field:
t

ravelInformation.lodging.cashDisbursementCost

Simple Order API Field:

lodgingData_cashDisbursementCost

travelInformation.lodging. checkInDate

Date on which the guest checked in.

In the case of a no-show or a reservation, it is the scheduled arrival date.

Format:

MMDDYY

.

For the best interchange rates, make sure it is a valid date.

Specifications

Data Type:
String

Data Length:
6

Mapping Information

REST API Field:

travelInformation.lodging.checkInDate

Simple Order API Field:

lodgingData_checkInDate

travelInformation.lodging. checkOutDate

travelInformation.lodging. nonRoomCost

lodgingData_roomLocation

travelInformation.lodging. room[].numberOfNights

lodgingData_roomTaxElements

travelInformation.lodging. smokingPreference

Smoking preference of the guest.

Possible values:

Y

: Smoking room

N

: Non-smoking room

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

travelInformation.lodging.smokingPreference

Simple Order API Field:

lodgingData_guestSmokingPreference

travelInformation.lodging. specialProgramCode

Code that identifies special circumstances.

Possible values:

REST API Field:

travelInformation.lodging.valetParkingCost

Simple Order API Field:

lodgingData_valetParkingCost

travelInformation. numberOfPassengers

Number of passengers for whom the ticket was issued.

If you do not include this field in your request, a default value of 1 is used.

Required for American Express SafeKey (US) for travel-related requests.

Specifications

Specifications

Data Type:
String

Data Length:
15

Mapping Information

REST API Field:

travelInformation.transit.airline.ancillaryInformation.connectedTicketNumber

SCMP API Field:

ancillary_connected_ticket_number

Simple Order API Field:

ancillaryData_connectedTicketNumber

travelInformation. transit.airline. ancillaryInformation. creditReasonIndicator

Indicates reason for credit to cardholder.

Possible Values:

A

: Passenger transport ancillary fee cancellation

REST API Field:

travelInformation.transit.airline.ancillaryInformation.ticketNumber

SCMP API Field:

ancillary_ticket_number

Simple Order API Field:

ancillaryData_ticketNumber

Processor Field Names:

Processor-specific field names for each processor supporting this field:

FDC Nashville Global: Ancillary Ticket Document Number

travelInformation. transit.airline.arrivalDate

Date of final arrival after completion of all legs of travel.

Format:

FDC Nashville Global:

YYYYMMDD

All other processors:

MMDDYYYY

Specifications

Data Type:
String

Data Length:
8

Mapping Information

REST API Field:

travelInformation.transit.airline.arrivalDate

SCMP API Field:

airline_arrival_date

Simple Order API Field:

airlineData_arrivalDate

travelInformation. transit. airline. carrierName

The name of the airline carrier that generated the airline ticket.

OmniPay Direct and Lloyds-OmniPay: The field value is the two letter IATA carrier code for the airline carrier.

This is applicable to all OmniPay Direct processors.

Specifications

Data Type:
String

Data Length:
25

Mapping Information

REST API Field:

travelInformation.transit.airline.carrierName

Code showing reason customer was provided a credit.

Possible values:

A
: Cancellation of the ancillary passenger transport purchase.

B
: Cancellation of the airline ticket and the ancillary passenger transport purchase.

C
: Cancellation of the airline ticket.

O
: Other.

P
: Partial refund of the airline ticket.

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

travelInformation.transit.airline.creditReasonIndicator

Simple Order API Field:

airlineData_creditReasonIndicator

travelInformation. transit.airline.customerCode

Code assigned by carrier to a corporation or business entity to identify corporate rates or discounts; or, a code supplied by cardholder to merchant; or, a code supplied by cardholder.

Specifications

Data Type:
String

Data Length:
17

Mapping Information

REST API Field:

travelInformation.transit.airline.customerCode

SCMP API Field:

airline_customer_code

Simple Order API Field:

airlineData_customerCode

travelInformation. transit.airline.documentType

Travel package code for indicating whether the package includes a car rental, airline flight, both, or neither.

This field is only used with American Express cards.

FDC Nashville Global possible value:

A

: Airline flight reservation included.

Possible values for all other processors:

A

: Airline flight reservation included.

B

: Both car rental and airline flight reservations included.

C

: Car rental reservation included.

N

: Unknown.

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

travelInformation.transit.airline.documentType

SCMP API Field:

airline_document_type

Simple Order API Field:

airlineData_documentType

travelInformation. transit. airline. electronicTicketIndicator

Flag indicates an e-ticket was issued.

Possible values:

True
: Ticket issued electronically.

False
: Ticket issued as a paper ticket.

Specifications

Data Type:
Boolean

Mapping Information

REST API Field:

travelInformation.transit.airline.electronicTicketIndicator

Simple Order API Field:

airlineData_electronicTicket

travelInformation. transit.airline.legs[].arrivalTime

Arrival time for a leg of a trip.

Format:

HHMM

Possible values for hours (

HH

) range from

00

to

23

.

Possible values for minutes (

MM

) range from

01

to

59

.

Specifications

Data Type:
String

Data Length:
4

Mapping Information

REST API Field:

travelInformation.transit.airline.legs[].arrivalTime

SCMP API Field:

airline_leg#_arrival_time

Simple Order API Field:

airlineData_leg_#_arrivalTime

travelInformation. transit.airline.legs[].arrivalTimeMeridian

Indicates whether arrival time for a segment of a trip occurs during AM or PM.

Possible values:

A

: 12:00 AM — 11:59 AM

P

: 12:00 PM — 11:59 PM

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

travelInformation.transit.airline.legs[].arrivalTimeMeridian

SCMP API Field:

airline_leg#_arrival_time_segment

Simple Order API Field:

airlineData_leg_#_arrivalTimeSegment

travelInformation. transit.airline.legs[].carrierCode

Standard code for the airline or railway carrier for a leg of the trip. Required for each leg.

Payer Authentication services only use the first leg of the trip.

International Air Transport Association (IATA) code is obtained from the Official Airline Guide or its equivalent.

FDC Nashville Global: Airline carrier code for each leg of ticket, including origin and destination.

A ticket may consist of multiple legs of travel. Each leg requires its own unique coupon number.

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

travelInformation.transit.airline.legs[].couponNumber

SCMP API Field:

airline_leg#_coupon_number

Simple Order API Field:

airlineData_leg_#_couponNumber

travelInformation. transit.airline.legs[]. departureTime

Departure time for a leg of a trip.

Format:

HHMM

Possible values for hours (

HH

) range from

00

to

24

.

Possible values for minutes (

MM

) range from

01

to

59

.

Specifications

Data Type:
String

Data Length:
4

Mapping Information

REST API Field:

travelInformation.transit.airline.legs[].departureTime

SCMP API Field:

airline_leg#_departure_time

Simple Order API Field:

airlineData_leg_#_departureTime

travelInformation. transit.airline.legs[]. departureTimeMeridian

Indicates whether departure time for a segment of a trip occurs during AM or PM.

Possible values:

A

Code indicating whether a stopover is allowed on this leg of the trip.

Possible values:

O

: Stopover allowed (capital letter "O"). Default value.

X

: Stopover not allowed.

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

travelInformation.transit.airline.legs[].stopoverIndicator

SCMP API Field:

airline_leg#_stopover_code

Simple Order API Field:

airlineData_leg_#_stopoverCode

travelInformation. transit.airline.legs[]. taxAmount

Tax amount for a leg of a trip.

Specifications

Data Type:
String

Data Length:
9

Mapping Information

REST API Field:

travelInformation.transit.airline.legs[].taxAmount

SCMP API Field:

airline_leg#_tax

Simple Order API Field:

airlineData_leg_#_tax

travelInformation. transit.airline.legs[]. totalFareAmount

Ticket amount for a leg of a trip.

Specifications

Data Type:
String

Data Length:

FDC Nashville Global: 11

All other processors: 15

Mapping Information

REST API Field:

travelInformation.transit.airline.legs[].totalFareAmount

SCMP API Field:

airline_leg#_fare

Simple Order API Field:

airlineData_leg_#_fare

travelInformation. transit. airline. numberOfPassengers

Number of passengers on ticket.

Specifications

Data Type:
Integer

Data Length:
3

Mapping Information

REST API Field:

travelInformation.transit.airline.numberOfPassengers

Simple Order API Field:

airlineData_numberOfPassengers

travelInformation. transit.airline. passengerName

Name of the person to which the ticket was issued.

Specifications

Data Type:
String

Data Length:
25

Visa Platform Connect: 20

Mapping Information

REST API Field:

travelInformation.transit.airline.passengerName

SCMP API Field:

airline_passenger_name

Simple Order API Field:

airlineData_passengerName

travelInformation. transit.airline. planNumber

Plan number that is based on fare. It is supplied by the carrier.

Specifications

Data Type:
String

Data Length:
2

Mapping Information

REST API Field:

travelInformation.transit.airline.planNumber

SCMP API Field:

airline_plan_number

Simple Order API Field:

airlineData_planNumber

travelInformation. transit. airline. purchaseType

Type of purchase.

Possible values:

EXC
: Ticket exchange.

MSC
: Miscellaneous purchase (not a ticket purchase or related to a ticket exchange).

REF
: Refund.

TKT
: Ticket purchase.

Specifications

Data Type:
String

Data Length:
3

Mapping Information

REST API Field:

travelInformation.transit.airline.purchaseType

Simple Order API Field:

airlineData_purchaseType

travelInformation. transit. airline. reservationSystemCode

Code specifying the reservation system used to make the reservation and purchase the ticket.

Codes can only use letters, numbers, and spaces. No special characters are allowed.

Specifications

Data Type:
String

Data Length:
20

Mapping Information

REST API Field:

travelInformation.transit.airline.reservationSystemCode

Simple Order API Field:

airlineData_reservationSystem

travelInformation. transit. airline. restrictedTicketDescription

Text describing any ticket restrictions or limitations such as

_nonrefundable_

.

Specifications

Data Type:
String

Data Length:
20

Mapping Information

REST API Field:

travelInformation.transit.airline.restrictedTicketDescription

Simple Order API Field:
No corresponding field

travelInformation. transit.airline. restrictedTicketIndicator

Indicates whether ticket is refundable.

Possible values:

0

: refundable

1

: nonrefundable

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

travelInformation.transit.airline.restrictedTicketIndicator

SCMP API Field:

airline_restricted_ticket_indicator

Simple Order API Field:

airlineData_restrictedTicketIndicator

travelInformation. transit.airline. ticketChangeIndicator

Indicates the type of update to a ticket.

Possible values:

C

: Change to existing ticket

N

: New ticket

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

travelInformation.transit.airline.ticketChangeIndicator

SCMP API Field:

airline_ticket_update_indicator

Simple Order API Field:

airlineData_ticketUpdateIndicator

travelInformation. transit.airline. ticketIssueDate

Date that the ticket was issued to customer.

If information is not available, use spaces.

Format:

MMDDYY

Specifications

Data Type:
String

Data Length:
6

Mapping Information

REST API Field:

travelInformation.transit.airline.ticketIssueDate

SCMP API Field:

airline_ticket_issue_date

Simple Order API Field:

airlineData_ ticketIssueDate

travelInformation. transit.airline. ticketIssuer. address

Address of agency issuing the ticket.

Specifications

Data Type:
String

Data Length:
16

Mapping Information

REST API Field:

travelInformation.transit.airline.ticketIssuer.address

SCMP API Field:

airline_ticket_issuer_address

Simple Order API Field:

airlineData_ticketIssuerAddress

travelInformation. transit. airline. ticketIssuer. code

The IATA2 airline code.

The field value can only consist of English letters.

Specifications

Data Type:
String

Data Length:
4

Mapping Information

REST API Field:

travelInformation.transit.airline.ticketIssuer.code

SCMP API Field:

airline_ticket_issuer_code

Simple Order API Field:

airlineData_ticketIssuerCode

travelInformation. transit. airline. ticketIssuer. locality

City of agency issuing the ticket.

If the city exceeds 18 characters, the name will be truncated. We recommend that if the city name exceeds 18 characters, use a meaningful abbreviation.

Specifications

Data Type:
String

Data Length:
18

Mapping Information

REST API Field:

travelInformation.transit.airline.ticketIssuer.locality

Simple Order API Field:

airlineData_ticketIssuerCity

travelInformation. transit. airline. ticketNumber

airline_exchange_ticket_fee

Simple Order API Field:

airlineData_exchangeTicketFee

type

Type of point-of-sale (POS) terminal.

Valid values:

TERMINAL

MOBILE

Specifications

Data Type:
Enum of string

Data Size:
Pre-defined values

Mapping Information

REST API Field:

type

SCMP API Field:
No corresponding field

Simple Order API Field:
No corresponding field

validationInformation

These fields provide validation information.

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. matchPersonalIdentificationIssuedBy

validationInformation.bank.accountOwner. matchPersonalIdentificationType

validationInformation.bank.accountOwner. matchPersonalIdentificationID

validationInformation.bank.accountOwner. matchPhoneNumber

validationInformation.bank.accountOwner. matchSocialSecurityNumber

validationInformation.bank.accountOwner. matchTaxId

validationInformation.bank.accountOwner. matchPostalCode

validationInformation.bank.accountOwner. overallMatchScore

validationInformation.bank.accountStatus. additionalStatusCode

validationInformation.bank.accountStatus. addedOrClosedDate

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.referenceID

validationInformation.resultCode

validationInformation.transactionReason

validationInformation.validationType

validationInformation. accountType

The bank account type.

Possible values:

BC

: Business checking

BI

: Business IRA

BS

: Business savings

CC

: Consumer checking

CI

: Consumer IRA

CS

: Consumer savings

Specifications

Data Type:
String

Data Length:
Enum

Mapping Information

REST API Field:

validationInformation.accountType

SCMP API Field:

ecp_avs_account_type

Simple Order API Field:

ecAVSReply_accountType

validationInformation. authorizationLevel

The requested party’s authorization level for the account.

Valid values:

O

: Check cashing

S

: Signer

U

: Unknown

Specifications

Data Type:
String

Data Length:
Enum

Mapping Information

REST API Field:

validationInformation.authorizationLevel

SCMP API Field:

ecp_avs_authorization_level

Simple Order API Field:

ecAVSReply_authorizationLevel

validationInformation.bank. accountOwner. customerDataConditionCode

Indicates the status of the account owner data provided by the customer.

Condition codes help provide context about the account owner and authorized signer data in the National Shared Database.

Specifications

Data Type:
String

Data Length:
3

Mapping Information

REST API Field:

validationInformation.bank. accountOwner.customerDataConditionCode

SCMP API Field:

ecp_avs_customer_data_condition_code

Simple Order API Field:

ecAVSReply_customerDataConditionCode

validationInformation.bank. accountOwner. matchAddress

Indicates how closely the overall address (address line 1 and address line 2) in the request matches a National Shared Database record.

Possible values:

Y

: The address information in the request closely or exactly matches a National Shared Database record.

C

: The address information in the request partially matches a National Shared Database record.

N

: The address information in the request does not match a National Shared Database record.

U

: No address information is available in the National Shared Database.

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

validationInformation.bank.accountOwner.matchAddress

SCMP API Field:

ecp_avs_match_bill_address

Simple Order API Field:

ecAVSReply_matchBillToAddress

validationInformation.bank. accountOwner. matchAdministrativeArea

Indicates how closely the state code in the request matches a National Shared Database record.

Possible values:

Y

: The state code in the request closely or exactly matches the information in a National Shared Database record.

C

: The state code in the request partially matches the information in a National Shared Database record.

N

: The state code in the request does not match the information in a National Shared Database record.

U

: The database contains the routing transit number is found in the database, but a state code is not available for the database record.

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

validationInformation.bank.accountOwner.matchAdministrativeArea

SCMP API Field:

ecp_avs_match_bill_state

Simple Order API Field:

ecAVSReply_matchBillToState

validationInformation.bank. accountOwner. matchCompanyName

Indicates how closely the business name in the request matches a National Shared Database record.

Possible values:

Y

: The value in the request closely or exactly matches a National Shared Database record.

C

: The value in the request partially matches a National Shared Database record.

N

: The value in the request does not match.

U

: No relevant data is available in the National Shared Database.

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

validationInformation.bank.accountOwner.matchCompanyName

SCMP API Field:

ecp_avs_match_company_name

Simple Order API Field:

ecAVSReply_matchBillToCompany

validationInformation.bank. accountOwner. matchCompanyPhoneNumber

Indicates how closely the business phone number in the request matches the National Shared Database record.

Possible values:

Y

: The home phone or work phone number in the request exactly matches a database record.

C

: The home phone or work phone number in the request is a close match but does not exactly match by one digit, or two correct digits have been transposed.

N

: The home phone or work phone number in the request does not match the database record. Two or more digits do not match.

U

: The routing transit number is in the database, but a home or work phone number is not available in the database record.

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

validationInformation.bank.accountOwner.matchCompanyPhoneNumber

SCMP API Field:

ecp_avs_match_company_phone

Simple Order API Field:

ecAVSReply_matchBillToCompanyPhoneNumber

validationInformation.bank. accountOwner. matchDateOfBirth

Indicates how closely the date of birth in the request matches the National Shared Database record.

Possible values:

Y

: The date of birth in the request exactly matches a database record.

C

: The year and month of the date of birth in the request match the database record, but the day of the month does not match

N

: The date of birth in the request does not match a database record. The year or month or both do not match.

U

: The routing transit number number is in the database, but a date of birth is not available in the database record.

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

validationInformation.bank.accountOwner.matchDateOfBirth

SCMP API Field:

ecp_avs_match_date_of_birth

Simple Order API Field:

ecAVSReply_matchBillToDateOfBirth

validationInformation.bank. accountOwner. matchFirstName

Indicates how closely the first name in the reqeust matches the National Shared Database record.

Possible values:

Y

: The value in the request closely or exactly matches a record in the National Shared Database.

N

: The value in the request does not match a record in the National Shared Database.

U

: No first name data for this account is available in the National Shared Database.

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

validationInformation.bank.accountOwner.matchFirstName

SCMP API Field:

ecp_avs_match_customer_first_name

Simple Order API Field:

ecAVSReply_matchBillToFirstName

validationInformation.bank. accountOwner. matchFullName

How closely the full name matches the record in the National Shared Database.

Indicates how closely the full name (first name, middle name, and last name) in the request matches the National Shared Database record.

Possible values:

Y

: The value in the request closely or exactly matches a National Shared Database record.

C

: The value in the request conditionally (partially) matches a National Shared Database record.

N

: The value in the request does not match a National Shared Database record.

U

: No full name data for this account is available in the National Shared Database.

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

validationInformation.bank.accountOwner.matchFullName

SCMP API Field:

ecp_avs_match_customer_full_name

Simple Order API Field:

ecAVSReply_matchBillToFullName

validationInformation.bank. accountOwner. matchLastName

Indicates how closely the last name in the reqeust matches the National Shared Database record.

Possible values:

Y

: The value in the request closely or exactly matches a National Shared Database record.

N

: The value in the request does not match a National Shared Database record.

U

: No last name data for this account is available in the National Shared Database.

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

validationInformation.bank.accountOwner.matchLastName

SCMP API Field:

ecp_avs_match_customer_last_name

Simple Order API Field:

ecAVSReply_matchBillToLastName

validationInformation.bank. accountOwner. matchLocality

Indicates how closely the city name in the request matches the National Shared Database record.

Possible values:

Y

: The city name in the request closely or exactly matches a National Shared Database record.

C

: The city name in the request partially matches a National Shared Database record.

N

: The city name in the request does not match a National Shared Database record.

U

: No city name information for this account is available in the National Shared Database.

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

validationInformation.bank.accountOwner.matchLocality

SCMP API Field:

ecp_avs_match_bill_city

Simple Order API Field:

ecAVSReply_matchBillToCity

validationInformation.bank. accountOwner. matchMiddleName

Indicates how closely the middle name in the request matches a National Shared Database record.

Possible values:

Y

: The value in the request closely or exactly matches a National Shared Database record.

N

: The value in the request does not match a National Shared Database record.

U

: No middle name data is available in the National Shared Database.

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

validationInformation.bank.accountOwner.matchMiddleName

SCMP API Field:

ecp_avs_match_customer_middle_name

Simple Order API Field:

ecAVSReply_matchBillToMIddleName

validationInformation.bank. accountOwner. matchNamePrefix

How closely the name prefix matches the National Shared Database record.

When a name prefix is included in the request,

U

is always returned.

Possible values:

U

: No data is available in the National Shared Database.

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

validationInformation.bank.accountOwner.matchNamePrefix

SCMP API Field:

ecp_avs_match_customer_prefix

Simple Order API Field:

ecAVSReply_matchBillToPrefix

validationInformation.bank. accountOwner. matchNameSuffix

How closely the name suffix matches the National Shared Database record.

When a name suffix is included in the request,

U

is always returned.

Possible values:

U

: No data is available in the National Shared Database.

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

validationInformation.bank.accountOwner.matchNameSuffix

SCMP API Field:

ecp_avs_match_customer_suffix

Simple Order API Field:

ecAVSReply_matchBillToSuffix

validationInformation.bank. accountOwner. matchPersonalIdentificationID

Indicates how closely the document identification number in the request matches the National Shared Database record.

Possible values:

Y

: The value in the request closely or exactly matches information in a National Shared Database record.

C

: The value in the request partially matches information in a National Shared Database record.

N

: The value in the request does not match information in a National Shared Database record.

U

: No personal identification ID data is available in the National Shared Database.

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

validationInformation.bank.accountOwner.matchPersonalIdentificationID

SCMP API Field:

ecp_avs_match_personal_id

Simple Order API Field:

ecAVSReply_matchPersonalID

validationInformation.bank. accountOwner. matchPersonalIdentificationIssuedBy

Indicates how closely the issuer of the document in the request matches the National Shared Database record.

Possible values:

Y

: The value in the request closely or exactly matches information in a National Shared Database record.

N

: The value in the request does not match information in a National Shared Database record.

U

: No personal identification issued by data is available in the National Shared Database.

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

validationInformation.bank.accountOwner.matchPersonalIdentificationIssuedBy

SCMP API Field:

ecp_avs_match_personal_id_issued_by

Simple Order API Field:

ecAVSReply_matchPersonalIDIssuedBy

validationInformation.bank. accountOwner. matchPersonalIdentificationType

Indicates how closely the type of identification in the request matches the National Shared Database record.

Possible values:

Y

: The value in the request closely or exactly matches information in a National Shared Database record.

C

: The value in the request partially matches information in a National Shared Database record.

N

: The value in the request does not match information in a National Shared Database record.

U

: No personal identification type data for this account is available in the National Shared Database.

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

validationInformation.bank.accountOwner.matchPersonalIdentificationType

SCMP API Field:

ecp_avs_match_personal_id_type

Simple Order API Field:

ecAVSReply_matchPersonalIDType

validationInformation.bank. accountOwner. matchPhoneNumber

Indicates how closely the home phone number in the request matches the National Shared Database record.

Possible values:

Y

: The home or work phone number in the request exactly matches a database record.

C

: The home or work phone number in the request is a close match but does not exactly match by one digit, or two correct digits are transposed.

N

: The home or work phone number in the request does not match a database record. Two or more digits do not match.

U

: The routing transit number is in the database, but no home or work phone number is in the database record.

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

validationInformation.bank.accountOwner.matchPhoneNumber

SCMP API Field:

ecp_avs_match_customer_phone

Simple Order API Field:

ecAVSReply_matchBillToPhoneNumber

validationInformation.bank. accountOwner. matchTaxId

Indicates how closely the tax ID number in the request matches the National Shared Database record.

Possible values:

Y

: The tax identification number in the request exactly matches a database record.

C

: The tax identification number in the request is a close match but does not exactly match by one digit, or two correct digits have been transposed.

N

: The tax identification number in the request does not match a database record. Two or more digits do not match.

U

: The routing transit number is found in the database, but no tax identification number is in the database record.

Valid values for a four-digit tax ID are

Y

,

N

,

U

.

Valid values for a nine-digit tax ID are

Y

,

C

,

N

,

U

.

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

validationInformation.bank.accountOwner.matchTaxId

SCMP API Field:

ecp_avs_match_bill_company_tax_id

Simple Order API Field:

ecAVSReply_matchBillToCompanyTaxID

validationInformation.bank. accountOwner. matchPostalCode

Indicates how closely the postal code in the request matches the National Shared Database record.

Possible values:

Y

: The postal code in the request closely or exactly matches a National Shared Database record.

C

: The postal code in the request partially matches a National Shared Database record.

N

: The postal code in the request does not match a National Shared Database record.

U

: No postal code data for this account is available in the National Shared Database.

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

validationInformation.bank.accountOwner.matchPostalCode

SCMP API Field:

ecp_avs_match_bill_zip

Simple Order API Field:

ecAVSReply_matchBillToPostalCode

validationInformation.bank. accountOwner. overallMatchScore

Score designating how well the request data matches a database record.

The score is a measure of how closely the data values in the request match the information in a National Shared Database record. It is derived by compiling all of the data matches for the account information submitted for matching and includes name variations, abbreviations, spelling, phonetic encoding, and other matching algorithms.

Possible values range from 0 through 100.

A value of 81 or greater meets the criteria for a match.

Specifications

Data Type:
Integer

Data Length:
1-3

Mapping Information

REST API Field:

validationInformation.bank.accountOwner.overallMatchScore

SCMP API Field:

ecp_avs_overall_match_score

Code indicating a dispute related to the Fair Credit Reporting Act (FCRA).

Possible value:

B9

: Consumer information includes a statement of dispute.

Specifications

Data Type:
String

Data Length:
2

Mapping Information

REST API Field:

validationInformation.bank.accountStatus.fcraDisputeCode

SCMP API Field:

ecp_avs_fcra_dispute_code

Simple Order API Field:

ecAVSReply_fcraDisputeCode

validationInformation.bank. accountStatus. lastUpdateDate

Date on which the customer's bank account was most recently updated in the National Shared Database.

Format: YYYYMMDD

Specifications

Data Type:
String

Data Length:
8

Mapping Information

REST API Field:

validationInformation.bank.accountStatus.lastUpdateDate

SCMP API Field:

ecp_avs_previous_status_code

Simple Order API Field:

ecAVSReply_previousStatusCode

validationInformation.bank. accountStatus. previousStatusCode

Status code for the customer's bank account before its most recent update in the National Shared Database.

Specifications

Data Type:
String

Data Length:
3

Mapping Information

REST API Field:

validationInformation.bank.accountStatus.previousStatusCode

SCMP API Field:

ecp_avs_previous_status_code

Simple Order API Field:

ecAVSReply_previousStatusCode

validationInformation.bank. accountStatus. primaryStatusCode

Primary status code for the customer's bank account.

The primary, secondary, and additional status codes are automatically determined by combining the bank account status with information provided by contributing financial institutions.

Specifications

Data Type:
String

Data Length:
3

Mapping Information

REST API Field:

validationInformation.bank.accountStatus.primaryStatusCode

SCMP API Field:

ecp_avs_primary_status_code

Simple Order API Field:

ecAVSReply_primaryStatusCode

validationInformation.bank. accountStatus. scoredAccountProcessorResponse1

Scored account processor response 1.

The value of the field indicates the reason for the score shown in the primary status code field.

This value is returned for scored accounts only. A scored account refers to a bank account residing at a financial institution that does not contribute to the National Shared Database. Scored Account Reason Codes 1-3 contain the primary reasons that contributed to the score value in the

validationInformation.bank.accountStatus.primaryStatusCode

field.

Specifications

Data Type:
String

Data Length:
2

Mapping Information

REST API Field:

validationInformation.bank.accountStatus.scoredAccountProcessorResponse1

SCMP API Field:

ecp_avs_scored_account_processor_response1

Simple Order API Field:

ecAVSReply_scoredAccountProcessorResponse1

validationInformation.bank. accountStatus. scoredAccountProcessorResponse2

Scored account processor response 2.

The value of the field indicates the reason for the score shown in the primary status code field.

This value is returned for scored accounts only. A scored account refers to a bank account residing at a financial institution that does not contribute to the National Shared Database. Scored Account Reason Codes 1-3 contain the primary reasons that contributed to the score value in the

validationInformation.bank.accountStatus.primaryStatusCode

field.

Specifications

Data Type:
String

Data Length:
2

Mapping Information

REST API Field:

validationInformation.bank.accountStatus.scoredAccountProcessorResponse2

SCMP API Field:

ecp_avs_scored_account_processor_response2

Simple Order API Field:

ecAVSReply_scoredAccountProcessorResponse2

validationInformation.bank. accountStatus. scoredAccountProcessorResponse3

Simple Order API Field:

ecAVSReply_secondaryStatusCode

validationInformation. calculatedResponse

Calculated response based on the business rules provided to Wells Fargo.

Possible values:

Y

: Yes, the account matches your acceptance criteria.

N

: No, the account does not match your acceptance criteria.

U

: Unavailable. There is insufficient data in the National Shared Database to determine whether the account is valid.

Specifications

Data Type:
Enum

Data Length:
1

Mapping Information

REST API Field:

validationInformation.calculatedResponse

SCMP API Field:

ecAVSReply_calculatedResponse

Simple Order API Field:

ecp_avs_calculated_response

validationInformation.referenceID

Reference ID generated to track each request. This ID is returned in the response header.

The reference ID must be a UUID value compliant with RFC 4122.

Specifications

Data Type:
String

Data Length:
36

Mapping Information

REST API Field:

validationInformation.referenceID

SCMP API Field:

ecp_avs_reference_id

Simple Order API Field:

ecAVSReply_referenceID

validationInformation.resultCode

The result code indicates whether high-focus items and duplicate items or participant score information or both are available (if applicable).

Specifications

Data Type:
String

Data Length:
5

Mapping Information

REST API Field:

validationInformation.resultCode

SCMP API Field:

ecp_avs_result_code

Simple Order API Field:

ecAVSReply_resultCode

validationInformation.transactionReason

Three-character code indicating the reason for the transaction.

This field is generated by combining payment requests such as eCheck debit or credit with AVS.

This field is mandatory for standalone AVS calls.

Possible values:

DEP

: Deposit.

ENR

: Enrollment for recurring payments.

PMT

: Payment.

Specifications

Data Type:
String

Data Length:
Enum

Mapping Information

REST API Field:

validationInformation.transactionReason

SCMP API Field:

ecp_transaction_reason

Simple Order API Field:

check_transactionReason

validationInformation.validationType

Type of account validation that you are requesting.

Possible values:

ACCOUNT STATUS (default)

ACCOUNT OWNERSHIP

If your account is enabled for account ownership, this field is required.

If your account is enabled for both ownership and status, this field is required whenever you request ownership.

Specifications

Data Type:
String

Data Length:
17

Mapping Information

REST API Field:

validationInformation.validationType

SCMP API Field:

ecp_avs_validation_type

Simple Order API Field:

ecAVSReply_validationType

voidAmountDetails

These fields provide void amount details.

voidAmountDetails.originalTransactionAmount

voidAmountDetails.voidAmount

voidAmountDetails.currency

voidAmountDetails. originalTransactionAmount

Amount of the original transaction.

Specifications

Data Type:
String

Data Length:
15

Mapping Information

REST API Fields:

reversalAmountDetails.originalTransactionAmount

voidAmountDetails.originalTransactionAmount

SCMP API Field:

original_transaction_amount

Simple Order API Field:

originalTransaction_amount

voidAmountDetails. voidAmount

Amount that was voided.

Specifications

Data Type:
String

Data Length:
15

Mapping Information

REST API Field:

voidAmountDetails.voidAmount

SCMP API Fields:

pin_debit_reversal_auth_amount

void_void_amount

Simple Order API Fields:

pinDebitReversalReply_amount

voidReply_amount

voidAmountDetails. currency

Currency used for the order.

Specifications

Data Type:
String

Data Length:
5

Mapping Information

REST API Field:

voidAmountDetails.currency

SCMP API Field:

void_void_currency

Simple Order API Field:

voidReply_currency

warning

Text and additional detail about an error for this transaction.

Used with 3-D Secure 2.0. This field concatenates all of the fields from optional extensions that are contributing to the error. This error does not stop the transaction. Merchants should take corrective action to resolve the warning issue.

Specifications

Data Type:
String

Data Length:
255

Mapping Information

REST API Field:

warning

SCMP API Field:

pa_enroll_warning

Simple Order API Field:

payerAuthEnrollReply_warning

watchlistScreeningInformation

These fields provide watchlist screening information.

watchlistScreeningInformation.addressOperator

watchlistScreeningInformation.infoCodes[]

watchlistScreeningInformation.ipCountryConfidence

watchlistScreeningInformation.proceedOnMatch

watchlistScreeningInformation.sanctionLists[]

watchlistScreeningInformation.watchList.matches[].addresses[]

watchlistScreeningInformation.watchList.matches[].aliases[]

watchlistScreeningInformation.watchList.matches[].programs[]

watchlistScreeningInformation.watchList.matches[].sanctionList

watchlistScreeningInformation.weights.address

watchlistScreeningInformation.weights.company

watchlistScreeningInformation.weights.name

watchlistScreeningInformation. addressOperator

Customer information that must match an entry in the Denied Parties List (DPL).

Possible values:

AND

: (default) The customer’s name or company and the customer’s address must appear in the database.

OR

: The customer’s name must appear in the database.

IGNORE

: You want the service to detect only a match of the customer’s name or company but not of the address.

This field is used only when the

processingInformation.actionList

field contains the value

WATCHLIST_SCREENING

.

Specifications

Data Type:
String

Data Length:
2,147,483,647

Mapping Information

REST API Field:

watchlistScreeningInformation.addressOperator

SCMP API Field:

export_address_operator

Simple Order API Field:

exportService_addressOperator

watchlistScreeningInformation. infoCodes[]

Returned when the Denied Parties List (DPL) check (first two codes) or the export service (all others) would have declined the transaction.

Possible values:

MATCH-DPC

: DPL match.

UNV-DPC

: DPL is unavailable.

MATCH-BCO

: Billing country is restricted.

MATCH-EMCO

: Email country is restricted.

MATCH-HCO

: Host name country is restricted.

MATCH-IPCO

: IP country is restricted.

MATCH-SCO

: Shipping country is restricted.

This field is used only when the

processingInformation.actionList

field contains the value

WATCHLIST_SCREENING

.

Specifications

Data Type:
Array of strings

Data Length:
2,147,483,647

Mapping Information

REST API Field:

watchlistScreeningInformation.infoCodes[]

SCMP API Field:

export_info

Simple Order API Field:

exportReply_infoCode

watchlistScreeningInformation. ipCountryConfidence

Likelihood that the country associated with the customer’s IP address was identified correctly.

A value between

1–100

is returned.

100

indicates the highest likelihood. If the country cannot be identified, the value is

–1

.

This field is used only when the

processingInformation.actionList

field contains the value

WATCHLIST_SCREENING

.

Specifications

Data Type:
Integer

Data Length:
3

Mapping Information

REST API Field:

watchlistScreeningInformation.ipCountryConfidence

SCMP API Field:

export_ip_country_confidence

Simple Order API Field:

exportReply_ipCountryConfidence

watchlistScreeningInformation. proceedOnMatch

Indicates whether the transaction should proceed if there is a match in Watchlist Screening.

This is used when the merchant wants more fine-grained control over the declines. The merchant can also use the watchlist match results in the Decision Manager rule builder.

Possible values:

true

: Transaction proceeds even when a match is found in the Denied Parties List. Any match is noted in the response.

false

(default): Normal watchlist screening behavior occurs. A match stops the transaction. When there is no match, the transaction proceeds.

Specifications

Data Type:
Boolean

Data Length:
5

Mapping Information

REST API Field:

watchlistScreeningInformation.proceedOnMatch

SCMP API Field:

ignore_export_result

Simple Order API Field:

businessRules_ignoreExportResult

watchlistScreeningInformation. sanctionLists[]

Specifies which list(s) to check with the request.

The response includes the list name as well as the response data. To check against multiple lists, enter multiple list codes separated by carets (^).

This field is used only when the

processingInformation.actionList

field contains the value

WATCHLIST_SCREENING

.

Specifications

Data Type:
Array of strings

Data Length:
2,147,483,647

Mapping Information

REST API Field:

watchlistScreeningInformation.sanctionLists[]

SCMP API Field:

export_sanctions_lists

Simple Order API Field:

exportService_sanctionsLists

watchlistScreeningInformation. watchList.matches[].addresses[]

Address was found on the matched sanction list for the entity (name and address) in the request.

This field is only used when the

processingInformation.actionList

field contains the value

WATCHLIST_SCREENING

.

Specifications

Data Type:
Array of strings

Data Length:
2,147,483,647

Mapping Information

REST API Field:

watchlistScreeningInformation.watchList.matches[].addresses[]

SCMP API Fields:

export_matchN_address1

to

export_matchN_addressN

Simple Order API Fields:

deniedPartiesMatch_N_address_0

through

deniedPartiesMatch_N_address_N

watchlistScreeningInformation. watchList.matches[].aliases[]

Name found on the matched sanction list for the entity (name and address) in the request.

This field is used only when the

processingInformation.actionList

field contains the value

WATCHLIST_SCREENING

.

Specifications

Data Type:
Array of strings

Data Length:
2,147,483,647

Mapping Information

REST API Field:

watchlistScreeningInformation.watchList.matches[].aliases[]

SCMP API Fields:

export_matchN_name1

to

export_matchN_nameN

Simple Order API Fields:

deniedPartiesMatch_N_name_0

through

deniedPartiesMatch_N_name_N

watchlistScreeningInformation. watchList.matches[].programs[]

Sub-lists matched by the order data.

platform="rest"This field is only used when the

processingInformation.actionList

field contains the value

WATCHLIST_SCREENING

.

Specifications

Data Type:
Array of strings

Data Length:
2,147,483,647

Mapping Information

REST API Field:

watchlistScreeningInformation.watchList.matches[].programs[]

SCMP API Field:

export_matchN_programN

Simple Order API Field:

deniedPartiesMatch_N_program_N

watchlistScreeningInformation. watchList.matches[].sanctionList

List on which the first Denied Parties List match appears.

This field is used only when the

processingInformation.actionList

field contains the value

WATCHLIST_SCREENING

.

Specifications

Data Type:
String

Data Length:
255

Mapping Information

REST API Field:

watchlistScreeningInformation.watchList.matches[].sanctionList

SCMP API Field:

export_matchN_list

Simple Order API Field:

deniedPartiesMatch_N_list

watchlistScreeningInformation. weights.address

Degree of correlation between a customer’s address and an entry in the Denied Parties List (DPL).

Possible values:

Exact

: The address must be identical to the entry in the DPL.

High

: The address cannot differ significantly from the entry in the DPL (default).

Medium

: The address can differ slightly more from the entry in the DPL.

Low

: The address can differ significantly from the entry in the DPL.

This field is used only when the

processingInformation.actionList

field contains the value

WATCHLIST_SCREENING

.

Specifications

Data Type:
String

Data Length:
6

Mapping Information

REST API Field:

watchlistScreeningInformation.weights.address

SCMP API Field:

export_address_weight

Simple Order API Field:

exportService_addressWeight

watchlistScreeningInformation. weights.company

Degree of correlation between a company name and an entry in the Denied Parties List (DPL).

Possible values:

Exact

: The company name must be identical to the entry in the DPL.

High

: The company name cannot differ significantly from the entry in the DPL (default).

Medium

: The company name can differ slightly more from the entry in the DPL.

Low

: The company name can differ significantly from the entry in the DPL.

This field is used only when the

processingInformation.actionList

field contains the value

WATCHLIST_SCREENING

.

Specifications

Data Type:
String

Data Length:
6

Mapping Information

REST API Field:

watchlistScreeningInformation.weights.company

SCMP API Field:

export_company_weight

Simple Order API Field:

exportService_companyWeight

watchlistScreeningInformation. weights.name

Degree of correlation between a customer’s address and an entry in the Denied Parties List (DPL).

Possible values:

Exact

: The address must be identical to the entry in the DPL.

High

: The address cannot differ significantly from the entry in the DPL (default).

Medium

: The address can differ slightly more from the entry in the DPL.

Low

: The address can differ significantly from the entry in the DPL.

This field is used only when the

processingInformation.actionList

field contains the value

WATCHLIST_SCREENING

.

Specifications

Data Type:
String

Data Length:
6

Mapping Information

REST API Field:

watchlistScreeningInformation.weights.name

SCMP API Field:

export_name_weight

Simple Order API Field:

exportService_nameWeight

Relaxed Requirements for Address Data and Expiration Date in Payment Transactions

With relaxed requirements for address data and the expiration date, not all standard payment request fields are required. It is your responsibility to determine whether your account is enabled to use this feature and which fields are required.

allowedCardNetworks

The card networks that are allowed for the merchant.

Possible values:

Microform Integration: AMEX
CARNET
CARTESBANCAIRES
CUP
DINERSCLUB
DISCOVER
EFTPOS
ELO
JCB
JCREW
MADA
MAESTRO
MASTERCARD
MEEZA
VISA
Unified Checkout: AMEX
CARNET
CARTESBANCAIRES
CUP
DINERSCLUB
DISCOVER
EFTPOS
ELO
JCB
JCREW
MADA
MAESTRO
MASTERCARD
MEEZA
VISA

Specifications

Data Type:
Enum

Mapping Information

REST API Field:

allowedCardNetworks

Simple Order API Field:
No corresponding field.

allowedPaymentTypes

The payment types that are allowed for the merchant.

Possible values:

Click to Pay Drop-In UI: CLICKTOPAY
Microform Integration: CARD
CHECK
Unified Checkout: APPLEPAY
CHECK
CLICKTOPAY
GOOGLEPAY
PANENTRY

IMPORTANT

Click to Pay supports American Express, Mastercard, and Visa for saved cards. Visa and Mastercard tokenize payment credentials using network tokenization for all Click to Pay requests. Click to Pay uses Click to Pay Token Requester IDs (TRIDs) rather than your existing TRIDs.

Specifications

Data Type:
Enum

Mapping Information

REST API Field:

allowedPaymentTypes

Simple Order API Field:
No corresponding field.

authenticatorRenderMethod

The render method for the authenticator.

Possible values:

IFRAME

POPUP

Specifications

Data Type:
Enum

Mapping Information

REST API Field:

authenticatorRenderMethod

Simple Order API Field:
No corresponding field.

captureOptions. dateToCapture

Mapping Information

REST API Field:

comment

SCMP API Field:
No corresponding field

Simple Order API Field:
No corresponding field

configVersion

Version of the terminal software configuration profile.

To get this value, contact Visa Acceptance Solutions customer support.

Specifications

Data Type:
String

Data Length:
64

Mapping Information

REST API Field:

configVersion

SCMP API Field:
No corresponding field

Simple Order API Field:
No corresponding field

consumerId

The identifier of the consumer within the wallet.

Visa Token Service (VTS) supports

consumerId

values that are 24 characters in length. If you send a request with a

consumerId

value that is longer than 24 characters, only the first 24 characters are sent to VTS.

Specifications

Data Type:
String

Maximum Data Length:
36

Mapping Information

REST API Field:

consumerId

SCMP API Field:
No corresponding field

Simple Order API Field:
No corresponding field

country

Country where Unified Checkout is being used. Use a two-character ISO country code.

Possible values:

AD-CV	CY-ID	IE-MM	MN-SG	SI-ZW
AD	CY	IE	MN	SI
AE	DE	IL	MO	SK
AF	DJ	IM	MR	SL
AG	DK	IN	MT	SM
AL	DK	IQ	MU	SN
AM	DM	IS	MV	SO
AO	DO	IT	MW	SR
AR	DZ	JE	MX	SS
AT	EC	JM	MY	ST
AU	EE	JO	MZ	SV
AZ	EG	JP	NA	SZ
BA	ER	KE	NE	TD
BB	ES	KG	NG	TG
BD	ET	KH	NI	TH
BE	FI	KI	NL	TJ
BF	FJ	KM	NO	TL
BG	FM	KN	NP	TM
BH	FO	KR	NR	TN
BI	FR	KW	NZ	TO
BJ	GA	KZ	OM	TR
BN	GB	LA	PA	TT
BO	GD	LB	PE	TV
BR	GE	LC	PG	TW
BS	GG	LI	PH	TZ
BT	GH	LK	PK	UA
BW	GI	LR	PL	UG
BY	GL	LS	PS	US
BZ	GM	LT	PT	UY
CA	GN	LU	PW	UZ
CD	GQ	LV	PY	VA
CF	GR	LY	QA	VC
CG	GT	MA	RO	VE
CH	GW	MC	RS	VN
CI	GY	MD	RW	VU
CL	HK	ME	SA	WS
CM	HN	MG	SB	YE
CN	HR	MH	SC	ZA
CO	HT	MK	SD	ZM
CR	HU	ML	SE	ZW
CV	ID	MM	SG

Specifications

Data Type:
Enum

Mapping Information

REST API Field:

country

Simple Order API Field:
No corresponding field.

createInstrumentIdentifier

Indicates if a Token Management Service instrument identifier token should be created when you are provisioning a network tokenized card. When this field is set to true, an instrument identifier should be created.

Possible values:

true

false

Specifications

Data Type:
Boolean

Mapping Information

REST API Field:

createInstrumentIdentifier

SCMP API Field:
No corresponding field.

Simple Order API Field:
No corresponding field

For transaction processing, this field contains the processor transaction identifier (TID) that isused to identify and track a transaction throughout its lifecycle.

For plans and subscriptions, the identifier is assigned by Visa Acceptance Solutions to identify the submitted plan or subscription request.

Not all processors provide this value for transaction processing.

American Express Direct: American Express generates this value. To comply with the American Express Card Acceptance Processing Network (CAPN) requirements, this value must be included in all subsequent follow-on requests, such as captures and follow-on credits.

When you perform authorizations, captures, and credits through Visa Acceptance Solutions, Visa Acceptance Solutions passes this value from the authorization service to the subsequent services for you. However, when you perform authorizations through Visa Acceptance Solutions and perform subsequent services through other financial institutions, you must ensure that requests for captures and credits include this value.
Cielo: This value is the non-sequential unit (NSU) and is returned for all transactions. Cielo or the issuing bank generates the value.
Comercio Latino: This value is the proof of sale or non-sequential unit (NSU) number. The Cielo acquirer, Rede acquirer, or issuing bank generates the value.
Moneris: This value identifies the transaction on a host system. You must store this value. If you give the customer a receipt, display this value on the receipt.

The value contains the following information:

Terminal used to process the transaction
Shift during which the transaction took place
Batch number
Transaction number within the batch

Example:
For the value
66012345001069003
:

Terminal ID = 66012345
Shift number = 001
Batch number = 069
Transaction number = 003
GPN: The value is generated for each card type:
American Express: The payment card company generates this value. This value is saved and sent to the processor in all subsequent capture requests.
Discover: The payment card company generates this value. This value is saved and sent to the processor in all subsequent requests for full authorization reversals and captures.
Mastercard: The payment card company generates this value. This value is saved and sent to the processor in all subsequent requests for full authorization reversals and captures. Format:
Positions 1-9: Mastercard Banknet reference number.
Positions 10-13: Date.
Positions 14-15: Spaces.
Visa: The payment card company generates this value. This value is saved and sent to the processor in all subsequent requests for full authorization reversals and captures.
Other Card Types: Not used.
Visa Platform Connect: The value is generated for each card type:
American Express: American Express generates this value. It is included in all replies from the American Express Global Network (AEGN).
Mastercard: This value is the qualification information for the Mastercard Interchange Compliance (MIC) program. It is used for all Mastercard responses coming from Mastercard Banknet through Visa to certified acquirers. Format:
Positions 1–4: Date in MMDD format.
Positions 5–7: Product code or financial network code. Mastercard can introduce new values for this subfield without advance notice.
Positions 8–13: First six digits of Mastercard Banknet reference number.
Positions 14–15: Spaces.
Visa and other card types: The payment card company generates this value. It is unique for each original authorization and identifies a transaction throughout its life cycle.

The value for this field corresponds to the following data in the TC 33 capture file:

Record: CP01 TCR7
Position: 81-95
Field: Gateway Transaction Identifier

Specifications

Data Type:
String

Data Length for Transaction Processing:

Cielo:
50

Elavon:
22

Comercio Latino:
20

Moneris:
18

All other processors:
26

Data Length for Plans and Subscriptions:
26

Mapping Information

REST API Field:

id

SCMP API Fields:

auth_payment_network_transaction_id

auth_processor_trans_id

auth_request_id

auth_reversal_processor_trans_id

ecp_debit_request_id

Simple Order API Fields:

ccAuthReply_paymentNetworkTransactionID

ccAuthReply_processorTransactionID

ccAuthReversalReply_processorTransactionID

ccAuthReversalService_authRequestID

ccCaptureService_authRequestID

ccCheckStatusService_authRequestID

ccIncrementalAuthService_authRequestID

ecDebitService_debitRequestID

issuerAuthCode

Issuer authentication code that the issuer receives through redirect from the mobile payment application when the

stepUpOption.method

field is set to

APP_TO_APP

.

Specifications

Data Type:
String

Data Length:
4096

Mapping Information

REST API Field:

issuerAuthCode

Simple Order API Field:
No corresponding field.

locale

Locale where Unified Checkout is being used. This field controls aspects of the application such as the language it will be rendered in.

Possible values:

ar_AE

ca_ES

cs_CZ

da_DK

de_AT

de_DE

el_GR

en_AU

en_CA

en_GB

en_IE

en_NZ

en_US

es_AR

es_CL

es_CO

es_ES

es_MX

es_PE

es_US

fi_FI

fr_CA

fr_FR

he_IL

hr_HR

hu_HU

id_ID

it_IT

ja_JP

km_KH

ko_KR

lo_LA

ms_MY

nb_NO

nl_NL

pl_PL

pt_BR

ru_RU

sk_SK

sv_SE

th_TH

tl_PH

tr_TR

vi_VN

zh_CN

zh_HK

zh_MO

zh_SG

zh_TW

Specifications

Data Type:
Enum

Mapping Information

REST API Field:

locale

Simple Order API Field:
No corresponding field.

make

Manufacturer of the point-of-sale (POS) terminal.

When sending a request, you must send either the

partName

field or both the

make

and

model

fields.

Valid values:

Ingenico

PAX

Verifone

Specifications

Data Type:
String

Data Length:
Pre-defined values

Mapping Information

REST API Field:

make

SCMP API Field:
No corresponding field

Simple Order API Field:
No corresponding field

model

Model of the point-of-sale device.

Valid values:

A60

A80

A920

Aries 6

Aries 8

D135

E355

E600

E700

E800

E800 lite

Lane 3000

Lane 5000

Link 2500

M400

P400

S80

S300

SP30

Specifications

Data Type:
String

Data Length:
Pre-defined values

Mapping Information

REST API Field:

model

SCMP API Field:
No corresponding field

Simple Order API Field:
No corresponding field

otp

The one-time password (OTP) that the cardholder enters when the

stepUpOption.method

field is set to one of these values:

OTP_EMAIL

OTP_ONLINE_BANKING

OTP_SMS

Specifications

Data Type:
String

Data Length:
8

Mapping Information

REST API Field:

otp

Simple Order API Field:
No corresponding field.

p2peConfirmation

Status of the point-to-point encryption (P2PE) confirmation from the merchant.

The confirmation status is recorded only if the

p2peStatus

field is set to

Enabled

.

Valid values:

Pending

: Merchant has not yet confirmed the P2PE status.

Confirmed

: Merchant has confirmed the P2PE status.

Rejected

: Merchant has rejected the P2PE status.

Specifications

Data Type:
Enum of string

Data Length:
Pre-defined values

Mapping Information

REST API Field:

p2peConfirmation

SCMP API Field:
No corresponding field

Simple Order API Field:
No corresponding field

p2peConfirmationDateInUTC

Point-to-point encryption (P2PE) confirmation timestamp in UTC format.

Format:
yyyy-MM-DDThh:mm:ssZ

The P2PE confirmation timestamp is recorded only if the

p2peConfirmation

field is set to

Confirmed

.

Example
:

2021-08-11T22:47:57Z

equals August 11, 2021, at 22:47:57 (10:47:57 p.m.). The T separates the date and the time. The Z indicates UTC.

Specifications

Data Type:
String (date/time)

Data Length:
Formatted value

Mapping Information

REST API Field:

p2peConfirmationDateInUTC

SCMP API Field:
No corresponding field

Simple Order API Field:
No corresponding field

p2peStatus

Status of the point-to-point encryption (P2PE) for the terminal.

Valid values:

Enabled

Disabled

Specifications

Data Type:
Enum of string

Data Length:
Pre-defined values

Mapping Information

REST API Field:

p2peStatus

SCMP API Field:
No corresponding field

Simple Order API Field:
No corresponding field

partName

Point of Sale (POS) device name.

When sending a transaction request, you must send either the

partName

field or both the

make

and

model

fields.

The following values can be used:

INGENICO LANE 3000

INGENICO LANE 5000

INGENICO LINK 2500

PAX Aries 6

PAX Aries 8

PAX A60

PAX A80

PAX A920

PAX D135

PAX E600

PAX E700

PAX E800

PAX E800 lite

PAX SP30

PAX S80

PAX S300

Verifone E355

Verifone M400

Verifone P400

Specifications

Data Type:
String

Data Size:
Pre-defined values

Mapping Information

REST API Field:

partName

SCMP API Field:
No corresponding field

Simple Order API Field:
No corresponding field

paymentCredentialType

The type of payment credentials that are requested by the Token Management Service.

By default, payment credentials include network token and cryptogram or dynamic CVV.

When this field is set to

NETWORK_TOKEN

, only the network token is requested and cryptogram or dynamic CVV are excluded.

When this field is set to

SECURITY_CODE

, the dynamic CVV is requested and is returned with the network token card number. Dynamic CVV is supported only for American Express card brands and

When this field is set to

CRYPTOGRAM

, the cryptogram is requested and returned with the network token card number. You cannot request the cryptogram for American Express card brands.

Possible values:

CRYPTOGRAM

NETWORK_TOKEN

SECURITY_CODE

Specifications

Data Type:
Enum

Mapping Information

REST API Field:

paymentCredentialType

SCMP API Field:
No corresponding field

Simple Order API Field:
No corresponding field

paymentInstrument

These fields provide payment instruments.

paymentInstrument.bankAccount.type

paymentInstrument.instrumentIdentifier.bankAccount. number

paymentInstrument.instrumentIdentifier.bankAccount. routingNumber

paymentInstrument. bankAccount. type

The type of bank account that is stored in the payment instrument token.

Specifications

Data Type:
String

Data Length:
1

Mapping

REST Field Name:

paymentInstrument.bankAccount.type

Simple Order Field Name:
No corresponding field.

paymentInstrument. instrumentIdentifier. bankAccount. number

The number of the bank account stored in the instrument identifier token.

Specifications

Data Type:
String

Maximum Data Length:
17

Mapping

REST Field Name:

paymentInstrument.instrumentIdentifier.bankAccount.number

Simple Order Field Name:

No corresponding field.

Reference number for the transaction.

You can use this value to reconcile Visa Acceptance Solutions reports with processor reports.

This value is not returned for all processors.

Syntax

This syntax is used with this field:

{
  "reconciliationId": [ReferenceNumber]
}

Specifications

Data Type:
String

Data Length:

FDC Nashville Global:
8

Other processors:
60

Mapping Information

REST API Field:

reconciliationID

SCMP API Fields:

ap_auth_trans_ref_no

ap_auth_reversal_trans_ref_no

ap_capture_trans_ref_no

ap_check_status_trans_ref_no

ap_refund_trans_ref_no

ap_sales_trans_ref_no

auth_reversal_trans_ref_no

auth_trans_ref_no

bill_trans_ref_no

credit_trans_ref_no

dcc_reference_number

ecp_credit_ref_no

incremental_auth_trans_ref_no

oct_trans_ref_no

pin_debit_credit_trans_ref_no

pin_debit_purchase_trans_ref_no

pin_debit_reversal_trans_ref_no

Simple Order API Fields:

apAuthReply_reconciliationID

apAuthReversalReply_reconciliationID

apCaptureReply_reconciliationID

apCheckStatusReply_reconciliationID

apRefundReply_reconciliationID

apSaleReply_reconciliationID

ccAuthReply_reconciliationID

ccAuthReversalReply_reconciliationID

ccCaptureReply_reconciliationID

ccCaptureService_reconciliationID

ccCreditReply_reconciliationID

ccIncrementalAuthReply_reconciliationID

dcc_referenceNumber

ecCreditReply_reconciliationID

octReply_reconciliationID

pinDebitCreditReply_reconciliationID

pinDebitPurchaseReply_reconciliationID

pinDebitReversalReply_reconciliationID

replacementReason

Reason for replacement of the terminal.

The reason is recorded only if the

statusChangeReason

field is set to

Replaced

.

Valid Values:

Chip Read Error

Compromised

Incorrect Key Injection

Incorrect Password

Power Issue

Suspected Tampering

Tampered

Terminal Error

Other

Specifications

Data Type:
Enum of string

Data Length:
Pre-defined values

Mapping Information

REST API Field:

replacementReason

SCMP API Field:
No corresponding field

Simple Order API Field:
No corresponding field

replacementSerialNumber

The new serial number for the terminal that replaces the current one.

The reason is recorded only if the

statusChangeReason

field is set to

Replaced

.

Specifications

Data Type:
String

Data Length:
64

Mapping Information

REST API Field:

replacementSerialNumber

SCMP API Field:
No corresponding field

Simple Order API Field:
No corresponding field

retrieveBinDetails

Indicates if you want to retrieve BIN details in a Token Management Service (TMS) request. When this field is set to

true

, BIN details are included in a TMS response.

Possible Values

true

false

Specifications

Data Type:
Boolean

Mapping Information

REST API Field:

retrieveBinDetails

SCMP API Field:
No corresponding field

Simple Order API Field:
No corresponding field

serialNumber

Serial number of the terminal.

IMPORTANT

After the serial number is set, it cannot be changed. To get this value, contact Visa Acceptance Solutions customer support.

Specifications

Data Type:
String

Data Length:
64

Mapping Information

REST API Field:

serialNumber

SCMP API Field:
No corresponding field

Simple Order API Field:
No corresponding field

shippedDateInUTC

Date in UTC that the terminal was shipped.

Format
: yyyy-MM-DDThh:mm:ssZ

To get this value, contact Visa Acceptance Solutions customer support.

Example
:

2021-08-11T22:47:57Z

equals August 11, 2021, at 22:47:57 (10:47:57 p.m.). The T separates the date and the time. The Z indicates UTC.

Specifications

Data Type:
String (date time)

Data Length:
Pre-defined format length

Mapping Information

REST API Field:

shippedDateInUTC

SCMP API Field:
No corresponding field

Simple Order API Field:
No corresponding field

shippingTrackingNumber

Tracking number from the shipping carrier.

To get this value, contact Visa Acceptance Solutions customer support.

Specifications

Data Type:
String

Data Length:
128

Mapping Information

REST API Field:

shippingTrackingNumber

SCMP API Field:
No corresponding field

Simple Order API Field:
No corresponding field

source

The type of card that is used to provision a Token Management Service network tokenized card.

Possible Values

ISSUER

ON_FILE

TOKEN

Specifications

Data Type:
Enum

Mapping Information

REST API Field:

source

SCMP API Field:
No corresponding field

Simple Order API Field:
No corresponding field

status

Request Description

The status of the terminal. To set the status field as

Active

, you must set the

paymentProcessor

,

terminalId

, and

serialNumber

fields. For terminals that have an

Active

status, the

statusChangeReason

field is set to

In Production

.

Possible values:

Active

Inactive

Response Description

The status of the plan, subscription, or submitted transaction.

Valid values :

ACTIVE

CANCELLED

DELINQUENT

EXPIRED

PENDING

REVERSED

SUSPENDED

Specifications

Data Type:
Enum

Data Length:
Pre-defined values

Mapping Information

REST API Field:

status

SCMP API Field:
No corresponding field.

Simple Order API Field:
Use the

decision

field to determine the response status.

statusChangeReason

Reason for change in status of the terminal.

Valid values:

Broken/Damaged

: Terminal is broken; does not work.

End of Life

: Terminal is not supported any more.

In Production

: Terminal is active.

Lost/Stolen

: Terminal is lost or stolen.

Other

: Terminal is inactive. (default)

Pending Setup

: Terminal has not been set up.

Replaced

: Terminal has been replaced.

Returned

: Terminal has been returned.

Specifications

Data Type:
Enum of string

Data Length:
Pre-defined values

Mapping Information

REST API Field:

statusChangeReason

SCMP API Field:
No corresponding field

Simple Order API Field:
No corresponding field

submitTimeUTC

Time when the service was requested in Coordinated Universal Time (UTC).

Specifications

Type:
String

Length:
20

Mapping Information

REST API Field:

submitTimeUTC

SCMP API Fields:

auth_auth_time

auth_reversal_request_time

bill_bill_request_time

credit_credit_request_time

ecp_credit_submit_time

ecp_debit_submit_time

incremental_auth_time

oct_request_time

pin_debit_credit_time

pin_debit_purchase_time

pin_debit_reversal_time

void_void_request_time

Simple Order API Fields:

ccAuthReply_authorizedDateTime

ccAuthReversalReply_requestDateTime

ccCaptureReply_requestDateTime

ccCreditReply_requestDateTime

ccIncrementalAuthReply_authorizedDateTime

ecCreditReply_requestDateTime

ecDebitReply_requestDateTime

octReply_requestDateTime

pinDebitCreditReply_dateTime

pinDebitPurchaseReply_dateTime

pinDebitReversalReply_dateTime

voidReply_requestDateTime

targetOrigins

The target origin of the website on which you will be launching Unified Checkout/Microform is defined by the scheme (protocol), hostname (domain), and port number (if used).

You must use https://hostname (unless you use http://localhost)

Wildcards are NOT supported. Ensure that subdomains are included.

Any valid top-level domain is supported (Such as .com, .co.uk, and .gov.br)

Examples:

https://example.com

https://subdomain.example.com

https://example.com:8080

If you are embedding within multiple nested iframes you need to specify the origins of all the browser contexts used, for example:

targetOrigins: [
"https://example.com",
"https://basket.example.com",
"https://ecom.example.com"
]

Specifications

Data Type:
String

Data Length:

Mapping Information

REST API Field:

targetOrigins

Simple Order API Field:
No corresponding field.

teBagSerialNumber

Serial number of the tamper-evident bag used for shipping the terminal.

To get this value, contact Visa Acceptance Solutions customer support.

Specifications

Data Type:
String

Data Length:
64

Mapping Information

REST API Field:

teBagSerialNumber

SCMP API Field:
No corresponding field

Simple Order API Field:
No corresponding field

ticketNumbers

Optional ticket number to track the state of the terminal.

Specifications

Data Type:
String

Data Length:
128

Mapping Information

REST API Field:

ticketNumbers

SCMP API Field:
No corresponding field

Simple Order API Field:
No corresponding field

tokenizedCard. source

The indicator for how the card information was acquired for creating the token.

Possible values:

ISSUER

: Card information was submitted by an issuing bank.

ONFILE

: Card information was submitted by a PAN.

TOKEN

: Card information was submitted by a tokenized card.

Specifications

Data Type:
String

Data Length:
6

Mapping Information

REST API Field:

tokenizedCard.source

Simple Order API Field:
No corresponding field.

totalCount

The total number of plans created by the merchant.

Specifications

Data Type:
Integer

Data Length:
36

Mapping Information

REST API Field:
:

totalCount

SCMP API Field:
No corresponding field.

Simple Order API Field:
No corresponding field.

transactionType

The type of transaction for the payment credentials that are returned by the Token Management Service.

Possible values:

AFT

: Account funding transaction. This value is supported for Visa card types and the

paymentCredentialType

field must be set to

CRYPTOGRAM

.

Specifications

Data Type:
Enum

Mapping Information

REST API Field:
:

transactionType

Simple Order API Field:
No corresponding field.

transientTokenResponseOptions. includeCardPrefix

Specifies the flexible truncated card number response to Microform Integration and Unified Checkout.

Use this field to choose your preferred card number prefix length:

For a 6-digit prefix length, do not include this field.

For an 8-digit prefix length, set this field to

true

.

For no prefix at all, set this field to

false

.

These conditions apply:

8-digit card number prefixes only apply to Discover, JCB, Mastercard, UnionPay, and Visa brands with 16-digit card numbers or longer.

Any card with fewer than 16-digit numbers will return a 6-digit prefix, even when this field is set to

true

.

Any card brand other than Discover, JCB, Mastercard, UnionPay, or Visa will return a 6-digit prefix, even when this field is set to

true

.

If any card brand is co-branded with Discover, JCB, Mastercard, UnionPay, or Visa, an 8-digit prefix will be returned if this field is set to

true

.

IMPORTANT

If your application does not require a card number prefix for routing or identification purposes, set this field to

false

. Doing so minimizes your exposure to sensitive personal data.

Specifications

Data Type:
Boolean

Mapping Information

REST API Field:
:

transientTokenResponseOptions. includeCardPrefix

SCMP API Field:
No corresponding field.

Simple Order API Field:
No corresponding field.

type

Type of point-of-sale (POS) terminal.

Valid values:

TERMINAL

MOBILE

Specifications

Data Type:
Enum of string

Data Size:
Pre-defined values

Mapping Information

REST API Field:

type

SCMP API Field:
No corresponding field

Simple Order API Field:
No corresponding field

warning

Text and additional detail about an error for this transaction.

Used with 3-D Secure 2.0. This field concatenates all of the fields from optional extensions that are contributing to the error. This error does not stop the transaction. Merchants should take corrective action to resolve the warning issue.

Specifications

Data Type:
String

Data Length:
255

Mapping Information

REST API Field:

warning

SCMP API Field:

pa_enroll_warning

Simple Order API Field:

payerAuthEnrollReply_warning

AD-CV	CY-ID	IE-MM	MN-SG	SI-ZW
AD	CY	IE	MN	SI
AE	DE	IL	MO	SK
AF	DJ	IM	MR	SL
AG	DK	IN	MT	SM
AL	DK	IQ	MU	SN
AM	DM	IS	MV	SO
AO	DO	IT	MW	SR
AR	DZ	JE	MX	SS
AT	EC	JM	MY	ST
AU	EE	JO	MZ	SV
AZ	EG	JP	NA	SZ
BA	ER	KE	NE	TD
BB	ES	KG	NG	TG
BD	ET	KH	NI	TH
BE	FI	KI	NL	TJ
BF	FJ	KM	NO	TL
BG	FM	KN	NP	TM
BH	FO	KR	NR	TN
BI	FR	KW	NZ	TO
BJ	GA	KZ	OM	TR
BN	GB	LA	PA	TT
BO	GD	LB	PE	TV
BR	GE	LC	PG	TW
BS	GG	LI	PH	TZ
BT	GH	LK	PK	UA
BW	GI	LR	PL	UG
BY	GL	LS	PS	US
BZ	GM	LT	PT	UY
CA	GN	LU	PW	UZ
CD	GQ	LV	PY	VA
CF	GR	LY	QA	VC
CG	GT	MA	RO	VE
CH	GW	MC	RS	VN
CI	GY	MD	RW	VU
CL	HK	ME	SA	WS
CM	HN	MG	SB	YE
CN	HR	MH	SC	ZA
CO	HT	MK	SD	ZM
CR	HU	ML	SE	ZW
CV	ID	MM	SG

AD-CV	CY-ID	IE-MM	MN-SG	SI-ZW
AD	CY	IE	MN	SI
AE	DE	IL	MO	SK
AF	DJ	IM	MR	SL
AG	DK	IN	MT	SM
AL	DK	IQ	MU	SN
AM	DM	IS	MV	SO
AO	DO	IT	MW	SR
AR	DZ	JE	MX	SS
AT	EC	JM	MY	ST
AU	EE	JO	MZ	SV
AZ	EG	JP	NA	SZ
BA	ER	KE	NE	TD
BB	ES	KG	NG	TG
BD	ET	KH	NI	TH
BE	FI	KI	NL	TJ
BF	FJ	KM	NO	TL
BG	FM	KN	NP	TM
BH	FO	KR	NR	TN
BI	FR	KW	NZ	TO
BJ	GA	KZ	OM	TR
BN	GB	LA	PA	TT
BO	GD	LB	PE	TV
BR	GE	LC	PG	TW
BS	GG	LI	PH	TZ
BT	GH	LK	PK	UA
BW	GI	LR	PL	UG
BY	GL	LS	PS	US
BZ	GM	LT	PT	UY
CA	GN	LU	PW	UZ
CD	GQ	LV	PY	VA
CF	GR	LY	QA	VC
CG	GT	MA	RO	VE
CH	GW	MC	RS	VN
CI	GY	MD	RW	VU
CL	HK	ME	SA	WS
CM	HN	MG	SB	YE
CN	HR	MH	SC	ZA
CO	HT	MK	SD	ZM
CR	HU	ML	SE	ZW
CV	ID	MM	SG

AD-CV	CY-ID	IE-MM	MN-SG	SI-ZW
AD	CY	IE	MN	SI
AE	DE	IL	MO	SK
AF	DJ	IM	MR	SL
AG	DK	IN	MT	SM
AL	DK	IQ	MU	SN
AM	DM	IS	MV	SO
AO	DO	IT	MW	SR
AR	DZ	JE	MX	SS
AT	EC	JM	MY	ST
AU	EE	JO	MZ	SV
AZ	EG	JP	NA	SZ
BA	ER	KE	NE	TD
BB	ES	KG	NG	TG
BD	ET	KH	NI	TH
BE	FI	KI	NL	TJ
BF	FJ	KM	NO	TL
BG	FM	KN	NP	TM
BH	FO	KR	NR	TN
BI	FR	KW	NZ	TO
BJ	GA	KZ	OM	TR
BN	GB	LA	PA	TT
BO	GD	LB	PE	TV
BR	GE	LC	PG	TW
BS	GG	LI	PH	TZ
BT	GH	LK	PK	UA
BW	GI	LR	PL	UG
BY	GL	LS	PS	US
BZ	GM	LT	PT	UY
CA	GN	LU	PW	UZ
CD	GQ	LV	PY	VA
CF	GR	LY	QA	VC
CG	GT	MA	RO	VE
CH	GW	MC	RS	VN
CI	GY	MD	RW	VU
CL	HK	ME	SA	WS
CM	HN	MG	SB	YE
CN	HR	MH	SC	ZA
CO	HT	MK	SD	ZM
CR	HU	ML	SE	ZW
CV	ID	MM	SG

AD-CV	CY-ID	IE-MM	MN-SG	SI-ZW
AD	CY	IE	MN	SI
AE	DE	IL	MO	SK
AF	DJ	IM	MR	SL
AG	DK	IN	MT	SM
AL	DK	IQ	MU	SN
AM	DM	IS	MV	SO
AO	DO	IT	MW	SR
AR	DZ	JE	MX	SS
AT	EC	JM	MY	ST
AU	EE	JO	MZ	SV
AZ	EG	JP	NA	SZ
BA	ER	KE	NE	TD
BB	ES	KG	NG	TG
BD	ET	KH	NI	TH
BE	FI	KI	NL	TJ
BF	FJ	KM	NO	TL
BG	FM	KN	NP	TM
BH	FO	KR	NR	TN
BI	FR	KW	NZ	TO
BJ	GA	KZ	OM	TR
BN	GB	LA	PA	TT
BO	GD	LB	PE	TV
BR	GE	LC	PG	TW
BS	GG	LI	PH	TZ
BT	GH	LK	PK	UA
BW	GI	LR	PL	UG
BY	GL	LS	PS	US
BZ	GM	LT	PT	UY
CA	GN	LU	PW	UZ
CD	GQ	LV	PY	VA
CF	GR	LY	QA	VC
CG	GT	MA	RO	VE
CH	GW	MC	RS	VN
CI	GY	MD	RW	VU
CL	HK	ME	SA	WS
CM	HN	MG	SB	YE
CN	HR	MH	SC	ZA
CO	HT	MK	SD	ZM
CR	HU	ML	SE	ZW
CV	ID	MM	SG

REST API Field Reference (Pilot Release)

Recent Revisions to This Document

25.10.02

25.10.01

25.09.02

25.09.01

25.08.01

25.07.01

25.06.02

25.06.01

25.05.02

25.05.01

25.04.02

25.04.01

25.04

25.03

25.02

25.01

24.24

24.23

24.22

24.21

24.20

24.19

24.18

24.17

24.16

24.15

24.14

24.13

24.12

24.11

24.10

24.09

24.08

24.07

24.06

24.05

24.04

24.03

24.02

VISA Platform Connect: Specifications and Conditions for Resellers/Partners

Introduction to the REST API Fields

acquirerInformation

acquirerInformation. acquirerMerchantId

Specifications

Mapping Information

acquirerInformation. acquirerBin

Specifications

Mapping Information

acquirerInformation. country

Specifications

Mapping Information

acquirerInformation. merchantId

Specifications

Mapping Information

acquirerInformation. password

Specifications

Mapping Information

addressVerificationInformation

addressVerificationInformation. addressType

Specifications

Mapping Information

addressVerificationInformation. applicableRegion

Specifications

Mapping Information

addressVerificationInformation. barCode.checkDigit

Specifications

Mapping Information

addressVerificationInformation. barCode.value

Specifications

Mapping Information

addressVerificationInformation. careOf

Specifications

Mapping Information

addressVerificationInformation. errorCode

Specifications

Mapping Information

addressVerificationInformation. matchScore

Specifications

`REST API` Field Reference
(Pilot Release)

AD-CV	CY-ID	IE-MM	MN-SG	SI-ZW
AD	CY	IE	MN	SI
AE	DE	IL	MO	SK
AF	DJ	IM	MR	SL
AG	DK	IN	MT	SM
AL	DK	IQ	MU	SN
AM	DM	IS	MV	SO
AO	DO	IT	MW	SR
AR	DZ	JE	MX	SS
AT	EC	JM	MY	ST
AU	EE	JO	MZ	SV
AZ	EG	JP	NA	SZ
BA	ER	KE	NE	TD
BB	ES	KG	NG	TG
BD	ET	KH	NI	TH
BE	FI	KI	NL	TJ
BF	FJ	KM	NO	TL
BG	FM	KN	NP	TM
BH	FO	KR	NR	TN
BI	FR	KW	NZ	TO
BJ	GA	KZ	OM	TR
BN	GB	LA	PA	TT
BO	GD	LB	PE	TV
BR	GE	LC	PG	TW
BS	GG	LI	PH	TZ
BT	GH	LK	PK	UA
BW	GI	LR	PL	UG
BY	GL	LS	PS	US
BZ	GM	LT	PT	UY
CA	GN	LU	PW	UZ
CD	GQ	LV	PY	VA
CF	GR	LY	QA	VC
CG	GT	MA	RO	VE
CH	GW	MC	RS	VN
CI	GY	MD	RW	VU
CL	HK	ME	SA	WS
CM	HN	MG	SB	YE
CN	HR	MH	SC	ZA
CO	HT	MK	SD	ZM
CR	HU	ML	SE	ZW
CV	ID	MM	SG

AD-CV	CY-ID	IE-MM	MN-SG	SI-ZW
AD	CY	IE	MN	SI
AE	DE	IL	MO	SK
AF	DJ	IM	MR	SL
AG	DK	IN	MT	SM
AL	DK	IQ	MU	SN
AM	DM	IS	MV	SO
AO	DO	IT	MW	SR
AR	DZ	JE	MX	SS
AT	EC	JM	MY	ST
AU	EE	JO	MZ	SV
AZ	EG	JP	NA	SZ
BA	ER	KE	NE	TD
BB	ES	KG	NG	TG
BD	ET	KH	NI	TH
BE	FI	KI	NL	TJ
BF	FJ	KM	NO	TL
BG	FM	KN	NP	TM
BH	FO	KR	NR	TN
BI	FR	KW	NZ	TO
BJ	GA	KZ	OM	TR
BN	GB	LA	PA	TT
BO	GD	LB	PE	TV
BR	GE	LC	PG	TW
BS	GG	LI	PH	TZ
BT	GH	LK	PK	UA
BW	GI	LR	PL	UG
BY	GL	LS	PS	US
BZ	GM	LT	PT	UY
CA	GN	LU	PW	UZ
CD	GQ	LV	PY	VA
CF	GR	LY	QA	VC
CG	GT	MA	RO	VE
CH	GW	MC	RS	VN
CI	GY	MD	RW	VU
CL	HK	ME	SA	WS
CM	HN	MG	SB	YE
CN	HR	MH	SC	ZA
CO	HT	MK	SD	ZM
CR	HU	ML	SE	ZW
CV	ID	MM	SG