`Simple Order API` Field Reference

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

Audience and Purpose: This guide is written for application developers who want to use the Simple Order API to integrate Cybersource services into an order management system. Implementing Cybersource services requires software development skills. You must write code that uses the Simple Order API request and reply fields.
Conventions: These special statements are used in this document:
An Important
statement contains information essential to successfully completing a task or learning a concept.

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.
Related Documentation: Refer to the Technical Documentation Hub in the Cybersource Developer Center for additional technical documentation:
https://developer.cybersource.com/docs.html
Customer Support: For support information about any service, visit the Support Center:
http://support.visaacceptance.com

Recent Revisions to This Document

25.10.01

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

Updated this field:

payerAuthEnrollService_countryCode

Deprecated these fields:

ccAuthReply_personalIDCode

ccAuthService_veresEnrolled

25.09.02

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

Updated these fields:

card_usage

ccAuthService_overridePaymentMethod

ccCreditService_overridePaymentMethod

pinDebitCreditService_overridePaymentMethod

pos_catLevel

pos_terminalCapability

25.09.01

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

Added these new fields:

ccCreditReply_merchantAdviceCode

ccCreditReply_merchantAdviceCodeRaw

octService__merchantAdviceCode

octService__merchantAdviceCodeRaw

Updated these fields:

fidoFlowType

fidoReasonCode

fidoReasonDescription

methodUrlPresent

payerAuthEnrollReply_alternateAuthenticationMethod

payerAuthSetupService.languagePreference

25.08.01

August 2025: This revision contains only editorial changes and no technical updates.

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:

payerAuthSetupService.languagePreference

fidoFlowType

fidoReasonCode

fidoReasonDescription

methodUrlPresent

Updated these fields:

consumerAuthenticationInformation. alternateAuthenticationMethod

25.06.01

Updated this field:

card_cardType

25.05.02

autoRentalData_dailyRate

autoRentalData_distanceUnit

autoRentalData_driverAge

autoRentalData_extraCharge

autoRentalData_gasCost

autoRentalData_gpsCharge

autoRentalData_insuranceCost

autoRentalData_lateReturnCost

autoRentalData_locationId

autoRentalData_maximumFreeMiles

autoRentalData_mileageCost

autoRentalData_milesTraveled

autoRentalData_noShowIndicator

autoRentalData_odometerReading

autoRentalData_oneWayCost

autoRentalData_otherCharges

autoRentalData_parkingViolationCost

autoRentalData_phoneCharge

autoRentalData_pickUpCity

autoRentalData_pickUpCountry

autoRentalData_pickupLocation

autoRentalData_pickUpState

autoRentalData_pickUpTime

autoRentalData_programCode

autoRentalData_ratePerMile

autoRentalData_regularMileageCost

autoRentalData_rentalAddress

autoRentalData_rentalLocationID

autoRentalData_renterName

autoRentalData_returnCity

autoRentalData_returnCountry

autoRentalData_returnDate

autoRentalData_returnLocation

autoRentalData_returnLocationID

autoRentalData_returnState

autoRentalData_specialProgramCode

autoRentalData_taxAmount

autoRentalData_taxIndicator

autoRentalData_taxRate

autoRentalData_taxStatusIndicator

autoRentalData_taxSummary

autoRentalData_taxType

autoRentalData_timePeriod

autoRentalData_towingCharge

autoRentalData_vehicleIdentificationNumber

autoRentalData_vehicleInsuranceIndicator

autoRentalData_vehicleMake

autoRentalData_vehicleModel

autoRentalData_weeklyRentalRate

autoRental_promotion_additionalCode

autoRental_promotion_code

25.03

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

Added these new fields:

jpo_bonusAmount

jpo_bonuses

jpo_bonusMonth

jpo_preapprovalType

jpo_secondBonusAmount

jpo_secondBonusMonth

Updated this field:

recipient_nationality

25.02

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

Added these new fields:

ccAuthReversalService_gratuityAmount

ccAuthService_gratuityAmount

Updated these fields:

billTo_hostname

billPaymentType

ccCaptureService_gratuityAmount

25.01

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

Updated these fields:

invoiceHeader_businessApplicationID

octService_purposeOfPayment

recipient_accountID

recipient_accountType

recipient_address

recipient_city

recipient_country

recipient_firstName

recipient_lastName

recipient_middleName

recipient_postalCode

recipient_state

sender_accountNumber

sender_address

sender_city

sender_firstName

sender_identificationNumber

sender_lastName

sender_middleName

sender_name

sender_personalIDType

sender_sourceOfFunds

sender_state

sender_phoneNumber

sender_referenceNumber

subsequentAuthReason

24.22

November 2024:
This revision of the guide contains updated or new field information.

Updated this field:

aft_indicator

ccAuthService_commerceIndicator

invoiceHeader_businessApplicationID

recipient_accountID

recipient_accountType

recipient_address

recipient_country

recipient_firstName

recipient_lastName

recipient_middleName

sender_address

sender_firstName

sender_lastName

sender_city

sender_middleName

24.21

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

Updated these fields:

aft_indicator

ccAuthService_consumerBillPayment

invoiceHeader_businessApplicationID

invoiceHeader_merchantDescriptor

recipient_accountID

recipient_accountType

recipient_address

recipient_country

recipient_firstName

recipient_lastName

recipient_city

recipient_middleName

recipient_phoneNumber

recipient_postalCode

recipient_state

sender_accountNumber

sender_address

sender_state

sender_sourceOfFunds

sender_country

sender_firstName

sender_lastName

sender_city

sender_phoneNumber

sender_referenceNumber

24.20

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

Added these fields:

authenticationData_qualityIndicator

merchant_riskPrediction

recipient_countryOfBirth

recipient_email

recipient_nationality

recipient_occupation

serviceProcessing_serviceType

Updated these fields:

aft_indicator

ccAuthService_consumerBillPayment

ccAuthService_authenticationOutageExemptionIndicator

ccAuthService_consumerBillPayment

installment_identifier

invoiceHeader_businessApplicationID

octService_purposeOfPayment

recipient_dateOfBirth

24.19

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

Updated this field:

invoiceHeader_servicePostalCode

Added these new fields:

accountHolder_type

ccAuthService_aggregatorCity

ccAuthService_aggregatorCountry

ccAuthService_aggregatorPostalcode

ccAuthService_aggregatorState

ccAuthService_aggregatorStreetAddress

octService_aggregatorCity

octService_aggregatorCountry

octService_aggregatorPostalcode

octService_aggregatorState

octService_aggregatorStreetAddress

24.18

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

Added these fields:

ccAuthService_acsReferenceNumber

payerAuthEnrollReply_authenticationBrand

payerAuthValidateReply_authenticationBrand

24.17

August 2024:
This revision of the guide contains updated or new field information.

Updated this field:

payerAuthEnrollService_httpUserAgent

24.16

August 2024:
This revision of the guide contains updated or new field information.

Updated these field:

lodgingData_additionalCoupon

ccAuthReply_paymentInsightsInformation_responseInsightsCategoryCode

24.15

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

Updated these fields:

apCaptureService_isFinal

ccAuthService_acquirerMerchantId

24.14

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

Updated these fields:

card_usage

ccAuthService_overridePaymentMethod

ccCreditService_overridePaymentMethod

pinDebitCreditService_overridePaymentMethod

24.13

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

Added these new fields:

Lodging data fields, which begin with

lodgingData_

.

Updated these fields:

ccAuthReply_processorResponse

ccAuthReply_merchantAdviceCode

ccAuthReversalReply_processorResponse

ccCreditReply_processorResponse

ccIncrementalAuthReply_processorResponse

ecCreditReply_processorResponse

ecDebitReply_processorResponse

octReply_processorResponse

pinDebitCreditReply_processorResponse

pinDebitPurchaseReply_processorResponse

pinDebitReversalReply_processorResponse

24.12

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

Updated these fields:

card_cardType

ccCaptureService_totalCount

invoiceHeader_merchantDescriptorCountry

invoiceHeader_submerchantCountry

paymentNetworkTransactionInformation

24.11

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

Added these new fields:

apAuthService_reconciliationID

apCaptureService_authRequestID

ap_device_type

apImportMandateService_dateSigned

apSaleService_preapprovalToken

apSaleService_successURL

apSaleService_transactionTimeout

apSessionsService_cancelURL

apSessionsService_paymentFlowMode

billTo_company

billTo_county

billTo_gender

billTo_language

billTo_middleName

billTo_title

ccAuth_initiatorType

ccAuthService_extendAuthIndicator

fundTransfer_iban

merchantDefinedData_mddField_#

recipient_accountType

recipient_address2

recipient_buildingNumber

recipient_streetName

shipTo_company

24.10

April 2024:
This revision of the guide contains updated or new field information.

Added these new fields:

airlineData_clearingCount

airlineData_clearingSequence

airlineData_creditReasonIndicator

airlineData_electronicTicket

airlineData_purchaseType

airlineData_reservationSystem

airlineData_ticketIssuerCity

airlineData_ticketNumber

airlineData_totalClearingAmount

Updated these fields:

balanceInquiry

businessRules_declineAVSFlags

businessRules_ignoreCVResult

ccAuthReply_merchantAdviceCode

ccAuthReply_merchantAdviceCodeRaw

ccCaptureService_purchasingLevel

ccCreditService_purchasingLevel

24.09

April 2024:
This revision of the guide contains updated or new field information.

Added these new fields:

ccAuthReply_paymentInsightsInformation_orchestration_infoCodes

Updated these fields:

item_#_grossNetIndicator

24.08

April 2024:
This revision of the guide contains updated or new field information.

Added these new fields:

additionalToken_responseInformation

developerID

paymentTypeIndicator

Updated these fields:

ccAuthReply_processorResponse

ccAuthReversalReply_processorResponse

ccCreditReply_processorResponse

ccIncrementalAuthReply_processorResponse

ecCreditReply_processorResponse

ecDebitReply_processorResponse

octReply_processorResponse

pinDebitCreditReply_processorResponse

pinDebitPurchaseReply_processorResponse

pinDebitReversalReply_processorResponse

24.07

April 2024:
This revision of the guide contains updated or new field information.

Added these new fields:

emvRequest_combinedTags

enablerId

healthCard

Updated these fields:

ccAuthReply_merchantAdviceCode

ccAuthReply_merchantAdviceCodeRaw

ccAuthReply_paymentInsightsInformation_responseInsightsCategoryCode

ccAuthService_aggregatorID

ccAuthService_authType

ccAuthService_networkPartnerId

ccAuthService_paSpecificationVersion

ccCaptureService_authType

emvReply_combinedTags

invoiceHeader_salesOrganizationID

invoiceHeader_submerchantID

paymentNetworkTransactionInformation

pinDataEncryptedPIN

24.06

March 2024:
This revision of the guide contains updated or new field information.

Added these new fields:

ccAuthService_dsReferenceNumber

transactionTypeIndicator

24.05

February 2024:
This revision of the guide contains updated or new field information.

Added this new field:

businessRules_ignoreExportResult

24.04

February 2024:
This revision of the guide contains updated or new field information.

Updated the field length for

installment_identifier

(Request)

24.03

January 2024:
This revision of the guide contains updated or new field information.

Added the value

UA

to the field

ccAuthService_overridePaymentMethod

.

Added these new fields:

billTo_companyPhoneNumber

billTo_prefix

check_checkTransactionCode

check_transactionReason

ecAVSReply_accountType

ecAVSReply_addedOrClosedDate

ecAVSReply_additionalStatusCode

ecAVSReply_authorizationLevel

ecAVSReply_calculatedResponse

ecAVSReply_customerDataCondition Code

ecAVSReply_fcraDisputeCode

ecAVSReply_lastUpdateDate

ecAVSReply_matchBillToAddress

ecAVSReply_matchBillToCity

ecAVSReply_matchBillToCompany

ecAVSReply_ matchBillToCompanyPhoneNumber

ecAVSReply_matchBillToCompanyTaxID

ecAVSReply_ matchBillToDateOfBirth

ecAVSReply_matchBillToFirstName

ecAVSReply_matchBillToFullName

ecAVSReply_matchBillToLastName

ecAVSReply_matchBillToMiddleName

ecAVSReply_matchBillToPhoneNumber

ecAVSReply_matchBillToPostalCode

ecAVSReply_matchBillToPrefix

ecAVSReply_matchBillToSSN

ecAVSReply_matchBillToState

ecAVSReply_matchBillToSuffix

ecAVSReply_matchPersonalID

ecAVSReply_matchPersonalIDIssuedBy

ecAVSReply_matchPersonalIDType

ecAVSReply_overallMatchScore

ecAVSReply_previousStatusCode

ecAVSReply_primaryStatusCode

ecAVSReply_referenceID

ecAVSReply_resultCode

ecAVSReply_scoredAccountProcessorResponse1

ecAVSReply_scoredAccountProcessorResponse2

ecAVSReply_scoredAccountProcessorResponse3

ecAVSReply_scoredAccountProcessorResponse5

ecAVSReply_secondaryStatusCode

ecAVSReply_validationType

personalID_issuedBy

Updated supported processor information for these fields:

billTo_companyName

billTo_customerID

card_cardType

card_cvNumber

ccAuthReply_reconciliationReferenceNumber

ccAuthService_cavvAlgorithm

ccAuthService_commerceIndicator

ccCaptureReply_reconciliationReferenceNumber

ccCreditReply_reconciliationReferenceNumber

ccCreditService_commerceIndicator

invoiceHeader_purchaserCode

octService_commerceIndicator

payerAuthEnrollReply_cavvAlgorithm

payerAuthValidateReply_cavvAlgorithm

pinDebitCreditService_commerceIndicator

pinDebitPurchaseService_commerceIndicator

shipTo_city

shipTo_firstName

shipTo_lastName

shipTo_street1

shipTo_street2

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:

ccAuthReply_merchantAdviceCode

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

Cybersource for

Visa Platform Connect

(“VPC”) processing

. 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 Simple Order API Fields

This guide provides an alphabetical list of the Simple Order API fields available through the Cybersource platform.

Data Type Definitions

For more information about these data types, see the World Wide Web Consortium (W3C) XML Schema Part 2: Datatypes Second Edition.

Date and time:

Format:
yyyy-MM-DDThh:mm:ssZ

T separates the date and the time.

Z indicates Coordinated Universal Time (UTC), also known as Greenwich Mean Time (GMT)

Example:
2021-01-11T22:47:57Z is January 11, 2021, at 22:47:57 (10:47:57 p.m.)

Integer:
Whole number {..., -3, -2, -1, 0, 1, 2, 3, ...}

String:
Sequence of letters, numbers, spaces, and special characters

accountHolder_type

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

acquirerMerchantNumber

Identifier that was assigned to you by your acquirer.

This value must be printed on the receipt.

This field is supported only for Cybersource integrations.

Specifications

Data Type:
String

Data Length:
15

Mapping Information

REST API Field:

processorInformation.merchantNumber

SCMP API Field:

acquirer_merchant_number

Simple Order API Field:

acquirerMerchantNumber

additionalData

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

additionalProcessorResponse

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

ccAuthReply_processorResponse

field or the

ccAuthReversalReply_processorResponse

field, depending on which service you requested.

Specifications

Data Type:
Integer

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

additionalToken_responseInformation

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

afsReply_binCountry

afsService_cvCode

ccAuthReply_cvCode

aft_foreignExchangeFee

Fee the issuer charges when the recipient’s currency is not the same as the sender’s currency. When this fee is charged, the grand total amount must include the fee.

Specifications

Data Type:
String

Data Length:
12

Mapping Information

REST API Field:

orderInformation.amountDetails.foreignExchangeFee

SCMP API Field:

aft_foreign_exchange_fee

Simple Order API Field:

aft_foreignExchangeFee

aft_indicator

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

aft_serviceFee

Fee you are charging for the transaction.

When this fee is charged, the grand total amount must include the fee.

Specifications

Data Type:
String

Data Length:
12

Mapping Information

REST API Field:

orderInformation.amountDetails.serviceFeeAmount

SCMP API Field:

aft_service_fee

Simple Order API Field:

aft_serviceFee

agencyInformation_name

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

airlineData_agentCode

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

airlineData_agentName

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

airlineData_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

airlineData_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

airlineData_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

airlineData_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

airlineData_electronicTicket

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

airlineData_exchangeTicketAmount

Amount of the exchanged ticket.

Specifications

Data Type
: Numerical

Data Length
: 12

Mapping Information

REST API Field:

travelInformation.transit.exchangeTicketAmount

SCMP API Field:

airline_exchange_ticket_amount

Simple Order API Field:

airlineData_exchangeTicketAmount

airlineData_exchangeTicketFee

Fee amount for changing the destination or departure time of the original ticket.

Specifications

Data Type:
Numerical

Data Length:
12

Mapping Information

REST API Field:

travelInformation.transit.airline.exchangeTicketFeeAmount

SCMP API Field:

airline_exchange_ticket_fee

Simple Order API Field:

airlineData_exchangeTicketFee

airlineData_leg_#_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

airlineData_leg_#_arrivalTimeSegment

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

airlineData_leg_#_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

airlineData_leg_#_departureDate

Departure date for the first leg of the trip. Can also be referred to as effective date.

Format:

YYYYMMDD

Payer Authentication: The numbered element name should contain
0
instead of
#
. Payer Authentication services only use the first leg of the trip.

Specifications

Data Type:
Integer

Data Length:
8

Mapping Information

REST API Field:

travelInformation.transit.airline.legs[].departureDate

SCMP API Field:

airline_leg#_leg_departure_date

Simple Order API Field:

airlineData_leg_#_departureDate

airlineData_leg_#_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

airlineData_leg_#_departureTimeSegment

Indicates whether departure time for a segment of a trip occurs during AM or PM.

Possible values:

A

International Air Transport Association (IATA) code for originating airport for the first leg of the trip.

Specifications

Data Type:
String

Data Length:
5

Mapping Information

REST API Field:

travelInformation.transit.airline.legs[].originatingAirportCode

SCMP API Field:

airline_leg#_originating_airport_code

Simple Order API Field:

airlineData_leg_#_originatingAirportCode

airlineData_leg_#_stopoverCode

Simple Order API Field:

airlineData_numberOfPassengers

airlineData_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

airlineData_passenger_#_firstName

First name of the passenger to whom the ticket was issued.

If there are multiple passengers, include all that are listed on the ticket. Do not include special characters such as commas, hyphens, or apostrophes. Only ASCII characters are supported.

Required for American Express SafeKey (US) for travel-related requests.

Specifications

Data Type:
Array of strings

Data Length:
60

Mapping Information

REST API Field:

travelInformation.passengers.firstName

SCMP API Field:

airline_passenger#_firstname

Simple Order API Field:

airlineData_passenger_#_firstName

airlineData_passenger_#_lastName

Last name of the passenger to whom the ticket was issued.

If there are multiple passengers, include all that are listed on the ticket. Do not include special characters such as commas, hyphens, or apostrophes. Only ASCII characters are supported.

Required for American Express SafeKey (US) for travel-related requests.

Specifications

Data Type:
Array of strings

Data Length:
60

Mapping Information

REST API Field:

travelInformation.passengers.lastName

SCMP API Field:

airline_passenger#_lastname

Simple Order API Field:

airlineData_passenger_#_lastName

airlineData_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

airlineData_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

airlineData_reservationSystem

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

airlineData_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

airlineData_ ticketIssueDate

Date that the ticket was issued to customer.

If information is not available, use spaces.

Format:

YYYYMMDD

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

airlineData_ticketIssuerAddress

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

airlineData_ticketIssuerCity

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

airlineData_ ticketIssuerCode

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

airlineData_ticketNumber

Ticket number.

This field only accepts letters, numbers and spaces. Special characters are not allowed.

Specifications

Data Type:
String

Data Length:
15

Mapping Information

REST API Field:

travelInformation.transit.airline.ticketNumber

Simple Order API Field:

airlineData_ticketNumber

airlineData_ticketUpdateIndicator

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

airlineData_totalClearingAmount

The total amount for all transactions in the clearing count set.

This value cannot exceed 99,999,999,999,999,999,999 (twenty 9s) (comma added for readability).

Specifications

Data Type:
String

Data Length:
20

Mapping Information

REST API Field:

travelInformation.transit.airline.totalClearingAmount

Simple Order API Field:

airlineData_totalClearingAmount

airlineData_totalFee

Fee that the customer is charged to change the destination or departure time of an original ticket.

Specifications

Data Type:
Numerical

Data Length:
11

Mapping Information

REST API Field:

travelInformation.transit.airline.totalFeeAmount

SCMP API Field:

airline_total_fee

Simple Order API Field:

airlineData_totalFee

ancillaryData_connectedTicketNumber

Airline ticket number connected to ancillary purchase.

If purchase has connection or relation to another purchase, such as a baggage fee for a passenger transport ticket, this field must contain the ticket number for the other purchase.

For stand-alone purchases, the value for this field must be the same value used for the

ancillaryData_ticketNumber

field.

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

ancillaryData_creditReasonIndicator

Indicates reason for credit to cardholder.

Possible Values:

A

: Passenger transport ancillary fee cancellation

B

: Airline ticket and passenger transport ancillary fee cancellation

C

: Airline ticket cancellation

O

: Other

P

: Partial refund of airline ticket

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

travelInformation.transit.airline.ancillaryInformation.creditReasonIndicator

SCMP API Field:

ancillary_credit_reason_indicator

Simple Order API Field:

ancillaryData_creditReasonIndicator

ancillaryData_passengerName

Passenger name or the cardholder name if the passenger is unavailable. If neither names are available, this value is a description of the ancillary purchase.

Specifications

Data Type:
String

Data Length:
20

Mapping Information

REST API Field:

travelInformation.transit.airline.ancillaryInformation.passengerName

SCMP API Field:

ancillary_passenger_name

Simple Order API Field:

ancillaryData_passengerName

ancillaryData_service_#_categoryCode

Category code for ancillary service provided. Obtain the codes from the International Air Transport Association (IATA).

Replace the

#

character with a sequential number from

0

to

3

.

Specifications

Data Type:
String

Data Length:
4

Mapping Information

REST API Field:

travelInformation.transit.airline.ancillaryInformation.service[].categoryCode

SCMP API Field:

ancillary_service#_category_code

Simple Order API Field:

ancillaryData_service_#_categoryCode

ancillaryData_service_#_subcategoryCode

Subcategory code for the ancillary service category. Obtain codes from the International Air Transport Association (IATA).

Replace the

#

character with a sequential number from

0

to

3

.

Specifications

Data Type:
String

Data Length:
4

Mapping Information

REST API Field:

travelInformation.transit.airline.ancillaryInformation.service[].subCategoryCode

SCMP API Field:

ancillary_service#_subcategory_code

Simple Order API Field:

ancillaryData_service_#_subcategoryCode

ancillaryData_ticketNumber

Ticket number, which consists of carrier code, form, and serial number, without the check digit.

Specifications

Data Type:
String

Data Length:
15

Mapping Information

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

ap_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

ap_appUrl

Simple Order API Field:

apAuthReply_dateTime

apAuthReply_merchantURL

The alternative payment service provider URL.

Direct the customer to this URL after the transaction is completed.

Specifications

Data Type:
String

Data Length:
2048

Mapping Information

REST API Field:
No corresponding field

SCMP API Field:

ap_auth_merchant_url

Simple Order API Field:

apAuthReply_merchantURL

apAuthReply_paymentStatus

Payment authorization status.

Possible values:

AUTHORIZED

: Payment successfully authorized.

PENDING

: Request received and waiting to be processed.

FAILED

: Request failed.

Specifications

Data Type:
String

Data Length:
15

Mapping Information

REST API Field:
No corresponding field

SCMP API Field:

ap_auth_payment_status

Simple Order API Field:

apAuthReply_paymentStatus

apAuthReply_processorResponse

Code from the alternative payment processor that describes why the authorization is pending or failed.

Specifications

Data Type:
String

Data Length:
5

Mapping Information

REST API Field:
No corresponding field

SCMP API Field:

ap_auth_processor_response

Simple Order API Field:

apAuthReply_processorResponse

apAuthReply_processorTransactionID

Processor transaction ID.

This value is a unique identifier for the transaction.

Specifications

Data Type:
String

Data Length:
50

Mapping Information

REST API Field:
No corresponding field

SCMP API Field:

ap_auth_processor_trans_id

Simple Order API Field:

apAuthReply_processorTransactionID

apAuthReply_reasonCode

Numeric value that corresponds to the result of the authorization request.

See Reason Codes for Alternative Payments for the Simple Order API for a list and description of the reason codes.

Specifications

Data Type:
Integer

Data Length:
5

Mapping Information

REST API Field:
No corresponding field

SCMP API Field:
No corresponding field

Simple Order API Field:

apAuthReply_reasonCode

apAuthReply_reconciliationID

Reference number for the transaction.

You can use this value to reconcile Cybersource reports with processor reports.

This value is not returned for all processors.

Syntax

This syntax is used with this field:

dcc_referenceNumber=[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

Data Type:
String

Data Length:
20

Mapping Information

REST API Field:
No corresponding field

SCMP API Field:

ap_auth_reversal_date_time

Simple Order API Field:

apAuthReversalReply_dateTime

apAuthReversalReply_paymentStatus

Authorization reversal status returned from the payment processor.

Possible values:

Auth-reversed

: Authorization reversal successfully processed.

Failed

: Authorization reversal failed.

Specifications

Data Type:
String

Data Length:
15

Mapping Information

REST API Field:
No corresponding field

SCMP API Field:

ap_auth_reversal_payment_status

Simple Order API Field:

apAuthReversalReply_paymentStatus

apAuthReversalReply_processorResponse

Code from the alternative payment processor that describes why the authorization reversal is pending or failed.

Specifications

Data Type:
String

Data Length:
5

Mapping Information

REST API Field:
No corresponding field

SCMP API Field:

ap_auth_reversal_processor_response

Simple Order API Field:

apAuthReversalReply_processorResponse

apAuthReversalReply_reasonCode

Numeric value that corresponds to the result of the authorization reversal request.

See Reason Codes for Alternative Payments for the Simple Order API for a list and description of the reason codes.

Specifications

Data Type:
Integer

Data Length:
5

Mapping Information

REST API Field:
No corresponding field

SCMP API Field:
No corresponding field

Simple Order API Field:

apAuthReversalReply_reasonCode

apAuthReversalReply_reconciliationID

Reference number for the transaction.

You can use this value to reconcile Cybersource reports with processor reports.

This value is not returned for all processors.

Syntax

This syntax is used with this field:

dcc_referenceNumber=[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

apAuthReversalReply_responseCode

Response code from the processor.

Specifications

Data Type:
Integer

Data Length:
5

Mapping Information

REST API Field:
No corresponding field

SCMP API Field:

ap_auth_reversal_response_code

Simple Order API Field:

apAuthReversalReply_responseCode

apAuthReversalService_authRequestID

Request ID of the authorization for which you are requesting this service.

Specifications

Data Type:
String

Data Length:
26

Mapping Information

REST API Field:
No corresponding field

SCMP API Field:

ap_auth_request_id

Simple Order API Fields:

apAuthReversalService_authRequestID

apCaptureService_authRequestID

apAuthReversalService_run

Flag that specifies whether to include the authorization reversal service in the request.

Possible values:

true

: Include the authorization reversal service in the request.

false

(default): Do not include the authorization reversal service in the request.

Specifications

Data Type:
String

Data Length:
5

Mapping Information

Data Length:
60

Mapping Information

REST API Field:

processorInformation.preApprovalToken

SCMP API Field:

ap_auth_preapproval_token

Simple Order API Field:

apAuthService_preapprovalToken

apAuthService_reconciliationID

Reference number for the transaction.

For most Cybersource services, the response message includes a unique reconciliation ID that is assigned by Cybersource. For most payment processors, you can use this value to reconcile the transactions in your Cybersource 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

apAuthService_run

Flag that specifies whether to include the authorization service in the request.

Possible values:

true

: Include the authorization service in the request.

false

(default): Do not include the authorization service in the request.

Specifications

Data Type:
String

Data Length:
5

Mapping Information

REST API Field:
No corresponding field

SCMP API Field:
No corresponding field

Simple Order API Fields:

apAuthService_run

apAuthService_successURL

URL to which the customer is directed after completing a payment.

Specifications

Data Type:
String

Data Length:
255

Mapping Information

REST API Field:
No corresponding field

SCMP API Field:

ap_auth_success_url

Simple Order API Field:

apAuthService_successURL

ap_billingAgreementId

Identifier for the billing agreement.

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

Set to the value returned in the

apReply_billingAgreementID

field.

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

apCancelReply_dateTime

The date and time at which the service was requested.

Format:

YYYY-MM-DDThh:mm:ssZ

T

separates the date and the time.

Z

indicates Coordinated Universal Time (UTC), also known as Greenwich Mean Time (GMT).

Example:

2020-01-11T22:47:57Z

is equivalent to January 11, 2020, at 22:47:57 (10:47:57 p.m.).

Specifications

Data Type:
String

Data Length:
20

Mapping Information

Simple Order API Field:

apCancelReply_dateTime

apCancelReply_paymentStatus

The status of the cancel payment service request from the processor.

Possible values:

ACCEPTED

: the cancel request is accepted.

Simple Order API Field:

apCancelReply_responseCode

apCancelReply_status

The cancel payment status from the processor.

Possible values:

ACCEPTED

: the cancel request is accepted.

CANCELLED

: the cancel request is accepted and cancelled.

FAILED

: the cancel request is not accepted.

Specifications

Data Type:
String

Data Length:
15

Mapping Information

Simple Order API Field:

apCancelReply_status

apCancelService_dateTime

The date and time at which the cancel service was requested.

Format:

YYYY-MM-DDThh:mm:ssZ

T

separates the date and the time.

Z

indicates Coordinated Universal Time (UTC), also known as Greenwich Mean Time (GMT).

Example:

2020-01-11T22:47:57Z

is equivalent to January 11, 2020, at 22:47:57 (10:47:57 p.m.).

Specifications

Data Type:
String

Data Length:
18

Mapping Information

SCMP API Field:

ap_cancel_date_time

Simple Order API Field:

apCancelService_dateTime

apCancelService_run

Indicates whether to include the alternative payment method cancel service
(

apCancelService

) in the API request.

Possible values:

false

(default): Do not include the service in your request.

true

: Include the service in your request.

Specifications

Data Type:
String

Data Length:
5

Mapping Information

SCMP API Field and Value:

ics_applications

=ics_ap_cancel

Simple Order API Field:

apCancelService_run

apCancelService_saleRequestID

The request ID of the sale for which you are requesting a cancellation. Set to the value of the

requestID

field in the sale service response.

Specifications

Data Type:
String

Data Length:
26

Mapping Information

Simple Order API Field:

apCancelService_saleRequestID

apCaptureReply_amount

Authorized amount.

Specifications

Data Type:
String

Data Length:
15

Mapping Information

REST API Field:
No corresponding field

SCMP API Field:

ap_capture_amount

Simple Order API Fields:

apCaptureReply_amount

apCaptureReply_paymentStatus

Capture status returned from the payment processor.

REST API Field:
No corresponding field

SCMP API Field:
No corresponding field

Simple Order API Field:

apCaptureReply_reasonCode

apCaptureReply_reconciliationID

Reference number for the transaction.

You can use this value to reconcile Cybersource reports with processor reports.

This value is not returned for all processors.

Syntax

This syntax is used with this field:

dcc_referenceNumber=[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

apCaptureReply_responseCode

Response code from the processor.

Specifications

Data Type:
Integer

Data Length:
5

Mapping Information

REST API Field:
No corresponding field

SCMP API Field:

ap_capture_response_code

Simple Order API Field:

apCaptureReply_responseCode

apCaptureService_authRequestID

Request ID of the authorization for which you are requesting this service.

Specifications

Data Type:
String

Data Length:
26

Mapping Information

REST API Field:
No corresponding field

SCMP API Field:

ap_auth_request_id

Simple Order API Fields:

apAuthReversalService_authRequestID

apCaptureService_authRequestID

apCaptureService_run

Flag that specifies whether to include the capture service in the request.

Possible values:

true

: Include the capture service in the request.

false

(default): Do not include the capture service in the request.

Specifications

Data Type:
String

Data Length:
5

Mapping Information

REST API Field:
No corresponding field

SCMP API Field:
No corresponding field

Simple Order API Fields:

apCaptureService_run

apCheckStatusReply_paymentStatus

Payment status returned from the payment processor.

REST API Field:
No corresponding field

SCMP API Field:
No corresponding field

Simple Order API Field:

apCheckStatusReply_reasonCode

apCheckStatusReply_reconciliationID

Reference number for the transaction.

You can use this value to reconcile Cybersource reports with processor reports.

This value is not returned for all processors.

Syntax

This syntax is used with this field:

dcc_referenceNumber=[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

apCheckStatusReply_transactionID

Transaction ID number generated by Korea Cyber Payment (KCP).

Specifications

Data Type:
String

Data Length:
14

Mapping Information

REST API Field:
No corresponding field

SCMP API Field:

ap_check_status_transaction_id

Simple Order API Fields:

apCheckStatusReply_transactionID

apCheckStatusService_apInitiateRequestID

Identifier returned from the initiate payment service request.

Specifications

Data Type:
String

Data Length:
26

Mapping Information

REST API Field:
No corresponding field. The service is requested with the

{id}

value in these endpoints:

Check Status:

https://api.cybersource.com/v2/status/{id}/refresh

Refund:

https://api.cybersource.com/v2/status/{id}/refunds

SCMP API Field:

ap_initiate_request_id

Simple Order API Fields:

apCheckStatusService_apInitiateRequestID

apRefundService_apInitiateRequestID

apCheckStatusService_checkStatusRequestID

Request ID of the authorization, authorization reversal, capture, sale, or credit service for which you are requesting the check status service.

Specifications

Data Type:
String

Data Length:
26

Mapping Information

REST API Field:
No corresponding field

SCMP API Field:

ap_check_status_request_id

Simple Order API Field:

apCheckStatusService_checkStatusRequestID

apCheckStatusService_run

Flag that specifies whether to include the check status service in the request.

Possible values:

true

: Include the check status service in the request.

false

(default): Do not include the check status service in the request.

Specifications

Data Type:
String

Data Length:
5

Mapping Information

REST API Field:
No corresponding field. The service is requested with the endpoint:

https://api.cybersource.com/v2/status/{id}/refresh

SCMP API Field:

ics_applications

=ics_ap_check_status

Simple Order API Fields:

apCheckStatusService_run

apCreateMandateReply_dateCreated

The date on which the mandate is created.

Format:

YYYYMMDD

Specifications

Data Type:
Numerical string

Data Length:
8

Mapping Information

Simple Order API Field:

apCreateMandateReply_dateCreated

apCreateMandateReply_dateSigned

The date on which the mandate is created.

Format:

YYYYMMDD

Specifications

Data Type:
Numerical string

Data Length:
8

Mapping Information

Simple Order API Field:

apCreateMandateReply_dateSigned

apCreateMandateReply_dateTime

The date and time at which the service was requested.

Format:

YYYY-MM-DDThh:mm:ssZ

T

separates the date and the time.

Z

Simple Order API Field:

apCreateMandateReply_responseCode

apCreateMandateReply_riskScore

The risk score returned by the processor.

Possible values:

0

through

10

A value of

10

indicates a high risk.

Specifications

Data Type:
String

Data Length:
25

Mapping Information

REST API Field:
No corresponding field.

Simple Order API Field:

apCreateMandateReply_riskScore

apCreateMandateReply_status

The status for the create mandate service request from the processor.

Possible values:

PENDING

: the mandate creation request is accepted.

FAILED

: the mandate creation request is not accepted.

Specifications

Data Type:
String

Data Length:
5

Mapping Information

REST API Field:
No corresponding field.

Simple Order API Field:

apCreateMandateReply_status

apCreateMandateService_cancelURL

The URL to which the customer is directed if they cancel signing of the mandate.

Specifications

Data Type:
String

Data Length:
255

Mapping Information

SCMP API Field:

ap_create_mandate_cancel_url

Simple Order API Field:

apCreateMandateService_cancelURL

apCreateMandateService_failureURL

The URL to which the customer is directed if they do not sign the mandate.

Specifications

Data Type:
String

Data Length:
255

Mapping Information

SCMP API Field:

ap_create_mandate_failure_url

Simple Order API Field:

apCreateMandateService_failureURL

apCreateMandateService _run

Indicates whether to include the alternative payment method create mandate service
(

apCreateMandateService

) in the API request.

Possible values:

true

: Include the service in your request.

false

(default): Do not include the service in your request.

Specifications

Data Type:
String

Data Length:
5

Mapping Information

SCMP API Field and Value:

ics_applications

=ics_ap_create_mandate

Simple Order API Field:

apCreateMandateService _run

apCreateMandateService_saleRequestID

The request ID from the online bank transfer (OBT) sale response. The request ID is used to create a mandate.

Specifications

Data Type:
String

Data Length:
26

Mapping Information

SCMP API Field:

ap_create_mandate_sale_request_id

Simple Order API Field:

apCreateMandateService_saleRequestID

apCreateMandateService_successURL

The URL to which the customer is directed if they successfully sign the mandate.

Specifications

Data Type:
String

Data Length:
255

Mapping Information

SCMP API Field:

ap_create_mandate_success_url

Simple Order API Field:

apCreateMandateService_successURL

ap_device_type

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

apImportMandateReply_dateCreated

The date on which the import mandate was created.

Format:

YYYYMMDD

Specifications

Data Type:
Numerical string

Data Length:
8

Mapping Information

REST API Field:
No corresponding field.

Simple Order API Field:

apImportMandateReply_dateCreated

apImportMandateReply_dateSigned

The date on which the import mandate was signed.

Format:

YYYYMMDD

Specifications

Data Type:
Numerical string

Data Length:
8

Mapping Information

REST API Field:
No corresponding field.

Simple Order API Field:

apImportMandateReply_dateSigned

apImportMandateReply_dateTime

The date and time at which the service was requested.

Format:

YYYY-MM-DDThh:mm:ssZ

T

separates the date and the time.

REST API Field:
No corresponding field.

Simple Order API Field:

apImportMandateReply_processorTransactionID

apImportMandateReply_reasonCode

apImportMandateReply_responseCode

apImportMandateReply_status

The status of the import mandate service request from the processor.

Possible values:

ACTIVE

EXPIRED

FAILED

PENDING

REVOKED

Specifications

Data Type:
String

Data Length:
15

Mapping Information

REST API Field:
No corresponding field.

Simple Order API Field:

apImportMandateReply_status

apImportMandateService_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

apImportMandateService_run

Indicates whether to include the alternative payment method import mandate service
(

apImportMandateService

) in the API request.

Possible values:

false

(default): Do not include the service in your request.

true

: Include the service in your request.

Specifications

Data Type:
String

Data Length:
5

Mapping Information

SCMP API Field and Value:

ics_applications

=ics_ap_import_mandate

Simple Order API Field:

apImportMandateService_run

apInitiateReply_merchantURL

Redirect URL to the Korea Cyber Payment (KCP) plug-in. The URL has encrypted data that contains a unique reference ID and payment details for the order.

Some browsers restrict browser URL lengths, so the customer should be redirected to this URL using the code described in.

Specifications

Data Type:
String

Data Length:
Encrypted

Mapping Information

REST API Field:
No corresponding field.

SCMP API Field:

ap_initiate_merchant_url

Simple Order API Field:

apInitiateReply_merchantURL

apInitiateReply_reasonCode

Numeric value corresponding to the result of the

apInitiateService_run

request.

Specifications

Data Type:
Integer

Data Length:
5

Mapping Information

REST API Field:
No corresponding field.

SCMP API Field:
No corresponding field.

Simple Order API Field:

apInitiateReply_reasonCode

apInitiateReply_reconciliationID

Reference number for the transaction.

For most Cybersource services, the response message includes a unique reconciliation ID that is assigned by Cybersource. For most payment processors, you can use this value to reconcile the transactions in your Cybersource 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

apInitiateService_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

apInitiateService_escrowAgreement

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.

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

apInitiateService_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

apInitiateService_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

apInitiateService_languageInterface

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

apInitiateService_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

apInitiateService_productName

Name of product.

Specifications

Data Type:
String

Data Length

Barclays: 35

Other processors: 255

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.

Chase Paymentech Solutions: Description

Elavon Americas: Item Description

FDC Compass: Description

FDC Nashville Global: Description

OmniPay Direct: Item Description

RBS WorldPay Atlanta: Description

TSYS Acquiring Solutions:

Mastercard: Item Description

Visa: Item Descriptor

Visa Platform Connect: productName

Worldpay VAP: itemDescription

apInitiateService_reconciliationID

Reference number for the transaction.

For most Cybersource services, the response message includes a unique reconciliation ID that is assigned by Cybersource. For most payment processors, you can use this value to reconcile the transactions in your Cybersource 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

apInitiateService_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

apInitiateService_run

Flag that specifies whether to include the initiate sale service in the request.

Possible values:

true

: Include the service in your request.

false

(default): Do not include the service in your request.

Specifications

Data Type:
String

Data Length:
5

Mapping Information

REST API Field:
No corresponding field. The service is requested with the endpoint:

https://api.cybersource.com/pts/v2/payments

SCMP API Field:

ics_applications=ics_ap_initiate

Simple Order API Field:

apInitiateService_run

apInitiateService_successURL

URL the customer is directed to after completing a payment.

Make a GET request to this URL.

Specifications

Data Type:
String

Data Length:
255

Mapping Information

REST API Field:

merchantInformation.successUrl

SCMP API Field:

ap_initiate_success_url

Simple Order API Field:

apInitiateService_successURL

apRevokeMandateService_run

Indicates whether to include the alternative payment method revoke mandate service
(apRevokeMandateService
) in the API request.

Possible values:

false

(default): Do not include the service in your request.

true

: Include the service in your request.

Specifications

Data Type:
String

Data Length:
5

Mapping Information

SCMP API Field and Value:

ics_applications

=ics_ap_revoke_mandate

Simple Order API Field:

apRevokeMandateService_run

apMandateStatusService_run

Indicates whether to include the alternative payment method check status service
(

apMandateStatusService

) in the API request.

Possible values:

false

(default): Do not include the service in your request.

true

: Include the service in your request.

Specifications

Data Type:
String

Data Length:
5

Mapping Information

SCMP API Field and Value:

ics_applications

=ics_ap_mandate_status

Simple Order API Field:

apMandateStatusService_run

apOptionsReply_count

The number of options requested from the processor.

Possible values:

1-250

Specifications

Data Type:
Integer

Data Length:
3

Mapping Information

REST API Field:
No corresponding field.

SCMP API Field:

ap_options_count

Simple Order API Field:

apOptionsReply_count

apOptionsReply_offset

Offset from the first item in the list of options received from the processor.

If you want to display the options in multiple lists, this number represents the first option displayed in each list. Possible values:

0-9999

Request example:
this example values display 10 options to the customer, starting with the first item on the list received from the processor.

<apOptionsService>
   <limit>10</limit>
   <offset>0</offset>
</apOptionsService>

Specifications

Data Type:
String

Data Length:
4

Mapping Information

REST API Field:
No corresponding field.

SCMP API Field:

ap_options_offset

Simple Order API Fields:

apOptionsReply_offset

apOptionsService_offset

apOptionsReply_option_#_id

Unique identifier associated with the option name.

Example:

option0=id:1^name:Currency
option1=id:2^name:USD
option2=id:3^name:Minimum Amount
option3=id:4^name:1.00
option4=id:5^name:Maximum Amount
option5=id:6^name:1000.00

Specifications

Data Type:
String

Data Length:
34

Mapping Information

REST API Field:
No corresponding field.

SCMP API Field:

ap_option#id

Simple Order API Field:

apOptionsReply_option_#_id

apOptionsReply_option_#_name

Name associated with the option ID.

Example:

option0=id:1^name:Currency
option1=id:2^name:USD
option2=id:3^name:Minimum Amount
option3=id:4^name:1.00
option4=id:5^name:Maximum Amount
option5=id:6^name:1000.00

Specifications

Data Type:
String

Data Length:
60

Mapping Information

REST API Field:
No corresponding field.

SCMP API Field:

ap_option#name

Simple Order API Field:

apOptionsReply_option_#_name

apOptionsReply_reasonCode

Numeric value that corresponds to the result of the options request.

Specifications

Data Type:
Integer

Data Length:
5

Mapping Information

REST API Field:
No corresponding field.

SCMP API Field:
No corresponding field.

Simple Order API Fields:

Offset from the first item in the list of options received from the processor.

If you want to display the options in multiple lists, this number represents the first option displayed in each list. Possible values:

0-9999

Request example:
this example values display 10 options to the customer, starting with the first item on the list received from the processor.

<apOptionsService>
   <limit>10</limit>
   <offset>0</offset>
</apOptionsService>

Specifications

Data Type:
String

Data Length:
4

Mapping Information

REST API Field:
No corresponding field.

SCMP API Field:

ap_options_offset

Simple Order API Fields:

apOptionsReply_offset

apOptionsService_offset

apOptionsService_run

Flag that specifies whether to include the capture service in the request.

Possible values:

true

: Include the capture service in the request.

false

(default): Do not include the capture service in the request.

Specifications

Data Type:
String

Data Length:
5

Mapping Information

REST API Field:
No corresponding field

SCMP API Field:
No corresponding field

Simple Order API Fields:

apOptionsService_run

apPaymentType

Three-digit value that indicates the payment type.

Possible value:

afp

: Afterpay and Clearpay

REST API Field:
No corresponding field.

SCMP API Field:

ap_refund_amount

Simple Order API Field:

apRefundReply_amount

apRefundReply_dateTime

Date and time when the service was requested.

Specifications

Data Type:
String

Data Length:
20

Mapping Information

REST API Field:
No corresponding field.

SCMP API Field:

ap_refund_date_time

Simple Order API Field:

apRefundReply_dateTime

apRefundReply_paymentStatus

Refund status returned from the payment processor.

REST API Field:
No corresponding field.

SCMP API Field:
No corresponding field.

Simple Order API Field:

apRefundReply_reasonCode

apRefundReply_reconciliationID

Reference number for the transaction.

You can use this value to reconcile Cybersource reports with processor reports.

This value is not returned for all processors.

Syntax

This syntax is used with this field:

dcc_referenceNumber=[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

Data Type:
String

Data Length:
26

Mapping Information

REST API Field:
No corresponding field. The service is requested with the

{id}

value in these endpoints:

Check Status:

https://api.cybersource.com/v2/status/{id}/refresh

Refund:

https://api.cybersource.com/v2/status/{id}/refunds

SCMP API Field:

ap_initiate_request_id

Simple Order API Fields:

apCheckStatusService_apInitiateRequestID

apRefundService_apInitiateRequestID

apRefundService_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

apRefundService_refundRequestID

Request ID of the sale or capture for which you are requesting the credit service.

Specifications

Data Type:
String

Data Length:
26

Mapping Information

REST API Field:
No corresponding field.

SCMP API Field:

ap_refund_request_id

Simple Order API Field:

apRefundService_refundRequestID

apRefundService_run

Flag that specifies whether to include the credit service in the request.

Possible values:

true

: Include the credit service in the request.

false

(default): Do not include the credit service in the request.

Specifications

Data Type:
String

Data Length:
5

Mapping Information

REST API Field:
No corresponding field. The service is requested with the endpoint:

https://api.cybersource.com/pts/v2/payments/{id}/refunds

SCMP API Field:

ics_applications

=ics_ap_refund

Simple Order API Field:

apRefundService_run

apReply_sellerProtection_eligibility

Indicates whether customer has seller protection enabled.

Possible values:

true

: Seller protection is enabled.

false

: Seller protection is not enabled.

Specifications

Specifications

Data Type:
Integer

Data Length:
5

Mapping Information

REST API Field:
No corresponding field.

Simple Order API Field:

apRevokeMandateReply_reasonCode

apRevokeMandateReply_responseCode

The processor response code that corresponds to the service status.

Specifications

Data Type:
Integer

Data Length:
5

Mapping Information

REST API Field:
No corresponding field.

Simple Order API Field:

apRevokeMandateReply_responseCode

apRevokeMandateReply_status

Data Length:
2048

Mapping Information

REST API Field:
No corresponding field

SCMP API Field:

ap_sale_merchant_url

Simple Order API Field:

apSaleReply_merchantURL

apSaleReply_paymentStatus

Sale status returned from the payment processor.

Possible values:

Pending

: Request received and waiting to be processed.

Refunded

: Sale successfully processed.

Failed

: Sale failed.

Specifications

Data Type:
String

Data Length:
15

Mapping Information

REST API Field:
No corresponding field.

SCMP API Field:

ap_sale_payment_status

Simple Order API Field:

apSaleReply_paymentStatus

apSaleReply_processorResponse

Code from the alternative payment processor that describes why the sale is pending or failed.

Specifications

Data Type:
String

Data Length:
5

Mapping Information

REST API Field:
No corresponding field

SCMP API Field:

ap_sale_processor_response

Simple Order API Field:

apSaleReply_processorResponse

apSaleReply_processorTransactionID

Processor transaction ID.

This value is a unique identifier for the transaction.

Specifications

Data Type:
String

Data Length:
50

Mapping Information

REST API Field:
No corresponding field.

SCMP API Field:

ap_sale_processor_transaction_id

Simple Order API Field:

apSaleReply_processorTransactionID

apSaleReply_reasonCode

Numeric value that corresponds to the result of the sale request.

Specifications

Data Type:
Integer

Data Length:
5

Mapping Information

REST API Field:
No corresponding field.

SCMP API Field:
No corresponding field.

Simple Order API Field:

apSaleReply_reasonCode

apSaleReply_reconciliationID

Reference number for the transaction.

You can use this value to reconcile Cybersource reports with processor reports.

This value is not returned for all processors.

Syntax

This syntax is used with this field:

dcc_referenceNumber=[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

Data Type:
String

Data Length:
8

Mapping Information

SCMP API Field:

ap_sale_date_collect

Simple Order API Field:

apSaleService_dateCollect

apSaleService_failureURL

URL to which the customer is directed after a payment fails.

Specifications

Data Type:
String

Data Length:
255

Mapping Information

REST API Field:
No corresponding field

SCMP API Field:

ap_sale_failure_url

Simple Order API Field:

apSaleService_failureURL

apSaleService_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

apSessionsReply_processorToken

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

apSaleService_run

Flag that specifies whether to include the sale service in the request.

Possible values:

true

: Include the sale service in the request.

false

(default): Do not include the sale service in the request.

Specifications

Data Type:
String

Data Length:
5

Mapping Information

REST API Field:
No corresponding field. The service is requested with the endpoint:

https://api.cybersource.com/pts/v2/payments

SCMP API Field:

ics_applications

=ics_ap_sale

Simple Order API Field:

apSaleService_run

apSaleService_successURL

The URL to which the customer is directed after completing the payment.

Specifications

Data Type:
String

Data Length:
255

Mapping Information

REST API Field:

merchantInformation.successUrl

SCMP API Field:

ap_sale_success_url

Simple Order API Field:

apSaleService_successURL

apSaleService_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

apSessionsService_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

apSessionsService_failureURL

Website URL that the customer is directed to after the payment fails.

Direct the customer to the alternative payment method URL that is included in the authorization response. If the payment fails, the alternative payment method directs the customer to this failure URL.

Specifications

Data Type:
String

Data Length:
255

Mapping Information

REST API Field:
No corresponding field.

SCMP API Field:

ap_sessions_failure_url

Simple Order API Field:

apSessionsService_failureURL

apSessionService_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

apSessionsService_run

Indicator for whether the sessions service is include in the request or not.

Possible values:

true

: Include the service in the request.

false

: Do not include the service in the request. This is the default value.

This field is for alternative payment method services.

Specifications

Data Type:
String

Data Length:
5

Mapping Information

REST API Field:
No corresponding field.

SCMP API Field:
No corresponding field.

Simple Order API Field:

apSessionsService_run

apSessionsService_sessionsRequestID

Request ID of the session that you want to update.

Set the value of this field to the value of the request ID that was returned in the new session response message.

Specifications

Data Type:
String

Data Length:
26

Mapping Information

REST API Field:
No corresponding field.

SCMP API Field:

ap_sessions_request_id

Simple Order API Field:

apSessionsService_sessionsRequestID

apSessionsService_sessionsType

Indicate whether the request is to create a new session or update an existing session. Possible values:

N

: Create a session. This is the default value.

U

: Update a session.

Specifications

Data Type:
String

Data Length:
5

Mapping Information

REST API Field:
No corresponding field.

SCMP API Field:

ap_sessions_type

Simple Order API Field:

apSessionsService_sessionsType

apSessionsService_successURL

Website URL that the customer is directed to after successfully completing a payment:

Direct the customer to the alternative payment method URL that is included in the authorization response. If the customer successfully completes the payment, the alternative payment method directs the customer to this success URL.

Specifications

Data Type:
String

Data Length:
255

Mapping Information

Data Length:
8

Mapping Information

REST API Field:
No corresponding field.

Simple Order API Field:

apMandateStatusReply_dateSigned

apMandateStatusReply_ dateTime

The date and time at which the service was requested.

Format:

YYYY-MM-DDThh:mm:ssZ

T

separates the date and the time.

REST API Field:
No corresponding field.

Simple Order API Field:

apMandateStatusReply_processorTransactionID

apMandateStatusReply_ reasonCode

The numeric value corresponding to the result of the mandate status service
(

apMandateStatusService

) request.

Specifications

Data Type:
Integer

Data Length:
5

Mapping Information

REST API Field:
No corresponding field.

Simple Order API Field:

apMandateStatusReply_reasonCode

apMandateStatusReply_ responseCode

The processor response code that corresponds to the status of the mandate status request.

Specifications

Data Type:
Integer

Data Length:
5

Mapping Information

REST API Field:
No corresponding field.

Simple Order API Field:

apMandateStatusReply_responseCode

apMandateStatusReply_ status

The mandate status from the processor.

Possible values:

ACTIVE

EXPIRED

FAILED

PENDING

REVOKED

Specifications

Data Type:
String

Data Length:
15

Mapping Information

REST API Field:
No corresponding field.

Simple Order API Field:

apMandateStatusReply_status

apUI_borderRadius

Radius for the corners of the borders displayed on the widget.

Format:: <val1>px<val2>px<val3>px<val4>px
Values:: <val1>
is the radius for the right top corner.; <val2>
is the radius for the left top corner.; <val3>
is the radius for the right bottom corner.; <val4>
is the radius for the left bottom corner.
Example:: 25px10px25px10px

Specifications

Data Type:
String

Data Length:
25

Mapping Information

REST API Field:
No corresponding field.

SCMP API Field:

ap_ui_border_radius

Simple Order API Field:

apUI_borderRadius

apUI_colorBorder

Color for the border of an area.

Use one of three supported formats:

Hex

Example:

#3333FF

Partial hex

Data Type:
String

Data Length:
10

Mapping Information

REST API Field:
No corresponding field.

SCMP API Field:

ap_ui_color_border_selected

Simple Order API Field:

apUI_colorBorderSelected

apUI_colorButton

Color for buttons.

Use one of three supported formats:

Hex

Example:

#3333FF

Partial hex

Data Type:
String

Data Length:
10

Mapping Information

REST API Field:
No corresponding field.

SCMP API Field:

ap_ui_color_button_text

Simple Order API Field:

apUI_colorButtonText

apUI_colorCheckboxCheckMark

Color for a selected check box.

Use one of three supported formats:

Hex

Example:

#3333FF

Partial hex

Data Type:
String

Data Length:
10

Mapping Information

REST API Field:
No corresponding field.

SCMP API Field:

ap_ui_color_checkbox

Simple Order API Field:

apUI_colorCheckBox

apUI_colorHeader

Color for headings.

Use one of three supported formats:

Hex

Example:

#3333FF

Partial hex

Data Type:
String

Data Length:
10

Mapping Information

REST API Field:
No corresponding field.

SCMP API Field:

ap_ui_color_link

Simple Order API Field:

apUI_colorLink

apUI_colorText

Color for text.

Use one of three supported formats:

Hex

Example:

#3333FF

Partial hex

Example:

#33F

Name

Example:

neon blue

Specifications

Data Type:
String

Data Length:
10

Mapping Information

REST API Field:
No corresponding field.

SCMP API Field:

ap_ui_color_text

Simple Order API Field:

apUI_colorText

apUI_theme

Name given for the UI theme.

Specifications

Data Type:
String

Data Length:
100

Mapping Information

REST API Field:
No corresponding field.

SCMP API Field:

ap_ui_theme

Simple Order API Field:

apUI_theme

apUpdateMandateReply_dateCreated

The date on which the mandate is updated.

Format:

YYYYMMDD

Specifications

Data Type:
Numerical string

Data Length:
8

Mapping Information

REST API Field:
No corresponding field.

Simple Order API Field:

apUpdateMandateReply_dateCreated

apUpdateMandateReply_dateSigned

The date on which the mandate is updated.

Format:

YYYYMMDD

Specifications

Data Type:
Numerical string

Data Length:
8

Mapping Information

REST API Field:
No corresponding field.

Simple Order API Field:

apUpdateMandateReply_dateSigned

apUpdateMandateReply_dateTime

The date and time at which the service was requested.

Format:

YYYY-MM-DDThh:mm:ssZ

T

separates the date and the time.

REST API Field:
No corresponding field.

Simple Order API Field:

apUpdateMandateReply_processorTransactionID

apUpdateMandateReply_reasonCode

The numeric value corresponding to the result from the update mandate service
(

apUpdateMandateService

) request.

Specifications

Data Type:
Integer

Data Length:
5

Mapping Information

REST API Field:
No corresponding field.

Simple Order API Field:

apUpdateMandateReply_reasonCode

apUpdateMandateReply_responseCode

The processor response code from the update mandate that corresponds to the service status.

Specifications

Data Type:
Integer

Data Length:
5

Mapping Information

REST API Field:
No corresponding field.

Simple Order API Field:

apUpdateMandateReply_responseCode

apUpdateMandateReply_riskScore

The risk score returned by the processor response.

Possible values:

0-10

A value of

10

indicates a high risk.

Specifications

Data Type:
String

Data Length:
25

Mapping Information

REST API Field:
No corresponding field.

Simple Order API Field:

apUpdateMandateReply_riskScore

apUpdateMandateReply_status

The update mandate status from the processor.

Possible values:

FAILED

PENDING

Specifications

Data Type:
xxxx

Data Length:
xx

Mapping Information

REST API Field:
No corresponding field.

Simple Order API Field:

apUpdateMandateReply_status

apUpdateMandateService_cancelURL

The URL to which the customer is directed if they cancel the signing of the mandate during the update.

Specifications

Data Type:
String

Data Length:
255

Mapping Information

SCMP API Field:

ap_update_mandate_cancel_url

Simple Order API Field:

apUpdateMandateService_cancelURL

apUpdateMandateService_esign

Indicates whether to return the URL for the customer to sign the mandate update.

Possible values:

false

(default): the URL for the customer to sign the mandate update is not included in the response.

true

: the URL for the customer to sign the mandate update is present in the response.

Specifications

Data Type:
String

Data Length:
5

Mapping Information

SCMP API Field:

ap_update_mandate_esign

Simple Order API Field:

apUpdateMandateService_esign

apUpdateMandateService_failureURL

The URL to which the customer is directed if they do not sign the mandate during the update.

Specifications

Data Type:
String

Data Length:
255

Mapping Information

SCMP API Field:

ap_update_mandate_failure_url

Simple Order API Field:

apUpdateMandateService_failureURL

apUpdateMandateService_run

Indicates whether to include the alternative payment method update mandate service
(

apUpdateMandateService

) in your request.

Possible values:

false

(default): Do not include the service in your request.

true

: Include the service in your request.

Specifications

Data Type:
String

Data Length:
5

Mapping Information

SCMP API Field and Value:

ics_applications

=ics_ap_update_mandate

Simple Order API Field:

apUpdateMandateService_run

apUpdateMandateService_successURL

The URL to which the customer is directed if they successfully sign the mandate during the update.

Specifications

Data Type:
String

Data Length:
255

Mapping Information

SCMP API Field:

ap_update_mandate_success_url

Simple Order API Field:

apUpdateMandateService_successURL

authenticationData_qualityIndicator

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.

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

authIndicator (response)

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 Visa Platform Connect:

0

: Preauthorization

1

: Final authorization

Visa Platform Connect

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

authIndicator (request)

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.
Visa Platform Connect: 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.

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

autoRentalData_adjustmentCost

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

autoRentalData_agreementNumber

This field value is the rental agency’s agreement (invoice) number. The rental company provides this number to the customer.

This number is used to trace information for any inquiries about transactions. This field is required for the authorization serviice with Visa, Mastercard, and American Express.

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:

Visa: 12

Mastercard and American Express: 9

Mapping

REST Field Name:

travelInformation.autoRental.agreementNumber

SCMP Field Name:

auto_rental_agreement_number

Simple Order Field Name:

autoRentalData_agreementNumber

autoRentalData_classCode

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

autoRentalData_companyId

This field value is the unique identifier of the corporation or entity that is renting the vehicle.

Specifications

Data Type:
String

Data Length:
12

Mapping

REST Field Name:

travelInformation.autoRental.companyId

SCMP Field Name:

auto_rental_company_id

Simple Order Field Name:

autoRentalData_companyId

autoRentalData_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

autoRentalData_dailyRate

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

autoRentalData_distanceUnit

SCMP Field Name:

auto_rental_extra_charge

Simple Order Field Name:

autoRentalData_extraCharge

autoRentalData_gasCost

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

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

Simple Order: String

Data Length:

SCMP: 1

Simple Order: 5

Mapping

REST Field Name:

travelInformation.autoRental.noShowIndicator

SCMP Field Name:

no_show

Simple Order Field Name:

autoRentalData_noShowIndicator

autoRentalData_odometerReading

This value is the odometer reading at the time the vehicle is rented.

Specifications

Data Type:
Number

Data Length:
8

Mapping

REST Field Name:

travelInformation.autoRental.odometerReading

SCMP Field Name:

auto_rental_odometer_reading

Simple Order Field Name:

autoRentalData_odometerReading

autoRentalData_oneWayCost

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

autoRentalData_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

autoRentalData_parkingViolationCost

This value is the amount incurred due to a parking violation.

This field is supported only for Visa.

Specifications

Data Type:
String

Data Length:
12

Mapping

REST Field Name:

travelInformation.autoRental.parkingViolationCharge

SCMP Field Name:

auto_rental_parking_violation_cost

Simple Order Field Name:

autoRentalData_parkingViolationCost

autoRentalData_phoneCharge

This value is the amount incurred for phone usage that was included on the total bill.

Specifications

Data Type:
String

Data Length:
12

Mapping

REST Field Name:

travelInformation.autoRental.phoneCharge

SCMP Field Name:

auto_rental_phone_charge

Simple Order Field Name:

autoRentalData_phoneCharge

autoRentalData_pickUpCity

This value is the city in which the vehicle was rented.

For the authorization service, this field is supported for Visa, Mastercard, and American Express.

For the capture service, this field is supported only for American Express.

Specifications

Data Type:
String

Data Length:
18

Mapping

REST Field Name:

travelInformation.autoRental.rentalAddress.city

SCMP Field Name:

auto_rental_pick_up_city

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

autoRentalData_pickUpTime

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

autoRentalData_programCode

This value identifies special circumstances that apply to the card transaction or cardholder, such as renter
or show
.

Specifications

Data Type:
String

Data Length:
2

Mapping

REST Field Name:

travelInformation.autoRental.programCode

SCMP Field Name:

auto_rental_program_code

Simple Order Field Name:

autoRentalData_programCode

autoRentalData_ratePerMile

This value indicates the rate charged for each mile.

This field is supported only for the capture service and only for Mastercard and American Express.

Mastercard: This field is required to get the best rate.

American Express: This field is optional but is recommended.

Specifications

Data Type:
String

Data Length:
25

Mapping

REST Field Name:

travelInformation.autoRental. ratePerMile

SCMP Field Name:

auto_rental_rate_per_mile

Simple Order Field Name:

autoRentalData_ratePerMile

autoRentalData_regularMileageCost

This field value is the amount charged in the contract for the miles that are traveled during the vehicle rental.

Use two decimal places when entering the charge.

Specifications

Data Type:
String

Data Length:
12

Mapping

REST Field Name:

travelInformation.autoRental.mileageCharge

SCMP Field Name:

auto_rental_regular_mileage_cost

Simple Order Field Name:

autoRentalData_regularMileageCost

autoRentalData_rentalAddress

This value is the street address of the vehicle rental agency.

Specifications

Data Type:
String

Data Length:
26

Mapping

REST Field Name:

travelInformation.autoRental.rentalAddress.address1

SCMP Field Name:

auto_rental_address

Simple Order Field Name:

autoRentalData_rentalAddress

autoRentalData_rentalLocationID

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

autoRentalData_returnCity

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

autoRentalData_renterName

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

autoRentalData_returnCountry

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

autoRentalData_returnDate

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

autoRentalData_returnLocation

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

autoRentalData_returnLocationId

This value is the agency code, address, and phone number, that identifies the location where the vehicle was returned. 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.returnAddress.locationId

SCMP Field Name:

auto_rental_return_location_id

Simple Order Field Name:

autoRentalData_returnLocationId

autoRentalData_returnState

This value is the state in which the vehicle was returned to the rental agency. 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.returnAddress.state

SCMP Field Name:

auto_rental_return_state

Simple Order Field Name:

autoRentalData_returnstate

autoRentalData_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

autoRentalData_taxAmount

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

autoRentalData_taxIndicator

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

autoRentalData_taxRate

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

autoRentalData_taxStatusIndicator

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

autoRentalData_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

autoRentalData_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

autoRentalData_timePeriod

auto_rental_vehicle_identification_number

Simple Order Field Name:

autoRentalData_vehicleIdentificationNumber

autoRentalData_vehicleInsuranceIndicator

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

Simple Order: String

SCMP: String

Data Length:

Simple Order: 5

SCMP: 1

Mapping

REST Field Name:

travelInformation.autoRental.insuranceIndicator

SCMP Field Name:

auto_rental_vehicle_insurance_indicator

Simple Order Field Name:

autoRentalData_vehicleInsuranceIndicator

autoRentalData_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

autoRentalData_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

autoRentalData_weeklyRentalRate

SCMP Field Name:

promotion_code

Simple Order Field Name:

autoRental_promotion_code

balanceInquiry

Flag that specifies whether to return balance information.

Possible values:

true

: Return balance information.

false

: Do not return balance information.

Specifications

Data Type: String

REST API Field:

paymentInformation.bank.branchCode

SCMP API Field:

branch_code

Simple Order API Field:

bankInfo_branchCode

bankInfo_city

City where the bank is located.

If you do not send this field, we presume the bank location is specified in the

billTo_city

field. Because some banks validate the bank account information, consider sending this field if the bank location is not specified in the

billTo_city

field.

Specifications

Data Type:
String

Data Length:
35

Mapping Information

REST API Field:

paymentInformation.bank.locality

SCMP API Field:

bank_city

Simple Order API Field:

bankInfo_city

bankInfo_country

Country where the bank is located.

Use the two-character ISO codes

listed in ISO Standard Currency Codes

. You can use this field only when scoring a direct debit transaction.

Specifications

Data Type:
String

Data Length:
2

Mapping Information

REST API Field:

paymentInformation.bank.country

SCMP API Field:

bank_country

Simple Order API Field:

bankInfo_country

bankInfo_name

Bank's name.

You can use this field only when scoring a direct debit transaction.

Specifications

Data Type:
String

Data Length:
40

Mapping Information

REST API Field:

paymentInformation.bank.name

SCMP API Field:

bank_name

Simple Order API Field:

bankInfo_name

bankInfo_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

Simple Order API Field:

bankInfo_swiftCode

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.

REST API Field:

orderInformation.billTo.alternatePhoneNumber

SCMP API Field:

customer_alternate_phone_number

Simple Order API Field:

billTo_alternatePhoneNumber

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

billTo_city

The city in the billing address.

This field is optional if your account is configured for relaxed requirements for address data.

For details about relaxed requirements, see the support article Relaxed Requirements for Address Data and Expiration Date in Credit Card Transactions.

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

billTo_companyCity

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

billTo_companyCountry

Two-digit ISO standard code for the country in the address of the company purchasing the product.

Use the two-character ISO country code.

See ISO Standard Country 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.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

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

billTo_companyName

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

billTo_companyPhoneNumber

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

billTo_companyPostalCode

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

billTo_companyState

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.

For more information, see State, Province, and Territory Codes for the United States and Canada.

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

billTo_companyStreet1

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

billTo_companyStreet2

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

billTo_companyTaxID

Tax identifier for the customer’s company.

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

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

billTo_personalID

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

billTo_personalID

field is sent to the processor and the

billTo_companyTaxID

field is ignored.

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

Record: CP07 TCR6

Position: 26-39

Field: Buyer ID

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: 26-39

Field: Buyer ID

Specifications

Data Type:
String

Data Length:
9

Mapping Information

REST API Field:

buyerInformation.companyTaxId

SCMP API Field:

bill_company_tax_id

Simple Order API Field:

billTo_companyTaxID

billTo_country

Country in the billing address.

Use the two-character ISO country code.

See ISO Standard Country Codes

.

This field is optional if your account is configured for relaxed requirements for address data.

For details about relaxed requirements, see the support article Relaxed Requirements for Address Data and Expiration Date in Credit Card Transactions.

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

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

billTo_customerID

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, Cybersource verifies these fields in the order given for a customer account ID value, and it uses d the first value it finds:
The
billTo_customerID
field value in the follow-on credit request.
The
billTo_customerID
field value that was used for the capture that is being credited.
The
billTo_customerID
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.

billTo_customerPassword

Customer's account password.

This value is for merchant velocity use only. It is not stored, displayed, or returned.

Do not add random strings of characters to passwords (salting) that are used with this field because that prevents accurate velocity tests.

Specifications

Data Type:
String

Data Length:
255

Mapping Information

REST API Field:

buyerInformation.hashedPassword

SCMP API Field:

customer_password

Simple Order API Field:

billTo_customerPassword

billTo_dateOfBirth

Date of birth of the customer in the format: YYYY-MM-DD or YYYYMMDD.

Specifications

Data Type:
String

Data Length:
10

Mapping Information

REST API Field:

buyerInformation.dateOfBirth

SCMP API Field:

date_of_birth

Simple Order API Field:

billTo_dateOfBirth

billTo_district

Customer’s neighborhood, community, or region (a barrio in Brazil) within the city or municipality.

Comercio Latino: Boleto Bancário payments
on 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

billTo_driversLicenseNumber

Cardholder’s driver's license number.

Specifications

Data Type:
String

Data Length:
40

Mapping Information

REST API Fields:

buyerInformation.personalIdentification.type=DRIVER_LICENSE

buyerInformation.personalIdentification.id

buyerInformation.personalIdentification.issuedBy

SCMP API Field:

customer_passport_number

Simple Order API Field:

billTo_passportNumber

billTo_email

Customer's email address, including full domain name.

Format: name@host.domain

This field is optional if your account is configured for relaxed requirements for address data.

For details about relaxed requirements, see the support article Relaxed Requirements for Address Data and Expiration Date in Credit Card Transactions.

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

billTo_firstName

The customer name.

Value should match value on card.

This field is optional if your account is configured for relaxed requirements for address data.

For details about relaxed requirements, see the support article Relaxed Requirements for Address Data and Expiration Date in Credit Card Transactions.

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

billTo_gender

The gender of the customer.

Specifications

Data Type:
String

Data Length:
10

Mapping

REST Field Name:

buyerInformation.gender

Simple Order Field Name:

billTo_gender

billTo_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

billTo_httpBrowserColorDepth

Indicates the bit depth of the color palette for displaying images, in bits per pixel.

Example
:

24

Specifications

Data Type:
String

Data Length:
2

Mapping Information

REST API Field:

deviceInformation.httpBrowserColorDepth

SCMP API Field:

http_browser_color_depth

Simple Order API Field:

billTo_httpBrowserColorDepth

billTo_httpBrowserCookiesAccepted

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

billTo_httpBrowserEmail

Email address set in the customer's browser, which may differ from

billTo_email

.

Specifications

Data Type:
String

Data Length:
100

Mapping Information

REST API Field:

deviceInformation.httpBrowserEmail

SCMP API Field:

http_browser_email

Simple Order API Field:

billTo_httpBrowserEmail

billTo_httpBrowserJavaEnabled

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

billTo_httpBrowserJavaScriptEnabled

Simple Order API Field:

billTo_httpBrowserTimeDifference

billTo_httpBrowserType

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

billTo_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

billTo_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

billTo_lastName

The last name of the person requesting the product.

This person may or may not be the cardholder.

This field is optional if your account is configured for relaxed requirements for address data.

For details about relaxed requirements, see the support article Relaxed Requirements for Address Data and Expiration Date in Credit Card Transactions.

American Express Direct: Combined, this field and
billTo_firstName
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

billTo_merchantTaxID

Merchant tax ID number.

Cielo: This field is available for aggregator authorizations.
Getnet: This field is available for aggregator authorizations. All characters must be numbers.
Rede: This field is available for aggregator authorizations.
Visa Platform Connect: This field is available for these types of payments:

Authorizations with Mastercard. The value for this field corresponds to the following data in the TC 33 capture file:
Record: CP12 TCR4
Position: 21–55
Field: Acceptor Tax ID
Authorizations with Mastercard in Argentina, Chile, and Paraguay. The value for this field corresponds to the following data in the TC 33 capture file:
Record: CP01 TCR8
Position: 110–124
Field: Merchant Tax ID
BNDES transactions in Brazil. The value for this field is your Cadastro Nacional da Pessoa Jurídica (CNPJ) number. The value for this field corresponds to the following data in the TC 33 capture file:
Record: CP07 TCR6
Position: 40–59
Field: BNDES Reference Field 1
Installment payments with Mastercard in Croatia. The value for this field corresponds to the following data in the TC 33 capture file:
Record: CP01 TCR5
Position: 79–98
Field: Mastercard Croatia Domestic Card Acceptor Tax ID

Specifications

Data Type:
String

Data Length:
15

Mapping Information

REST API Field:

merchantInformation.taxId

SCMP API Field:

bill_merchant_tax_id

Simple Order API Field:

billTo_merchantTaxID

billTo_middleName

The customer's middle name.

Specifications

Data Type:
String

Data Length:
40

Mapping Information

REST API Field:

orderInformation.billTo.middleName

SCMP API Field:

customer_middlename

Simple Order API Field:

billTo_middleName

billTo_passportCountry

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.

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)

billTo_passportNumber

Cardholder’s passport number.

Specifications

Data Type:
String

Data Length:
40

Mapping Information

REST API Fields:

buyerInformation.personalIdentification.type=PASSPORT_NUMBER

buyerInformation.personalIdentification.id

buyerInformation.personalIdentification.issuedBy

SCMP API Field:

customer_passport_number

Simple Order API Field:

billTo_passportNumber

billTo_personalID

Customer ID.

Cielo 3.0: Set this field to the Cadastro Nacional da Pessoa Jurídica (CNPJ) or Cadastro de Pessoas Fisicas (CPF).
Comercio Latino: Set this field to the Cadastro de Pessoas Fisicas (CPF).
Visa Platform Connect: This field is supported only for these services and processor connections:
BNDES transactions using Visa Platform Connect.
Installment payments using Visa Platform Connect for Mastercard payment cards issued in Brazil.
Payouts OCTs using Visa Platform Connect.

Set this field to the Cadastro de Pessoas Fisicas (CPF). The request must include this field or
billTo_companyTaxID
.

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

Record: CP07 TCR2
Position: 7-21
Field: Cardholder Tax ID

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: 26-39
Field: Buyer ID

Specifications

Data Type:
String

Data Length:

Cielo:
18

Comercio Latino:
18

All other processors:
26

Mapping Information

REST API Fields:

buyerInformation.personalIdentification.type=PERSONAL_ID

buyerInformation.personalIdentification.id

buyerInformation.personalIdentification.issuedBy

SCMP API Field:

personal_id

Simple Order API Field:

billTo_personalID

billTo_phoneNumber

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 Cybersource. 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

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

This field is optional if your account is configured for relaxed requirements for address data.

For details about relaxed requirements, see the support article Relaxed Requirements for Address Data and Expiration Date in Credit Card Transactions.

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:

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

billTo_prefix

Name prefix.

For example, Dr.

Specifications

Data Type:
String

Data Length:
4

Mapping Information

REST API Field:

orderInformation.billTo.namePrefix

SCMP API Field:

customer_prefix

Simple Order API Field:

billTo_prefix

billTo_ssn

Customer social security number.

This field is available only for the FDC Compass processor.

Specifications

Data Type:
Numeric

Data Length:
9

Mapping Information

REST API Field:
No corresponding field.

SCMP API Field:

customer_ssn

Simple Order API Field:

billTo_ssn

billTo_state

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 the US and Canada, see State, Province, and Territory Codes for the United States and Canada.

For all countries, use the ISO 3166-2 format when using this field for Payer Authentication.

This field is optional if your account is configured for relaxed requirements for address data.

For details about relaxed requirements, see the support article Relaxed Requirements for Address Data and Expiration Date in Credit Card Transactions.

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

billTo_street1

First line of the billing street address as it appears in the payment card issuer records.

This field is optional if your account is configured for relaxed requirements for address data.

For details about relaxed requirements, see the support article Relaxed Requirements for Address Data and Expiration Date in Credit Card Transactions.

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

billTo_street2

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

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

businessRules_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.

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

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

Cybersource Codes

In addition to standard Visa codes, Cybersource provides the following numeric codes:

Cybersource 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 `Cybersource` 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:
255

Mapping Information

REST API Field:

processingInformation.authorizationOptions.declineAvsFlags

SCMP API Field:

decline_avs_flags

Simple Order API Field:

businessRules_declineAVSFlags

businessRules_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

reason code value of

200

.

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

businessRules_declineAVSFlags

field is ignored.

Specifications

Data Type:
String

Data Length:
5

Mapping Information

REST API Field:

processingInformation.authorizationOptions.ignoreAvsResult

SCMP API Field:

ignore_avs

Simple Order API Field:

businessRules_ignoreAVSResult

businessRules_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

ccAuthReply_cvCode

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

businessRules_ignoreDAVResult

Enables other applications to continue processing the request if the

ics_dav

service cannot verify the address.

This field can contain one of the following values:

yes

: Ignore the results of address verification and continue to process the request.

no

: (default) If the

ics_dav

service cannot verify the address, stop processing the request.

Specifications

Data Type:
String

Data Length:
3

Mapping Information

REST API Field:
No corresponding field.

SCMP API Field:

ignore_dav_result

Simple Order API Field:

businessRules_ignoreDAVResult

businessRules_ignoreExportResult

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:
String

Data Length:
5

Mapping Information

REST API Field:

watchlistScreeningInformation.proceedOnMatch

SCMP API Field:

ignore_export_result

Simple Order API Field:

businessRules_ignoreExportResult

card_accountEncoderID

Identifier for the issuing bank that provided the customer’s encoded account number.

This field is available only on theChase Paymentech Solutions processor. Contact the processor to obtain the bank’s ID.

Specifications

Data Type:
String

Data Length:
3

Mapping Information

REST API Field:

paymentInformation.card.accountEncoderId

SCMP API Field:

account_encoder_id

Simple Order API Field:

card_accountEncoderID

card_accountNumber

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):

Data Type:
String with numbers only

Data Length:
19

Other Processors:

Data Type:
String with numbers only

Data Length:
20

Mapping Information

REST API Field:

paymentInformation.card.number

SCMP API Field:

customer_cc_number

Simple Order API Field:

card_accountNumber

card_bin

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

card_cardType

Three-digit value that indicates the card type. This field is required for the Payer Authentication Check Enrollment and Validation services.

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 Cybersource 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 Cybersource. 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

card_cvIndicator

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

card_cvNumber

field in the request.

1

(default): CVN service requested and supported. This default value is used when you include the

card_cvNumber

field in the request.

2

: CVN on payment card is illegible.

9

: CVN not imprinted on payment card.

Specifications

Data Type:
Nonnegative integer

Data Length:
1

Mapping Information

REST API Field:

paymentInformation.card.securityCodeIndicator

SCMP API Field:

customer_cc_cv_indicator

Simple Order API Field:

card_cvIndicator

card_cvNumber

Card verification number (CVN).

When enabling web browsers to auto-fill payment tokens, you must include

this 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

ccAuthReply_cvCode

or

ccAuthReply_cvCodeRaw

fields.

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

Specifications

Data Type:
String with numbers only

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

card_encryptedData

Payment card data that was encrypted by the POS terminal.

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

Credit Card Transactions: The encrypted data can be track data or keyed data and is in tag-length-value (TLV) format. A data set consists of encrypted data and the encryption attributes that are associated with the encrypted data. This field can contain multiple data sets.
PIN Debit Transactions: This field contains the PIN data, which is optional because some networks no longer require the PIN. Your agreement with the debit networks determines whether the customer must provide a PIN.

Specifications

Data Type:
String

Data Length:
255

Mapping Information

REST API Field:
No corresponding field.

SCMP API Field:

card_encrypted_data

Simple Order API Field:

card_encryptedData

card_expirationMonth

Two-digit month in which the payment card expires.

Format: MM

Possible values:

01

through

12

. Leading

0

is required.

This field is optional if your account is configured for relaxed requirements for expiration date.

For details about relaxed requirements, see the support article Relaxed Requirements for Address Data and Expiration Date in Credit Card Transactions

.

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 Cybersource to reject a request. However, an invalid expiration date might cause the issuer to reject a request.
Chase Paymentech Solutions: For encoded account numbers (
card_cardType
=
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

card_expirationYear

Four-digit year in which the payment card expires.

Format: yyyy

This field is optional if your account is configured for relaxed requirements for expiration date.

For details about relaxed requirements, see the support article Relaxed Requirements for Address Data and Expiration Date in Credit Card Transactions

.

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 Cybersource to reject a request. However, an invalid expiration date might cause the issuer to reject a request.
Chase Paymentech Solutions: For encoded account numbers (
card_cardType
=
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 Cybersource 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

card_hashedAccountNumber

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

card_issueNumber

paymentInformation.card.personalData

SCMP API Field:

card_personal_data

Simple Order API Field:

card_personalData

card_prepaidReloadable

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

card_prepaidType

Description for type of prepaid card.

This field is available only on theWorldpay VAP processor.

Examples:

GIFT

PAYROLL

GENERAL_PREPAID

Specifications

Data Type:
String

Data Length:
50

Mapping Information

REST API Field:
No corresponding field.

SCMP API Field:

card_prepaid_type

Simple Order API Field:

card_prepaidType

card_productName

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

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

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

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 Cybersource 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 Cybersource. 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

cardTypeSelectionIndicator

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

card_usage

Flag that specifies the type of account associated with the card.

This field is available only for China UnionPay, Cielo, Comercio Latino, eftpos, 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
card_usage
field is
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 Cybersource. 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

ccCreditService_overridePaymentMethod

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

card_virtual

Flag that indicates whether the card number corresponds to a virtual card number.

This field is available only on the Worldpay VAP processor.

Possible values:

true

: Card number corresponds to a virtual card number.

false

: Card number does not correspond to a virtual card number.

Specifications

Data Type:
String

Data Length:
5

Mapping Information

REST API Field:
No corresponding field.

SCMP API Field:

card_virtual

Simple Order API Field:

card_virtual

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

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 Cybersource. 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
purchaseTotals_grandTotalAmount
field.

Specifications

Data Type:
String

Data Length:

Authorization: 9

Authorization Reversal: 9

PIN Debit Purchase: 13

Mapping Information

Mapping Information

REST API Field:
No corresponding field.

SCMP API Field:

category_group

Simple Order API Field:

category_group

ccAuth_initiatorType

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:

sender_personalIDType

sender_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

ccAuthReply_accountBalance

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

ccAuthReply_accountBalanceCurrency

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

ccAuthReply_accountBalanceSign

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

ccAuthReply_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

ccAuthReply_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

ccAuthReply_amount

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

ccAuthReply_amountType

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

ccAuthReply_authFactorCode

Risk factor code from Smart Authorization.

This value consists of one or more codes separated by carets (^).

Possible values:

J

: Billing and shipping address do not match.

M

: Cost of the order exceeds the maximum transaction amount.

N

: Nonsensical input in the customer name or address fields.

O

: Obscenities in the order form.

U

: Unverifiable billing or shipping address.

X

: Order does not comply with the USA PATRIOT Act.

Specifications

Type:
String

Length:
100

Mapping Information

REST API Field:
No corresponding field.

SCMP API Field:
No corresponding field.

Simple Order API Field:

ccAuthReply_authFactorCode

ccAuthReply_authorizationCode

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

ccAuthReply_authorizedDateTime

Time when the service was requested in Coordinated Universal Time (UTC).

Specifications

Type:
Date and time

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

ccAuthReply_avsCode

Code returned by the Address Verification Service (AVS) during authorization.

See AVS Codes

.

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

ccAuthReply_avsCodeRaw

AVS result code sent directly from the processor.

This field is returned only when the processor sends this value.

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

ccAuthReply_cardCategory

Card type category.

GPN: Visa or Mastercard product ID.
Visa Platform Connect: Visa product ID.
RBS WorldPay Atlanta: 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.
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

RBS WorldPay Atlanta: 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

ccAuthReply_cardCommercial

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

ccAuthReply_cardGroup

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

ccAuthReply_cardHealthcare

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

ccAuthReply_cardIssuerCountry

Country where the card was issued.

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

Use two-character ISO Standard Country Codes.

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

ccAuthReply_cardLevel3Eligible

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

ccAuthReply_cardPayroll

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

ccAuthReply_cardPINlessDebit

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

ccAuthReply_cardPrepaid

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

ccAuthReply_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 Visa Platform Connect, HSBC, and Streamline processors.

Set the value for this field to the value for the

ccAuthReply_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

paymentNetworkTransactionInformation

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

ccAuthReply_cardRegulated

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

ccAuthReply_cardSignatureDebit

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

ccAuthReply_cavvResponseCode

Mapped response code for American Express SafeKey, RuPay PaySecure, or Visa Secure.

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. 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

ccAuthReply_cavvResponseCodeRaw

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

ccAuthReply_cvCode

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

ccAuthReply_cvCodeRaw

CVN result code sent directly from the processor.

This field is returned only when the processor sends this value.

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

ccAuthReply_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.

REST API Field:

processorInformation.electronicVerificationResults.emailRaw

SCMP API Field:

auth_ev_email_raw

Simple Order API Field:

ccAuthReply_evEmailRaw

ccAuthReply_evFirstName

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

ccAuthReply_evFirstNameRaw

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

ccAuthReply_evLastName

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

ccAuthReply_evLastNameRaw

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

ccAuthReply_evMiddleName

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

ccAuthReply_evMiddleNameRaw

Raw electronic verification response code from the processor for the customer’s middle name.

REST API Field:

processorInformation.electronicVerificationResults.streetRaw

SCMP API Field:

auth_ev_street_raw

Simple Order API Field:

ccAuthReply_evStreetRaw

ccAuthReply_forwardCode

Name of the Japanese acquirer that processed the transaction.

This field is only returned by the JCN Gateway processor.

Contact the Cybersource 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

ccAuthReply_issuerPINrequest

Value of

1

in this field indicates that the issuer requires a PIN.

When you request an authorization for a card-present transaction but do not include a PIN in the request, the issuer can require the PIN. To complete the authorization:

Request a PIN from the customer.

Send a duplicate authorization request that includes the PIN and the

emvRequest_repeat

field.

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

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:
No corresponding field.

SCMP API Field:

issuer_pin_request

Simple Order API Field:

ccAuthReply_issuerPINrequest

ccAuthReply_merchantAdviceCode

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.

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.

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 Barclays processor:

00

: No information, or response not provided.

01

: Updated or additional information needed.

02

: Cannot approve at this time; try again later.

03

: Do not try again.

05

: Payment blocked by card scheme.

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

ccAuthReply_merchantAdviceCodeRaw

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 Barclays processor:

0

: No information, or response not provided.

1

: Updated or additional information needed.

2

: Cannot approve at this time; try again later.

4

: Do not try again.

8

: Payment blocked by card scheme.

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

ccAuthReply_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

billTo_lastName

field. The authorization request should include these additional request fields if the information is available:

billTo_firstName

billTo_lastName

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

Simple Order API Field:

ccAuthReply_nameMatch

ccAuthReply_ownerMerchantID

Merchant ID that was used to create the subscription or token for which the service was requested.

Specifications

Data Type:
String

Data Length:
30

Mapping Information

REST API Field:
No corresponding field.

SCMP API Field:

auth_owner_merchant_id

Simple Order API Field:

ccAuthReply_ownerMerchantID

ccAuthReply_partialPANandIBAN

Partial primary account number (PAN) and International Bank Account Number (IBAN).

The issuer provides the value for this field, which consists of four digits of the PAN and seven digits of the IBAN.

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

Specifications

Data Type:
String

Data Length:
11

Mapping Information

REST API Field:
No corresponding field.

SCMP API Field:

partial_pan_and_iban

Simple Order API Field:

ccAuthReply_partialPANandIBAN

ccAuthReply_paymentCardService

Mastercard service that was used for the transaction.

Mastercard provides this value to Cybersource.

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 Cybersource. 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

ccAuthReply_paymentCardServiceResult

Result of the Mastercard card-on-file token service.

Mastercard provides this value to Cybersource.

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

ccAuthReply_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

ccAuthReply_paymentInsightsInformation_ responseInsightsCategory

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

ccAuthReply_paymentInsightsInformation_ responseInsightsCategoryCode

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

ccAuthReply_paymentNetworkTransactionID

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 Cybersource, Cybersource passes this value from the authorization service to the subsequent services for you. However, when you perform authorizations through Cybersource 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

ccAuthReply_personalIDCode

Personal identifier result.

If you included

billTo_personalID

in the request, this value indicates whether

billTo_personalID

matched a value in a record on file.

Possible values:

Y: Match

N: No match

K: Not supported

U: Unknown

Z: No response returned

This field is available only for Rede card in Brazil for the Cybersource Latin American Processing processor. It is returned only when the personal ID result is returned by the processor.

Cybersource Latin American Processing is the name of a specific processing connection. Cybersource Latin American Processing
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 Cybersource Latin American Processing. It is not for any other Latin American processors.

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

processorInformation.customer.personalIDResult

SCMP API Field:

auth_personal_id_result

Simple Order API Field:

ccAuthReply_personalIDCode

ccAuthReply_posData

Point-of-sale details for the transaction.

This field enables you to comply with American Express CAPN requirements.

Cybersource 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 Cybersource, Cybersource passes this value from the authorization service to the subsequent services for you. However, when you perform authorizations through Cybersource 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 Cybersource uses a default value. Cybersource 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

ccAuthReply_processorResponse

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.

Do not use this field to evaluate the result of the request.

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
additionalProcessorResponse
Simple Order 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 a decline reason code in the
ccAuthReply_merchantAdviceCode
Simple Order API field.

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

ccAuthReply_processorTransactionID

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 Cybersource, Cybersource passes this value from the authorization service to the subsequent services for you. However, when you perform authorizations through Cybersource 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

ccAuthReply_reasonCode

Numeric value that corresponds to the result of the authorization request.

Specifications

Data Type:
Integer

Data Length:
5

Mapping Information

REST API Field:
No corresponding field.

SCMP API Field:
No corresponding field.

Simple Order API Field:

ccAuthReply_reasonCode

ccAuthReply_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

ccAuthReply_reconciliationReferenceNumber

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

ccAuthReply_referralResponseNumber

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

ccAuthReply_requestAmount

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

.

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.

Barclays: Line Item Total

Chase Paymentech Solutions: Does not apply

FDC Compass: Does not apply

FDC Nashville Global: Does not apply

OmniPay Direct: Line Item Total

RBS WorldPay Atlanta: Amount

TSYS Acquiring Solutions: Does not apply

ccAuthReply_requestCurrency

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.

For partial authorizations, the

ccAuthReply_requestCurrency

field returns the currency code.

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:
5

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

ccAuthReply_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 Cybersource, Cybersource passes this value from the authorization service to the subsequent services for you. However, when you perform authorizations through Cybersource 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

ccAuthReply_transactionIntegrity

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

: Unclassified.

For information about these values, contact Mastercard or your acquirer.

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

Record: CP01 TCR6

Position: 136-137

Field: Mastercard Transaction Integrity Classification

Specifications

Data Type:
String

Data Length:
2

Mapping Information

REST API Field:

processorInformation.transactionIntegrityCode

SCMP API Field:

auth_transaction_integrity

Simple Order API Field:

ccAuthReply_transactionIntegrity

ccAuthReply_transactionQualification

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 Cybersource.

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 Cybersource. 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

ccAuthReversalReply_amount

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

ccAuthReversalReply_authorizationCode

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

ccAuthReversalReply_forwardCode

Name of the Japanese acquirer that processed the transaction.

This field is only returned by the JCN Gateway processor.

Contact the Cybersource 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

ccAuthReversalReply_paymentCardService

Mastercard service that was used for the transaction.

Mastercard provides this value to Cybersource.

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 Cybersource. 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

ccAuthReversalReply_paymentCardServiceResult

Result of the Mastercard card-on-file token service.

Mastercard provides this value to Cybersource.

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

ccAuthReversalReply_processorResponse

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.

Do not use this field to evaluate the result of the request.

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
additionalProcessorResponse
Simple Order 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 a decline reason code in the
ccAuthReply_merchantAdviceCode
Simple Order API field.

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

ccAuthReversalReply_processorTransactionID

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 Cybersource, Cybersource passes this value from the authorization service to the subsequent services for you. However, when you perform authorizations through Cybersource 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

ccAuthReversalReply_reasonCode

Numeric value that corresponds to the result of the authorization reversal request.

This field is available only on the FDC Compass processor.

Specifications

Data Type:
Integer

Data Length:
5

Mapping Information

REST API Field:
No corresponding field.

SCMP API Field:
No corresponding field.

Simple Order API Field:

ccAuthReversalReply_reasonCode

ccAuthReversalReply_reconciliationID

Reference number for the transaction.

You can use this value to reconcile Cybersource reports with processor reports.

This value is not returned for all processors.

Syntax

This syntax is used with this field:

dcc_referenceNumber=[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

ccAuthReversalReply_requestDateTime

Time when the service was requested in Coordinated Universal Time (UTC).

Specifications

Type:
Date and time

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

ccAuthReversalService_authRequestID

Request ID of the authorization for which you are requesting this service.

Specifications

Data Type:
String

Data Length:
26

Mapping Information

REST API Field:
No corresponding field.

SCMP API Field:

auth_request_id

Simple Order API Fields:

ccAuthReversalService_authRequestID

ccCaptureService_authRequestID

ccCheckStatusService_authRequestID

ccIncrementalAuthService_authRequestID

ccAuthReversalService_authRequestToken

Request token for the authorization for which you are requesting this service.

This value is an encoded string that contains no confidential information, such as an account number or card verification number.

Specifications

Data Type:
String

Data Length:
256

Mapping Information

REST API Field:
No corresponding API field.

SCMP API Field:

auth_request_token

Simple Order API Fields:

ccAuthReversalService_authRequestToken

ccCaptureService_authRequestToken

ccAuthReversalService_gratuityAmount

Gratuity or tip amount for restaurants when the card is present.

Allowed only when the

ccCaptureService_industryDatatype

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

ccAuthReversalService_reversalReason

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

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

ccAuthService_acsServerTransactionID

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

payerAuthEnrollReply_acsTransactionID

or

payerAuthValidateReply_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

ccAuthService_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 Cybersource. 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.aggregatedAuthIndicator

SCMP API Field:

aggregated_auth_indicator

Simple Order API Field:

ccAuthService_aggregatedAuthIndicator

ccAuthService_aggregatorCity

The city name of the payment facilitator.

This field is applicable to the Visa card type.

Specifications

Data Type:
String

Data Length:
50

Mapping Information

REST API Field:

aggregatorInformation.city

SCMP API Field:

aggregator_city

Simple Order API Fields:

ccAuthService_aggregatorCity

octService_aggregatorCity

ccAuthService_aggregatorCountry

The country 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.country

SCMP API Field:

aggregator_country

Simple Order API Fields:

ccAuthService_aggregatorCountry

octService_aggregatorCountry

ccAuthService_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.; The
ccCreditService_aggregatorID
field is optional in a request for an AFT with aggregator support. The
octService_aggregatorID
field is optional in a request for 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

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

All other processors:
20

Mapping Information

REST API Field:

aggregatorInformation.aggregatorId

SCMP API Field:

aggregator_id

Simple Order API Fields:

ccAuthService_aggregatorID

ccCaptureService_aggregatorID

ccCreditService_aggregatorID

octService_aggregatorID

(for Chase Paymentech Solutions)

ccAuthService_aggregatorName

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

Data Length:
99

Mapping Information

REST API Field:

aggregatorInformation.streetAddress

SCMP API Field:

aggregator_streetAddress

Simple Order API Fields:

ccAuthService_aggregatorStreetAddress

octService_aggregatorStreetAddress

ccAuthService_ 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

ccAuthService_ 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 Cybersource system but then capture the order through Cybersource. 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 Cybersource, 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

ccAuthService_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:
String

Data Length:
5

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

ccAuthService_captureDate

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

ccAuthService_cardholderVerificationMethod

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 Cybersource 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

ccAuthService_cardProductSubtype

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

ccAuthService_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 Visa Platform Connect, HSBC, and Streamline processors.

Set the value for this field to the value for the

ccAuthReply_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

paymentNetworkTransactionInformation

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

ccAuthService_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

ccAuthService_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

payerAuthValidateReply_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
ccAuthService_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

ccAuthService_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.

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

payerAuthValidateReply_cavvAlgorithm

response field.

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

ccAuthService_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
: Cybersource software timed out.

When you request the payer authentication and authorization services separately, get the value for this field from the
payerAuthEnrollReply_challengeCancelCode
or
payerAuthValidateReply_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

ccAuthService_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 ccAuthService_networkTokenCryptogram 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 `Visa Platform Connect` 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.
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
payerAuthValidateReply_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

ccAuthService_consumerBillPayment

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
recipient_accountType
value must be either
01
,
02
,
03
or
06
.
FT
: Funds transfer where OCT not available. The
recipient_accountType
value must be either
00
,
01
,
02
,
03
or
06
.
PD
: Payroll disbursement. The
recipient_accountType
value must be
03
.
TU
: Top Up: Prepaid load. The
recipient_accountType
value must be either
01
,
02
,
03
or
06
.
WT
: Wallet transfer. The
recipient_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

ccAuthService_cryptocurrencyPurchase

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

ccAuthService_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 Cybersource. 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

ccAuthService_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 Cybersource. 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.deferredAuthIndicator

SCMP API Field:

auth_deferred_auth_indicator

Simple Order API Field:

ccAuthService_deferredAuthIndicator

ccAuthService_ 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

ccAuthService_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

issuer_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

ccAuthService_ 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

ccAuthService_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

issuer_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

ccAuthService_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

payerAuthEnrollReply_directoryServerTransactionID

or

payerAuthValidateReply_directoryServerTransactionID

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 Cybersource. 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

ccAuthService_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

payerAuthEnrollReply_dsReferenceNumber

or

payerAuthValidateReply_dsReferenceNumber

response field.

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

ccAuthService_duration

Number of days of the auto rental or lodging rental.

Auto rental: This field is supported for Visa, Mastercard, and American Express.
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
.; 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

ccAuthService_eciRaw

Raw electronic commerce indicator (ECI).

The field is absent if authentication fails.

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

payerAuthValidateReply_eciRaw

response field.

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

ccAuthService_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

payerAuthEnrollReply_effectiveAuthenticationType

or

payerAuthValidateReply_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

ccAuthService_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

ccAuthService_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 Cybersource. 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.extendAuthIndicator

SCMP API Field:

auth_extend_auth_indicator

Simple Order API Field:

ccAuthService_extendAuthIndicator

ccAuthService_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

ccAuthService_gratuityAmount

Gratuity or tip amount for restaurants when the card is present.

Allowed only when the

ccCaptureService_industryDatatype

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

ccAuthService_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

ccAuthService_initiatorType

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:

sender_personalIDType

sender_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

ccAuthService_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:

true

: Request that the processor use least-cost routing for the transaction

false

(default): Do not request that the processor use least-cost routing for the transaction

Specifications

Data Type:
String

Data Length:
5

Mapping Information

REST API Field:

processingInformation.leastCostRouting

SCMP API Field:

auth_least_cost_routing

Simple Order API Field:

ccAuthService_leastCostRouting

ccAuthService_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

ccAuthService_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

ccAuthService_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

ccAuthService_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, Cybersource 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, Cybersource 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

ccAuthService_networkTokenCryptogram

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.

Specifications

Data Type:
String

Data Length:
40

Mapping Information

REST API Field:

paymentinformation.tokenizedCard.cryptogram

SCMP API Field:

network_token_cryptogram

Simple Order API Field:

ccAuthService_networkTokenCryptogram

ccAuthService_overridePaymentDetails

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

ccAuthService_overridePaymentMethod

or

ccCreditService_overridePaymentMethod

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

ccAuthService_overridePaymentMethod

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
card_usage
field is
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 Cybersource. 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

ccCreditService_overridePaymentMethod

is set to the value of

CR

or

DB

and there is a value in the

ccCreditService_overridePaymentMethod

field, the value in the

ccCreditService_overridePaymentMethod

field takes precedence.

If

ccCreditService_overridePaymentMethod

is set to

CR/DB

and there is a value in the

ccCreditService_overridePaymentMethod

field, the value in the

ccCreditService_overridePaymentMethod

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

ccAuthService_paAuthenticationDate

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

ccAuthService_paChallengeCode

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 Cybersource 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

.

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

payerAuthEnrollService_challengeCode

request field.

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

ccAuthService_paNetworkScore

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

payerAuthEnrollReply_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

ccAuthService_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

ccAuthService_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

ccAuthService_paresStatusReason

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

payerAuthEnrollReply_authenticationStatusReason

or

payerAuthValidateReply_authenticationStatusReason

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

ccAuthService_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

ccAuthService_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

ccAuthService_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

ccAuthService_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

ccAuthService_run

Flag that specifies whether to include the authorization service in the request.

Possible values:

true

: Include the authorization service in the request.

false

(default): Do not include the authorization service in the request.

Specifications

Data Type:
String

Data Length:
5

Mapping Information

REST API Field:
No corresponding field.

SCMP API Field:
No corresponding field.

Simple Order API Field:

ccAuthService_run

ccAuthService_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

ccAuthService_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:
String

Data Length:
5

Mapping Information

REST API Field:

processingInformation.authorizationOptions.splitPaymentTransaction

SCMP API Field:

split_payment_transaction

Simple Order API Field:

ccAuthService_splitPaymentTransaction

ccAuthService_threeDSServerTransactionID

Unique transaction identifier assigned by the 3-D Secure server to identify a single transaction.

Specifications

Data Type:
String

Data Length:
36

Mapping Information

REST API Field:

consumerAuthenticationInformation. threeDSServerTransactionId

SCMP API Field:

pa_three_ds_server_transaction_id

Simple Order API Fields:

ccAuthService_threeDSServerTransactionID

payerAuthEnrollReply_threeDSServerTransactionID

payerAuthValidateReply_threeDSServerTransactionID

ccAuthService_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

ccAuthService_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 Cybersource. 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

ccAuthService_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

ccAuthService_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

ccAuthService_veresEnrolled

Verification response enrollment status.

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

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

payerAuthEnrollReply_veresEnrolled

response field.

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

ccAuthService_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

ccAuthService_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.

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

payerAuthValidateReply_xid

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. 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

ccCaptureReply_amount

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

.

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.

Barclays: Line Item Total

Chase Paymentech Solutions: Does not apply

FDC Compass: Does not apply

FDC Nashville Global: Does not apply

OmniPay Direct: Line Item Total

RBS WorldPay Atlanta: Amount

TSYS Acquiring Solutions: Does not apply

ccCaptureReply_processorTransactionID

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 Cybersource, Cybersource passes this value from the authorization service to the subsequent services for you. However, when you perform authorizations through Cybersource 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

ccCaptureReply_reasonCode

Numeric value that corresponds to the result of the capture request.

Specifications

Data Type:
Integer

Data Length:
5

Mapping Information

REST API Field:
No corresponding field.

SCMP API Field:
No corresponding field.

Simple Order API Field:

ccCaptureReply_reasonCode

ccCaptureReply_reconciliationID

Reference number for the transaction.

You can use this value to reconcile Cybersource reports with processor reports.

This value is not returned for all processors.

Syntax

This syntax is used with this field:

dcc_referenceNumber=[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

ccCaptureReply_reconciliationReferenceNumber

Unique number that Cybersource generates to identify the transaction.

Specifications

Data Type:
String

Data Length:
20

Mapping Information

REST API Field:
No corresponding field.

SCMP API Field:

bill_reconciliation_reference_number

Simple Order API Field:

ccCaptureReply_reconciliationReferenceNumber

ccCaptureReply_requestDateTime

Time when the service was requested in Coordinated Universal Time (UTC).

Specifications

Type:
Date and time

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

ccCaptureService_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.; The
ccCreditService_aggregatorID
field is optional in a request for an AFT with aggregator support. The
octService_aggregatorID
field is optional in a request for 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

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

All other processors:
20

Mapping Information

REST API Field:

aggregatorInformation.aggregatorId

SCMP API Field:

aggregator_id

Simple Order API Fields:

ccAuthService_aggregatorID

ccCaptureService_aggregatorID

ccCreditService_aggregatorID

octService_aggregatorID

(for Chase Paymentech Solutions)

ccCaptureService_aggregatorName

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

ccCaptureService_authRequestID

Request ID of the authorization for which you are requesting this service.

Specifications

Data Type:
String

Data Length:
26

Mapping Information

REST API Field:
No corresponding field.

SCMP API Field:

auth_request_id

Simple Order API Fields:

ccAuthReversalService_authRequestID

ccCaptureService_authRequestID

ccCheckStatusService_authRequestID

ccIncrementalAuthService_authRequestID

ccCaptureService_authRequestToken

Request token for the authorization for which you are requesting this service.

This value is an encoded string that contains no confidential information, such as an account number or card verification number.

Specifications

Data Type:
String

Data Length:
256

Mapping Information

REST API Field:
No corresponding API field.

SCMP API Field:

auth_request_token

Simple Order API Fields:

ccAuthReversalService_authRequestToken

ccCaptureService_authRequestToken

ccCaptureService_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 Cybersource system but then capture the order through Cybersource. 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 Cybersource, 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

ccCaptureService_dpdeBillingMonth

Dynamic payment descriptor extension (DPDE) that specifies the month for which you are billing the customer.

This field is available only on the JCN Gateway processor and is not available for all Japanese acquirers.

Depending on your business model, you might bill for a service that has already been provided, such as a telephone service, or you might bill for a service that is going to be provided, such as a subscription to investment information. This value lets the customer know which month the payment is for.

Specifications

Field Type:
Request

Data Type:
String

Data Length:
4

Mapping Information

REST API Field:
No corresponding field.

SCMP API Field:

dpde_billing_month

Simple Order API Fields:

ccCaptureService_dpdeBillingMonth

ccCreditService_dpdeBillingMonth

ccCaptureService_gratuityAmount

Gratuity or tip amount for restaurants when the card is present.

Allowed only when the

ccCaptureService_industryDatatype

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

ccCaptureService_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

ccCaptureService_posData

Point-of-sale details for the transaction.

This field enables you to comply with American Express CAPN requirements.

Cybersource 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 Cybersource, Cybersource passes this value from the authorization service to the subsequent services for you. However, when you perform authorizations through Cybersource 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 Cybersource uses a default value. Cybersource 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

ccCaptureService_purchasingLevel

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, RBS WorldPay Atlanta, 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.

ccCaptureService_reconciliationIDAlternative

Alternative reference number that can be up to 12 characters in length.

If this field is used, it overrides any data added to the

ccCaptureService_reconciliationID

field.

You can use this value to reconcile Cybersource reports with processor reports.

The syntax must conform to this regular expression:

[a-zA-Z0-9]

Specifications

Data Type:
String

Data Length:
12

Mapping Information

REST API Field:

No corresponding field.

SCMP API Field:

No corresponding field.

Simple Order API Fields:

ccCaptureService_reconciliationIDAlternative

ccCreditService_reconciliationIDAlternative

ccCaptureService_reconciliationID

Reference number for the transaction.

You can use this value to reconcile Cybersource reports with processor reports.

This value is not returned for all processors.

Syntax

This syntax is used with this field:

dcc_referenceNumber=[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

ccCaptureService_run

Flag that specifies whether to include the capture service in the request.

Possible values:

true

: Include the capture service in the request.

false

(default): Do not include the capture service in the request.

Specifications

Data Type:
String

Data Length:
5

Mapping Information

REST API Field:
No corresponding field.

SCMP API Field:
No corresponding field.

Simple Order API Field:

ccCaptureService_run

ccCaptureService_sequence

Capture number when requesting multiple partial captures for one authorization.

This value is used along with

ccCaptureService_totalCount

to track which capture is being processed.

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

ccCaptureService_sequence=2
ccCaptureService_totalCount=5

Visa Platform Connect

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

ccCaptureService_totalCount

Total number of captures when requesting multiple partial captures for one authorization.

This value is used along with

ccCaptureService_sequence

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

ccCaptureService_sequence

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:

ccCaptureService_sequence=2
ccCaptureService_totalCount=5

Visa Platform Connect

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

ccCaptureService_transactionID

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 Cybersource 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

ccCaptureService_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

ccCheckStatusReply_authorizationCode

Authorization code.

This field is returned only when the payment status is

AUTHORIZED

.

This field is available only for the RuPay processor.

Specifications

Data Type:
String

Data Length:
6

Mapping Information

REST API Field:
No corresponding field.

SCMP API Field:

check_status_auth_code

Simple Order API Field:

ccCheckStatusReply_authorizationCode

ccCheckStatusReply_paymentStatus

Authorization status.

Possible values:

AUTHORIZED

: Payment was authorized.

DECLINED

: Authorization request was declined.

Specifications

Data Type:
String

Data Length:
20

Mapping Information

REST API Field:
No corresponding field.

SCMP API Field:

check_status_payment_status

Simple Order API Field:

ccCheckStatusReply_paymentStatus

ccCheckStatusReply_reasonCode

Numeric value that corresponds to the result of the check status request.

Specifications

Data Type:
Integer

Data Length:
5

Mapping Information

REST API Field:
No corresponding field.

SCMP API Field:
No corresponding field.

Simple Order API Field:

ccCheckStatusReply_reasonCode

ccCheckStatusService_authRequestID

Request ID of the authorization for which you are requesting this service.

Specifications

Data Type:
String

Data Length:
26

Mapping Information

REST API Field:
No corresponding field.

SCMP API Field:

auth_request_id

Simple Order API Fields:

ccAuthReversalService_authRequestID

ccCaptureService_authRequestID

ccCheckStatusService_authRequestID

ccIncrementalAuthService_authRequestID

ccCheckStatusService_run

Flag that specifies whether to include the check status service in the request.

Possible values:

true

: Include the check status service in the request.

false

(default): Do not include the check status service in the request.

Specifications

Data Type:
String

Data Length:
5

Mapping Information

REST API Field:
No corresponding field.

SCMP API Field:
No corresponding field.

Simple Order API Field:

ccCheckStatusService_run

ccCreditReply_amount

Amount refunded to the cardholder.

Specifications

Data Type:
Decimal

Data Length:
15

Mapping Information

REST API Fields:

creditAmountDetails.creditAmount

refundAmountDetails.refundAmount

SCMP API Field:

credit_credit_amount

Simple Order API Field:

ccCreditReply_amount

ccCreditReply_authorizationCode

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

ccCreditReply_enhancedDataEnabled

Flag returned by Cybersource 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

ccCreditReply_forwardCode

Name of the Japanese acquirer that processed the transaction.

This field is only returned by the JCN Gateway processor.

Contact the Cybersource 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

ccCreditReply_ownerMerchantID

Merchant ID that was used to create the subscription or token for which the service was requested.

Specifications

Data Type:
String

Data Length:
30

Mapping Information

REST API Field:
No corresponding field.

SCMP API Field:

credit_owner_merchant_id

Simple Order API Field:

ccCreditReply_ownerMerchantID

ccCreditReply_paymentNetworkTransactionID

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

ccCreditReply_processorResponse

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.

Do not use this field to evaluate the result of the request.

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
additionalProcessorResponse
Simple Order 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 a decline reason code in the
ccAuthReply_merchantAdviceCode
Simple Order API field.

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

ccCreditReply_processorTransactionID

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 Cybersource, Cybersource passes this value from the authorization service to the subsequent services for you. However, when you perform authorizations through Cybersource 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

ccCreditReply_reasonCode

Numeric value that corresponds to the result of the credit request.

Specifications

Data Type:
Integer

Data Length:
5

Mapping Information

REST API Field:
No corresponding field.

SCMP API Field:
No corresponding field.

Simple Order API Field:

ccCreditReply_reasonCode

ccCreditReply_reconciliationID

Reference number for the transaction.

You can use this value to reconcile Cybersource reports with processor reports.

This value is not returned for all processors.

Syntax

This syntax is used with this field:

dcc_referenceNumber=[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

ccCreditReply_reconciliationReferenceNumber

Unique number that Cybersource generates to identify the transaction.

Specifications

Data Type:
String

Data Length:
20

Mapping Information

REST API Field:
No corresponding field.

SCMP API Field:

credit_reconciliation_reference_number

Simple Order API Field:

ccCreditReply_reconciliationReferenceNumber

ccCreditReply_requestDateTime

Time when the service was requested in Coordinated Universal Time (UTC).

Specifications

Type:
Date and time

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

ccCreditReply_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

ccCreditService_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.; The
ccCreditService_aggregatorID
field is optional in a request for an AFT with aggregator support. The
octService_aggregatorID
field is optional in a request for 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

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

All other processors:
20

Mapping Information

REST API Field:

aggregatorInformation.aggregatorId

SCMP API Field:

aggregator_id

Simple Order API Fields:

ccAuthService_aggregatorID

ccCaptureService_aggregatorID

ccCreditService_aggregatorID

octService_aggregatorID

(for Chase Paymentech Solutions)

ccCreditService_aggregatorName

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

ccCreditService_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:
String

Data Length:
5

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

ccCreditService_captureRequestID

Request ID for the capture that you want to credit.

This value creates a follow-on credit by linking the credit to the capture. When you include this field, you do not need to include several other credit request fields.

Specifications

Data Type:
String

Length:
26

Mapping Information

REST API Field:
No corresponding field.

SCMP API Field:

bill_request_id

Simple Order API Field:

ccCreditService_captureRequestID

ccCreditService_captureRequestToken

Request token for the capture that you want to credit.

This value is an encoded string that contains no confidential information, such as an account number or card verification number.

Specifications

Data Type:
String

Length:
256

Mapping Information

REST API Field:
No corresponding field.

SCMP API Field:

bill_request_token

Simple Order API Field:

ccCreditService_captureRequestToken

ccCreditService_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 ccAuthService_networkTokenCryptogram 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 `Visa Platform Connect` 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.
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
payerAuthValidateReply_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

ccCreditService_dpdeBillingMonth

Dynamic payment descriptor extension (DPDE) that specifies the month for which you are billing the customer.

This field is available only on the JCN Gateway processor and is not available for all Japanese acquirers.

Depending on your business model, you might bill for a service that has already been provided, such as a telephone service, or you might bill for a service that is going to be provided, such as a subscription to investment information. This value lets the customer know which month the payment is for.

Specifications

Field Type:
Request

Data Type:
String

Data Length:
4

Mapping Information

REST API Field:
No corresponding field.

SCMP API Field:

dpde_billing_month

Simple Order API Fields:

ccCaptureService_dpdeBillingMonth

ccCreditService_dpdeBillingMonth

ccCreditService_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

ccCreditService_overridePaymentDetails

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

ccAuthService_overridePaymentMethod

or

ccCreditService_overridePaymentMethod

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

ccCreditService_overridePaymentMethod

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
card_usage
field is
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 Cybersource. 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

ccCreditService_overridePaymentMethod

is set to the value of

CR

or

DB

and there is a value in the

ccCreditService_overridePaymentMethod

field, the value in the

ccCreditService_overridePaymentMethod

field takes precedence.

If

ccCreditService_overridePaymentMethod

is set to

CR/DB

and there is a value in the

ccCreditService_overridePaymentMethod

field, the value in the

ccCreditService_overridePaymentMethod

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

ccCreditService_purchasingLevel

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, RBS WorldPay Atlanta, 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.

ccCreditService_reconciliationIDAlternative

Alternative reference number that can be up to 12 characters in length.

If this field is used, it overrides any data added to the

ccCreditService_reconciliationID

field.

You can use this value to reconcile Cybersource reports with processor reports.

The syntax must conform to this regular expression:

[a-zA-Z0-9]

Specifications

Data Type:
String

Data Length:
12

Mapping Information

REST API Field:

No corresponding field.

SCMP API Field:

No corresponding field.

Simple Order API Fields:

ccCaptureService_reconciliationIDAlternative

ccCreditService_reconciliationIDAlternative

ccCreditService_refundReason

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

ccCreditService_run

Flag that specifies whether to include the credit service in the request.

Possible values:

true

: Include the credit service in the request.

false

(default): Do not include the credit service in the request.

Specifications

Data Type:
String

Data Length:
5

Mapping Information

REST API Field:
No corresponding field.

SCMP API Field:
No corresponding field.

Simple Order API Field:

ccCreditService_run

ccIncrementalAuthReply_amount

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

ccIncrementalAuthReply_authorizationCode

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

ccIncrementalAuthReply_authorizedDateTime

Time when the service was requested in Coordinated Universal Time (UTC).

Specifications

Type:
Date and time

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

ccIncrementalAuthReply_cardCategory

Card type category.

GPN: Visa or Mastercard product ID.
Visa Platform Connect: Visa product ID.
RBS WorldPay Atlanta: 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.
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

RBS WorldPay Atlanta: 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

ccIncrementalAuthReply_paymentNetworkTransactionID

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 Cybersource, Cybersource passes this value from the authorization service to the subsequent services for you. However, when you perform authorizations through Cybersource 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

ccIncrementalAuthReply_processorResponse

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.

Do not use this field to evaluate the result of the request.

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
additionalProcessorResponse
Simple Order 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 a decline reason code in the
ccAuthReply_merchantAdviceCode
Simple Order API field.

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

ccIncrementalAuthReply_reasonCode

Numeric value that corresponds to the result of the incremental authorization request.

Specifications

Data Type:
Integer

Data Length:
5

Mapping Information

REST API Field:
No corresponding field.

SCMP API Field:
No corresponding field.

Simple Order API Field:

ccIncrementalAuthReply_reasonCode

ccIncrementalAuthReply_reconciliationID

Reference number for the transaction.

You can use this value to reconcile Cybersource reports with processor reports.

This value is not returned for all processors.

Syntax

This syntax is used with this field:

dcc_referenceNumber=[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

ccIncrementalAuthService_authRequestID

Request ID of the authorization for which you are requesting this service.

Specifications

Data Type:
String

Data Length:
26

Mapping Information

REST API Field:
No corresponding field.

SCMP API Field:

auth_request_id

Simple Order API Fields:

ccAuthReversalService_authRequestID

ccCaptureService_authRequestID

ccCheckStatusService_authRequestID

ccIncrementalAuthService_authRequestID

ccIncrementalAuthService_duration

Number of days of the auto rental or lodging rental.

Auto rental: This field is supported for Visa, Mastercard, and American Express.
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
.; 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

ccIncrementalAuthService_run

Flag that specifies whether to include the incremental authorization service in the request.

Possible values:

true

: Include the incremental authorization service in the request.

false

(default): Do not include the incremental authorization service in the request.

Specifications

Data Type:
String

Data Length:
5

Mapping Information

REST API Field:
No corresponding field.

SCMP API Field:

ics_applications=ics_incremental_auth

Simple Order API Field:

ccIncrementalAuthService_run

ccIncrementalAuthService_transactionLocalDateTime

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

ccSaleService_cryptocurrencyPurchase

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

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
: Cybersource software timed out.

When you request the payer authentication and authorization services separately, get the value for this field from the
payerAuthEnrollReply_challengeCancelCode
or
payerAuthValidateReply_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

check_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).

Do not include the IBAN or BBAN in this field. Include the IBAN in the

fundTransfer_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

check_accountType

Account type.

Possible values:

C

: Checking.

G

: General ledger.

This value is supported only on Wells Fargo ACH.

S

: Savings

X

: Corporate checking

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

paymentInformation.bank.account.type

SCMP API Field:

ecp-account-type

Simple Order API Field:

check_accountType

check_bankTransitNumber

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.

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

comments

Brief description or comments for the order.

This value is not sent to the processor. Instead, the value is forwarded to the Cybersource reporting software.

This field is available only for Cybersource integrations.

Specifications

Data Type:
String

Data Length:
255

Mapping Information

REST API Field:
No corresponding field.

SCMP API Field:

comments

Simple Order API Field:

comments

customer_emailResult

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

customer_phoneResult

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

davReply_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.

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)

davReply_caInfo

Four-to-ten-character status code.

Specifications

Data Type:
String

Data Length:
255

Mapping Information

REST API Field:

addressVerificationInformation.statusCode

SCMP API Fields:

dav_ca_info

dav_intl_info

dav_us_info

Simple Order API Fields:

davReply_caInfo

davReply_intlInfo

davReply_usInfo

davReply_careOf

Care of data dropped from the standard address.

Specifications

Data Type:
String

Data Length:
255

Mapping Information

REST API Field:

addressVerificationInformation.careOf

SCMP API Field:

dav_careof

Simple Order API Field:

davReply_careOf

davReply_intlErrorInfo

Four-character error code returned for Canadian or international addresses.

Specifications

Data Type:
String

Data Length:
255

Mapping Information

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)

davReply_intlInfo

Four-to-ten-character status code.

Specifications

Data Type:
String

Data Length:
255

Mapping Information

REST API Field:

addressVerificationInformation.statusCode

SCMP API Fields:

dav_ca_info

dav_intl_info

dav_us_info

Simple Order API Fields:

davReply_caInfo

davReply_intlInfo

davReply_usInfo

davReply_matchScore

Indicates the probable correctness of the address match.

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

REST API Field:

addressVerificationInformation.standardAddress.address4

SCMP API Field:

dav_standard_address4

Simple Order API Field:

davReply_standardizedAddress4

davReply_standardizedAddressNoApt

(international)

dav_us_error_info

(US)

Simple Order API Fields:

davReply_caErrorInfo

(Canadian)

davReply_intlErrorInfo

(international)

davReply_usErrorInfo

(US)

davReply_usInfo

Four-to-ten-character status code.

Specifications

Data Type:
String

Data Length:
255

Mapping Information

REST API Field:

addressVerificationInformation.statusCode

SCMP API Fields:

dav_ca_info

dav_intl_info

dav_us_info

Simple Order API Fields:

davReply_caInfo

davReply_intlInfo

davReply_usInfo

davService_run

Indicates whether to include

davService

in your request.

The field can contain one of these values:

true

: Include the service in your request.

false

: Do not include the service in your request (default).

Specifications

Data Type:
String

Data Length:
5

Mapping Information

REST API Field:
No corresponding field.

SCMP API Field:
No corresponding field.

Simple Order API Field:

davService_run

dcc_dccIndicator

Enables Dynamic Currency Conversion during an authorization.

Available values:

0
: Not enabled (default)

1
: Enabled

Syntax

This syntax is used with this field:

dcc_dccIndicator=1

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

dcc_referenceNumber

Reference number for the transaction.

You can use this value to reconcile Cybersource reports with processor reports.

This value is not returned for all processors.

Syntax

This syntax is used with this field:

dcc_referenceNumber=[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

debtIndicator

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:
String

Data Length:
5

Mapping Information

REST API Field:

processingInformation.recurringOptions.loanPayment

SCMP API Field:

debt_indicator

Simple Order API Field:

debtIndicator

decision

Summary of the result of the overall request.

Possible values:

ACCEPT

: Request succeeded.

ERROR

: System error occurred.

REJECT

: One or more of the service requests were declined.

REVIEW

: The order was flagged for review. This value is returned only when you use Decision Manager.

Specifications

Data Type:
String

Data Length:
6

Mapping Information

REST API Field:
Use the

status

field to determine the response status.

SCMP API Field:
No corresponding field.

Simple Order API Field:

decision

decisionReply_travel_actualFinalDestinationCity

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

decisionManager_travelData_actualFinalDestination

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:

Address was found on the matched sanction list for the entity (name and address) in the request.

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

deniedPartiesMatch_N_list

List on which the first Denied Parties List match appears.

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

deniedPartiesMatch_N_name_0 through deniedPartiesMatch_N_name_N

Name found on the matched sanction list for the entity (name and address) in the request.

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

deniedPartiesMatch_N_program_N

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

developerID

Identifier for the developer that integrated a partner solution to Cybersource.

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

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

Mapping Information

REST API Field:
No equivalent field.

SCMP API Field:

ecp_authenticate_request_time

Simple Order API Field:

ecAuthenticateReply_requestDateTime

ecAVSReply_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

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

ecAVSReply_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

ecAVSReply_customerDataCondition Code

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

ecAVSReply_fcraDisputeCode

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

ecAVSReply_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

ecAVSReply_matchBillToAddress

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

ecAVSReply_matchBillToCity

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

ecAVSReply_matchBillToCompany

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

ecAVSReply_ matchBillToCompanyPhoneNumber

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

ecAVSReply_matchBillToCompanyTaxID

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

ecAVSReply_ matchBillToDateOfBirth

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

ecAVSReply_matchBillToFirstName

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

ecAVSReply_matchBillToFullName

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

ecAVSReply_matchBillToLastName

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

ecAVSReply_matchBillToMiddleName

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

ecAVSReply_matchBillToPhoneNumber

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

ecAVSReply_matchBillToPostalCode

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

ecAVSReply_matchBillToPrefix

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

ecAVSReply_matchBillToSSN

Indicates how closely the Social Security number in the request matches the National Shared Database record.

Possible values:

Y

: The identification number in the request exactly matches the database record.

C

: The 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 identification number in the request does not match the database record. Two or more digits do not match.

U

: The routing transit number is found in the database, but no identification number is in the database record.

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

validationInformation.bank.accountOwner.matchSocialSecurityNumber

SCMP API Field:

ecp_avs_match_bill_ssn

Simple Order API Field:

ecAVSReply_matchBillToSSN

ecAVSReply_matchBillToState

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

ecAVSReply_matchBillToSuffix

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

ecAVSReply_matchPersonalID

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

ecAVSReply_matchPersonalIDIssuedBy

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

ecAVSReply_matchPersonalIDType

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

ecAVSReply_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

Simple Order API Field:

ecAVSReply_overallMatchScore

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

ecAVSReply_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

ecAVSReply_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

ecAVSReply_scoredAccountProcessorResponse3

Simple Order API Field:

ecAVSReply_secondaryStatusCode

ecAVSReply_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

ecCreditReply_amount

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

.

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.

Barclays: Line Item Total

Chase Paymentech Solutions: Does not apply

FDC Compass: Does not apply

FDC Nashville Global: Does not apply

OmniPay Direct: Line Item Total

RBS WorldPay Atlanta: Amount

TSYS Acquiring Solutions: Does not apply

ecCreditReply_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

ecCreditReply_processorResponse

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.

Do not use this field to evaluate the result of the request.

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
additionalProcessorResponse
Simple Order 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 a decline reason code in the
ccAuthReply_merchantAdviceCode
Simple Order API field.

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

ecCreditReply_processorTransactionID

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 Cybersource, Cybersource passes this value from the authorization service to the subsequent services for you. However, when you perform authorizations through Cybersource 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

ecCreditReply_reconciliationID

Reference number for the transaction.

You can use this value to reconcile Cybersource reports with processor reports.

This value is not returned for all processors.

Syntax

This syntax is used with this field:

dcc_referenceNumber=[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

ecCreditReply_requestDateTime

Time when the service was requested in Coordinated Universal Time (UTC).

Specifications

Type:
Date and time

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

ecCreditReply_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

ecCreditReply_verificationCodeRaw

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

ecCreditService_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, Cybersource 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

ecCreditService_referenceNumber

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

ecCreditService_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

ecDebitReply_amount

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

.

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

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

ecDebitReply_processorResponse

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.

Do not use this field to evaluate the result of the request.

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
additionalProcessorResponse
Simple Order 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 a decline reason code in the
ccAuthReply_merchantAdviceCode
Simple Order API field.

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

ecDebitReply_processorTransactionID

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 Cybersource, Cybersource passes this value from the authorization service to the subsequent services for you. However, when you perform authorizations through Cybersource 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

ecDebitReply_requestDateTime

Time when the service was requested in Coordinated Universal Time (UTC).

Specifications

Type:
Date and time

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

ecDebitReply_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

ecDebitReply_verificationCode

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

ecDebitReply_verificationCodeRaw

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

ecDebitReply_verificationLevel

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

ecDebitService_debitRequestID

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 Cybersource 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 Cybersource, Cybersource passes this value from the authorization service to the subsequent services for you. However, when you perform authorizations through Cybersource 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

ecDebitService_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, Cybersource 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

ecDebitService_paymentMode

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.

Cybersource 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

ecDebitService_referenceNumber

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

ecDebitService_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

ecDebitService_verificationLevel

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

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

emvReply_chipValidationResults

Cryptogram validation results returned by the entity or service specified in

emvReply_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

emvReply_chipValidationType

Entity or service that provided the validation results returned in the

emvReply_chipValidationResults

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

emvReply_combinedTags

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.

For information about the individual tags, see the EMVCo Book 3 Application Specification at

Specifications

Data Type:
String

Data Length:

Visa Platform Connect: 252

Other Processors: 999

Mapping Information

REST API Field:

pointOfSaleInformation.emv.tags

SCMP API Field:

emv_reply_combined_tags

Simple Order API Field:

emvReply_combinedTags

emvRequest_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

emvRequest_combinedTags

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.

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

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
Visa Platform Connect 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 Cybersource. 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:

Visa Platform Connect: 252

Visa Platform Connect: 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

emvRequest_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:

true

: Fallback available

false

(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

emvRequest_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

emvRequest_repeat

Indicates the authorization is a duplicate authorization request.

When the

ccAuthReply_issuerPINrequest

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

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

encryptedPayment_data

Card-present transactions:
encrypted payment data.

Digital payment transactions:
encrypted payment data value. If you are using the Cybersource decryption option, populate this field with the encrypted payment data value returned by the Full Wallet request.

Specifications

Data Type:
String

Data Length:
3072

Mapping Information

REST API Field:

paymentInformation.fluidData.value

SCMP API Field:

encrypted_payment_data

Simple Order API Field:

encryptedPayment_data

encryptedPayment_descriptor

Format of the encrypted payment data.

Possible values:

Apple Pay:

RklEPUNPTU1PTi5BUFBMRS5JTkFQUC5QQVlNRU5U

Blue PCI P2PE:

Ymx1ZWZpbg==

Samsung Pay:

RklEPUNPTU1PTi5TQU1TVU5HLklOQVBQLlBBWU1FTlQ=

Specifications

Data Type:
String

Data Length:
128

Mapping Information

REST API Field:

paymentInformation.fluidData.descriptor

SCMP API Field:

encrypted_payment_descriptor

Simple Order API Field:

encryptedPayment_descriptor

encryptedPayment_encoding

Encoding method used to encrypt the payment data.

For Apple Pay transactions, the encoding method is Base64.

Specifications

Data Type:
String

Data Length:
6

Mapping Information

REST API Field:

paymentInformation.fluidData.encoding

SCMP API Field:

encrypted_payment_encoding

Simple Order API Field:

encryptedPayment_encoding

encryptedPayment_errorCode

Error code returned by Bluefin when the decryption fails.

Possible values:

1001 : Visa: Generic or unkown error code.
1101: Internal system configuration setup error.
1102: Internal system configuration setup error.
1103: Internal system configuration setup error.
1104: Internal system configuration setup error.
1105: Internal system configuration setup error.
1202: Device not found or device not recognized.
1203: Device not active.
1204: Invalid firmware version.
1303: All decryptions failed.
1404: Decryption failed for some other reason.
1406: Decrypted result did not include payment card information.

Specifications

Data Type:
String

Data Length:
4

Mapping Information

REST API Field:
No corresponding field.

SCMP API Field:

encrypted_payment_error_code

Simple Order API Field:

encryptedPayment_errorCode

encryptedPayment_referenceID

Unique transaction identifier returned by Bluefin.

You can use this value for tracking and reporting.

Specifications

Data Type:
Integer

Data Length:
25

Mapping Information

REST API Field:
No corresponding field.

SCMP API Field:

encrypted_payment_reference_id

Simple Order API Field:

encryptedPayment_referenceID

exportReply_infoCode

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.

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

exportReply_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

.

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

exportService_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.

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

exportService_addressWeight

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.

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

exportService_companyWeight

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.

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

exportService_nameWeight

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.

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

exportService_sanctionsLists

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 (^).

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

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

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

fidoFlowType

The type of enrollment flow used in the FIDO process.

Possible values:

ENROLLMENT

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

AUTHENTICATE

: Continue using the FIDO Challenge.

FAILURE

: 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

fidoReasonCode

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

fidoReasonDescription

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

foreignRetailIndicator

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

fundTransfer_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

fundTransfer_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).

Do not include the IBAN or BBAN in this field. Include the IBAN in the

fundTransfer_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

Data Type:
Boolean

Data Length:
5

Mapping Information

REST API Field:

paymentAccountInformation.features.healthCard

SCMP API Field:

health_card

Simple Order API Fields:

healthCard

healthCare#_amount

Amount of the healthcare payment.

Replace the # character with a sequential number from

0

to

4

.

Send this field with a corresponding

healthCare#_amountType

field.

Example:

<healthCare id="0">
  <amountType>vision</amountType>
  <amount>60.00</amount>

Specifications

Data Type:
String

Data Length:
13

Mapping Information

REST API Field:

healthCareInformation.amountDetails.amount

SCMP API Field:

health_care_#_amount

Simple Order API Field:

healthCare#_amount

healthCare#_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

Replace the # character with a sequential number from

0

to

4

.

Send this field with a corresponding

healthCare#_amount

field.

Example:

<healthCare id="0">
        <amountType>vision</amountType>
        <amount>60.00</amount>

Specifications

Data Type:
String

Data Length:
35

Mapping Information

REST API Field:

healthCareInformation.amountDetails.amountType

SCMP API Field:

health_care_#_amount_type

Simple Order API Field:

healthCare#_amountType

installment_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

installment_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

installment_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: Cybersource 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

installment_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

installment_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

installment_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

installment_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

installment_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

installment_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

installment_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

installment_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

installment_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

installment_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

installment_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

installment_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 Cybersource. 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

installment_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

installment_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

installment_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 Cybersource. 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

installment_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

installment_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

installment_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

installment_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

installment_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

installment_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

installment_paymentType

Payment plan for installments.

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

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.

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 Cybersource. 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 Cybersource. 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

installment_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

installment_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.

Cybersource Latin American Processing is the name of a specific processing connection. Cybersource Latin American Processing
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 Cybersource Latin American Processing. 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

installment_sequence

Installment payment number.

This field is used along with

installment_totalCount

to track which payment is being processed.

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

installment_sequence=2
installment_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

installment_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

installment_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

installment_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

installment_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

installment_sequence

to track which payment is being processed.

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

installment_sequence=2
installment_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

installment_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

invalidField_0 through invalidField_N

Fields in the request that have invalid data.

These fields are included as an aid to software developers. Do not use these fields to interact with customers.

Specifications

Data Type:
String

Data Length:
100

Mapping Information

REST API Field:
No corresponding field.

SCMP API Field:
No corresponding field.

Simple Order API Field:

invalidField_0

through

invalidField_N

invoiceHeader_amexDataTAA1

Transaction Advice Addendum (TAA) fields.

This topic provides a description of the sequence of fields from

invoiceHeader_amexDataTAA1

to

invoiceHeader_amexDataTAA4

.

These fields provide a description to display on the customer’s American Express card statement. They are frequently used for Level II transactions. When you provide TAA fields, first use

invoiceHeader_amexDataTAA1

, then

invoiceHeader_amexDataTAA2

, then

amexdata_taa2

, and so on. Before using these fields, 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

invoiceHeader_amexDataTAA2

Transaction Advice Addendum (TAA) fields.

This topic provides a description of the sequence of fields from

invoiceHeader_amexDataTAA1

to

invoiceHeader_amexDataTAA4

.

These fields provide a description to display on the customer’s American Express card statement. They are frequently used for Level II transactions. When you provide TAA fields, first use

invoiceHeader_amexDataTAA1

, then

invoiceHeader_amexDataTAA2

, then

amexdata_taa2

, and so on. Before using these fields, 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

invoiceHeader_amexDataTAA3

Transaction Advice Addendum (TAA) fields.

This topic provides a description of the sequence of fields from

invoiceHeader_amexDataTAA1

to

invoiceHeader_amexDataTAA4

.

These fields provide a description to display on the customer’s American Express card statement. They are frequently used for Level II transactions. When you provide TAA fields, first use

invoiceHeader_amexDataTAA1

, then

invoiceHeader_amexDataTAA2

, then

amexdata_taa2

, and so on. Before using these fields, 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

invoiceHeader_amexDataTAA4

Transaction Advice Addendum (TAA) fields.

This topic provides a description of the sequence of fields from

invoiceHeader_amexDataTAA1

to

invoiceHeader_amexDataTAA4

.

These fields provide a description to display on the customer’s American Express card statement. They are frequently used for Level II transactions. When you provide TAA fields, first use

invoiceHeader_amexDataTAA1

, then

invoiceHeader_amexDataTAA2

, then

amexdata_taa2

, and so on. Before using these fields, 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

invoiceHeader_authorizedContactName

The name of the individual or the company contacted for company authorized purchases.

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

Specifications

Data Type:
String

Data Length:
36

Mapping Information

REST API Field:

orderInformation.invoiceDetails.purchaseContactName

SCMP API Field:

authorized_contact_name

Simple Order API Field:

invoiceHeader_authorizedContactName

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: authorizedContactName

invoiceHeader_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
recipient_accountType
value must be either
01
,
02
,
03
or
06
.
FT
: Funds transfer where OCT not available. The
recipient_accountType
value must be either
00
,
01
,
02
,
03
or
06
.
PD
: Payroll disbursement. The
recipient_accountType
value must be
03
.
TU
: Top Up: Prepaid load. The
recipient_accountType
value must be either
01
,
02
,
03
or
06
.
WT
: Wallet transfer. The
recipient_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

invoiceHeader_cardAcceptorRefNumber

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

invoiceHeader_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

invoiceHeader_customData_1

Free form data about the transaction.

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

This value is forwarded to your processor, which then forwards the value to your acquirer during settlement.

When you provide this field in separate authorization and capture requests for the same order, the value from the capture request is forwarded to your processor.

Specifications

Data Type:
String

Data Length:
32

Mapping Information

REST API Field:
No corresponding field.

SCMP API Field:

custom_data1

Simple Order API Field:

invoiceHeader_customData_1

invoiceHeader_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.

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.

Barclays: Format: yyyyMMddHHmmss
Other processors: Format: yyyyMMdd

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

invoiceHeader_isGift

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

invoiceHeader_merchantDescriptor

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.

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, Cybersource 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

invoiceHeader_merchantDescriptorAlternate

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

invoiceHeader_merchantDescriptorCity

City for your business location.

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

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, Cybersource 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

invoiceHeader_merchantDescriptorContact

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.

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

invoiceHeader_merchantDescriptorCountry

Country code for your business location.

Use the two-character ISO country code.

See ISO Standard Country Codes

.

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

This value must consist of English characters.

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

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

invoiceHeader_merchantDescriptorState

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

octService_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
invoiceHeader_submerchantCountry
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

invoiceHeader_merchantDescriptorCountryOfOrigin

Country of origin for your business.

Use the two-character ISO country code.

See ISO Standard Country Codes

.

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 Cybersource 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 Cybersource 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

invoiceHeader_merchantDescriptorCounty

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

invoiceHeader_ merchantDescriptorCustomerServicePhoneNumber

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

invoiceHeader_merchantDescriptorPartnerIdCode

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

invoiceHeader_merchantDescriptorPostalCode

Postal code for your business location.

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

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

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

Simple Order

octService_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

invoiceHeader_merchantDescriptorState

State code or region code for your business location.

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

See State, Province, and Territory Codes for the United States 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.

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

invoiceHeader_merchantDescriptorStreet

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.

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, Cybersource recommends that you also include these fields in the request:

invoiceHeader_merchantDescriptorCountry

(merchant descriptor country)

invoiceHeader_merchantDescriptorState

(merchant descriptor state)

invoiceHeader_merchantDescriptorPostalCode

(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

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

invoiceHeader_merchantVATRegistrationNumber

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, RBS WorldPay Atlanta, TSYS Acquiring Solutions, Visa Platform Connect, and Worldpay VAP processors.

Specifications

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

RBS WorldPay Atlanta: 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

invoiceHeader_purchaserCode

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, Cybersource verifies these fields in the order given for a customer account ID value, and it uses d the first value it finds:
The
billTo_customerID
field value in the follow-on credit request.
The
billTo_customerID
field value that was used for the capture that is being credited.
The
billTo_customerID
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.

invoiceHeader_purchaserOrderDate

Date the order was processed.

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

Barclays: Format: yyyyMMdd
Worldpay VAP: Format: yyyy-MM-DD
Other processors: Format: YYMMDD

Specifications

Data Type:
String

Data Length

Barclays: 8

Worldpay VAP: 10

Other processors: 6

Mapping Information

REST API Field:

orderInformation.invoiceDetails.purchaseOrderDate

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

RBS WorldPay Atlanta: Order Date

TSYS Acquiring Solutions: Order Date

Visa Platform Connect: purchaserOrderDate

Worldpay VAP: orderDate

invoiceHeader_purchaserVATRegistrationNumber

Buyer’s VAT registration number.

This field is available on the Barclays, Elavon Americas, FDC Nashville Global, GPN, OmniPay Direct, RBS WorldPay Atlanta, 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

RBS WorldPay Atlanta: Customer VAT Number

TSYS Acquiring Solutions: Customer VAT Registration Number

Visa Platform Connect: purchaseVATRegistrationNumber

invoiceHeader_referenceDataCode

Code that identifies the value of the

invoiceHeader_referenceDataNumber

field.

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

This field is a pass-through, which means that this value is not verified or modified in any way before it is sent to the processor.

Specifications

Data Type:
String

Data Length:
3

Mapping Information

REST API Field:

orderInformation.invoiceDetails.referenceDataCode

SCMP API Field:

reference_data_code

Simple Order API Field:

invoiceHeader_referenceDataCode

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

invoiceHeader_referenceDataNumber

Reference number associated with the

invoiceHeader_referenceDataCode

field.

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

The meaning of this reference number is defined by the

invoiceHeader_referenceDataCode

field.

This field is a pass-through. The value in this field is not verified or modified in any way before it is sent to the processor.

Specifications

Data Type:
String

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

invoiceHeader_returnsAccepted

Indicates whether returns are accepted for this order.

This field can contain one of the following values:

yes

: Returns are accepted for this order.

no

: Returns are not accepted for this order.

Specifications

Data Type:
String

Data Length:
3

Mapping Information

REST API Field:

orderInformation.returnsAccepted

SCMP API Field:

returns_accepted

Simple Order API Field:

invoiceHeader_returnsAccepted

invoiceHeader_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

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

invoiceHeader_submerchantCountry

Sub-merchant’s country.

Use the two-character ISO country code.

Barclays: For marketplace transactions, include this field and the
invoiceHeader_merchantDescriptorCountry
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.
Visa Platform Connect: 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

invoiceHeader_submerchantEmail

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

invoiceHeader_submerchantId

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

invoiceHeader_submerchantMerchantId

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

invoiceHeader_submerchantName

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.
Visa Platform Connect: 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

invoiceHeader_submerchantPostalCode

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

invoiceHeader_submerchantRegion

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

invoiceHeader_submerchantState

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

invoiceHeader_submerchantStreet

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

invoiceHeader_submerchantTelephoneNumber

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

invoiceHeader_summaryCommodityCode

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

RBS WorldPay Atlanta: Commodity Code

TSYS Acquiring Solutions: Does not apply

Visa Platform Connect: summaryCommodityCode

invoiceHeader_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
item_#_productName
field instead.
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

invoiceHeader_taxable

Flag that indicates whether an order is taxable.

This field is available only for FDMS Nashville, Visa Platform Connect, and RBS WorldPay Atlanta.

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
RBS WorldPay Atlanta: This field is required for Level II Mastercard and Visa transactions. If
item_#_taxAmount
=
0
, set this field to
false
. If
item_#_taxAmount
> 0, set this field to
true
.
Visa Platform Connect: This value must be
true
if the the
item_#_taxAmount
value > 0.

If you do not include any
item_#_taxAmount
values in your request, the
invoiceHeader_taxable
field value is not included in the request.
Worldpay VAP: This field is required if
item_#_taxAmount
= 0. This field is optional if
item_#_taxAmount
> 0.

Specifications

Data Type:
String

Data Length:
5

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

RBS WorldPay Atlanta: Tax Exempt

Visa Platform Connect: localTaxIncluded

Worldpay VAP: taxExempt

invoiceHeader_tenderType

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

invoiceHeader_totalTaxTypeCode

Contains the tax type code that corresponds to the entry in the

item_#_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

invoiceHeader_userPO

Value used by your customer to identify the order.

This value is typically a purchase order number.

Cybersource 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, RBS WorldPay Atlanta, 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
merchantReferenceCode
field.

Specifications

Data Type:
String

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

RBS WorldPay Atlanta: 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:

American Express Direct: does not apply

Chase Paymentech Solutions: Customer Reference Number

Elavon Americas: Purchase Identifier

FDC Compass: Customer Reference Number

FDC Nashville Global: Customer Code

FDMS Nashville: does not apply

GPN: Market Data - Customer Code and Reference Number

OmniPay Direct: Customer Code / Customer Reference ID

RBS WorldPay Atlanta: PC2 Customer ID

TSYS Acquiring Solutions: does not apply

Visa Platform Connect: customerCode

Worldpay VAP: customerReference

invoiceHeader_vatInvoiceReferenceNumber

VAT invoice number associated with the transaction.

This field is available only on the Elavon Americas, FDC Nashville Global, Visa Platform Connect, RBS WorldPay Atlanta, 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

RBS WorldPay Atlanta: VAT Invoice Number

TSYS Acquiring Solutions: Unique VAT Invoice Reference Number

Visa Platform Connect: vatInvoiceReferenceNumber

Worldpay VAP: Invoice Reference Number

issuer_additionalData

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.

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

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

issuer_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

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

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

ccAuthReply_merchantAdviceCode

for Visa and Mastercard. See ccAuthReply_merchantAdviceCode 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.

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

issuer_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

issuer_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

issuer_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

issuer_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

item_#_alternateTaxAmount

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

item_#_alternateTaxID

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

RBS WorldPay Atlanta: Alternate Tax ID

TSYS Acquiring Solutions: Alternate Tax Identifier

Worldpay VAP: cardAcceptorTaxId

item_#_alternateTaxRate

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
item_#_alternateTaxAmount

Item-level
field.

When you include the
item_#_alternateTaxAmount

Item-level
field or the
otherTax_nationalTaxAmount
request field, do not include the
item_#_alternateTaxRate
field. The
otherTax_nationalTaxAmount
request field rate will be set using the following equation:

otherTax_nationalTaxAmount
/
item_#_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

item_#_alternateTaxTypeApplied

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

item_#_ alternateTaxAmount

.

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:
1

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

item_#_alternateTaxType

A flag that indicates whether an alternative tax amount (

otherTax_alternateTaxAmount

) is included in the request.

Possible values for this field:

0

: Alternate tax amount is not included in the request

1

: Alternate tax amount is included in the request

Specifications

Data Type:
String

Data Length:
1

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

RBS WorldPay Atlanta: Alternate Tax Indicator

TSYS Acquiring Solutions: Alternate Tax Amount Indicator

item_#_buyerRegistration

Buyer’s VAT registration number.

This field is available on the Barclays, Elavon Americas, FDC Nashville Global, GPN, OmniPay Direct, RBS WorldPay Atlanta, 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

RBS WorldPay Atlanta: Customer VAT Number

TSYS Acquiring Solutions: Customer VAT Registration Number

Visa Platform Connect: purchaseVATRegistrationNumber

item_#_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, RBS WorldPay Atlanta, TSYS Acquiring Solutions, Visa Platform Connect, and Worldpay VAP processors.

Specifications

Data Type:
String

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

RBS WorldPay Atlanta: 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

RBS WorldPay Atlanta: Commodity Code

TSYS Acquiring Solutions: Item Commodity Code

Visa Platform Connect: commodityCode

Worldpay VAP: commodityCode

item_#_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:

RBS WorldPay Atlanta:
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

RBS WorldPay Atlanta:
Discount Amount

TSYS Acquiring Solutions:

Mastercard:
Discount Amount

Visa:
Discount Amount Per Line Item

Visa Platform Connect:
discountAmount

Worldpay VAP:
Item Discount Amount

item_#_discountIndicator

Flag indicating a discount was applied to the item.

Possible values:

Y

: Discount applied

N

: No Discount applied

This field is automatically set to

Y

if the

itam_#_discountAmount

field is greater than 0.

Specifications

Type:
String

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

item_#_discountManagementIndicator

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

item_#_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

item_#_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%)
RBS WorldPay Atlanta: Maximum amount is 99.99. Example 5.25 (=5.25%)

Specifications

Data Type:
String

Data Length:
5

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

RBS WorldPay Atlanta: Discount Rate

TSYS Acquiring Solutions: Item Discount Rate

Visa Platform Connect: discountRate

item_#_export

List of countries where the product can be exported.

Use the two-character ISO country code.

See ISO Standard Country Codes

.

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

item_#_grossNetIndicator

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

RBS WorldPay Atlanta: Gross Net Indicator

TSYS Acquiring Solutions: Net/Gross Indicator

item_#_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:

Visa Platform Connect:
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

RBS WorldPay Atlanta:
Amount

TSYS Acquiring Solutions:
Amount

Visa Platform Connect:
invoiceNumber

Worldpay VAP:
invoiceNumber

item_#_localTax

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

item_#_nationalTax

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

item_#_noExport

List of countries to which the product cannot be exported.

Use the two-character ISO country codes.

See ISO Standard Country Codes

.

Specifications

Data Type:
Array of strings

Data Length:
2,147,483,647

Mapping Information

REST API Field:

orderInformation.lineItems[].restrictedExportCountries[]

SCMP API Field:

no_export

Simple Order API Field:

item_#_noExport

item_#_orderAcceptanceCity

City where you accept the customer’s order.

This

item-level

field overrides the corresponding request-level field.

This field is not used for tax calculation unless the

taxService_orderAcceptanceState

and

taxService_orderAcceptanceCountry

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

item_#_orderAcceptanceCountry

Country where you accept the customer’s order.

Use the two-character ISO standard country code.

See ISO Standard Country Codes.

This

item-level

field overrides the corresponding request-level field.

This field is not used for tax calculation unless the

taxService_orderAcceptanceState

and

taxService_orderAcceptanceCity

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

item_#_orderAcceptancePostalCode

Postal code where you accept the customer’s order.

This

item-level

field overrides the corresponding request-level field.

This field is not used for Tax Calculation unless the

taxService_orderAcceptanceCity

,

taxService orderAcceptanceState

, and

taxService_orderAcceptanceCountry

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

item_#_orderAcceptanceState

State where you accept the customer’s order.

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

See State, Province, and Territory Codes for the United States and Canada.

This

item-level

field overrides the corresponding request-level field.

This field is not used for Tax Calculation unless the

taxService_orderAcceptanceCity

and

taxService_orderAcceptanceCountry

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

item_#_orderOriginCity

City where you receive the customer’s order.

This

item-level

field overrides the corresponding request-level field.

This field is not used for tax calculation unless the

taxService_orderOriginState

and

taxService_orderOriginCountry

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

item_#_orderOriginCountry

Country where you receive the customer’s order.

Use the two-character ISO standard country code.

See ISO Standard Country Codes.

This

item-level

field overrides the corresponding request-level field.

This field is not used for tax calculation unless the

taxService_orderOriginState

and

taxService_orderOriginCity

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

item_#_orderOriginPostalCode

Postal code where you receive the customer’s order.

This

item-level

field overrides the corresponding request-level field.

This field is not used for Tax Calculation unless the

taxService_orderOriginCity

,

taxService_orderOriginState

, and

taxService_orderOriginCountry

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

item_#_orderOriginState

State where you receive the customer’s order.

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

See State, Province, and Territory Codes for the United States and Canada.

This

item-level

field overrides the corresponding request-level field.

This field is not used for tax calculation unless the

taxService_orderOriginCity

and

taxService_orderOriginCountry

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

item_#_otherTax_localTaxAmount

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

item_#_otherTax_#_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

item_#_otherTax_#_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, RBS WorldPay Atlanta, TSYS Acquiring Solutions processors.

RBS WorldPay Atlanta 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

RBS WorldPay Atlanta:

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)

RBS WorldPay Atlanta:
Tax Rate

TSYS Acquiring Solutions:
VAT/Tax Rate

Visa Platform Connect:
vat_tax_rate

item_#_otherTax_#_statusIndicator

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

item_#_otherTax_#_type

Defines the type of tax for the

other_tax#_amount

item_#_otherTax_#_amount

field.

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

Possible values include:

02

: State sales tax

03

: City sales tax

04

: Local sales tax

10

: Value-added tax

11

: Goods and services tax

12

: Provincial sales tax

13

: Harmonized sales tax

14

: Quebec sales tax

23

: City tax

24

: County or parish sales tax

25

: County tax

26

: Environment tax

27

: State and local sales tax (combined)

This field is a pass-though field. This means Cybersource does not verify the value or modify it in any way befoe sending it to the precessor.

Specifications

Data Type:
String

Data Length:
2

Mapping Information

REST API Field: No corresponding field.

SCMP API Field:

other_tax#_type

Simple Order API Field:

item_#_otherTax_#_type

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: N/A

item_#_passengerEmail

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

item_#_passengerFirstName

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

item_#_passengerID

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

item_#_passengerLastName

Passenger's last name.

Specifications

Data Type:
String

Data Length:
60

Mapping Information

REST API Field:

orderInformation.lineItems.passenger.lastName

SCMP API Field:

passenger_lastname

Simple Order API Field:

item_#_passengerLastName

item_#_passengerNationality

item_#_passengerType

item_#_productCode

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

item_#_ quantity

,

item_#_productName

, and

item_#_ 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

RBS WorldPay Atlanta:
Product Code

TSYS Acquiring Solutions:
Product Code

Visa Platform Connect:
productCode

Worldpay VAP:
productCode

item_#_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

item_#_productName

Name of product.

Specifications

Data Type:
String

Data Length

Barclays: 35

Other processors: 255

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.

Chase Paymentech Solutions: Description

Elavon Americas: Item Description

FDC Compass: Description

FDC Nashville Global: Description

OmniPay Direct: Item Description

RBS WorldPay Atlanta: Description

TSYS Acquiring Solutions:

Mastercard: Item Description

Visa: Item Descriptor

Visa Platform Connect: productName

Worldpay VAP: itemDescription

item_#_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

item_#_quantity

Quantity of the product.

The default is

1

.

Specifications

Data Type:
Integer

Data Length:
10

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.

American Express Direct: Does not apply

Barclays: Quantity

Chase Paymentech Solutions: Quantity

Elavon Americas: Quantity

FDC Compass: Quantity

FDC Nashville Global: Item Quantity

GPN: Item Quantity

OmniPay Direct: Quantity / Item Quantity

RBS WorldPay Atlanta: Quantity

TSYS Acquiring Solutions

Mastercard: Item Quantity

Visa: Quantity

Visa Platform Connect: quantity

Worldpay VAP: quantity

item_#_referenceData_#_code

Code that identifies the value of the corresponding

item_#_referenceData_#_number

field.

This field is a pass-though field. This means Cybersource 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

item_#_referenceData_#_number

Reference number. The meaning of this value is defined by the value of the corresponding

item_#_referenceData_#_code

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

item_#_sellerRegistration

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, RBS WorldPay Atlanta, TSYS Acquiring Solutions, Visa Platform Connect, and Worldpay VAP processors.

Specifications

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

RBS WorldPay Atlanta: 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

item_#_shipFromCity

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.

See State, Province, and Territory Codes for the United States and Canada.

This item-level field overrides the corresponding request-level field.

Tax Calculation: The value in this field is used for tax calculations only when the
shipFrom_state
and
shipFrom_country
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

item_#_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.

See ISO Standard Country Codes.

This item-level field overrides the corresponding request-level field.

Tax Calculation: The value in this field is used for tax calculations only when the
shipFrom_city
and
shipFrom_state
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

item_#_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

item-level

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, RBS WorldPay Atlanta, 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

RBS WorldPay Atlanta:
Origin ZIP

TSYS Acquiring Solutions:
Ship From Postal/ZIP Code

Visa Platform Connect:
shipFromAddress

Worldpay VAP:
shipFromPostalCode

item_#_shipFromState

State from which the product is shipped.

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

See State, Province, and Territory Codes for the United States 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
shipFrom_city
and
shipFrom_country
fields are present.

Specifications

Data Type:
String

Data Length:
2

Mapping Information

REST API Field:

orderInformation.shippingDetails.shipFromAdministrativeArea

SCMP API Field:

ship_from_state

REST API Field:

orderInformation.lineItems[].shippingCountryCode

SCMP API Field:

shipping_country_code

Simple Order API Field:

item_#_shippingCountryCode

item_#_shippingDestinationTypes

item_#_sign

Flag to indicate whether the

item_#_taxAmount

should be interpreted as a positive or negative value.

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

Possible values:

negative

positive

Specifications

Data Type:
String

Data Length:
8

Mapping Information

REST API Field: No corresponding field.

SCMP API Field:

sign

Simple Order API Field:

item_#_sign

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: sign

item_#_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, RBS WorldPay Atlanta, 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

item_#_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

items

in your request:

item_0_unitPrice=10.00
item_0_quantity=1
item_0_taxAmount=0.80
item_1_unitPrice=20.00
item_1_quantity=1
item_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

item_#_taxAmount

.

For more information, see the

Tax Calculation Developer Guide

.

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

GPX: localTax Amount

OmniPay Direct: Tax Amount / Total Tax Amount

RBS WorldPay Atlanta: Tax Amount

Visa Platform Connect: localTax Amount

TSYS Acquiring Solutions

Mastercard: Tax Amount

Visa: VAT / Tax Amount

Worldpay VAP: taxAmount

item_#_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, RBS WorldPay Atlanta, TSYS Acquiring Solutions, and Visa Platform Connect processors.


American Express Direct, RBS WorldPay Atlanta, TSYS Acquiring Solutions, and Visa Platform Connect: 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

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

RBS WorldPay Atlanta: Tax Rate

TSYS Acquiring Solutions:

Mastercard: Tax Rate Applied

Visa: VAT/Tax Rate

Visa Platform Connect: taxRate

item_#_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 Cybersource 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

item_#_taxTypeApplied

Type of tax applied to the item.

This field is available only on the Barclays, Chase Paymentech Solutions, Elavon Americas, FDC Compass, RBS WorldPay Atlanta, and TSYS Acquiring Solutions processors.

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, RBS WorldPay Atlanta, 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

Barclays: 2

Chase Paymentech Solutions: 4 numeric

Elavon Americas: 4 numeric

FDC Compass: 4 numeric

RBS WorldPay Atlanta: 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

RBS WorldPay Atlanta: Tax Type

TSYS Acquiring Solutions: Tax Type Applied

item_#_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, RBS WorldPay Atlanta, 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.
RBS WorldPay Atlanta: Do not use all zeros or spaces in Mastercard transactions.

Specifications

Data Type:
String

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

RBS WorldPay Atlanta: 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:

Barclays Line Item Total

Chase Paymentech Solutions: Line Item Total

Elavon Americas

Mastercard: Extended Item Amount

Visa: Line Item Total

FDC Compass: Line Item Total

OmniPay Direct: Line Item total / Extended Item Amount

RBS WorldPay Atlanta: Line Total

TSYS Acquiring Solutions

Mastercard: Extended Item Amount

Visa: Line Item Total

Visa Platform Connect: totalAmount

Worldpay VAP: lineItemTotal

item_#_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:

Visa Platform Connect: typeOfSupply

item_#_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, RBS WorldPay Atlanta, 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

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

RBS WorldPay Atlanta: 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:

American Express Direct: Does not apply

Barclays: Unit of Measure

Chase Paymentech Solutions: Unit of Measure

Elavon Americas: Unit of Measure

FDC Compass: Unit of Measure

FDC Nashville Global: Item Bulk / Unit of Measure

GPN: Unit of Measure

OmniPay Direct: Unit of Measure Code / Item Unit of Measure

RBS WorldPay Atlanta: Unit of Measure

TSYS Acquiring Solutions:

Mastercard: Item Unit of Measure

Visa: Unit of Measure/Code

Visa Platform Connect: unitOfMeasure

Worldpay VAP: unitOfMeasure

item_#_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, RBS WorldPay Atlanta, TSYS Acquiring Solutions, Visa Platform Connect, and Worldpay VAP processors.

Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths.

Barclays: Value must be numeric with two exponents.
Visa Platform Connect: 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

purchaseTotals_grandTotalAmount

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

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)

RBS WorldPay Atlanta: 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.

American Express Direct: Does not apply

Barclays: Unit Price

Chase Paymentech Solutions: Unit Cost

Elavon Americas: Unit Cost

FDC Compass: Unit Cost

FDC Nashville Global: Item Unit Cost

FDMS Nashville: Does not apply

GPN: Unit Price

OmniPay Direct: Unit Cost/Unit Price

RBS WorldPay Atlanta: Unit Cost

TSYS Acquiring Solutions: Unit Cost

Visa Platform Connect: unitPrice

Worldpay VAP: unitCost

item_#_vatRate

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, RBS WorldPay Atlanta, TSYS Acquiring Solutions processors.

RBS WorldPay Atlanta 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

RBS WorldPay Atlanta:

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)

RBS WorldPay Atlanta:
Tax Rate

TSYS Acquiring Solutions:
VAT/Tax Rate

Visa Platform Connect:
vat_tax_rate

item_#_weightAmount

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

item_#_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

item_#_weightunitOfMeasure

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

jpo_bonusAmount

If this field is included in a Japanese payment transaction, it specifies the amount of the bonus.

Specifications

Data Length:
12

Mapping Information

REST API Field:

processingInformation.japanPaymentOptions.bonusAmount

SCMP API Field:

jpo_bonus_amount

Simple Order API Field:

jpo_bonusAmount

jpo_bonuses

processingInformation. japanPaymentOptions. bonuses

The number of bonuses included in a Japanese payment transaction.

Specifications

Mapping Information

REST API Field:

processingInformation.japanPaymentOptions.bonuses

SCMP API Field:

jpo_bonuses

Simple Order API Field:

jpo_bonuses

jpo_bonusMonth

If a bonus is to be paid, this value specifies the month that a bonus is paid.

This field is only used with Japanese payments.

Possible values:

1-12

Data Type:
String

Data Length:
25

Mapping Information

REST API Field:

processingInformation.japanPaymentOptions.businessNameKatakana

SCMP API Field:

jpo_business_name_katakana

Simple Order API Field:

jpo_businessNameKatakana

jpo_firstBillingMonth

First billing month for a transaction that uses 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.

Possible values: 01 through 12.

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:
Integer

Data Length:
2

Mapping Information

REST API Field:

processingInformation.japanPaymentOptions.firstBillingMonth

SCMP API Field:

jpo_first_billing_month

Simple Order API Field:

jpo_firstBillingMonth

jpo_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

jpo_paymentMethod

field is set to

2

,

4

,

5

, or

6

.

Specifications

Data Type:
Integer

Data Length:
2

Mapping Information

REST API Field:

processingInformation.japanPaymentOptions.installments

SCMP API Field:

jpo_installments

Simple Order API Field:

jpo_installments

jpo_jccaTerminalID

Unique Japan Credit Card Association (JCCA) terminal identifier that is provided by Cybersource.

The difference between this field and the

pos_ terminalID

field is that you can define the

pos_ terminalID

field, but the

jpo_jccaTerminalID

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 Cybersource. 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

jpo_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

jpo_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:

2

,

4

,

5

, or

6

.

Possible values:

1

(default): Single payment.

2

: Bonus payment.

4

: Installment payment.

5

: Revolving payment.

6

: Combination of bonus payment and installment payment.

Specifications

Data Type:
Integer

Data Length:
1

Mapping Information

REST API Field:

processingInformation.japanPaymentOptions.paymentMethod

SCMP API Field:

jpo_payment_method

Simple Order API Field:

jpo_paymentMethod

jpo_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 Length:
1

Mapping Information

REST API Field:

processingInformation.japanPaymentOptions.preapprovalType

SCMP API Field:

jpo_preapproval_type

Simple Order API Field:

jpo_preapprovalType

jpo_secondBonusAmount

If this field is included in a Japanese payment transaction, it specifies the amount of the second bonus.

Specifications

Data Length:
12

Mapping Information

REST API Field:

processingInformation.japanPaymentOptions.secondBonusAmount

SCMP API Field:

jpo_second_bonus_amount

Simple Order API Field:

jpo_secondBonusAmount

jpo_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 Length:
2

Mapping Information

REST API Field:

processingInformation.japanPaymentOptions.secondBonusMonth

SCMP API Field:

jpo_second_bonus_month

Simple Order API Field:

jpo_secondBonusMonth

linkToRequest

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

loan_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

loan_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

lodgingData_additionalCoupon

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

lodgingData_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

lodgingData_checkOutDate

Code that identifies special circumstances.

Possible values:

REST API Field:

travelInformation.agency.code

SCMP API Fields:

airline_agent_code

lodging_travel_agency_code

Simple Order API Fields:

airlineData_agentCode

lodgingData_travelAgencyCode

lodgingData_travelAgencyName

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

lodgingData_valetParkingCost

Cost of valet parking services.

Specifications

Data Type:
String

Data Length:
12

Mapping Information

REST API Field:

travelInformation.lodging.valetParkingCost

Simple Order API Field:

lodgingData_valetParkingCost

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.

Specifications

Data Type:
Integer

Data Length:
7

Mapping Information

REST API Field:

orderInformation.invoiceDetails.merchandiseCode

SCMP API Field:

merchandise_code

Simple Order API Field:

merchandiseCode

merchantCategoryCode

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

merchantCategoryCodeDomestic

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
merchantCategoryCode
field.

When you include this field in a Mastercard request, including the
merchantCategoryCode
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
merchantCategoryCode
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

merchantdefineddata_field1-20

Fields that you can use to store information.

These fields have been replaced by

merchantDefinedData_mddField_1

through

merchantDefinedData_mddField_100

. It is recommended that you update your order management system to use the new fields.

Merchant-defined fields must not be used to capture personally identifying information as stated in the warning in the field description for

merchantDefinedData_mddField_1

through

merchantDefinedData_mddField_100

.

Specifications

Data Type:
String

Data Length:
255

Mapping Information

REST API Field:
No corresponding field.

SCMP API Field:
No corresponding field.

Simple Order API Field:

merchantDefinedData_field1

through

merchantDefinedData_field20

merchantdefineddata_mddField_1-100

Fields that you can use to store information.

This topic describes the sequence of fields from

merchantDefinedData_mddField_1

through

merchantDefinedData_mddField_100

.

These fields override the old merchant-defined data fields. For example, if you use the obsolete field

merchantDefinedData_field15

and the new field

merchantDefinedData_mddField_15

in the same request, the value for the new field overwrites the value for the obsolete field.

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 Cybersource discovers that a merchant is capturing or transmitting personally identifying information through the merchant-defined data fields, whether or not intentionally, Cybersource 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

merchantDefinedData_mddField_1

and

merchantDefinedData_mddField_2

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

For installment payments with Mastercard in Brazil:

The value for

merchantDefinedData_mddField_1

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

Record: CP07 TCR5

Position: 25-44

Field: Reference Field 2

The value for

merchantDefinedData_mddField_2

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:
255

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

merchantDefinedData_mddField_#

Fields that you can use to store information.

This topic describes the sequence of fields from

merchantDefinedData_mddField_1

through

merchantDefinedData_mddField_100

.

These fields override the old merchant-defined data fields. For example, if you use the obsolete field

merchantDefinedData_field15

and the new field

merchantDefinedData_mddField_15

in the same request, the value for the new field overwrites the value for the obsolete field.

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 Cybersource discovers that a merchant is capturing or transmitting personally identifying information through the merchant-defined data fields, whether or not intentionally, Cybersource 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

merchantDefinedData_mddField_1

and

merchantDefinedData_mddField_2

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

For installment payments with Mastercard in Brazil:

The value for

merchantDefinedData_mddField_1

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

Record: CP07 TCR5

Position: 25-44

Field: Reference Field 2

The value for

merchantDefinedData_mddField_2

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

REST API Field:

merchantInformation.merchantDomainName

SCMP API Field:

merchant_domain_name

Simple Order API Field:

merchantDomainName

merchantID

Your merchant ID.

Use the same merchant ID for evaluation, testing, and production.

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.

Specifications

Data Type:
String

Data Length:
30

Mapping Information

REST API Field:
No corresponding field.

SCMP API Field:

merchant_id

Simple Order API Field:

merchantID

merchantReferenceCode

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 Cybersource Advanced
guide.

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

merchant_riskPrediction

This value is the merchant risk prediction score. The score consists of seven independent scores that are determined by artificial intelligence (AI). The merchant risk prediction score is used in addition to existing risk management practices.

This field is available only for Visa Platform Connect.

Specifications

Data Type:
String

Data Length:
150

Mapping Information

REST API Field:

processorInformation.merchantRiskPrediction

SCMP API Field:

merchant_risk_prediction

Simple Order API Field:

merchant_riskPrediction

merchantTransactionIdentifier

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

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

missingField_0 through missingField_N

Required fields that were missing from the request.

These fields are included as an aid to software developers. Do not use these fields to interact with customers.

Specifications

Data Type:
String

Data Length:
100

Mapping Information

REST API Field:
No corresponding field.

SCMP API Field:
No corresponding field.

Simple Order API Field:

missingField_0

through

missingField_N

mPOS_deviceType

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 Cybersource. 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

nationalNetDomesticData

Supplementary domestic transaction information provided by the acquirer.

Specifications

Data Type:
String

Data Length:
123

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

octReply_amount

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

.

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.

Barclays: Line Item Total

Chase Paymentech Solutions: Does not apply

FDC Compass: Does not apply

FDC Nashville Global: Does not apply

OmniPay Direct: Line Item Total

RBS WorldPay Atlanta: Amount

TSYS Acquiring Solutions: Does not apply

octReply_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

octReply_paymentNetworkTransactionID

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 Cybersource, Cybersource passes this value from the authorization service to the subsequent services for you. However, when you perform authorizations through Cybersource 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

octReply_processorResponse

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.

Do not use this field to evaluate the result of the request.

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
additionalProcessorResponse
Simple Order 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 a decline reason code in the
ccAuthReply_merchantAdviceCode
Simple Order API field.

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

octReply_reasonCode

Numeric value corresponding to the result of the Original Credit Transaction (OCT) service request.

See Reason Codes for the Simple Order API.

Specifications

Data Type:
Integer

Data Length:
5

Mapping Information

REST API Field:
No corresponding field.

SCMP API Field:
No corresponding field.

Simple Order API Field:

octReply_reasonCode

octReply_reconciliationID

Reference number for the transaction.

You can use this value to reconcile Cybersource reports with processor reports.

This value is not returned for all processors.

Syntax

This syntax is used with this field:

dcc_referenceNumber=[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

octReply_requestDateTime

Time when the service was requested in Coordinated Universal Time (UTC).

Specifications

Type:
Date and time

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

octReply_processorResponse

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.

Do not use this field to evaluate the result of the request.

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
additionalProcessorResponse
Simple Order 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 a decline reason code in the
ccAuthReply_merchantAdviceCode
Simple Order API field.

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

octReply_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

octService_aggregatorCity

The city name of the payment facilitator.

This field is applicable to the Visa card type.

Specifications

Data Type:
String

Data Length:
50

Mapping Information

REST API Field:

aggregatorInformation.city

SCMP API Field:

aggregator_city

Simple Order API Fields:

ccAuthService_aggregatorCity

octService_aggregatorCity

octService_aggregatorCountry

The country 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.country

SCMP API Field:

aggregator_country

Simple Order API Fields:

ccAuthService_aggregatorCountry

octService_aggregatorCountry

octService_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.; The
ccCreditService_aggregatorID
field is optional in a request for an AFT with aggregator support. The
octService_aggregatorID
field is optional in a request for 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

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

All other processors:
20

Mapping Information

REST API Field:

aggregatorInformation.aggregatorId

SCMP API Field:

aggregator_id

Simple Order API Fields:

ccAuthService_aggregatorID

ccCaptureService_aggregatorID

ccCreditService_aggregatorID

octService_aggregatorID

(for Chase Paymentech Solutions)

octService_aggregatorName

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

Data Length:
99

Mapping Information

REST API Field:

aggregatorInformation.streetAddress

SCMP API Field:

aggregator_streetAddress

Simple Order API Fields:

ccAuthService_aggregatorStreetAddress

octService_aggregatorStreetAddress

octService_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 ccAuthService_networkTokenCryptogram 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 `Visa Platform Connect` 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.
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
payerAuthValidateReply_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

octService_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

octService_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: 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

octService_run

Whether to include

octService

in your request.

Possible values:

true

: Include the service in your request.

false

(default): Do not include the service in your request.

Specifications

Data Type:
String

Data Length:
5

Mapping Information

REST API Field:
No corresponding field.

SCMP API Field:
No corresponding field.

Simple Order API Field:

octService_run

octService_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

orderRequestToken

Request token value returned from a previous request.

This value links the previous request to the current follow-on request.

This value is an encoded string that contains no confidential information, such as an account number or card verification number.

Specifications

Data Type:
String

Data Length:
256

Mapping Information

REST API Field:
No corresponding REST API field.

SCMP API Field:

order_request_token

Simple Order API Field:

orderRequestToken

originalTransaction_amount

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

originalTransaction_reasonCode

Reason code for the original transaction.

Specifications

Type:
Integer

Length:
5

Mapping Information

REST API Field:
No corresponding field.

SCMP API Field:
No corresponding field.

Simple Order API Field:

originalTransaction_reasonCode

otherTax_alternateTaxAmount

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

item_#_nationalTax

differs from

item_#_taxAmount

. If you do not provide this value, Cybersource assumes that

item_#_nationalTax

is equal to

item_#_taxAmount

.

RBS WorldPay Atlanta: The value of this field cannot exceed
999999.99
.
FDC Nashville Global: The total should not include the local tax amount (
item_#_taxAmount
field) and national tax (
national_tax
item_#_nationalAmount
field) incluced in the total tax (
tax_amount
field).
GPN: The maximum amount is 99,999.99.
RBS WorldPay Atlanta: The maximum amount is 99,999.99.
OmniPay Direct: When you include this field in the request, you must also include the
item_#_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

RBS WorldPay Atlanta: 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)

RBS WorldPay Atlanta:
VAT Tax Amount

TSYS Acquiring Solutions:
National Tax Amount, Alternate Tax Amount and VAT/Tax Amount

otherTax_alternateTaxID

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

otherTax_alternateTaxIndicator

A flag that indicates whether an alternative tax amount (

otherTax_alternateTaxAmount

) is included in the request.

Possible values for this field:

0

: Alternate tax amount is not included in the request

1

: Alternate tax amount is included in the request

Specifications

Data Type:
String

Data Length:
1

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

RBS WorldPay Atlanta: Alternate Tax Indicator

TSYS Acquiring Solutions: Alternate Tax Amount Indicator

otherTax_greenTaxAmount

The green initiative tax amount for Korean Cyber Payment (KCP) sales.

Specifications

Data Type:
Integer

Data Length:
12

Mapping Information

REST API Field:

orderInformation.amountDetails.taxDetails[].type

Simple Order API Field:

otherTax_greenTaxAmount

otherTax_localTaxAmount

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

item_#_nationalTax

differs from

item_#_taxAmount

. If you do not provide this value, Cybersource assumes that

item_#_nationalTax

is equal to

item_#_taxAmount

.

RBS WorldPay Atlanta: The value of this field cannot exceed
999999.99
.
FDC Nashville Global: The total should not include the local tax amount (
item_#_taxAmount
field) and national tax (
national_tax
item_#_nationalAmount
field) incluced in the total tax (
tax_amount
field).
GPN: The maximum amount is 99,999.99.
RBS WorldPay Atlanta: The maximum amount is 99,999.99.
OmniPay Direct: When you include this field in the request, you must also include the
item_#_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

RBS WorldPay Atlanta: 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)

RBS WorldPay Atlanta:
VAT Tax Amount

TSYS Acquiring Solutions:
National Tax Amount, Alternate Tax Amount and VAT/Tax Amount

otherTax_localTaxIndicator

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

item_#_ alternateTaxAmount

.

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:
1

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

otherTax_nationalTaxAmount

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

item_#_nationalTax

differs from

item_#_taxAmount

. If you do not provide this value, Cybersource assumes that

item_#_nationalTax

is equal to

item_#_taxAmount

.

RBS WorldPay Atlanta: The value of this field cannot exceed
999999.99
.
FDC Nashville Global: The total should not include the local tax amount (
item_#_taxAmount
field) and national tax (
national_tax
item_#_nationalAmount
field) incluced in the total tax (
tax_amount
field).
GPN: The maximum amount is 99,999.99.
RBS WorldPay Atlanta: The maximum amount is 99,999.99.
OmniPay Direct: When you include this field in the request, you must also include the
item_#_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

RBS WorldPay Atlanta: 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)

RBS WorldPay Atlanta:
VAT Tax Amount

TSYS Acquiring Solutions:
National Tax Amount, Alternate Tax Amount and VAT/Tax Amount

otherTax_nationalTaxIndicator

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

item_#_nationalTax

values > 0.

If you do not include any

item_#_nationalTax

values in your request, Cybersource does not include

otherTax_ nationalTaxIndicator

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

otherTax_vatTaxAmount

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

item_#_nationalTax

differs from

item_#_taxAmount

. If you do not provide this value, Cybersource assumes that

item_#_nationalTax

is equal to

item_#_taxAmount

.

RBS WorldPay Atlanta: The value of this field cannot exceed
999999.99
.
FDC Nashville Global: The total should not include the local tax amount (
item_#_taxAmount
field) and national tax (
national_tax
item_#_nationalAmount
field) incluced in the total tax (
tax_amount
field).
GPN: The maximum amount is 99,999.99.
RBS WorldPay Atlanta: The maximum amount is 99,999.99.
OmniPay Direct: When you include this field in the request, you must also include the
item_#_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

RBS WorldPay Atlanta: 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)

RBS WorldPay Atlanta:
VAT Tax Amount

TSYS Acquiring Solutions:
National Tax Amount, Alternate Tax Amount and VAT/Tax Amount

otherTax_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

otherTax_vatTaxAmount

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

otherTax_vatTaxRate

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, RBS WorldPay Atlanta, TSYS Acquiring Solutions processors.

RBS WorldPay Atlanta 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

RBS WorldPay Atlanta:

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)

RBS WorldPay Atlanta:
Tax Rate

TSYS Acquiring Solutions:
VAT/Tax Rate

Visa Platform Connect:
vat_tax_rate

partnerOriginalTransactionID

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

This field is available only for Cybersource 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 Cybersource. Therefore, you can use this value to reconcile transactions between Cybersource and the terminal’s software.

This value is not sent to the processor. Instead, the value is forwarded to the Cybersource 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

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 Cybersource reporting software.

This field is available only for Cybersource 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

partnerSolutionID

Identifier for pre-built partner solution that is integrated to Cybersource.

Send this value in all requests that are sent through the partner solution. Cybersource 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

payByPoints_indicator

Simple Order API Fields:

payerAuthEnrollReply_accessToken

payerAuthSetupReply_accessToken

payerAuthEnrollReply_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

payerAuthEnrollReply_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

payerAuthEnrollReply_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

payerAuthEnrollReply_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

payerAuthEnrollReply_acsTransactionID

or

payerAuthValidateReply_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

payerAuthEnrollReply_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:
No length limit.

Mapping Information

REST API Field:

consumerAuthenticationInformation. acsUrl

SCMP API Field:

pa_enroll_acs_url

Simple Order API Field:

payerAuthEnrollReply_acsURL

payerAuthEnrollReply_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:
Integer

Data Length:
2

Mapping Information

REST API Field:

consumerAuthenticationInformation. acsWindowSize

SCMP API Field:

pa_acs_window_size

Simple Order API Field:

payerAuthEnrollService_acsWindowSize

payerAuthEnrollReply_alternateAuthenticationDate

Date and time in UTC of the cardholder authentication.

Format:

yyyyMMDDHHMM

Specifications

Data Type:
Integer

Data Length:
12

Mapping Information

REST API Field:

consumerAuthenticationInformation. alternateAuthenticationDate

SCMP API Field:

pa_alternate_authentication_date

Simple Order API Fields:

payerAuthEnrollReply_alternateAuthenticationDate

payerAuthEnrollService_alternateAuthenticationDate

payerAuthEnrollReply_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:
Integer

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

payerAuthEnrollReply_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

payerAuthEnrollReply_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

payerAuthEnrollReply_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

payerAuthEnrollReply_authenticationStatusMessage

Message that explains the

payerAuthValidateReply_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

payerAuthEnrollReply_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

payerAuthEnrollReply_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

payerAuthEnrollReply_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.

REST API Field:

No corresponding field.

SCMP API Field:

card_bin

Simple Order API Fields:

payerAuthEnrollReply_cardBin

payerAuthValidateReply_cardBin

payerAuthEnrollReply_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

payerAuthEnrollReply_cardTypeName

The card brand name associated with the cardholder’s card number.

Specifications

Data Type:
String

Data Length:
25

Mapping Information

REST API Field:
No corresponding field.

SCMP API Field:

card_type_name

Simple Order API Fields:

payerAuthEnrollReply_cardTypeName

payerAuthValidateReply_cardTypeName

payerAuthEnrollReply_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.

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

payerAuthValidateReply_cavvAlgorithm

response field.

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

payerAuthEnrollReply_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

payerAuthValidateReply_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
ccAuthService_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

payerAuthEnrollReply_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
: Cybersource software timed out.

When you request the payer authentication and authorization services separately, get the value for this field from the
payerAuthEnrollReply_challengeCancelCode
or
payerAuthValidateReply_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

payerAuthEnrollReply_challengeRequired

Indicates whether a challenge is required in order to complete authentication.

Regional mandates might determine that a challenge is required. Used by the Hybrid integration.

Possible values:

Y

: Challenge required.

N

: Challenge not required.

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

consumerAuthenticationInformation.challengeRequired

SCMP API Field:

challenge_required

Simple Order API Field:

payerAuthEnrollReply_challengeRequired

payerAuthEnrollReply_commerceIndicator

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

payerAuthEnrollReply_directoryServerErrorCode

The directory server error code indicating a problem with the transaction.

Specifications

Data Type:
Integer

Data Length:
3

Mapping Information

REST API Field:

consumerAuthenticationInformation.directoryServerErrorCode

SCMP API Field:

pa_directory_server_error_code

Simple Order API Fields:

payerAuthEnrollReply_directoryServerErrorCode

payerAuthValidateReply_directoryServerErrorCode

payerAuthEnrollReply_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

payerAuthEnrollReply_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

payerAuthEnrollReply_directoryServerTransactionID

or

payerAuthValidateReply_directoryServerTransactionID

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 Cybersource. 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

payerAuthEnrollReply_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.

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

If you are not using Cybersource 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

payerAuthEnrollReply_eciRaw

Raw electronic commerce indicator (ECI).

The field is absent if authentication fails.

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

payerAuthValidateReply_eciRaw

response field.

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

payerAuthEnrollReply_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

payerAuthEnrollReply_effectiveAuthenticationType

or

payerAuthValidateReply_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

payerAuthEnrollReply_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

payerAuthEnrollReply_effectiveAuthenticationType

or

payerAuthValidateReply_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

payerAuthEnrollReply_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

payerAuthEnrollReply_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

payerAuthEnrollReply_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

payerAuthEnrollReply_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

payerAuthEnrollReply_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

payerAuthEnrollReply_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

payerAuthEnrollReply_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

payerAuthEnrollReply_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

payerAuthEnrollReply_proofXml

payerAuthValidateReply_threeDSServerTransactionID

payerAuthEnrollReply_ucafAuthenticationData

Universal cardholder authentication field (UCAF) data.

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

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

payerAuthEnrollReply_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

payerAuthValidateReply_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.

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 with numbers only

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

payerAuthEnrollReply_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

payerAuthEnrollReply_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:
Integer

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

payerAuthEnrollReply_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.

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

payerAuthValidateReply_xid

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. 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

payerAuthEnrollService_accountPurchases

Number of purchases with this cardholder account during the previous six months.

Recommended for Discover ProtectBuy.

Specifications

Data Type:
Integer

Data Length:
4

Mapping Information

REST API Field:
No corresponding field.

SCMP API Field:

pa_account_purchases

Simple Order API Field:

payerAuthEnrollService_accountPurchases

payerAuthEnrollService_acquirerBin

Acquirer bank ID number that corresponds to a certificate that Cybersource already has.

Visa format:

4XXXXX

Mastercard format:

5XXXXX

Specifications

REST API Field:

consumerAuthenticationInformation. acsWindowSize

SCMP API Field:

pa_acs_window_size

Simple Order API Field:

payerAuthEnrollService_acsWindowSize

payerAuthEnrollService_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

payerAuthEnrollService_alternateAuthenticationDate

Date and time in UTC of the cardholder authentication.

Format:

yyyyMMDDHHMM

Specifications

Data Type:
Integer

Data Length:
12

Mapping Information

REST API Field:

consumerAuthenticationInformation. alternateAuthenticationDate

SCMP API Field:

pa_alternate_authentication_date

Simple Order API Fields:

payerAuthEnrollReply_alternateAuthenticationDate

payerAuthEnrollService_alternateAuthenticationDate

payerAuthEnrollService_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:
Integer

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

payerAuthEnrollService_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

payerAuthEnrollReply_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

payerAuthEnrollService_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

payerAuthEnrollService_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 Cybersource 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

.

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

payerAuthEnrollService_challengeCode

request field.

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

payerAuthEnrollService_customerCCAlias

An alias that uniquely identifies the customer's account and credit card on file.

This field is required if Tokenization is enabled in the merchant profile settings.

Specifications

Data Type:
String

Data Length:
128

Mapping Information

REST API Field:

consumerAuthenticationInformation. customerCardAlias

SCMP API Field:

pa_customer_cc_alias

Simple Order API Field:

payerAuthEnrollService_customerCCAlias

payerAuthEnrollService_ 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

payerAuthEnrollService_ 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

payerAuthEnrollService_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

payerAuthEnrollService_deviceChannel

Indicates the channel used for the transaction.

Required for SDK integration. Possible Values:

SDK

Browser

3RI (3-D Secure Integrator Request)

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

SDK

. If you use the JavaScript code, this field is dynamically set to

Browser

. For merchant-initiated or 3RI transactions, you must set the field to

3RI

. If you use this field in addition to JavaScript code, you must set the field to

Browser

.

Specifications

Data Type:
String

Data Length:
10

Mapping Information

REST API Field:

consumerAuthenticationInformation. deviceChannel

SCMP API Field:

pa_device_channel

Simple Order API Field:

payerAuthEnrollService_deviceChannel

payerAuthEnrollService_fraudActivity

Indicates whether the merchant experienced suspicious activity (including previous fraud) on the account.

This field can contain one of these values:

01

: No suspicious activity

02

: Suspicious activity observed

Specifications

Data Type:
String

Data Length:
2

Mapping Information

REST API Field:
No corresponding field.

SCMP API Field:

pa_fraud_activity

Simple Order API Field:

payerAuthEnrollService_fraudActivity

payerAuthEnrollService_giftCardAmount

The purchase amount total for prepaid gift cards in major units.

Example
123.45 USD=123

Specifications

Data Type:
Integer

Data Length:
15

Mapping Information

REST API Field:
No corresponding field.

SCMP API Field:

pa_gift_card_amount

Simple Order API Field:

payerAuthEnrollService_giftCardAmount

payerAuthEnrollService_giftCardCount

Total count of individual prepaid gift cards purchased.

Specifications

Data Type:
Integer

Data Length:
2

Mapping Information

REST API Field:
No corresponding field.

SCMP API Field:

pa_gift_card_count

Simple Order API Field:

payerAuthEnrollService_giftCardCount

payerAuthEnrollService_giftCardCurrency

pa_http_user_accept

Simple Order API Field:

payerAuthEnrollService_httpUserAccept

payerAuthEnrollService_httpUserAgent

Value of the User-Agent header sent by the customer’s web browser.

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

Specifications

Data Type:
String

Data Length:
2048

Mapping Information

REST API Field:

deviceInformation.userAgentBrowserValue

SCMP API Field:

pa_http_user_agent

Simple Order API Field:

payerAuthEnrollService_httpUserAgent

payerAuthEnrollService_installmentTotalCount

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

payerAuthEnrollService_marketingOptIn

Indicates whether the customer has opted in for marketing offers.

Recommended for Discover ProtectBuy.

Possible values:

true

false

Specifications

Data Type:
Boolean

Data Length:
5

Mapping Information

REST API Field:

consumerAuthenticationInformation. marketingOptIn

SCMP API Field:

pa_marketing_optin

Simple Order API Field:

payerAuthEnrollService_marketingOptIn

payerAuthEnrollService_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

payerAuthEnrollService_MCC

Merchant category code.

Specifications

REST API Field:

consumerAuthenticationInformation.merchantFraudRate

SCMP API Field:

pa_merchant_fraud_rate

Simple Order API Field:

payerAuthEnrollService_merchantFraudRate

payerAuthEnrollService_merchantId

User name on the Visa directory server.

The Visa directory server that is created when your acquirer sets up your account. This ID might be the same as your merchant ID. The user name can be 15 or 23 characters.

Specifications

Data Type:
Number

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

Mapping Information

REST API Field:

acquirerInformation.merchantId

SCMP API Field:

pa_merchant_id

pa_ds_login_id

Simple Order API Field:

payerAuthEnrollService_merchantId

payerAuthEnrollService_merchantName

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.

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, Cybersource 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

payerAuthEnrollService_merchantNewCustomer

Indicates whether the consumer is a new or existing customer with the merchant.

This field can contain one of these values:

true

false

Specifications

Data Type:
Boolean

Mapping Information

REST API Field:
No corresponding field.

SCMP API Field:

pa_merchant_new_customer

Simple Order API Field:

payerAuthEnrollService_merchantNewCustomer

payerAuthEnrollService_merchantScore

Risk score provided by merchants.

Specifications

Data Type:
String

Data Length:
20

Mapping Information

REST API Field:

consumerAuthenticationInformation. merchantScore

SCMP API Field:

pa_merchant_score

Simple Order API Field:

payerAuthEnrollService_merchantScore

payerAuthEnrollService_merchantURL

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

payerAuthEnrollService_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

payerAuthEnrollService_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

payerAuthEnrollService_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

REST API Field:
No corresponding field.

SCMP API Field:

pa_pre_order_date

Simple Order API Field:

payerAuthEnrollService_preorderDate

payerAuthEnrollService_preorder

Indicates whether cardholder is placing an order with a future availability or release date.

This field can contain one of these values:

01

: Merchandise available

02

: Future availability

Specifications

Data Type:
String

Data Length:
2

Mapping Information

REST API Field:
No corresponding field.

SCMP API Field:

pa_pre_order

Simple Order API Field:

payerAuthEnrollService_preorder

payerAuthEnrollService_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

payerAuthEnrollService_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:
Integer

Data Length:
2

Mapping Information

REST API Field:

consumerAuthenticationInformation. priorAuthenticationMethod

SCMP API Field:

pa_prior_authentication_method

Simple Order API Field:

payerAuthEnrollService_priorAuthenticationMethod

payerAuthEnrollService_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

payerAuthEnrollService_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

payerAuthEnrollService_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

payerAuthEnrollService_recurringEndDate

The date after which no further recurring authorizations should be performed.

Format:
yyyyMMDD.

Specifications

Data Type:
Integer

Data Length:
8

Mapping Information

REST API Field:

recurringPaymentInformation.endDate

SCMP API Field:

pa_recurring_end_date

Simple Order API Field:

payerAuthEnrollService_recurringEndDate

payerAuthEnrollService_recurringFrequency

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

payerAuthEnrollService_recurringOriginalPurchaseDate

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

payerAuthEnrollService_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

payerAuthEnrollService_reorder

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:
String

Data Length:
2

Mapping Information

REST API Field:

orderInformation.reordered

SCMP API Field:

pa_reorder

Simple Order API Field:

payerAuthEnrollService_reorder

payerAuthEnrollService_ 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

01

-

05

. Version 2.2.0 supports values

01

-

11

.

Specifications

Data Type:
Integer

Data Length:
2

Mapping Information

REST API Field:

consumerAuthenticationInformation. requestorInitiatedAuthenticationIndicator

SCMP API Field:

pa_requestor_initiated_authentication_indicator

Simple Order API Field:

payerAuthEnrollService_ requestorInitiatedAuthenticationIndicator

payerAuthEnrollService_requestorName

The 3-D Secure requestor name value assigned by the directory server.

Specifications

Data Type:
String

Data Length:
40

Mapping Information

REST API Field:

consumerAuthenticationInformation. requestorName

SCMP API Field:

pa_requestor_name

Simple Order API Field:

payerAuthEnrollService_requestorName

payerAuthEnrollService_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

payerAuthEnrollService_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:

payerAuthEnrollReply_idciScore

payerAuthEnrollReply_idciDecision

payerAuthEnrollReply_idciReasonCode1

payerAuthEnrollReply_idciReasonCode2

This field is used only with Mastercard transactions.

Specifications

Data Type:

String

Data Length:
1

Mapping Information

REST API Field:

consumerAuthenticationInformation. scoreRequest

SCMP API Field:

pa_score_request

Simple Order API Field:

payerAuthEnrollService_scoreRequest

payerAuthEnrollService_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

payerAuthEnrollService_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

payerAuthEnrollService_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

payerAuthEnrollService_ 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

payerAuthEnrollService_shipAddressUsageDate

Date when the shipping address for this transaction was first used.

This field can contain one of these values:

-1

: Guest account

0

: First used during this transaction

If neither applies, enter the date in yyyyMMDD format.

Recommended for Discover ProtectBuy.

Specifications

Data Type:
Integer

Data Length:
8

Mapping Information

REST API Field:
No correspoinding field.

SCMP API Field:

pa_ship_address_usage_date

Simple Order API Field:

payerAuthEnrollService_shipAddressUsageDate

payerAuthEnrollService_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

payerAuthEnrollService_transactionMode

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

Possible values:

M

: MOTO (Mail Order Telephone Order)

REST API Field:

consumerAuthenticationInformation. accessToken

SCMP API Field:

pa_access_token

Simple Order API Fields:

payerAuthEnrollReply_accessToken

payerAuthSetupReply_accessToken

payerAuthSetupReply_deviceDataCollectionURL

Location to send the authentication JSON Web Token (JWT) when you invoke device data collection.

Specifications

Data Type:
String

Data Length:
100

Mapping Information

REST API Field:

consumerAuthenticationInformation. deviceDataCollectionURL

SCMP API Field:

pa_setup_pa_device_data_collection_url

Simple Order API Field:

payerAuthSetupReply_deviceDataCollectionURL

payerAuthSetupReply_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

payerAuthSetupService. languagePreference

This value indicates which language to use. The value consists of the ISO 639-1 alpha-2 code, which consists of two-letter codes for languages such as

EN

for English.

Specifications

Data Type:
String

Data Length:
2

Mapping Information

REST API Field:

consumerAuthenticationInformation.languagePreference

Simple Order API Field:

payerAuthSetupService.languagePreference

payerAuthValidateReply_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

payerAuthValidateReply_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

payerAuthEnrollReply_acsTransactionID

or

payerAuthValidateReply_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

payerAuthValidateReply_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

payerAuthValidateReply_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

payerAuthValidateReply_authenticationStatusMessage

Message that explains the

payerAuthValidateReply_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

payerAuthValidateReply_authenticationStatusReason

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

payerAuthValidateReply_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.

REST API Field:
No corresponding field.

SCMP API Field:

card_type_name

Simple Order API Fields:

payerAuthEnrollReply_cardTypeName

payerAuthValidateReply_cardTypeName

payerAuthValidateReply_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

payerAuthValidateReply_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
ccAuthService_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

payerAuthValidateReply_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.

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

payerAuthValidateReply_cavvAlgorithm

response field.

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

payerAuthValidateReply_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
: Cybersource software timed out.

When you request the payer authentication and authorization services separately, get the value for this field from the
payerAuthEnrollReply_challengeCancelCode
or
payerAuthValidateReply_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

payerAuthValidateReply_commerceIndicator

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

payerAuthValidateReply_directoryServerErrorCode

The directory server error code indicating a problem with the transaction.

Specifications

Data Type:
Integer

Data Length:
3

Mapping Information

REST API Field:

consumerAuthenticationInformation.directoryServerErrorCode

SCMP API Field:

pa_directory_server_error_code

Simple Order API Fields:

payerAuthEnrollReply_directoryServerErrorCode

payerAuthValidateReply_directoryServerErrorCode

payerAuthValidateReply_ 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

payerAuthValidateReply_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

payerAuthEnrollReply_directoryServerTransactionID

or

payerAuthValidateReply_directoryServerTransactionID

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 Cybersource. 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

payerAuthValidateReply_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.

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

If you are not using Cybersource 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

payerAuthValidateReply_eciRaw

Raw electronic commerce indicator (ECI).

The field is absent if authentication fails.

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

payerAuthValidateReply_eciRaw

response field.

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

payerAuthValidateReply_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

payerAuthEnrollReply_effectiveAuthenticationType

or

payerAuthValidateReply_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

payerAuthValidateReply_interactionCounter

Indicates the number of authentication cycles that the cardholder attempted. The cycles are tracked by the issuing bank’s ACS.

Example
: The customer receives the challenge window, enters the one-time password, and clicks

Submit

. This sequence counts as one interaction.

Example:
The customer receives the challenge window, receives the bank message asking if the one-time password should be sent to their phone or email. The customer makes a selection before going to the next screen to enter the one-time password. This sequence counts as two interactions. The first interaction occurs when the customer chooses how to have the one-time password delivered. The second interaction occurs when the customer enters the one-time password and clicks

Submit

.

Specifications

Data Type:
Integer

Data Length:
2

Mapping Information

REST API Field:

consumerAuthenticationInformation.interactionCounter

SCMP API Field:

pa_interaction_counter

Simple Order API Field:

payerAuthValidateReply_interactionCounter

payerAuthValidateReply_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

Data Length:
36

Mapping Information

REST API Field:

consumerAuthenticationInformation. threeDSServerTransactionId

SCMP API Field:

pa_three_ds_server_transaction_id

Simple Order API Fields:

ccAuthService_threeDSServerTransactionID

payerAuthEnrollReply_threeDSServerTransactionID

payerAuthValidateReply_threeDSServerTransactionID

payerAuthValidateReply_ucafAuthenticationData

Universal cardholder authentication field (UCAF) data.

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

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

payerAuthValidateReply_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

payerAuthValidateReply_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.

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 with numbers only

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

payerAuthValidateReply_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

payerAuthValidateReply_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:
Integer

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

payerAuthValidateReply_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.

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

payerAuthValidateReply_xid

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. 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

payerAuthValidateService_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

payerAuthEnrollReply_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

payerAuthValidateService_credentialEncrypted

Indicates that you encrypted the passed credential.

This field is only used for IVR extension transactions in India.

Specifications

Data Type:
Boolean

Data Length:
1

Mapping Information

REST API Field:

consumerAuthenticationInformation. credentialEncrypted

SCMP API Field:

pa_credential_encrypted

Simple Order API Field:

payerAuthValidateService_credentialEncrypted

payerAuthValidateService_responseAccessToken

JSON Web Token (JWT) returned by the 3-D Secure provider when the authentication is complete.

Specifications

Data Type:
String

Data Length:
2048

Mapping Information

REST API Field:

consumerAuthenticationInformation.responseAccessToken

SCMP API Field:

pa_response_access_token

Simple Order API Field:

payerAuthValidateService_responseAccessToken

payerAuthValidateService_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.

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

payerAuthValidateReply_ threeDSServerOperatorId

The Directory Server-assigned 3-D Secure server identifier.

When checking enrollment and during validation for payer authentication, each Directory Server can provide a unique ID to each 3-D Secure server on an individual basis in the response.

Required for mada transactions.

Specifications

Data Type:
String

Data Length:
32

Mapping Information

REST API Field:

consumerAuthenticationInformation.threeDSServerOperatorId

SCMP API Field:

pa_enroll_pa_three_ds_server_operator_id

pa_validate_pa_three_ds_server_operator_id

Simple Order API Field:

payerAuthEnrollReply_threeDSServerOperatorId

payerAuthValidateReply_threeDSServerOperatorId

paymentAccountReference

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 Cybersource. 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

paymentDetails_executionDate

The date on which to execute the direct debit.

Format:

YYYYMMDD

Specifications

Data Type:
String

Data Length:
8

Mapping Information

SCMP API Field:

payment_details_execution_date

Simple Order API Field:

paymentDetails_executionDate

paymentInitiationChannel

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 Cybersource. 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

paymentNetworkToken_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

paymentNetworkToken_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

paymentNetworkToken_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

paymentNetworkToken_deviceTechType

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

paymentNetworkToken_originalCardCategory

Card type category.

GPN: Visa or Mastercard product ID.
Visa Platform Connect: Visa product ID.
RBS WorldPay Atlanta: 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.
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

RBS WorldPay Atlanta: 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

paymentNetworkToken_requestorID

Value that identifies your business and indicates that the cardholder’s account number is tokenized.

This value is assigned by the token service provider and is unique within the token service provider’s database.

This field is available only on the FDC Nashville Global and Visa Platform Connect processor.

Specifications

Data Type:
String

Data Length:
11

Mapping Information

REST API Field:

paymentInformation.tokenizedCard.requestorId

SCMP API Field:

payment_network_token_requestor_id

Simple Order API Field:

paymentNetworkToken_requestorID

paymentNetworkToken_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

paymentNetworkTransactionInformation

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

ccAuthReply_paymentNetworkTransactionID

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

When you use this field, you must also include the

ccAuthService_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

paymentScheme

The payment scheme that sets the rules for the direct debit process.

Possible values:

bacs

: Bacs Payment Schemes Limited (Bacs)

sepa

: Single Euro Payments Area (SEPA)

Specifications

Data Type:
String

Data Length:
5

Mapping Information

SCMP API Field:

payment_scheme

Simple Order API Field:

paymentScheme

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 Cybersource platform for reporting purposes.

Possible values:

001

: Apple Pay

004

: Cybersource 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

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

paySubscriptionCreateReply_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

personalID_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.

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

personalID_number

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.

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

personalID_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.

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

pinDataEncryptedPIN

Encrypted PIN data.

This value is provided by the client software that is installed on the POS terminal.

This field is available only for Cybersource 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

pinDataKeySerialNumber

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 Cybersource 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

pinDataPINblockEncodingFormat

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 Cybersource 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

pinDebitCreditReply_amount

Amount credited to the cardholder.

Specifications

Data Type:
Decimal

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

pinDebitCreditReply_authorizationCode

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

pinDebitCreditReply_dateTime

Time when the service was requested in Coordinated Universal Time (UTC).

Specifications

Type:
Date and time

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

pinDebitCreditReply_networkCode

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

pinDebitCreditReply_processorResponse

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.

Do not use this field to evaluate the result of the request.

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
additionalProcessorResponse
Simple Order 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 a decline reason code in the
ccAuthReply_merchantAdviceCode
Simple Order API field.

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

pinDebitCreditReply_reasonCode

Value that indicates the result of the PIN debit credit request.

See Reason Codes for the Simple Order API.

Specifications

Data Type:
Integer

Data Length:
5

Mapping Information

REST API Field:
No corresponding field.

SCMP API Field:
No corresponding field.

Simple Order API Field:

pinDebitCreditReply_reasonCode

pinDebitCreditReply_reconciliationID

Reference number for the transaction.

You can use this value to reconcile Cybersource reports with processor reports.

This value is not returned for all processors.

Syntax

This syntax is used with this field:

dcc_referenceNumber=[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

pinDebitCreditReply_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

pinDebitCreditService_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 ccAuthService_networkTokenCryptogram 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 `Visa Platform Connect` 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.
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
payerAuthValidateReply_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

pinDebitCreditService_ebtCategory

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

pinDebitCreditService_networkOrder

Priority order of the networks through which the transaction will be routed.

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, Cybersource 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

pinDebitCreditService_overridePaymentMethod

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
card_usage
field is
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 Cybersource. 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

ccCreditService_overridePaymentMethod

is set to the value of

CR

or

DB

and there is a value in the

ccCreditService_overridePaymentMethod

field, the value in the

ccCreditService_overridePaymentMethod

field takes precedence.

If

ccCreditService_overridePaymentMethod

is set to

CR/DB

and there is a value in the

ccCreditService_overridePaymentMethod

field, the value in the

ccCreditService_overridePaymentMethod

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

pinDebitCreditService_paymentType

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

Data Type:
String

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

pinDebitCreditService_run

Flag that indicates whether you are including the PIN debit credit service in your request.

Possible values:

true

: The service is included in your request.

false

(default): The service is not included in your request.

Specifications

Data Type:
String

Data Length:
5

Mapping Information

REST API Field:
No corresponding field

SCMP API Field:
No corresponding field

Simple Order API Field:

pinDebitCreditService_run

pinDebitPurchaseReply_accountBalance

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

pinDebitPurchaseReply_accountBalanceCurrency

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

pinDebitPurchaseReply_accountBalanceSign

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

pinDebitPurchaseReply_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

pinDebitPurchaseReply_amount

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

pinDebitPurchaseReply_amountType

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

pinDebitPurchaseReply_authorizationCode

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

pinDebitPurchaseReply_dateTime

Time when the service was requested in Coordinated Universal Time (UTC).

Specifications

Type:
Date and time

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

pinDebitPurchaseReply_networkCode

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

pinDebitPurchaseReply_processorResponse

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.

Do not use this field to evaluate the result of the request.

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
additionalProcessorResponse
Simple Order 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 a decline reason code in the
ccAuthReply_merchantAdviceCode
Simple Order API field.

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

pinDebitPurchaseReply_reasonCode

Value that indicates the result of the PIN debit purchase request.

See Reason Codes for the Simple Order API.

Specifications

Data Type:
Integer

Data Length:
5

Mapping Information

REST API Field:
No corresponding field.

SCMP API Field:
No corresponding field.

Simple Order API Field:

pinDebitPurchaseReply_reasonCode

pinDebitPurchaseReply_reconciliationID

Reference number for the transaction.

You can use this value to reconcile Cybersource reports with processor reports.

This value is not returned for all processors.

Syntax

This syntax is used with this field:

dcc_referenceNumber=[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

pinDebitPurchaseReply_requestAmount

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

.

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.

Barclays: Line Item Total

Chase Paymentech Solutions: Does not apply

FDC Compass: Does not apply

FDC Nashville Global: Does not apply

OmniPay Direct: Line Item Total

RBS WorldPay Atlanta: Amount

TSYS Acquiring Solutions: Does not apply

pinDebitPurchaseReply_requestCurrency

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.

For partial authorizations, the

ccAuthReply_requestCurrency

field returns the currency code.

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:
5

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

pinDebitPurchaseReply_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

pinDebitPurchaseService_authorizationCode

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

pinDebitPurchaseService_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 ccAuthService_networkTokenCryptogram 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 `Visa Platform Connect` 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.
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
payerAuthValidateReply_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

pinDebitPurchaseService_ebtCategory

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

pinDebitPurchaseService_ebtVoucherSerialNumber

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

pinDebitPurchaseService_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

pinDebitPurchaseService_networkOrder

Priority order of the networks through which the transaction will be routed.

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, Cybersource 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

pinDebitPurchaseService_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

pinDebitPurchaseService_paymentType

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

Data Type:
String

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

pinDebitPurchaseService_run

Flag that indicates whether you are including the PIN debit purchase service in your request.

Possible values:

true

: The service is included in your request.

false

(default): The service is not included in your request.

Specifications

Data Type:
String

Data Length:
5

Mapping Information

REST API Field:
No corresponding field

SCMP API Field:
No corresponding field

Simple Order API Field:

pinDebitPurchaseService_run

pinDebitPurchaseService_transactionType

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

pinDebitPurchaseService_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

pinDebitReversalReply_amount

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

pinDebitReversalReply_dateTime

Time when the service was requested in Coordinated Universal Time (UTC).

Specifications

Type:
Date and time

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

pinDebitReversalReply_processorResponse

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.

Do not use this field to evaluate the result of the request.

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
additionalProcessorResponse
Simple Order 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 a decline reason code in the
ccAuthReply_merchantAdviceCode
Simple Order API field.

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

pinDebitReversalReply_reasonCode

Value that indicates the result of the PIN debit reversal request.

See Reason Codes for the Simple Order API.

Specifications

Data Type:
Integer

Data Length:
5

Mapping Information

REST API Field:
No corresponding field.

SCMP API Field:
No corresponding field.

Simple Order API Field:

pinDebitReversalReply_reasonCode

pinDebitReversalReply_reconciliationID

Reference number for the transaction.

You can use this value to reconcile Cybersource reports with processor reports.

This value is not returned for all processors.

Syntax

This syntax is used with this field:

dcc_referenceNumber=[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

pinDebitReversalService_pinDebitRequestID

Request ID of the PIN debit purchase or PIN debit credit that you want to reverse.

Your request must include a request ID or a merchant transaction identifier.

Specifications

Data Type:
String

Data Length:
26

Mapping Information

REST API Field:
No corresponding field

SCMP API Field:

pin_debit_request_id

Simple Order API Field:

pinDebitReversalService_pinDebitRequestID

pinDebitReversalService_run

Flag that indicates whether you are including the PIN debit reversal service in your request.

Possible values:

true

: The service is included in your request.

false

(default): The service is not included in your request.

Specifications

Data Type:
String

Data Length:
5

Mapping Information

REST API Field:
No corresponding field.

SCMP API Field:
No corresponding field.

Simple Order API Field:

pinDebitReversalService_run

pos_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

pos_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

pos_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 Cybersource reporting software.

This field is available only for Cybersource 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

pos_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

pos_environment

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

pos_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

pos_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

pos_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 Cybersource 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 Cybersource 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

postdatedTransaction_guaranteeAmount

Amount that is guaranteed for a post-dated transaction.

This field is available only for post-dated transactions with Mastercard in Brazil on the Visa Platform Connect processor.

The guaranteed amount is specified in an agreement between you and the issuer.

A post-dated transaction enables a customer to make a purchase using a debit Mastercard and to have the debit post to the customer's account at a later date.

Format:
8 digits including 2 minor units, BRL currency only.

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

Record: CP07 TCR0

Position: 5-12

Field: Mastercard Post-Dated Transaction Details

Specifications

Type:
String

Length:
8

Mapping Information

REST API Field:
No corresponding field.

SCMP API Field:

postdated_transaction_guarantee_amount

Simple Order API Field:

postdatedTransaction_guaranteeAmount

postdatedTransaction_guaranteeIndicator

Flag that indicates whether a post-dated transaction has a guarantee.

This field is available only for post-dated transactions with Mastercard in Brazil on the Visa Platform Connect processor.

The guaranteed amount is specified in an agreement between you and the issuer. The customer tells you whether they would like the transaction to be post-dated. The issuer provides the guarantee.

A post-dated transaction enables a customer to make a purchase using a debit Mastercard and to have the debit post to the customer's account at a later date.

Possible values:

true

: Post-dated transaction has a guarantee.

false

: Post-dated transaction does not have a guarantee.

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

Record: CP07 TCR0

Position: 55

Field: Mastercard Post-Dated Transaction Details

Specifications

Type:
String

Length:
5

Mapping Information

REST API Field:
No corresponding field.

SCMP API Field:

postdated_transaction_guarantee_indicator

Simple Order API Field:

postdatedTransaction_guaranteeIndicator

postdatedTransaction_settlementDate

Date you plan to send a capture request for a post-dated transaction.

This field is available only for post-dated transactions with Mastercard in Brazil on the Visa Platform Connect processor.

A post-dated transaction enables a customer to make a purchase using a debit Mastercard and to have the debit post to the customer's account at a later date.

Format:
yyyyMMDD

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

Record: CP07 TCR0

Position: 13-18

Field: Mastercard Post-Dated Transaction Details

Specifications

Type:
String

Length:
8

Mapping Information

REST API Field:
No corresponding field.

SCMP API Field:

postdated_transaction_settlement_date

Simple Order API Field:

postdatedTransaction_settlementDate

pos_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, RBS WorldPay Atlanta, 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

pos_terminalCardCaptureCapability

Indicates whether the terminal can capture the card.

This field is available only for Cybersource 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:
5

Mapping Information

REST API Field:

pointOfSaleInformation.terminalCardCaptureCapability

SCMP API Field:

terminal_card_capture_capability

Simple Order API Field:

pos_terminalCardCaptureCapability

pos_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 Cybersource. 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

pos_terminalCVMcapabilities_#

List of cardholder verification methods (CVMs) supported by the terminal.

This field is available only for Cybersource 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_#

pos_terminalIDAlternate

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

pos_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

pos_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 Cybersource 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

pos_terminalInputCapabilities_#

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 Cybersource 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_#

pos_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 Cybersource 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

pos_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 Cybersource 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

pos_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 Cybersource reporting software.

This field is available only for Cybersource 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

pos_terminalType

Type of terminal.

Possible values:

21

: Attended terminal, online only

22

: Attended terminal, offline with online capability

23

: Attended terminal, offline only

24

: Unattended terminal, online only

25

: Unattended terminal, offline with online capability

26

: Unattended terminal, offline only

This field is available only for Cybersource integrations.

Specifications

Data Type:
String

Data Length:
2

Mapping Information

REST API Field:
No corresponding field.

SCMP API Field:

terminal_type

Simple Order API Field:

pos_terminalType

pos_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, RBS WorldPay Atlanta, 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

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

processorTransId

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

ccAuthReply_paymentNetworkTransactionID

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

promotion_discountApplied

Amount of the promotional discount applied to the transaction.

This field is available only on the Cielo processor.

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

purchaseTotals_additionalAmount#

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

purchaseTotals_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.

For partial authorizations, the

ccAuthReply_requestCurrency

field returns the currency code.

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:
5

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

purchaseTotals_discountAmount

The total discount applied to the order.

Example: A $20.00 discount off the order total.

RBS WorldPay Atlanta:
The discount amount cannot exceed 999999.99.

Specifications

Data Type:

Chase Paymentech Solutions, FDC Compass, TSYS Acquiring Solutions, FDC Nashville Global, RBS WorldPay Atlanta 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

RBS WorldPay Atlanta 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

RBS WorldPay Atlanta:
Discount Amount

TSYS Acquiring Solutions:
Discount Amount

Visa Platform Connect:
discountAmount

Worldpay VAP:
discountAmount

purchaseTotals_discountAmountSign

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

purchaseTotals_discountAmount

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

purchaseTotals_discountManagementIndicator

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

purchaseTotals_ 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

purchaseTotals_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 Type:
String

Data Length:

Chase Paymentech Solutions, FDC Compass:

Mastercard: 10

Visa: 13

Elavon Americas, GPN, OmniPay Direct, Visa Platform Connect: 12

FDC Nashville Global: 11

RBS WorldPay Atlanta 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

RBS WorldPay Atlanta: Duty Amount

TSYS Acquiring Solutions: Duty Amount

Visa Platform Connect: dutyAmount

Worldpay VAP: dutyAmount

purchaseTotals_dutyAmountSign

Flag that indicates whether the duty amount should be interpreted as negative or positive.

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

Possible values:

negative

: duty amount is considered negative and represents a refund on the invoice

positive

: duty amount is considered positive and represents a cost on the invoice

This field relates to the value in the

purchaseTotals_dutyAmount

field.

Specifications

Data Type:
String

Data Length:
8

Mapping Information

REST API Field: No corresponding field.

SCMP API Field:

duty_amount_sign

Simple Order API Field:

purchaseTotals_dutyAmountSign

Processor Field Names

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

Visa Platform Connect: dutyAmountSign

purchaseTotals_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:
16

Mapping Information

REST API Field:

orderInformation.amountDetails.exchangeRate

SCMP API Field:

exchange_rate

Simple Order API Field:

purchaseTotals_exchangeRate

purchaseTotals_exchangeRateTimeStamp

The time stamp returned by a Dynamic Currency Conversion provider when a conversion request is made. This value is set to GMT.

Specifications

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

Possible values:

negative

: freight amount is considered negative and represents a refund on the invoice

positive

: freight amount is considered positive and represents a cost on the invoice

This field relates to the value in the

purchaseTotals_freightAmount

field.

Specifications

Data Type:
String

Data Length:
8

Mapping Information

REST API Field: No corresponding field.

SCMP API Field:

freight_amount_sign

Simple Order API Field:

purchaseTotals_freightAmountSign

Processor Field Names

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

Visa Platform Connect: freightAmountSign

purchaseTotals_grandTotalAmount

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

.

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.

Barclays: Line Item Total

Chase Paymentech Solutions: Does not apply

FDC Compass: Does not apply

FDC Nashville Global: Does not apply

OmniPay Direct: Line Item Total

RBS WorldPay Atlanta: Amount

TSYS Acquiring Solutions: Does not apply

purchaseTotals_originalAmount

The purchase amount denominated in the local currency, when the

purchaseTotals_grandTotalAmount

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

purchaseTotals_originalCurrency

The local billing currency, when the

purchaseTotals_currency

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

purchaseTotals_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

reasonCode

Numeric value that corresponds to the result of the overall request.

See Reason Codes for the Simple Order API.

Specifications

Data Type:
Integer

Data Length:
5

Mapping Information

REST API Field:
No corresponding field.

SCMP API Field:
No corresponding field.

Simple Order API Field:

reasonCode

receiptNumber

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

recipient_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 with numbers only

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

recipient_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

recipient_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

recipient_address

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 Cybersource. 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

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 Cybersource. 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
recipient_city
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

recipient_country

The country associated with the address of the recipient.

Use the two-character ISO country code.

See ISO Standard Country Codes

.

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 Cybersource. 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

recipient_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, Cybersource 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

recipient_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.

Payouts using FDC Compass: Before sending this value to the processor, Cybersource reformats it to the FDC Compass format: MMDDyyyy.

Specifications

Data Type:
String with numbers only

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

recipient_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, Cybersource 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

recipient_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 Cybersource. 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
ccCreditService_refundReason
field to
pow
), the value in the
billTo_firstName
field is used by default as the first name of the Mastercard Payment of Winnings
stand-alone 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
recipient_firstname
,
recipient_middlename
, and
recipient_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
sender_firstname
,
sender_middlename
, and
sender_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

recipient_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 Cybersource. 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
ccCreditService_refundReason
field to
pow
), the value in the
billTo_lastName
field is used by default as the last name of the Mastercard Payment of Winnings
stand-alone 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
recipient_firstname
,
recipient_middlename
, and
recipient_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
sender_firstname
,
sender_middlename
, and
sender_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

recipient_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

recipient_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 Cybersource. 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
recipient_firstname
,
recipient_middlename
, and
recipient_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
sender_firstname
,
sender_middlename
, and
sender_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

recipient_name

First name or whole name of the recipient.

Specifications

Data Type:
String

Data Length:
30

Mapping Information

REST API Field:
No corresponding field.

SCMP API Field:

recipient_name

Simple Order API Field:

recipient_name

recipient_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, Cybersource 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

recipient_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, Cybersource 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

recipient_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

recipient_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 Cybersource. 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

recipient_state

State or province of the recipient.

This field is available only on these processors:

FDC Compass

First Data Merchant Solutions

LloydsTSB Cardnet International

Streamline

See State, Province, and Territory Codes for the United States and Canada.

First Data Merchant Solutions and LloydsTSB Cardnet International: Required with Visa when the
recipient_state
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

recipient_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

recurring_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. Cybersource 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

recurring_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

recurring_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

recurring_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

recurring_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

recurringSubscriptionInfo_subscriptionID

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:

card_accountNumber

card_expirationMonth

card_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

recurring_type

Indicates the type of recurring payment.

This field is required for recurring payments using cards issued in India.

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

recurring_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

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

requestID

Request identifier that the client software generates.

Specifications

Data Type:
String

Data Length:
256

Mapping Information

REST API Field:
No corresponding field. The value is returned in the endpoint of the resource that was requested.

SCMP API Field:

request_id

Simple Order API Field:

requestID

requestToken

Request token data.

This value is an encoded string that contains no confidential information, such as an account number or card verification number.

When you request the authorization and capture services together, the request token is for the capture response only.

Specifications

Data Type:
String

Data Length:
256

Mapping Information

REST API Field:
No corresponding field.

SCMP API Field:

request_token

Simple Order API Field:

requestToken

routing_networkLabel

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

routing_networkType

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

routing_signatureCVMRequired

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

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

receiptNumber

field is that Cybersource generates the receipt number for the

receiptNumber

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 Cybersource. 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

sender_accountNumber

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

sender_referenceNumber

or

sender_accountNumber

is present. If you do not include this tag,

sender_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
ccCreditService_refundReason
field to
pow
), you can use this field if you need to provide your merchant account number to process a Mastercard Payment of Winnings
stand-alone 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

sender_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.

sender_address

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
ccCreditService_refundReason
field to
pow
), the street name in your merchant configuration on the Cybersource platform is used by default as your default street address in a Mastercard Payment of Winnings
stand-alone 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

sender_city

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
ccCreditService_refundReason
field to
pow
), the merchant city in your merchant configuration on the Cybersource platform is used by default as your merchant city in a Mastercard Payment of Winnings
stand-alone 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

sender_country

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
ccCreditService_refundReason
field to
pow
), the merchant country in your merchant configuration on the Cybersource platform is used by default as your default country code in a Mastercard Payment of Winnings
stand-alone 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

sender_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, Cybersource 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

sender_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
ccCreditService_refundReason
field to
pow
), the merchant name in your merchant configuration on the Cybersource platform is used by default as your merchant first name in a Mastercard Payment of Winnings
stand-alone 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
sender_firstname
,
sender_middlename
, and
sender_lastname
fields.
Chase Paymentech Solutions: When the sender is a business or government entity, use the
sender_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

sender_identificationNumber

Acquirer-populated value associated with the

sender_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

sender_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 Cybersource. 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
ccCreditService_refundReason
field to
pow
), you can use this field to specify a merchant last name in a Mastercard Payment of Winnings
stand-alone 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
sender_firstname
,
sender_middlename
, and
sender_lastname
fields.
Chase Paymentech Solutions: When the sender is a business or government entity, use the
sender_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

sender_middleInitial

Middle initial of sender when the sender is an individual. When the sender is a business or government entity, use the

sender_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
sender_firstname
,
sender_middlename
, and
sender_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

sender_middleName

Middle name of sender when the sender is an individual. When the sender is a business or government entity, use the

sender_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 Cybersource. 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
sender_firstname
,
sender_middlename
, and
sender_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

sender_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

sender_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

sender_personalIDType

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

sender_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

sender_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

sender_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

sender_sourceOfFunds

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
ccCreditService_refundReason
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
stand-alone credit
.; Possible values for processing a Mastercard Payment of Winnings
stand-alone 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

sender_state

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
sender_state
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

sender_type

Type of tax identifier (business or individual) when Tag 9F20 IDType (the

sender_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

serviceProcessing_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

shipFrom_city

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.

See State, Province, and Territory Codes for the United States and Canada.

This item-level field overrides the corresponding request-level field.

Tax Calculation: The value in this field is used for tax calculations only when the
shipFrom_state
and
shipFrom_country
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

shipFrom_country

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.

See ISO Standard Country Codes.

This item-level field overrides the corresponding request-level field.

Tax Calculation: The value in this field is used for tax calculations only when the
shipFrom_city
and
shipFrom_state
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

shipFrom_lastName

Last name of the person who is shipping the product.

The combined length of this field and the

orderInformation.billTo.first.name

ship_from_firstname

ship_from_firstName

field must not exceed 40 characters.

Specifications

Data Type:
String

Data Length:
40, see description

Mapping Information

REST API Field: No corresponding field.

SCMP API Field:

ship_from_lastname

Simple Order API Field:

shipFrom_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: N/A

shipFrom_phoneNumber

Phone number of the company that ships the product.

Specifications

Data Type:
String

Data Length:
15

Mapping Information

REST API Field: No corresponding field.

SCMP API Field:

ship_from_phone

Simple Order API Field:

shipFrom_phoneNumber

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: N/A

shipFrom_postalCode

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

item-level

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, RBS WorldPay Atlanta, 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

RBS WorldPay Atlanta:
Origin ZIP

TSYS Acquiring Solutions:
Ship From Postal/ZIP Code

Visa Platform Connect:
shipFromAddress

Worldpay VAP:
shipFromPostalCode

shipFrom_state

State from which the product is shipped.

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

See State, Province, and Territory Codes for the United States 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
shipFrom_city
and
shipFrom_country
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

shipFrom_street1

Street address from where the product is shipped.

Specifications

Data Type:
String

Data Length:
40

Mapping Information

REST API Field: No corresponding field.

SCMP API Field:

ship_from_address1

Simple Order API Field:

shipFrom_street1

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: N/A

shipFrom_street2

Additional address information from where the product is shipped.

Specifications

Data Type:
String

Data Length:
40

Mapping Information

REST API Field: No corresponding field.

SCMP API Field:

ship_from_address2

Simple Order API Field:

shipFrom_street2

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: N/A

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

shipTo_city

City of the shipping address.

When the field is not included in the request and the service defaults to the

billTo_city

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
shipTo_state
and
shipTo_country
API fields are present.

This field is available only on these processors: AIBMS, American Express Direct, Bank of America ACH, Banque de France et Tresor Public, Barclays, BNP Paribas France, Chase Paymentech Solutions, Chase Paymentech Tandem, China UnionPay, Cielo, Comercio Latino, Credit Mutuel-CIC, Cybersource ACH Service, Elavon, Elavon Americas, FDC Compass, FDC Nashville Global, FDI Australia, FDMS Nashville, First Data Merchant Solutions, Getnet, GPN, HBoS, HSBC, JCN Gateway, Korean Cyber Payments, Lloyds-OmniPay, LloydsTSB Cardnet, Moneris, OmniPay Direct, Prosa, RBS WorldPay Atlanta, Rede, RuPay, SIX, Streamline, TeleCheck, UATP, ValueLink, Vero, TSYS Acquiring Solutions, Visa Platform Connect, Worldpay VAP, Wells Fargo ACH.

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

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

shipTo_country

Country of the shipping address.

Use the two-character ISO standard country code.

See ISO Standard Country Codes.

This field is available only on the FDC Nashville Global, RBS WorldPay Atlanta, and Worldpay VAP processors.

These processors have specific requirements:

Payments Processing: FDC Nashville Global:
If you include the
shipTo_country
field in a request and if the ship-to country is the U.S. or Canada, the request must also include the
shipTo_state
field.; RBS WorldPay Atlanta:
If you do not provide this value, the
billTo_country
value is used. If you do not provide either of these values, the default value of
US
is used.; Worldpay VAP:
If this value is not included in the request, the
billTo_country
value from the authorization request is used.
Tax Calculation: This field is optional for US, Canadian, international, and value-added taxes.; When
shipTo_country
is not included in the request and the service defaults to
billTo_ country
, the value for
shipTo_country
is left blank in the Tax Detail Report; When
shipTo_country
is not included in the request and the service defaults to
billTo_ country
, the value for
shipTo_country
is left blank in the Tax DetailReport.; This field is used for Tax Calculaton only when the
shipTo_city
and
shipTo_state
fields are present.

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

RBS WorldPay Atlanta: Destination Country Code

TSYS Acquiring Solutions: Destination Country Code

Worldpay VAP: destinationCountryCode

shipTo_county

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

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

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

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

shipTo_email

Email address of the recipient, including full domain name.

Format:
name@host.domain

Specifications

Data Type:
String

Data Length:
255

Mapping Information

REST API Field:

orderInformation.shipTo.email

SCMP API Field:

ship-to-email

Simple Order API Field:

shipTo_email

shipTo_firstName

First name of the person receiving the shipment.

The field is available for these processors: AIBMS, Bank of America ACH, Banque de France et Tresor Public, Barclays, BNP Paribas France, Chase Paymentech Solutions, Chase Paymentech Tandem, China UnionPay, Cielo, Comercio Latino, Credit Mutuel-CIC, Cybersource ACH Service, Elavon, Elavon Americas, FDC Compass, FDC Nashville Global, FDI Australia, FDMS Nashville, First Data Merchant Solutions, Getnet, GPN, HBoS, HSBC, JCN Gateway, Korean Cyber Payments, Lloyds-OmniPay, LloydsTSB Cardnet, Moneris, OmniPay Direct, Prosa, RBS WorldPay Atlanta, Rede, RuPay, SIX, Streamline, TeleCheck, UATP, ValueLink, Vero, TSYS Acquiring Solutions, Visa Platform Connect, Worldpay VAP, Wells Fargo ACH.

Specifications

Data Type:
Request

Data Format:
String

Data Length

Worldpay VAP: 35

Other processors: 60

Mapping Information

REST API Field:

orderInformation.shipTo.firstName

SCMP API Field:

ship_to_firstname

Simple Order API Field:

shipTo_firstName

shipTo_lastName

Last name of the person receiving the shipment.

The field is available for these processors: AIBMS, American Express Direct, Bank of America ACH, Banque de France et Tresor Public, Barclays, BNP Paribas France, Chase Paymentech Solutions, Chase Paymentech Tandem, China UnionPay, Cielo, Comercio Latino, Credit Mutuel-CIC, Cybersource ACH Service, Elavon, Elavon Americas, FDC Compass, FDC Nashville Global, FDI Australia, FDMS Nashville, First Data Merchant Solutions, Getnet, GPN, HBoS, HSBC, JCN Gateway, Korean Cyber Payments, Lloyds-OmniPay, LloydsTSB Cardnet, Moneris, OmniPay Direct, Prosa, RBS WorldPay Atlanta, Rede, RuPay, SIX, Streamline, TeleCheck, UATP, ValueLink, Vero, TSYS Acquiring Solutions, Visa Platform Connect, Worldpay VAP, Wells Fargo ACH.

Specifications

Data Type:
Request

Data Format:
String

Data Length

Worldpay VAP: 35

Other processors: 60

Mapping Information

REST API Field:

orderInformation.shipTo.lastName

SCMP API Field:

ship_to_lastname

Simple Order API Field:

shipTo_lastName

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

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

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
shipTo_postalCode
field is not included in the request and the service defaults to
billTo_ postalCode
, the value for the
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.

This field is available only on these processors: American Express Direct, Chase Paymentech Solutions, Elavon Americas, FDC Compass, FDC Nashville Global, FDMS Nashville, GPN, OmniPay Direct, RBS WorldPay Atlanta, TSYS Acquiring Solutions, Visa Platform Connect, and Worldpay VAP.

These processors have specific requirements:

American Express Direct: Before sending the postal code to the processor, all non-alphanumeric characters are removed. When the remaining value is longer than nine characters, the value is truncated starting from the right side.; The postal code is required for Level II processing in the US and US territories. When you do not include this field in the request, the value for the
billTo_postalCode
field is used. When you do not include either field, the value in your account is used.
Chase Paymentech Solutions , Elavon Americas , FDC Compass , FDC Nashville Global , OmniPay Direct , TSYS Acquiring Solutions , Visa Platform Connect , and Worldpay VAP: This value is the same as the value for
shipFrom_postalCode
when your customer takes possession of the items at your location.
FDC Nashville Global , FDMS Nashville , and RBS WorldPay Atlanta: If the postal code for the shipping address is not included in the request message, the postal code for the billing address is used. If the postal code for the billing address is not included in the request message, the postal code for the shipping address is required.
Worldpay VAP: It is recommended that this value not exceed 10 characters. If this value is not included in the request, the
billTo_postalCode
value from the authorization request is used.

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:

American Express Direct: Does not apply

Chase Paymentech Solutions: Destination ZIP/Postal Code

Elavon Americas: Destination ZIP/Postal Code

FDC Compass: Destination ZIP/Postal Code

FDC Nashville Global: Destination ZIP

FDMS Nashville: Does not apply

GPN: Destination Postal/ZIP Code

OmniPay Direct: Destination Postal/ZIP Code

RBS WorldPay Atlanta: Destination ZIP

TSYS Acquiring Solutions: Destination Postal/ZIP Code

Visa Platform Connect: shipToAddress

Worldpay VAP: destinationPostalCode

shipTo_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

shipTo_state

State of the shipping address.

Specifications

Data Type:
String

Data Length:
80

Mapping Information

REST API Field:

orderInformation.shipTo.administrativeArea

SCMP API Field:

ship_to_state

Simple Order API Field:

shipTo_state

shipTo_street1

First line of the shipping address.

When

ship_to_address1

is not included in the request and the service defaults to

billTo_street1

, the value for

ship_to_address1

is left blank in the Tax Detail Report.

This field is available on these processors: AIBMS, American Express Direct, Bank of America ACH, Banque de France et Tresor Public, Barclays, BNP Paribas France, Chase Paymentech Solutions, Chase Paymentech Tandem, China UnionPay, Cielo, Comercio Latino, Credit Mutuel-CIC, Cybersource ACH Service, Elavon, Elavon Americas, FDC Compass, FDC Nashville Global, FDI Australia, FDMS Nashville, First Data Merchant Solutions, Getnet, GPN, HBoS, HSBC, JCN Gateway, Korean Cyber Payments, Lloyds-OmniPay, LloydsTSB Cardnet, Moneris, OmniPay Direct, Prosa, RBS WorldPay Atlanta, Rede, RuPay, SIX, TeleCheck, UATP, ValueLink, Vero, Visa Platform Connect, Worldpay VAP, TSYS Acquiring Solutions, and Wells Fargo ACH.

Specifications

Data Type:
Request

Data Format:
String

Data Length

TSYS Acquiring Solutions: 36

Other processors: 60

Mapping Information

REST API Field:

orderInformation.shipTo.address1

SCMP API Field:

ship_to_address1

Simple Order API Field:

shipTo_street1

shipTo_street2

Second line of the shipping address.

This field is available on these processors: AIBMS, American Express Direct, Bank of America ACH, Banque de France et Tresor Public, Barclays, BNP Paribas France, Chase Paymentech Solutions, Chase Paymentech Tandem, China UnionPay, Cielo, Comercio Latino, Credit Mutuel-CIC, Cybersource ACH Service, Elavon, Elavon Americas, FDC Compass, FDC Nashville Global, FDI Australia, FDMS Nashville, First Data Merchant Solutions, Getnet, GPN, HBoS, HSBC, JCN Gateway, Korean Cyber Payments, Lloyds-OmniPay, LloydsTSB Cardnet, Moneris, OmniPay Direct, Prosa, RBS WorldPay Atlanta, Rede, RuPay, SIX, Streamline, TeleCheck, UATP, ValueLink, Vero, Visa Platform Connect, Worldpay VAP, TSYS Acquiring Solutions, and Wells Fargo ACH.

Specifications

Data Type:
Request

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.commerceIndicator

field set to

recurring

(for recurring transactions) or

install

(for installment transactions).

The

subsequentAuthReason

field set to any value supported for that field.

Possible values:

true

: Merchant-initiated transaction.

false

: 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:
5

Mapping Information

REST API Field:

processingInformation.authorizationOptions.initiator.type

SCMP API Field:

subsequent_auth

Simple Order API Field:

subsequentAuth

subsequentAuthFirst

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.

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 Cybersource. 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.initiator.credentialStoredOnFile

SCMP API Field:

subsequent_auth_first

Simple Order API Field:

subsequentAuthFirst

subsequentAuthOriginalAmount

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

subsequentAuthReason

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

subsequentAuthStoredCredential

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 Visa Platform Connect.

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

Type:
String

Length:
5

Mapping Information

REST API Field:

processingInformation.authorizationOptions. initiator.storedCredentialUsed

SCMP API Field:

subsequent_auth_stored_credential

Simple Order API Field:

subsequentAuthStoredCredential

subsequentAuthTransactionID

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

ccAuthReply_paymentNetworkTransactionID

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

surchargeAmount

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 Cybersource. 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
purchaseTotals_grandTotalAmount
.
Include the
surchargeSign
field in the request.

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

surchargeSign

Sign for the surcharge amount.

This field is available only on the FDC Nashville Global, Worldpay VAP, and Visa Platform Connect processors.

Possible values:

C

: Surcharge amount will be credited to the customer’s account.

D

: Surcharge amount will be debited from the customer’s account.

Visa Platform Connect: Merchants in Canada must include surcharge information in authorization requests for card-present transactions.

Acquirers that have merchants in Canada must support credit/debit 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 Cybersource. 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

If you include this field in the request, you must also include the
surgargeAmount
field.
FDC Nashville Global: US Credit Card Transactions

Surcharge amount can be applied to card-present and card-not-present transactions on payment cards in US.

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:
1

Mapping Information

REST API Field:
No corresponding field

SCMP API Field:

surcharge_sign

Simple Order API Field:

surchargeSign

taxManagementIndicator

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

taxReply_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:

true

false

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

taxReply_grandTotalAmount

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

.

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.

Barclays: Line Item Total

Chase Paymentech Solutions: Does not apply

FDC Compass: Does not apply

FDC Nashville Global: Does not apply

OmniPay Direct: Line Item Total

RBS WorldPay Atlanta: Amount

TSYS Acquiring Solutions: Does not apply

taxReply_item_#_cityTaxAmount

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

taxReply_item_#_countryTaxAmount

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

taxReply_item_#_countyTaxAmount

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

taxReply_item_#_districtTaxAmount

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

taxReply_item_#_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

taxReply_item_#_jurisdiction_#_code

Jurisdiction code assigned by the tax provider.

Returned only when the 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

taxReply_item_#_jurisdiction_#_country

Jurisdiction country for the item.

Returned only when the 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

taxReply_item_#_jurisdiction_#_name

Free-text description of the jurisdiction for the item. For example, San Mateo County

Returned only when the 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

taxReply_item_#_jurisdiction_#_rate

Jurisdiction tax rate for the item.

Returned only when the 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

taxReply_item_#_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 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

taxReply_item_#_jurisdiction_#_taxable

Jurisdiction taxable amount for the item, not including product level exemptions.

Returned only when the 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

taxReply_item_#_jurisdiction_#_taxAmount

Jurisdiction taxable amount for the item.

Returned only when the 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

taxReply_item_#_jurisdiction_#_taxName

Name of the jurisdiction tax for the item.

For example, CA State Tax.

Returned only when the 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

taxReply_item_#_jurisdiction_#_type

Type of jurisdiction for the item.

For example, city, county, state, country, or special.

Returned only when the 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

taxReply_item_#_specialTaxAmount

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

taxReply_item_#_stateTaxAmount

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

taxReply_item_#_taxableAmount

Taxable amount for the item.

Specifications

Data Type:
String

Data Length:
15

Mapping Information

REST API Fields:

orderInformation.lineItems[].taxableAmount

SCMP API Field:

tax_taxable_amount0..N

Simple Order API Field:

taxReply_item_#_taxableAmount

taxReply_item_#_totalTaxAmount

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

taxReply_reasonCode

Numeric value corresponding to the result of the Tax Calculation service request.

Specifications

Data Type:
Integer

Data Length:
5

Mapping Information

REST API Field:
No corresponding field.

SCMP API Field:
No corresponding field.

Simple Order API Field:

taxReply_reasonCode

taxReply_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

taxReply_totalCityTaxAmount

Total amount of applicable taxes (city, county, national, special, state). This value is the sum of the values for all the applicable tax fields.

Specifications

Data Type:
String

Data Length:
15

Mapping Information

REST API Field:

orderInformation.taxDetails[].amount

orderInformation.taxDetails[].type = "city"

orderInformation.taxDetails[].type = "county"

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

taxReply_totalCountryTaxAmount

Total amount of applicable taxes (city, county, national, special, state). This value is the sum of the values for all the applicable tax fields.

Specifications

Data Type:
String

Data Length:
15

Mapping Information

REST API Field:

orderInformation.taxDetails[].amount

orderInformation.taxDetails[].type = "city"

orderInformation.taxDetails[].type = "county"

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

taxReply_totalCountyTaxAmount

Total amount of applicable taxes (city, county, national, special, state). This value is the sum of the values for all the applicable tax fields.

Specifications

Data Type:
String

Data Length:
15

Mapping Information

REST API Field:

orderInformation.taxDetails[].amount

orderInformation.taxDetails[].type = "city"

orderInformation.taxDetails[].type = "county"

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

taxReply_totalExemptAmount

Total amount of exempt amounts.

This value is the sum of the values for all the

taxReply_item_#_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

taxReply_totalSpecialTaxAmount

Total amount of applicable taxes (city, county, national, special, state). This value is the sum of the values for all the applicable tax fields.

Specifications

Data Type:
String

Data Length:
15

Mapping Information

REST API Field:

orderInformation.taxDetails[].amount

orderInformation.taxDetails[].type = "city"

orderInformation.taxDetails[].type = "county"

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

Total amount of applicable taxes (city, county, national, special, state). This value is the sum of the values for all the applicable tax fields.

Specifications

Data Type:
String

Data Length:
15

Mapping Information

REST API Field:

orderInformation.taxDetails[].amount

orderInformation.taxDetails[].type = "city"

orderInformation.taxDetails[].type = "county"

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

taxReply_totalTaxableAmount

Total amount of all taxable amounts.

This value is the sum of the values for all the

taxReply_item_#_taxableAmount

fields.

Specifications

Data Type:
String

Data Length:
15

Mapping Information

REST API Field:

orderInformation.taxableAmount

SCMP API Field:

tax_total_taxable_amount

Simple Order API Field:

taxReply_totalTaxableAmount

taxReply_totalTaxAmount

Total tax for all items.

Specifications

Data Type:
String

Data Length:
15

Mapping Information

REST API Field:

orderInformation.taxAmount

SCMP API Field:

tax_total_tax

Simple Order API Field:

taxReply_totalTaxAmount

taxService_buyerRegistration

Buyer’s VAT registration number.

This field is available on the Barclays, Elavon Americas, FDC Nashville Global, GPN, OmniPay Direct, RBS WorldPay Atlanta, 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

RBS WorldPay Atlanta: Customer VAT Number

TSYS Acquiring Solutions: Customer VAT Registration Number

Visa Platform Connect: purchaseVATRegistrationNumber

taxService_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:

true

false

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

taxService_dateOverrideReason

When a past or future date is specified in

invoiceHeader_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

taxService_nexus

List of states or provinces in which merchandise is taxable.

Do not use both the

taxService_nexus

and

taxService_noNexus

fields in your request. The default value for

taxService_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.

Use the State, Province, and Territory Codes for the United States and Canada.

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

taxService_noNexus

List of states or provinces in which merchandise is not taxable.

Do not use both the

taxService_nexus

and

taxService_noNexus

fields in your request. The default value for

taxService_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.

See State, Province, and Territory Codes for the United States and Canada.

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

taxService_orderAcceptanceCity

City where you accept the customer’s order.

This

item-level

field overrides the corresponding request-level field.

This field is not used for tax calculation unless the

taxService_orderAcceptanceState

and

taxService_orderAcceptanceCountry

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

taxService_orderAcceptanceCountry

Country where you accept the customer’s order.

Use the two-character ISO standard country code.

See ISO Standard Country Codes.

This

item-level

field overrides the corresponding request-level field.

This field is not used for tax calculation unless the

taxService_orderAcceptanceState

and

taxService_orderAcceptanceCity

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

taxService_orderAcceptancePostalCode

Postal code where you accept the customer’s order.

This

item-level

field overrides the corresponding request-level field.

This field is not used for Tax Calculation unless the

taxService_orderAcceptanceCity

,

taxService orderAcceptanceState

, and

taxService_orderAcceptanceCountry

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

taxService_orderAcceptanceState

State where you accept the customer’s order.

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

See State, Province, and Territory Codes for the United States and Canada.

This

item-level

field overrides the corresponding request-level field.

This field is not used for Tax Calculation unless the

taxService_orderAcceptanceCity

and

taxService_orderAcceptanceCountry

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

taxService_orderOriginCity

City where you receive the customer’s order.

This

item-level

field overrides the corresponding request-level field.

This field is not used for tax calculation unless the

taxService_orderOriginState

and

taxService_orderOriginCountry

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

taxService_orderOriginCountry

Country where you receive the customer’s order.

Use the two-character ISO standard country code.

See ISO Standard Country Codes.

This

item-level

field overrides the corresponding request-level field.

This field is not used for tax calculation unless the

taxService_orderOriginState

and

taxService_orderOriginCity

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

taxService_orderOriginPostalCode

Postal code where you receive the customer’s order.

This

item-level

field overrides the corresponding request-level field.

This field is not used for Tax Calculation unless the

taxService_orderOriginCity

,

taxService_orderOriginState

, and

taxService_orderOriginCountry

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

taxService_orderOriginState

State where you receive the customer’s order.

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

See State, Province, and Territory Codes for the United States and Canada.

This

item-level

field overrides the corresponding request-level field.

This field is not used for tax calculation unless the

taxService_orderOriginCity

and

taxService_orderOriginCountry

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

taxService_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

taxService_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

taxService_run

Services to process for the request.

Tax Calculation: Set this field to
TRUE
to request the tax service.

Specifications

Data Type:
String

Data Length:
5

Mapping Information

REST API Field:
No corresponding field.

SCMP API Field:
No corresponding field.

Simple Order API Field:

taxService_run

taxService_sellerRegistration

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, RBS WorldPay Atlanta, TSYS Acquiring Solutions, Visa Platform Connect, and Worldpay VAP processors.

Specifications

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

RBS WorldPay Atlanta: 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

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

token_expirationMonth

token_prefix

Simple Order API Field:

token_prefix

tokenSource_networkTokenOption

Indicates whether Cybersource 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

tokenSource_transientToken

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

tokenSource_transientToken

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

token_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

transactionLocalDateTime

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

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

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

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

ucaf_authenticationData

Universal cardholder authentication field (UCAF) data.

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

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

ucaf_collectionIndicator

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

payerAuthValidateReply_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.

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 with numbers only

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

ucaf_downgradeReasonCode

Reason the transaction was downgraded.

This field is available only for downgraded Mastercard Identity Check transactions on Visa Platform Connect.

When you set the e-commerce indicator to a value that indicates that Mastercard Identity Check data is included in the request, Mastercard provides this value when the transaction is downgraded.

Possible values:

0

: The

ucaf_authenticationData

field is missing.

1

: The value for the

ucaf_authenticationData

field is invalid.

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

Record: CP01 TCR6

Position: 80

Field: Mastercard Electronic Commerce Indicators

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:
No corresonding field.

SCMP API Field:

ucaf_downgrade_reason_code

Simple Order API Field:

ucaf_downgradeReasonCode

vc_orderID

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

verificationResults_buyerRegistration

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.

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)

verificationResults_driversLicenseNumber

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.

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

verificationResults_merchantTaxID

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.

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

verificationResults_passportNumber

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.

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)

verificationResults_personalId

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.

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

voidReply_amount

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

voidReply_creditAuthReversalResponse

Processor response code.

The processor provides this value when a credit authorization reversal does not succeed.

Specifications

Data Type:
String

Data Length:
3

Mapping Information

REST API Field:
No corresponding field.

SCMP API Field:

void_credit_auth_reversal_response

Simple Order API Field:

voidReply_creditAuthReversalResponse

voidReply_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

voidReply_reasonCode

Numeric value that corresponds to the result of the void request.

Specifications

Data Type:
Integer

Data Length:
5

Mapping Information

REST API Field:
No corresponding field.

SCMP API Field:
No corresponding field.

Simple Order API Field:

voidReply_reasonCode

voidReply_requestDateTime

Time when the service was requested in Coordinated Universal Time (UTC).

Specifications

Type:
Date and time

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

voidReply_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:

true

: Authorization reversal was successfully submitted.

false

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

Specifications

Data Type:
String

Data Length:
5

Mapping Information

REST API Field:

authorizationInformation.reversalSubmitted

SCMP API Field:

reversal_submitted

Simple Order API Field:

voidReply_reversalSubmitted

voidService_run

Flag that specifies whether to include the void service in the request.

Possible values:

true

: Include the service in the request.

false

(default): Do not include the service in the request.

Specifications

Type:
String

Length:
5

Mapping Information

REST API Field:
No corresponding field.

SCMP API Field:
No corresponding field.

Simple Order API Field:

voidService_run

voidService_voidRequestID

Request ID of the capture or credit you want to void.

Specifications

Data Type:
String

Data Length:
26

Mapping Information

REST API Field:
No corresponding field.

SCMP API Field:

void_request_id

Simple Order API Field:

voidService_voidRequestID

voidService_voidRequestToken

Value of the request token returned from a previous request for a service that you want to void.

This value is an encoded string that contains no confidential information, such as an account number or card verification number.

Specifications

Data Type:
String

Data Length:
256

Mapping Information

REST API Field:
No corresponding field.

SCMP API Field:

void_request_token

Simple Order API Field:

voidService_voidRequestToken

wallet_type

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

orderInformation. shipTo.administrativeArea

State of the shipping address.

Specifications

Data Type:
String

Data Length:
80

Mapping Information

REST API Field:

orderInformation.shipTo.administrativeArea

SCMP API Field:

ship_to_state

Simple Order API Field:

shipTo_state

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

orderInformation. amountDetails.foreignCurrency

Customer’s billing currency.

Specifications

Data Type:
String

Data Length:
5

Mapping Information

REST API Field:

orderInformation.amountDetails.foreignCurrency

SCMP API Field:

foreign_currency

Simple Order API Field:

purchaseTotals_foreignCurrency

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

travelInformation. autoRental. returnAddress.state

This value is the state in which the vehicle was returned to the rental agency. 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.returnAddress.state

SCMP Field Name:

auto_rental_return_state

Simple Order Field Name:

autoRentalData_returnstate

processorInformation. merchantRiskPrediction

This value is the merchant risk prediction score. The score consists of seven independent scores that are determined by artificial intelligence (AI). The merchant risk prediction score is used in addition to existing risk management practices.

This field is available only for Visa Platform Connect.

Specifications

Data Type:
String

Data Length:
150

Mapping Information

REST API Field:

processorInformation.merchantRiskPrediction

SCMP API Field:

merchant_risk_prediction

Simple Order API Field:

merchant_riskPrediction

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

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.
Visa Platform Connect: 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

travelInformation.lodging. numberOfRooms

Number of rooms booked by the cardholder.

Specifications

Data Type:
Integer

Data Length:
2

Mapping

REST Field Name:

travelInformation.lodging.numberOfRooms

Simple Order Field Name:

lodgingData_numberOfRooms

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: 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

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

travelInformation. transit. airline. clearingSequence

Number that identifies each clearing message associated with an authorization request.

Each clearing message linked to an authorization request must include a unique clearing sequence number between 1 and the total number of clearing records.

Specifications

Data Type:
String

Data Length:
2

Mapping Information

REST API Field:

travelInformation.transit.airline.clearingSequence

Simple Order API Field:

airlineData_clearingSequence

consumerAuthenticationInformation. overrideCountryCode

Two-character ISO standard country code.

See ISO Standard Country Codes.

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

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

item_#_nationalTax

differs from

item_#_taxAmount

. If you do not provide this value, Cybersource assumes that

item_#_nationalTax

is equal to

item_#_taxAmount

.

RBS WorldPay Atlanta: The value of this field cannot exceed
999999.99
.
FDC Nashville Global: The total should not include the local tax amount (
item_#_taxAmount
field) and national tax (
national_tax
item_#_nationalAmount
field) incluced in the total tax (
tax_amount
field).
GPN: The maximum amount is 99,999.99.
RBS WorldPay Atlanta: The maximum amount is 99,999.99.
OmniPay Direct: When you include this field in the request, you must also include the
item_#_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

RBS WorldPay Atlanta: 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)

RBS WorldPay Atlanta:
VAT Tax Amount

TSYS Acquiring Solutions:
National Tax Amount, Alternate Tax Amount and VAT/Tax Amount

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 Visa Platform Connect 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

senderInformation. middleName

Middle name of sender when the sender is an individual. When the sender is a business or government entity, use the

sender_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 Cybersource. 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
sender_firstname
,
sender_middlename
, and
sender_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

orderInformation. shipTo.firstName

First name of the person receiving the shipment.

The field is available for these processors: AIBMS, Bank of America ACH, Banque de France et Tresor Public, Barclays, BNP Paribas France, Chase Paymentech Solutions, Chase Paymentech Tandem, China UnionPay, Cielo, Comercio Latino, Credit Mutuel-CIC, Cybersource ACH Service, Elavon, Elavon Americas, FDC Compass, FDC Nashville Global, FDI Australia, FDMS Nashville, First Data Merchant Solutions, Getnet, GPN, HBoS, HSBC, JCN Gateway, Korean Cyber Payments, Lloyds-OmniPay, LloydsTSB Cardnet, Moneris, OmniPay Direct, Prosa, RBS WorldPay Atlanta, Rede, RuPay, SIX, Streamline, TeleCheck, UATP, ValueLink, Vero, TSYS Acquiring Solutions, Visa Platform Connect, Worldpay VAP, Wells Fargo ACH.

Specifications

Data Type:
Request

Data Format:
String

Data Length

Worldpay VAP: 35

Other processors: 60

Mapping Information

REST API Field:

orderInformation.shipTo.firstName

SCMP API Field:

ship_to_firstname

Simple Order API Field:

shipTo_firstName

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: String

Data Length: 5

Mapping Information

REST API Field:

processingInformation.authorizationOptions.balanceInquiry

Simple Order API Field:

balanceInquiry

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

travelInformation. actualFinalDestination.latitude

Latitude of the actual final destination.

Use the format: ###.######

For example: 12.982267

Specifications

Data Type:
String

Data Length:
15

Mapping Information

REST API Field:

travelInformation.actualFinalDestination.latitude

SCMP API Field:

decision_travel_actual_final_destination_latitude

Simple Order API Field:

decisionReply_travel_actualFinalDestinationLatitude

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

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

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 Cybersource. 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

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

paymentInformation. bank.country

Country where the bank is located.

Use the two-character ISO codes

listed in ISO Standard Currency Codes

. You can use this field only when scoring a direct debit transaction.

Specifications

Data Type:
String

Data Length:
2

Mapping Information

REST API Field:

paymentInformation.bank.country

SCMP API Field:

bank_country

Simple Order API Field:

bankInfo_country

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 Cybersource. 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

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

paymentInformation. fluidData.descriptor

Format of the encrypted payment data.

Possible values:

Apple Pay:

RklEPUNPTU1PTi5BUFBMRS5JTkFQUC5QQVlNRU5U

Blue PCI P2PE:

Ymx1ZWZpbg==

Samsung Pay:

RklEPUNPTU1PTi5TQU1TVU5HLklOQVBQLlBBWU1FTlQ=

Specifications

Data Type:
String

Data Length:
128

Mapping Information

REST API Field:

paymentInformation.fluidData.descriptor

SCMP API Field:

encrypted_payment_descriptor

Simple Order API Field:

encryptedPayment_descriptor

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

RBS WorldPay Atlanta: Gross Net Indicator

TSYS Acquiring Solutions: Net/Gross Indicator

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

travelInformation. autoRental. maxFreeDistance

This field value is the maximum number of free miles or kilometers that are allowed to a customer for the duration of the auto rental agreement.

This field is supported only for Mastercard and American Express. It is supported only with the capture service.

Specifications

Data Type:
String

Data Length:
4

Mapping

REST Field Name:

travelInformation.autoRental.maxFreeDistance

SCMP Field Name:

auto_rental_maximum_free_miles

Simple Order Field Name:

autoRentalData_maximumFreeMiles

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.lodging. loungeBarCost

Cost of lounge and bar purchases.

Specifications

Data Type:
Sting

Data Length:
12

Mapping Information

REST API Field:

travelInformation.lodging.loungeBarCost

Simple Order API Field:

lodgingData_loungeBarCost

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

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

.

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

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 Cybersource 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 Cybersource. 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

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

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 Cybersource. 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.deferredAuthIndicator

SCMP API Field:

auth_deferred_auth_indicator

Simple Order API Field:

ccAuthService_deferredAuthIndicator

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 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

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

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

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

paymentInformation. accountFeatures. accountStatus

travelInformation.transit.airline.legs[].conjunctionTicket

SCMP API Field:

airline_leg#_conjunction_ticket

Simple Order API Field:

airlineData_leg_#_conjunctionTicket

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

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

travelInformation.lodging. corporateClientCode

Code assigned to a business. You can use this code to identify corporate rates and discounts for guests.

Specifications

Data Type:
String

Data Length:
17

Mapping Information

REST API Field:

travelInformation.lodging.corporateClientCode

Simple Order API Field:

lodgingData_corporateClientCode

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. 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.

Specifications

Data Type:
String

Data Length:
40

Mapping Information

REST API Field:

paymentinformation.tokenizedCard.cryptogram

SCMP API Field:

network_token_cryptogram

Simple Order API Field:

ccAuthService_networkTokenCryptogram

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.

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

tokenInformation. networkTokenOption

Indicates whether Cybersource 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

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

item_#_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

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

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.

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

processorInformation. electronicVerificationResults.email

Mapped electronic verification response code for the customer’s email address.

Specifications

Type:
String

Length:
1

Mapping Information

REST API Field:

processorInformation.electronicVerificationResults.email

SCMP API Field:

auth_ev_email

Simple Order API Field:

ccAuthReply_evEmail

processorInformation. merchantNumber

Identifier that was assigned to you by your acquirer.

This value must be printed on the receipt.

This field is supported only for Cybersource integrations.

Specifications

Data Type:
String

Data Length:
15

Mapping Information

REST API Field:

processorInformation.merchantNumber

SCMP API Field:

acquirer_merchant_number

Simple Order API Field:

acquirerMerchantNumber

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

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. fluidData.encoding

Encoding method used to encrypt the payment data.

For Apple Pay transactions, the encoding method is Base64.

Specifications

Data Type:
String

Data Length:
6

Mapping Information

REST API Field:

paymentInformation.fluidData.encoding

SCMP API Field:

encrypted_payment_encoding

Simple Order API Field:

encryptedPayment_encoding

paymentInformation. bank.account. correctedAccountNumber

Corrected account number from the ACH verification service.

Specifications

Data Type:
String

Data Length:
17

Mapping Information

REST API Field:

paymentInformation.bank.account.correctedAccountNumber

SCMP API Field:

ecp_debit_corrected_account_number

Simple Order API Field:

ecDebitReply_correctedAccountNumber

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

Y

if the

itam_#_discountAmount

field is greater than 0.

Specifications

Type:
String

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. billTo.email

Customer's email address, including full domain name.

Format: name@host.domain

This field is optional if your account is configured for relaxed requirements for address data.

For details about relaxed requirements, see the support article Relaxed Requirements for Address Data and Expiration Date in Credit Card Transactions.

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

travelInformation.lodging. transportationCost

Cost of transportation services.

Specifications

Data Type:
String

Data Length:
12

Mapping Information

REST API Field:

travelInformation.lodging.transportationCost

Simple Order API Field:

lodgingData_transportationCost

submitTimeUTC

Time when the service was requested in Coordinated Universal Time (UTC).

Specifications

Type:
Date and time

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

pointOfSaleInformation. cardholderVerificationMethod

List of cardholder verification methods (CVMs) supported by the terminal.

This field is available only for Cybersource 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_#

paymentInformation. card.expirationMonth

Two-digit month in which the payment card expires.

Format: MM

Possible values:

01

through

12

. Leading

0

is required.

This field is optional if your account is configured for relaxed requirements for expiration date.

For details about relaxed requirements, see the support article Relaxed Requirements for Address Data and Expiration Date in Credit Card Transactions

.

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 Cybersource to reject a request. However, an invalid expiration date might cause the issuer to reject a request.
Chase Paymentech Solutions: For encoded account numbers (
card_cardType
=
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

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

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

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

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

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

orderInformation. amountDetails.gratuityAmount

Gratuity or tip amount for restaurants when the card is present.

Allowed only when the

ccCaptureService_industryDatatype

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

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

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

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

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

card_cvNumber

field in the request.

1

(default): CVN service requested and supported. This default value is used when you include the

card_cvNumber

field in the request.

2

: CVN on payment card is illegible.

9

: CVN not imprinted on payment card.

Specifications

Data Type:
Nonnegative integer

Data Length:
1

Mapping Information

REST API Field:

paymentInformation.card.securityCodeIndicator

SCMP API Field:

customer_cc_cv_indicator

Simple Order API Field:

card_cvIndicator

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

paymentInformation.bank.account. checkTransactionCode

Process control transaction code of the check.

This code is included in the stop-payment inquiry. The check must be identified by a check number, but the process control transaction code can also help to identify the check. If a process control transaction code appears on a check, it is part of the MICR line to the right of the On-Us symbol immediately following the bank account number.

Specifications

Data Type:
String

Data Length:
6

Mapping Information

REST API Field:

paymentInformation.bank.account.checkTransactionCode

SCMP API Field:

ecp_check_transaction_code

Simple Order API Field:

check_checkTransactionCode

healthCareInformation. amountDetails.amount

Amount of the healthcare payment.

Replace the # character with a sequential number from

0

to

4

.

Send this field with a corresponding

healthCare#_amountType

field.

Example:

<healthCare id="0">
  <amountType>vision</amountType>
  <amount>60.00</amount>

Specifications

Data Type:
String

Data Length:
13

Mapping Information

REST API Field:

healthCareInformation.amountDetails.amount

SCMP API Field:

health_care_#_amount

Simple Order API Field:

healthCare#_amount

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

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

promotionInformation.code

Code for a promotion or discount.

Specifications

Data Type:
String

Data Length:
12

Mapping Information

REST API Field:

promotionInformation.code

Simple Order API Field:

lodgingData_promotionalCode

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 Cybersource 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

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

.

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.

Barclays: Line Item Total

Chase Paymentech Solutions: Does not apply

FDC Compass: Does not apply

FDC Nashville Global: Does not apply

OmniPay Direct: Line Item Total

RBS WorldPay Atlanta: Amount

TSYS Acquiring Solutions: Does not apply

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 Cybersource system but then capture the order through Cybersource. 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 Cybersource, 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

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

travelInformation.lodging. giftShopCost

Cost of gift shop purchases.

Specifications

Data Type:
String

Data Length:
12

Mapping Information

REST API Field:

travelInformation.lodging.giftShopCost

Simple Order API Field:

lodgingData_giftShopCost

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, RBS WorldPay Atlanta, and TSYS Acquiring Solutions processors.

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, RBS WorldPay Atlanta, 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

Barclays: 2

Chase Paymentech Solutions: 4 numeric

Elavon Americas: 4 numeric

FDC Compass: 4 numeric

RBS WorldPay Atlanta: 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

RBS WorldPay Atlanta: Tax Type

TSYS Acquiring Solutions: Tax Type Applied

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

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

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

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):

Data Type:
String with numbers only

Data Length:
19

Other Processors:

Data Type:
String with numbers only

Data Length:
20

Mapping Information

REST API Field:

paymentInformation.card.number

SCMP API Field:

customer_cc_number

Simple Order API Field:

card_accountNumber

travelInformation. transit.airline. ticketIssueDate

Simple Order API Fields:

payerAuthEnrollReply_authenticationStatusReason

payerAuthValidateReply_authenticationStatusReason

merchantInformation. merchantDescriptor. country

Country code for your business location.

Use the two-character ISO country code.

See ISO Standard Country Codes

.

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

This value must consist of English characters.

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

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

invoiceHeader_merchantDescriptorState

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

octService_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
invoiceHeader_submerchantCountry
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

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

travelInformation.lodging. guestName

Name of the guest under which the room is reserved.

Specifications

Data Type:
String

Data Length:
40

Mapping Information

REST API Field:

travelInformation.lodging.guestName

Simple Order API Field:

lodgingData_guestName

orderInformation. lineItems[].jurisdiction[]. type

Type of jurisdiction for the item.

For example, city, county, state, country, or special.

Returned only when the 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

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, Cybersource 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

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

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:

true

: Fallback available

false

(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

deviceInformation. httpBrowserScreenWidth

Total width of the cardholder's screen in pixels.

Example
:

1536

Specifications

Data Type:
String

Data Length:
6

Mapping Information

REST API Field:

deviceInformation.httpBrowserScreenWidth

SCMP API Field:

http_browser_screen_width

Simple Order API Field:

billTo_httpBrowserScreenWidth

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

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

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

travelInformation. transit.airline.ancillaryInformation. ticketNumber

Ticket number, which consists of carrier code, form, and serial number, without the check digit.

Specifications

Data Type:
String

Data Length:
15

Mapping Information

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

validationInformation.bank. accountStatus. additionalStatusCode

Additional 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.additionalStatusCode

SCMP API Field:

ecp_avs_additional_status_code

Simple Order API Field:

ecAVSReply_additionalStatusCode

travelInformation.lodging. valetParkingCost

Cost of valet parking services.

Specifications

Data Type:
String

Data Length:
12

Mapping Information

REST API Field:

travelInformation.lodging.valetParkingCost

Simple Order API Field:

lodgingData_valetParkingCost

processorInformation. forwardedAcquirerCode

Name of the Japanese acquirer that processed the transaction.

This field is only returned by the JCN Gateway processor.

Contact the Cybersource 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

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

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

paymentNetworkToken_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

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

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

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

processorInformation. cardVerification.resultCodeRaw

CVN result code sent directly from the processor.

This field is returned only when the processor sends this value.

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

reversalInformation. amountDetails.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.

For partial authorizations, the

ccAuthReply_requestCurrency

field returns the currency code.

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:
5

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

travelInformation. transit.airline. totalFeeAmount

Fee that the customer is charged to change the destination or departure time of an original ticket.

Specifications

Data Type:
Numerical

Data Length:
11

Mapping Information

REST API Field:

travelInformation.transit.airline.totalFeeAmount

SCMP API Field:

airline_total_fee

Simple Order API Field:

airlineData_totalFee

orderInformation. lineItems[].orderOrigin.country

Country where you receive the customer’s order.

Use the two-character ISO standard country code.

See ISO Standard Country Codes.

This

item-level

field overrides the corresponding request-level field.

This field is not used for tax calculation unless the

taxService_orderOriginState

and

taxService_orderOriginCity

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

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

travelInformation.lodging. restaurantCost

Cost of restaurant purchases.

Specifications

Data Type:
String

Data Length:
12

Mapping

REST Field Name:

travelInformation.lodging.restaurantCost

Simple Order Field Name:

lodgingData_restaurantCost

orderInformation. rewardPointsDetails. pointsRedeemed

Number of loyalty points that were redeemed.

Specifications

Data Type:
String

Data Length:
10

Mapping Information

REST API Field:

orderInformation.rewardPointsDetails.pointsRedeemed

Simple Order API Field:

payByPoints_pointsRedeemed

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

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. 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

payerAuthEnrollReply_effectiveAuthenticationType

or

payerAuthValidateReply_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

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

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

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

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.

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, Cybersource 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

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

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

travelInformation. transit.airline. ancillaryInformation. creditReasonIndicator

Indicates reason for credit to cardholder.

Possible Values:

A

: Passenger transport ancillary fee cancellation

B

: Airline ticket and passenger transport ancillary fee cancellation

C

: Airline ticket cancellation

O

: Other

P

: Partial refund of airline ticket

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

travelInformation.transit.airline.ancillaryInformation.creditReasonIndicator

SCMP API Field:

ancillary_credit_reason_indicator

Simple Order API Field:

ancillaryData_creditReasonIndicator

orderInformation. lineItems[].shippingPostalCode

Recipient's postal code.

Specifications

Data Type:
String

Data Length:
16

Mapping Information

REST API Field:

orderInformation.lineItems[].shippingPostalCode

SCMP API Field:

shipping_postal_code

Simple Order API Field:

item_#_shippingPostalCode

orderInformation. amountDetails.amexAdditionalAmounts[N]. amount

Additional amount.

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

Sequence

of fields from

purchaseTotals_additionalAmount0

to

purchaseTotals_additionalAmount4

.

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

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. 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

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

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 Cybersource 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 Cybersource, Cybersource passes this value from the authorization service to the subsequent services for you. However, when you perform authorizations through Cybersource 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

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, Cybersource 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

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:

Visa Platform Connect:
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

RBS WorldPay Atlanta:
Amount

TSYS Acquiring Solutions:
Amount

Visa Platform Connect:
invoiceNumber

Worldpay VAP:
invoiceNumber

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

deviceInformation. httpBrowserJavaEnabled

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

installmentInformation. sequence

Installment payment number.

This field is used along with

installment_totalCount

to track which payment is being processed.

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

installment_sequence=2
installment_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

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

ccAuthReply_cvCode

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

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.

Payouts using FDC Compass: Before sending this value to the processor, Cybersource reformats it to the FDC Compass format: MMDDyyyy.

Specifications

Data Type:
String with numbers only

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

travelInformation. autoRental. programCode

This value identifies special circumstances that apply to the card transaction or cardholder, such as renter
or show
.

Specifications

Data Type:
String

Data Length:
2

Mapping

REST Field Name:

travelInformation.autoRental.programCode

SCMP Field Name:

auto_rental_program_code

Simple Order Field Name:

autoRentalData_programCode

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

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:

RBS WorldPay Atlanta:
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

RBS WorldPay Atlanta:
Discount Amount

TSYS Acquiring Solutions:

Mastercard:
Discount Amount

Visa:
Discount Amount Per Line Item

Visa Platform Connect:
discountAmount

Worldpay VAP:
Item Discount Amount

processorInformation. electronicVerificationResults.codeRaw

Raw electronic verification response code from the processor for the customer’s last name.

Specifications

Data Type:
String

Data Length:
s1

Mapping Information

REST API Field:

processorInformation.electronicVerificationResults.codeRaw

SCMP API Field:

auth_ev_name_raw

Simple Order API Field:

ccAuthReply_evNameRaw

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

Data Type:
String

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

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 Barclays processor:

0

: No information, or response not provided.

1

: Updated or additional information needed.

2

: Cannot approve at this time; try again later.

4

: Do not try again.

8

: Payment blocked by card scheme.

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

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 Cybersource. 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.aggregatedAuthIndicator

SCMP API Field:

aggregated_auth_indicator

Simple Order API Field:

ccAuthService_aggregatedAuthIndicator

clientReferenceInformation. reconciliationId

Reference number for the transaction.

For most Cybersource services, the response message includes a unique reconciliation ID that is assigned by Cybersource. For most payment processors, you can use this value to reconcile the transactions in your Cybersource 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

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

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

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

REST API Field:

aggregatorInformation.postalCode

SCMP API Field:

aggregator_postalCode

Simple Order API Fields:

ccAuthService_aggregatorPostalcode

octService_aggregatorPostalcode

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

travelInformation.lodging. checkOutDate

Date on which the guest checked out.

Format: MMDDYY

Specifications

Data Type:
String

Data Length:
6

Mapping Information

REST API Field:

travelInformation.lodging.checkOutDate

Simple Order API Field:

lodgingData_checkOutDate

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

reason code value of

200

.

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

businessRules_declineAVSFlags

field is ignored.

Specifications

Data Type:
String

Data Length:
5

Mapping Information

REST API Field:

processingInformation.authorizationOptions.ignoreAvsResult

SCMP API Field:

ignore_avs

Simple Order API Field:

businessRules_ignoreAVSResult

orderInformation. lineItems[]. shippingAddress1

Address to which the item will be shipped.

Specifications

Data Type:
String

Data Length:
50

Mapping Information

REST API Field:

orderInformation.lineItems[].shippingAddress1

SCMP API Field:

shipping_address1

Simple Order API Field:

item_#_shippingAddress1

addressVerificationInformation. standardAddress.address1. withoutApartment

First line of the standardized address, without apartment information.

Returned for US and Canadian addresses.

Specifications

Data Type:
String

Data Length:
255

Mapping Information

REST API Field:

addressVerificationInformation.standardAddress.address1.withoutApartment

SCMP API Field:

dav_standard_address_noapt

Simple Order API Field:

davReply_standardizedAddressNoApt

orderInformation. lineItems[].taxDetails[].applied

A flag that indicates whether an alternative tax amount (

otherTax_alternateTaxAmount

) is included in the request.

Possible values for this field:

0

: Alternate tax amount is not included in the request

1

: Alternate tax amount is included in the request

Specifications

Data Type:
String

Data Length:
1

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

RBS WorldPay Atlanta: Alternate Tax Indicator

TSYS Acquiring Solutions: Alternate Tax Amount Indicator

orderInformation. invoiceDetails. referenceDataCode

Code that identifies the value of the

invoiceHeader_referenceDataNumber

field.

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

This field is a pass-through, which means that this value is not verified or modified in any way before it is sent to the processor.

Specifications

Data Type:
String

Data Length:
3

Mapping Information

REST API Field:

orderInformation.invoiceDetails.referenceDataCode

SCMP API Field:

reference_data_code

Simple Order API Field:

invoiceHeader_referenceDataCode

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

travelInformation. actualFinalDestination.longitude

Longitude of the actual final destination.

Use the format: ###.######

For example: 80.16378

Specifications

Data Type:
String

Data Length:
15

Mapping Information

REST API Field:

travelInformation.actualFinalDestination.longitude

SCMP API Field:

decision_travel_actual_final_destination_longitude

Simple Order API Field:

decisionReply_travel_actualFinalDestinationLongitude

orderInformation. lineItems[].jurisdiction[]. taxable

Jurisdiction taxable amount for the item, not including product level exemptions.

Returned only when the 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

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 Cybersource. 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.extendAuthIndicator

SCMP API Field:

auth_extend_auth_indicator

Simple Order API Field:

ccAuthService_extendAuthIndicator

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. 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

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, RBS WorldPay Atlanta, TSYS Acquiring Solutions, Visa Platform Connect, and Worldpay VAP processors.

Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths.

Barclays: Value must be numeric with two exponents.
Visa Platform Connect: 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

purchaseTotals_grandTotalAmount

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

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)

RBS WorldPay Atlanta: 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.

American Express Direct: Does not apply

Barclays: Unit Price

Chase Paymentech Solutions: Unit Cost

Elavon Americas: Unit Cost

FDC Compass: Unit Cost

FDC Nashville Global: Item Unit Cost

FDMS Nashville: Does not apply

GPN: Unit Price

OmniPay Direct: Unit Cost/Unit Price

RBS WorldPay Atlanta: Unit Cost

TSYS Acquiring Solutions: Unit Cost

Visa Platform Connect: unitPrice

Worldpay VAP: unitCost

orderInformation. invoiceDetails. purchaseContactName

The name of the individual or the company contacted for company authorized purchases.

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

Specifications

Data Type:
String

Data Length:
36

Mapping Information

REST API Field:

orderInformation.invoiceDetails.purchaseContactName

SCMP API Field:

authorized_contact_name

Simple Order API Field:

invoiceHeader_authorizedContactName

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: authorizedContactName

orderInformation. shipTo.address2

Second line of the shipping address.

This field is available on these processors: AIBMS, American Express Direct, Bank of America ACH, Banque de France et Tresor Public, Barclays, BNP Paribas France, Chase Paymentech Solutions, Chase Paymentech Tandem, China UnionPay, Cielo, Comercio Latino, Credit Mutuel-CIC, Cybersource ACH Service, Elavon, Elavon Americas, FDC Compass, FDC Nashville Global, FDI Australia, FDMS Nashville, First Data Merchant Solutions, Getnet, GPN, HBoS, HSBC, JCN Gateway, Korean Cyber Payments, Lloyds-OmniPay, LloydsTSB Cardnet, Moneris, OmniPay Direct, Prosa, RBS WorldPay Atlanta, Rede, RuPay, SIX, Streamline, TeleCheck, UATP, ValueLink, Vero, Visa Platform Connect, Worldpay VAP, TSYS Acquiring Solutions, and Wells Fargo ACH.

Specifications

Data Type:
Request

Data Format:
String

Data Length:

Worldpay VAP:
35

Other processors:
60

Mapping Information

REST API Field:

orderInformation.shipTo.address2

SCMP API Field:

ship_to_address2

Simple Order API Field:

shipTo_street2

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

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

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

orderInformation. billTo.phoneNumber

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 Cybersource. 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

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

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

ccAuthReply_merchantAdviceCode

for Visa and Mastercard. See ccAuthReply_merchantAdviceCode 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.

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

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, RBS WorldPay Atlanta, 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.

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
sender_state
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

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:
Integer

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

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

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

orderInformation. lineItems[].passenger.phone

Passenger's phone number.

If the order is from outside the US, it is recommended that you include the telephone country code.

Specifications

Data Type:
String

Data Length:
15

Mapping Information

REST API Field:

orderInformation.lineItems[].passenger.phone

SCMP API Field:

passenger_phone

Simple Order API Field:

item_#_passengerPhone

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

processorInformation. electronicVerificationResults.code

Mapped electronic verification response code for the customer’s name.

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

processorInformation.electronicVerificationResults.code

SCMP API Field:

auth_ev_name

Simple Order API Field:

ccAuthReply_evName

consumerAuthenticationInformation. mcc

Merchant category code.

Specifications

Data Type:
Integer

Data Length:
4

Mapping Information

REST API Field:

consumerAuthenticationInformation. mcc

SCMP API Field:

pa_mcc

Simple Order API Field:

payerAuthEnrollService_MCC

travelInformation. autoRental. oneWayDropOffAmount

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. transit. airline. ticketNumber

Ticket number.

This field only accepts letters, numbers and spaces. Special characters are not allowed.

Specifications

Data Type:
String

Data Length:
15

Mapping Information

REST API Field:

travelInformation.transit.airline.ticketNumber

Simple Order API Field:

airlineData_ticketNumber

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

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.

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.

Barclays: Format: yyyyMMddHHmmss
Other processors: Format: yyyyMMdd

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

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

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

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

travelInformation.lodging. cashDisbursementCost

Cost of the cash that was disbursed plus any associated service fees.

Specifications

Data Type:
String

Data Length:
12

Mapping Information

REST API Field:
t

ravelInformation.lodging.cashDisbursementCost

Simple Order API Field:

lodgingData_cashDisbursementCost

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

orderInformation. billTo. address3

Third line of the billing street address as it appears in the payment card issuer records.

Specifications

Data Type:
String

Data Length:
50

Mapping Information

REST API Field:

orderInformation.billTo.address3

SCMP API Field:

bill_address3

Simple Order API Field:

billTo_street3

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).

Do not include the IBAN or BBAN in this field. Include the IBAN in the

fundTransfer_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

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

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

watchlistScreeningInformation. watchList.matches[].addresses[]

Address was found on the matched sanction list for the entity (name and address) in the request.

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

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

merchantInformation. merchantDescriptor.countryOfOrigin

Country of origin for your business.

Use the two-character ISO country code.

See ISO Standard Country Codes

.

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 Cybersource 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 Cybersource 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

travelInformation. autoRental. mileageCharge

This field value is the amount charged in the contract for the miles that are traveled during the vehicle rental.

Use two decimal places when entering the charge.

Specifications

Data Type:
String

Data Length:
12

Mapping

REST Field Name:

travelInformation.autoRental.mileageCharge

SCMP Field Name:

auto_rental_regular_mileage_cost

Simple Order Field Name:

autoRentalData_regularMileageCost

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

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

processingInformation. japanPaymentOptions. bonusAmount

If this field is included in a Japanese payment transaction, it specifies the amount of the bonus.

Specifications

Data Length:
12

Mapping Information

REST API Field:

processingInformation.japanPaymentOptions.bonusAmount

SCMP API Field:

jpo_bonus_amount

Simple Order API Field:

jpo_bonusAmount

orderInformation. billTo. alternateEmailAddress

Customer's alternate email address.

This field is available only for the Visa Platform Connect 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

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

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
shipTo_postalCode
field is not included in the request and the service defaults to
billTo_ postalCode
, the value for the
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.

This field is available only on these processors: American Express Direct, Chase Paymentech Solutions, Elavon Americas, FDC Compass, FDC Nashville Global, FDMS Nashville, GPN, OmniPay Direct, RBS WorldPay Atlanta, TSYS Acquiring Solutions, Visa Platform Connect, and Worldpay VAP.

These processors have specific requirements:

American Express Direct: Before sending the postal code to the processor, all non-alphanumeric characters are removed. When the remaining value is longer than nine characters, the value is truncated starting from the right side.; The postal code is required for Level II processing in the US and US territories. When you do not include this field in the request, the value for the
billTo_postalCode
field is used. When you do not include either field, the value in your account is used.
Chase Paymentech Solutions , Elavon Americas , FDC Compass , FDC Nashville Global , OmniPay Direct , TSYS Acquiring Solutions , Visa Platform Connect , and Worldpay VAP: This value is the same as the value for
shipFrom_postalCode
when your customer takes possession of the items at your location.
FDC Nashville Global , FDMS Nashville , and RBS WorldPay Atlanta: If the postal code for the shipping address is not included in the request message, the postal code for the billing address is used. If the postal code for the billing address is not included in the request message, the postal code for the shipping address is required.
Worldpay VAP: It is recommended that this value not exceed 10 characters. If this value is not included in the request, the
billTo_postalCode
value from the authorization request is used.

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:

American Express Direct: Does not apply

Chase Paymentech Solutions: Destination ZIP/Postal Code

Elavon Americas: Destination ZIP/Postal Code

FDC Compass: Destination ZIP/Postal Code

FDC Nashville Global: Destination ZIP

FDMS Nashville: Does not apply

GPN: Destination Postal/ZIP Code

OmniPay Direct: Destination Postal/ZIP Code

RBS WorldPay Atlanta: Destination ZIP

TSYS Acquiring Solutions: Destination Postal/ZIP Code

Visa Platform Connect: shipToAddress

Worldpay VAP: destinationPostalCode

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

ccAuthReply_paymentNetworkTransactionID

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

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

orderInformation.billTo. namePrefix

Name prefix.

For example, Dr.

Specifications

Data Type:
String

Data Length:
4

Mapping Information

REST API Field:

orderInformation.billTo.namePrefix

SCMP API Field:

customer_prefix

Simple Order API Field:

billTo_prefix

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

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

processingInformation. captureOptions. captureSequenceNumber

Capture number when requesting multiple partial captures for one authorization.

This value is used along with

ccCaptureService_totalCount

to track which capture is being processed.

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

ccCaptureService_sequence=2
ccCaptureService_totalCount=5

Visa Platform Connect

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

travelInformation.lodging. movieCost

Cost of movies.

Specifications

Data Type:
String

Data Length:
12

Mapping Information

REST API Field:

travelInformation.lodging.movieCost

Simple Order API Field:

lodgingData_movieCost

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. transit.airline.legs[]. departureDate

Departure date for the first leg of the trip. Can also be referred to as effective date.

Format:

YYYYMMDD

Payer Authentication: The numbered element name should contain
0
instead of
#
. Payer Authentication services only use the first leg of the trip.

Specifications

Data Type:
Integer

Data Length:
8

Mapping Information

REST API Field:

travelInformation.transit.airline.legs[].departureDate

SCMP API Field:

airline_leg#_leg_departure_date

Simple Order API Field:

airlineData_leg_#_departureDate

orderInformation. shipTo.locality

City of the shipping address.

When the field is not included in the request and the service defaults to the

billTo_city

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
shipTo_state
and
shipTo_country
API fields are present.

This field is available only on these processors: AIBMS, American Express Direct, Bank of America ACH, Banque de France et Tresor Public, Barclays, BNP Paribas France, Chase Paymentech Solutions, Chase Paymentech Tandem, China UnionPay, Cielo, Comercio Latino, Credit Mutuel-CIC, Cybersource ACH Service, Elavon, Elavon Americas, FDC Compass, FDC Nashville Global, FDI Australia, FDMS Nashville, First Data Merchant Solutions, Getnet, GPN, HBoS, HSBC, JCN Gateway, Korean Cyber Payments, Lloyds-OmniPay, LloydsTSB Cardnet, Moneris, OmniPay Direct, Prosa, RBS WorldPay Atlanta, Rede, RuPay, SIX, Streamline, TeleCheck, UATP, ValueLink, Vero, TSYS Acquiring Solutions, Visa Platform Connect, Worldpay VAP, Wells Fargo ACH.

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

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

REST API Field:

consumerAuthenticationInformation. veresEnrolled

SCMP API Field:

veres_enrolled

Simple Order API Field:

ccAuthService_veresEnrolled

orderInformation. billTo.lastName

The last name of the person requesting the product.

This person may or may not be the cardholder.

This field is optional if your account is configured for relaxed requirements for address data.

For details about relaxed requirements, see the support article Relaxed Requirements for Address Data and Expiration Date in Credit Card Transactions.

American Express Direct: Combined, this field and
billTo_firstName
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

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

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 Cybersource 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

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

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

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
merchantCategoryCode
field.

When you include this field in a Mastercard request, including the
merchantCategoryCode
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
merchantCategoryCode
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

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, RBS WorldPay Atlanta, TSYS Acquiring Solutions processors.

RBS WorldPay Atlanta 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

RBS WorldPay Atlanta:

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)

RBS WorldPay Atlanta:
Tax Rate

TSYS Acquiring Solutions:
VAT/Tax Rate

Visa Platform Connect:
vat_tax_rate

orderInformation. taxableAmount

additionalData

orderInformation. billTo.country

Country in the billing address.

Use the two-character ISO country code.

See ISO Standard Country Codes

.

This field is optional if your account is configured for relaxed requirements for address data.

For details about relaxed requirements, see the support article Relaxed Requirements for Address Data and Expiration Date in Credit Card Transactions.

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

paymentInformation. card.accountEncoderId

Identifier for the issuing bank that provided the customer’s encoded account number.

This field is available only on theChase Paymentech Solutions processor. Contact the processor to obtain the bank’s ID.

Specifications

Data Type:
String

Data Length:
3

Mapping Information

REST API Field:

paymentInformation.card.accountEncoderId

SCMP API Field:

account_encoder_id

Simple Order API Field:

card_accountEncoderID

processingInformation. japanPaymentOptions.firstBillingMonth

First billing month for a transaction that uses 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.

Possible values: 01 through 12.

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:
Integer

Data Length:
2

Mapping Information

REST API Field:

processingInformation.japanPaymentOptions.firstBillingMonth

SCMP API Field:

jpo_first_billing_month

Simple Order API Field:

jpo_firstBillingMonth

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

merchantDefinedInformation[]. key

Fields that you can use to store information.

This topic describes the sequence of fields from

merchantDefinedData_mddField_1

through

merchantDefinedData_mddField_100

.

These fields override the old merchant-defined data fields. For example, if you use the obsolete field

merchantDefinedData_field15

and the new field

merchantDefinedData_mddField_15

in the same request, the value for the new field overwrites the value for the obsolete field.

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 Cybersource discovers that a merchant is capturing or transmitting personally identifying information through the merchant-defined data fields, whether or not intentionally, Cybersource 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

merchantDefinedData_mddField_1

and

merchantDefinedData_mddField_2

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

For installment payments with Mastercard in Brazil:

The value for

merchantDefinedData_mddField_1

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

Record: CP07 TCR5

Position: 25-44

Field: Reference Field 2

The value for

merchantDefinedData_mddField_2

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:
255

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

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

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

tokenSource_transientToken

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

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

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

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

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.

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

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

consumerAuthenticationInformation. languagePreference

This value indicates which language to use. The value consists of the ISO 639-1 alpha-2 code, which consists of two-letter codes for languages such as

EN

for English.

Specifications

Data Type:
String

Data Length:
2

Mapping Information

REST API Field:

consumerAuthenticationInformation.languagePreference

Simple Order API Field:

payerAuthSetupService.languagePreference

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

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

travelInformation. transit.airline.ancillaryInformation.service[]. subCategoryCode

Subcategory code for the ancillary service category. Obtain codes from the International Air Transport Association (IATA).

Replace the

#

character with a sequential number from

0

to

3

.

Specifications

Data Type:
String

Data Length:
4

Mapping Information

REST API Field:

travelInformation.transit.airline.ancillaryInformation.service[].subCategoryCode

SCMP API Field:

ancillary_service#_subcategory_code

Simple Order API Field:

ancillaryData_service_#_subcategoryCode

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

travelInformation. transit.airline.legs[]. destinationAirportCode

International Air Transport Association (IATA) code for the destination airport for this leg of trip.

Required for reduced interchange.

Payer Authentication: Payer Authentication services only use the first leg of the trip.

Specifications

Data Type:
String

Data Length:
5

Mapping Information

REST API Field:

travelInformation.transit.airline.legs[].destinationAirportCode

SCMP API Field:

airline_leg#_destination

Simple Order API Field:

airlineData_leg_#_destination

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

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.

See State, Province, and Territory Codes for the United States and Canada.

This item-level field overrides the corresponding request-level field.

Tax Calculation: The value in this field is used for tax calculations only when the
shipFrom_state
and
shipFrom_country
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

travelInformation.lodging. healthClubCost

Cost of health club services.

Specifications

Data Type:
String

Data Length:
12

Mapping Information

REST API Field:

travelInformation.lodging.healthClubCost

Simple Order API Field:

lodgingData_healthClubCost

consumerAuthenticationInformation. ucafAuthenticationData

Universal cardholder authentication field (UCAF) data.

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

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

buyerInformation. vatRegistrationNumber

Buyer’s VAT registration number.

This field is available on the Barclays, Elavon Americas, FDC Nashville Global, GPN, OmniPay Direct, RBS WorldPay Atlanta, 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

RBS WorldPay Atlanta: Customer VAT Number

TSYS Acquiring Solutions: Customer VAT Registration Number

Visa Platform Connect: purchaseVATRegistrationNumber

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

travelInformation.lodging. additionalDiscountAmount

Amount of an additional coupon or discount.

Specifications

Data Type:
String

Data Length:
12

Mapping Information

REST API Field:

travelInformation.lodging.additionalDiscountAmount

SCMP API Field:

lodging_additional_coupon

Simple Order API Field:

lodgingData_additionalCoupon

travelInformation.lodging. miscellaneousCost

Miscellaneous costs.

Specifications

Data Type:
String

Data Length:
12

Mapping Information

REST API Field:

travelInformation.lodging.miscellaneousCost

Simple Order API Field:

lodgingData_miscellaneousCost

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

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.

Cybersource Latin American Processing is the name of a specific processing connection. Cybersource Latin American Processing
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 Cybersource Latin American Processing. 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

travelInformation.lodging. banquetCost

Cost of banquet services.

Specifications

Data Type:
String

Data Length:
12

Mapping Information

REST API Field:

travelInformation.lodging.banquetCost

Simple Order API Field:

lodgingData_banquetCost

orderInformation. amountDetails. settlementCurrency

Currency used by the issuer to deposit the funds into the recipient’s account.

See the ISO Standard Currency Codes reference guide.

Specifications

Data Type:
String

Data Length:
3

Mapping Information

REST API Field:

orderInformation.amountDetails.settlementCurrency

SCMP API Field:

recipient_billing_currency

Simple Order API Field:

recipient_billingCurrency

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. 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 Cybersource 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

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

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

orderInformation. lineItems[].shippingState

State to which the item will be shipped.

Specifications

Data Type:
String

Data Length:
3

Mapping Information

REST API Field:

orderInformation.lineItems[].shippingState

SCMP API Field:

shipping_state

Simple Order API Field:

item_#_shippingState

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

Simple Order: String

SCMP: String

Data Length:

Simple Order: 5

SCMP: 1

Mapping

REST Field Name:

travelInformation.autoRental.insuranceIndicator

SCMP Field Name:

auto_rental_vehicle_insurance_indicator

Simple Order Field Name:

autoRentalData_vehicleInsuranceIndicator

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

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 Cybersource. 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
ccCreditService_refundReason
field to
pow
), you can use this field to specify a merchant last name in a Mastercard Payment of Winnings
stand-alone 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
sender_firstname
,
sender_middlename
, and
sender_lastname
fields.
Chase Paymentech Solutions: When the sender is a business or government entity, use the
sender_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

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

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. httpBrowserTimeDifference

Time difference between UTC time and the cardholder browser local time, in minutes.

Example
:

300

Specifications

Data Type:
String

Data Length:
5

Mapping Information

REST API Field:

deviceInformation.httpBrowserTimeDifference

SCMP API Field:

http_browser_time_difference

Simple Order API Field:

billTo_httpBrowserTimeDifference

consumerAuthenticationInformation. authenticationStatusMsg

Message that explains the

payerAuthValidateReply_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

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

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

sender_personalIDType

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

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. companyId

This field value is the unique identifier of the corporation or entity that is renting the vehicle.

Specifications

Data Type:
String

Data Length:
12

Mapping

REST Field Name:

travelInformation.autoRental.companyId

SCMP Field Name:

auto_rental_company_id

Simple Order Field Name:

autoRentalData_companyId

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

addressVerificationInformation. barCode.checkDigit

Check digit for the 11-digit delivery point barcode.

Specifications

Data Type:
Non-negative integer

Data Length:
1

Mapping Information

REST API Field:

addressVerificationInformation.barCode.checkDigit

SCMP API Field:

dav_bar_code_chkdigit

Simple Order API Field:

davReply_barCodeCheckDigit

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

travelInformation. autoRental. promotion.couponCode

This value is the code for a rental agency coupon that discounts the rental rate of the vehicle.

Specifications

Data Type:
String

Data Length:
12

Mapping

REST Field Name:

travelInformation.autoRental.promotion.couponCode

SCMP Field Name:

promotion_code

Simple Order Field Name:

autoRental_promotion_code

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

buyerInformation. dateOfBirth

Date of birth of the customer in the format: YYYY-MM-DD or YYYYMMDD.

Specifications

Data Type:
String

Data Length:
10

Mapping Information

REST API Field:

buyerInformation.dateOfBirth

SCMP API Field:

date_of_birth

Simple Order API Field:

billTo_dateOfBirth

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

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

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

processingInformation. japanPaymentOptions.businessNameAlphaNumeric

Business name in alphanumeric characters.

This field is available only on the JCN Gateway processor, and for the Sumitomo Mitsui Card Co. acquirer on the Visa Platform Connect processor.

Specifications

Data Type:
String

Data Length:
25

Mapping Information

REST API Field:

processingInformation.japanPaymentOptions.businessNameAlphaNumeric

SCMP API Field:

jpo_business_name_alphanumeric

Simple Order API Field:

jpo_businessNameAlphanumeric

buyerInformation. companyTaxId

Tax identifier for the customer’s company.

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

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

billTo_personalID

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

billTo_personalID

field is sent to the processor and the

billTo_companyTaxID

field is ignored.

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

Record: CP07 TCR6

Position: 26-39

Field: Buyer ID

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: 26-39

Field: Buyer ID

Specifications

Data Type:
String

Data Length:
9

Mapping Information

REST API Field:

buyerInformation.companyTaxId

SCMP API Field:

bill_company_tax_id

Simple Order API Field:

billTo_companyTaxID

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

processingInformation. networkRoutingOrder

Priority order of the networks through which the transaction will be routed.

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, Cybersource 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

deviceInformation. httpBrowserLanguage

Indicates the browser language as defined in IETF BCP47.

Example
:

en-US

Specifications

Data Type:
String

Data Length:
8

Mapping Information

REST API Field:

deviceInformation.httpBrowserLanguage

SCMP API Field:

http_browser_language

Simple Order API Field:

billTo_httpBrowserLanguage

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, Cybersource verifies these fields in the order given for a customer account ID value, and it uses d the first value it finds:
The
billTo_customerID
field value in the follow-on credit request.
The
billTo_customerID
field value that was used for the capture that is being credited.
The
billTo_customerID
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.

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

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

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

orderInformation. returnsAccepted

Indicates whether returns are accepted for this order.

This field can contain one of the following values:

yes

: Returns are accepted for this order.

no

: Returns are not accepted for this order.

Specifications

Data Type:
String

Data Length:
3

Mapping Information

REST API Field:

orderInformation.returnsAccepted

SCMP API Field:

returns_accepted

Simple Order API Field:

invoiceHeader_returnsAccepted

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.

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

payerAuthValidateReply_cavvAlgorithm

response field.

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

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

processorInformation. electronicVerificationResults.emailRaw

Raw electronic verification response code from the processor for the customer’s email address.

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

processorInformation.electronicVerificationResults.emailRaw

SCMP API Field:

auth_ev_email_raw

Simple Order API Field:

ccAuthReply_evEmailRaw

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

decisionManager_travelData_actualFinalDestination

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:

decisionReply_travel_actualFinalDestinationCity

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. lineItems[].orderAcceptance. locality

City where you accept the customer’s order.

This

item-level

field overrides the corresponding request-level field.

This field is not used for tax calculation unless the

taxService_orderAcceptanceState

and

taxService_orderAcceptanceCountry

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

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 Visa Platform Connect:

0

: Preauthorization

1

: Final authorization

Visa Platform Connect

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

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

payerAuthEnrollReply_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

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

orderInformation. lineItems[]. orderAcceptance. administrativeArea

State where you accept the customer’s order.

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

See State, Province, and Territory Codes for the United States and Canada.

This

item-level

field overrides the corresponding request-level field.

This field is not used for Tax Calculation unless the

taxService_orderAcceptanceCity

and

taxService_orderAcceptanceCountry

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

merchantInformation. serviceLocation.postalCode

Postal code where a merchant provides a service. The postal code is not the merchant location.

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: 64–73

Field: Service Location Postal Code

Specifications

Data Type:
String

Data Length:
10

Mapping Information

REST API Field:

merchantInformation.serviceLocation.postalCode

SCMP API Field:

merchant_service_postal_code

Simple Order API Field:

invoiceHeader_servicePostalCode

travelInformation. actualFinalDestination.country

Country of the actual final destination.

Specifications

Data Type:
String

Data Length:
90

Mapping Information

REST API Field:

travelInformation.actualFinalDestination.country

SCMP API Field:

decision_travel_actual_final_destination_country

Simple Order API Field:

decisionReply_travel_actualFinalDestinationCountry

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

installment_sequence

to track which payment is being processed.

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

installment_sequence=2
installment_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

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.

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

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

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

orderInformation. amountDetails.discountAmount

The total discount applied to the order.

Example: A $20.00 discount off the order total.

RBS WorldPay Atlanta:
The discount amount cannot exceed 999999.99.

Specifications

Data Type:

Chase Paymentech Solutions, FDC Compass, TSYS Acquiring Solutions, FDC Nashville Global, RBS WorldPay Atlanta 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

RBS WorldPay Atlanta 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

RBS WorldPay Atlanta:
Discount Amount

TSYS Acquiring Solutions:
Discount Amount

Visa Platform Connect:
discountAmount

Worldpay VAP:
discountAmount

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

clientReferenceInformation. partner. developerId

Simple Order API Fields:

check_terminalState

senderInformation. middleInitial

Middle initial of sender when the sender is an individual. When the sender is a business or government entity, use the

sender_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
sender_firstname
,
sender_middlename
, and
sender_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

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

aggregatorInformation. subMerchant.country

Sub-merchant’s country.

Use the two-character ISO country code.

Barclays: For marketplace transactions, include this field and the
invoiceHeader_merchantDescriptorCountry
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.
Visa Platform Connect: 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

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

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

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. 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

payerAuthEnrollReply_acsTransactionID

or

payerAuthValidateReply_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

promotionInformation. discountApplied

Amount of the promotional discount applied to the transaction.

This field is available only on the Cielo processor.

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

deviceInformation. httpAcceptContent

The exact content of the HTTP accept header.

Specifications

Data Type:
String

Data Length:
256

Mapping Information

REST API Field:

deviceInformation.httpAcceptContent

SCMP API Field:

pa_http_user_accept

Simple Order API Field:

payerAuthEnrollService_httpUserAccept

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

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

orderInformation. lineItems[]. referenceDataNumber

Reference number. The meaning of this value is defined by the value of the corresponding

item_#_referenceData_#_code

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. 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 Cybersource. 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
purchaseTotals_grandTotalAmount
.
Include the
surchargeSign
field in the request.

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

merchantInformation. transactionLocalDateTime

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

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

orderInformation. rewardPointsDetails. pointsBeforeRedemption

Loyalty points balance before redemption.

Specifications

Data Type:
String

Data Length:
10

Mapping Information

REST API Field:

orderInformation.rewardPointsDetails.pointsBeforeRedemption

SCMP API Field:

points_before_redemption

Simple Order API Field:

payByPoints_pointsBeforeRedemption

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:
String

Data Length:
5

Mapping Information

REST API Field:

processingInformation.recurringOptions.loanPayment

SCMP API Field:

debt_indicator

Simple Order API Field:

debtIndicator

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

travelInformation.lodging. conferenceRoomCost

Cost of conference room services.

Specifications

Data Type:
String

Data Length:
12

Mapping Information

REST API Field:

travelInformation.lodging.conferenceRoomCost

Simple Order API Field:

lodgingData_conferenceRoomCost

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

orderInformation. billTo.locality

The city in the billing address.

This field is optional if your account is configured for relaxed requirements for address data.

For details about relaxed requirements, see the support article Relaxed Requirements for Address Data and Expiration Date in Credit Card Transactions.

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

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

orderInformation. amountDetails.originalCurrency

The local billing currency, when the

purchaseTotals_currency

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

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

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

travelInformation. autoRental. noShowIndicator

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

Simple Order: String

Data Length:

SCMP: 1

Simple Order: 5

Mapping

REST Field Name:

travelInformation.autoRental.noShowIndicator

SCMP Field Name:

no_show

Simple Order Field Name:

autoRentalData_noShowIndicator

addressVerificationInformation. errorCode

Four-character error code returned for Canadian or international addresses.

Specifications

Data Type:
String

Data Length:
255

Mapping Information

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)

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 Cybersource 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

travelInformation. transit. airline. clearingCount

Total number of clearing messages associated with the authorization request.

Specifications

Data Type:
String

Data Length:
2

Mapping Information

REST API Field:

travelInformation.transit.airline.clearingCount

Simple Order API Field:

airlineData_clearingCount

recipientInformation. country

The country associated with the address of the recipient.

Use the two-character ISO country code.

See ISO Standard Country Codes

.

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 Cybersource. 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

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. Cybersource 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

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

orderInformation. taxDetails[].amount

Total amount of applicable taxes (city, county, national, special, state). This value is the sum of the values for all the applicable tax fields.

Specifications

Data Type:
String

Data Length:
15

Mapping Information

REST API Field:

orderInformation.taxDetails[].amount

orderInformation.taxDetails[].type = "city"

orderInformation.taxDetails[].type = "county"

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. 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

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

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

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
ccCreditService_refundReason
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
stand-alone credit
.; Possible values for processing a Mastercard Payment of Winnings
stand-alone 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

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 Cybersource 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

travelInformation. passengers.lastName

Last name of the passenger to whom the ticket was issued.

If there are multiple passengers, include all that are listed on the ticket. Do not include special characters such as commas, hyphens, or apostrophes. Only ASCII characters are supported.

Required for American Express SafeKey (US) for travel-related requests.

Specifications

Data Type:
Array of strings

Data Length:
60

Mapping Information

REST API Field:

travelInformation.passengers.lastName

SCMP API Field:

airline_passenger#_lastname

Simple Order API Field:

airlineData_passenger_#_lastName

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

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
item_#_alternateTaxAmount

Item-level
field.

When you include the
item_#_alternateTaxAmount

Item-level
field or the
otherTax_nationalTaxAmount
request field, do not include the
item_#_alternateTaxRate
field. The
otherTax_nationalTaxAmount
request field rate will be set using the following equation:

otherTax_nationalTaxAmount
/
item_#_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[].orderOrigin. administrativeArea

State where you receive the customer’s order.

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

See State, Province, and Territory Codes for the United States and Canada.

This

item-level

field overrides the corresponding request-level field.

This field is not used for tax calculation unless the

taxService_orderOriginCity

and

taxService_orderOriginCountry

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

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

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

paymentInformation. card.securityCode

Card verification number (CVN).

When enabling web browsers to auto-fill payment tokens, you must include

this 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

ccAuthReply_cvCode

or

ccAuthReply_cvCodeRaw

fields.

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

Specifications

Data Type:
String with numbers only

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

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

travelInformation.lodging. roomLocation

Location of room, such as lake view or ocean view.

Specifications

Data Type:
String

Data Length:
10

Mapping Information

REST API Field:

travelInformation.lodging.roomLocation

Simple Order API Field:

lodgingData_roomLocation

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

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 Cybersource 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 Cybersource 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

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 Length:
2

Mapping Information

REST API Field:

processingInformation.japanPaymentOptions.secondBonusMonth

SCMP API Field:

jpo_second_bonus_month

Simple Order API Field:

jpo_secondBonusMonth

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

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.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. 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

watchlistScreeningInformation. watchList.matches[].programs[]

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

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

travelInformation. transit.airline.legs[]. couponNumber

Coupon number for a specific travel leg within a ticket.

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

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.

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

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

processingInformation. recurringOptions.firstRecurringPayment

orderInformation.lineItems[].shippingCity

SCMP API Field:

shipping_city

Simple Order API Field:

item_#_shippingCity

orderInformation. lineItems[].jurisdiction[]. taxName

Name of the jurisdiction tax for the item.

For example, CA State Tax.

Returned only when the 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

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

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

ccAuthReply_paymentNetworkTransactionID

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

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

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

consumerAuthenticationInformation. alternateAuthenticationDate

Date and time in UTC of the cardholder authentication.

Format:

yyyyMMDDHHMM

Specifications

Data Type:
Integer

Data Length:
12

Mapping Information

REST API Field:

consumerAuthenticationInformation. alternateAuthenticationDate

SCMP API Field:

pa_alternate_authentication_date

Simple Order API Fields:

payerAuthEnrollReply_alternateAuthenticationDate

payerAuthEnrollService_alternateAuthenticationDate

consumerAuthenticationInformation. directoryServerErrorCode

The directory server error code indicating a problem with the transaction.

Specifications

Data Type:
Integer

Data Length:
3

Mapping Information

REST API Field:

consumerAuthenticationInformation.directoryServerErrorCode

SCMP API Field:

pa_directory_server_error_code

Simple Order API Fields:

payerAuthEnrollReply_directoryServerErrorCode

payerAuthValidateReply_directoryServerErrorCode

pointOfSaleInformation. cardPresent

aggregator_country

Simple Order API Fields:

ccAuthService_aggregatorCountry

octService_aggregatorCountry

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

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

01

-

05

. Version 2.2.0 supports values

01

-

11

.

Specifications

Data Type:
Integer

Data Length:
2

Mapping Information

REST API Field:

consumerAuthenticationInformation. requestorInitiatedAuthenticationIndicator

SCMP API Field:

pa_requestor_initiated_authentication_indicator

Simple Order API Field:

payerAuthEnrollService_ requestorInitiatedAuthenticationIndicator

processorInformation. consumerAuthenticationResponse. code

Mapped response code for American Express SafeKey, RuPay PaySecure, or Visa Secure.

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. 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

travelInformation. autoRental. parkingViolationCharge

This value is the amount incurred due to a parking violation.

This field is supported only for Visa.

Specifications

Data Type:
String

Data Length:
12

Mapping

REST Field Name:

travelInformation.autoRental.parkingViolationCharge

SCMP Field Name:

auto_rental_parking_violation_cost

Simple Order Field Name:

autoRentalData_parkingViolationCost

addressVerificationInformation. standardAddress.county

US county, if available.

Specifications

Data Type:
String

Data Length:
255

Mapping Information

REST API Field:

addressVerificationInformation.standardAddress.county

SCMP API Field:

dav_standard_county

Simple Order API Field:

davReply_standardizedCounty

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 Type:
String

Data Length:

Chase Paymentech Solutions, FDC Compass:

Mastercard: 10

Visa: 13

Elavon Americas, GPN, OmniPay Direct, Visa Platform Connect: 12

FDC Nashville Global: 11

RBS WorldPay Atlanta 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

RBS WorldPay Atlanta: Duty Amount

TSYS Acquiring Solutions: Duty Amount

Visa Platform Connect: dutyAmount

Worldpay VAP: dutyAmount

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 Cybersource. 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

travelInformation. passengers.firstName

First name of the passenger to whom the ticket was issued.

If there are multiple passengers, include all that are listed on the ticket. Do not include special characters such as commas, hyphens, or apostrophes. Only ASCII characters are supported.

Required for American Express SafeKey (US) for travel-related requests.

Specifications

Data Type:
Array of strings

Data Length:
60

Mapping Information

REST API Field:

travelInformation.passengers.firstName

SCMP API Field:

airline_passenger#_firstname

Simple Order API Field:

airlineData_passenger_#_firstName

processingInformation. nationalNetDomesticData

Supplementary domestic transaction information provided by the acquirer.

Specifications

Data Type:
String

Data Length:
123

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. 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

REST API Field:

paymentInformation.bank.accountName

SCMP API Field:

bank_account_name

Simple Order API Field:

fundTransfer_accountName

paymentInformation. bank.locality

City where the bank is located.

If you do not send this field, we presume the bank location is specified in the

billTo_city

field. Because some banks validate the bank account information, consider sending this field if the bank location is not specified in the

billTo_city

field.

Specifications

Data Type:
String

Data Length:
35

Mapping Information

REST API Field:

paymentInformation.bank.locality

SCMP API Field:

bank_city

Simple Order API Field:

bankInfo_city

orderInformation. billTo. address4

Fourth line of the billing street address as it appears in the payment card issuer records.

Specifications

Data Type:
String

Data Length:
60

Mapping Information

REST API Field:

orderInformation.billTo.address4

SCMP API Field:

bill_address4

Simple Order API Field:

billTo_street4

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 Cybersource. 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
recipient_firstname
,
recipient_middlename
, and
recipient_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
sender_firstname
,
sender_middlename
, and
sender_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

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

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

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

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

processorInformation. customer.personalIDResult

Personal identifier result.

If you included

billTo_personalID

in the request, this value indicates whether

billTo_personalID

matched a value in a record on file.

Possible values:

Y: Match

N: No match

K: Not supported

U: Unknown

Z: No response returned

This field is available only for Rede card in Brazil for the Cybersource Latin American Processing processor. It is returned only when the personal ID result is returned by the processor.

Cybersource Latin American Processing is the name of a specific processing connection. Cybersource Latin American Processing
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 Cybersource Latin American Processing. It is not for any other Latin American processors.

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

processorInformation.customer.personalIDResult

SCMP API Field:

auth_personal_id_result

Simple Order API Field:

ccAuthReply_personalIDCode

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

Simple Order API Field:

airlineData_carrierName

addressVerificationInformation. standardAddress.country

Standardized country or region name.

Specifications

Data Type:
String

Data Length:
255

Mapping Information

REST API Field:

addressVerificationInformation.standardAddress.country

SCMP API Field:

dav_standard_country

Simple Order API Field:

davReply_standardizedCountry

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 Cybersource, Cybersource passes this value from the authorization service to the subsequent services for you. However, when you perform authorizations through Cybersource 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

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

merchantInformation. successUrl

URL the customer is directed to after completing a payment.

Make a GET request to this URL.

Specifications

Data Type:
String

Data Length:
255

Mapping Information

REST API Field:

merchantInformation.successUrl

SCMP API Field:

ap_initiate_success_url

Simple Order API Field:

apInitiateService_successURL

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

orderInformation. shipTo.country

Country of the shipping address.

Use the two-character ISO standard country code.

See ISO Standard Country Codes.

This field is available only on the FDC Nashville Global, RBS WorldPay Atlanta, and Worldpay VAP processors.

These processors have specific requirements:

Payments Processing: FDC Nashville Global:
If you include the
shipTo_country
field in a request and if the ship-to country is the U.S. or Canada, the request must also include the
shipTo_state
field.; RBS WorldPay Atlanta:
If you do not provide this value, the
billTo_country
value is used. If you do not provide either of these values, the default value of
US
is used.; Worldpay VAP:
If this value is not included in the request, the
billTo_country
value from the authorization request is used.
Tax Calculation: This field is optional for US, Canadian, international, and value-added taxes.; When
shipTo_country
is not included in the request and the service defaults to
billTo_ country
, the value for
shipTo_country
is left blank in the Tax Detail Report; When
shipTo_country
is not included in the request and the service defaults to
billTo_ country
, the value for
shipTo_country
is left blank in the Tax DetailReport.; This field is used for Tax Calculaton only when the
shipTo_city
and
shipTo_state
fields are present.

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

RBS WorldPay Atlanta: Destination Country Code

TSYS Acquiring Solutions: Destination Country Code

Worldpay VAP: destinationCountryCode

processingInformation. japanPaymentOptions. businessName

Business name in Japanese characters.

This field is available only on the JCN Gateway processor, and for the Sumitomo Mitsui Card Co. acquirer on the Visa Platform Connect processor.

Specifications

Data Type:
String

Data Length:
25

Mapping Information

REST API Field:

processingInformation.japanPaymentOptions.businessName

SCMP API Field:

jpo_business_name_japanese

Simple Order API Field:

jpo_businessNameJapanese

orderInformation. amountDetails.originalAmount

The purchase amount denominated in the local currency, when the

purchaseTotals_grandTotalAmount

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

reconciliationID

Reference number for the transaction.

You can use this value to reconcile Cybersource reports with processor reports.

This value is not returned for all processors.

Syntax

This syntax is used with this field:

dcc_referenceNumber=[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

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

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

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
ccCreditService_refundReason
field to
pow
), the merchant name in your merchant configuration on the Cybersource platform is used by default as your merchant first name in a Mastercard Payment of Winnings
stand-alone 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
sender_firstname
,
sender_middlename
, and
sender_lastname
fields.
Chase Paymentech Solutions: When the sender is a business or government entity, use the
sender_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

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

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

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

item_#_ alternateTaxAmount

.

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:
1

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

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

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

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

orderInformation. amountDetails. settlementAmount

Amount deposited into the recipient's account by the issuer.

Specifications

Data Type:
String

Data Length:
15

Mapping Information

REST API Field:

orderInformation.amountDetails.settlementAmount

SCMP API Field:

recipient_billing_amount

Simple Order API Field:

recipient_billingAmount

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

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

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 Cybersource reporting software.

This field is available only for Cybersource 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

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

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

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, RBS WorldPay Atlanta, 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.
RBS WorldPay Atlanta: Do not use all zeros or spaces in Mastercard transactions.

Specifications

Data Type:
String

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

RBS WorldPay Atlanta: 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:

Barclays Line Item Total

Chase Paymentech Solutions: Line Item Total

Elavon Americas

Mastercard: Extended Item Amount

Visa: Line Item Total

FDC Compass: Line Item Total

OmniPay Direct: Line Item total / Extended Item Amount

RBS WorldPay Atlanta: Line Total

TSYS Acquiring Solutions

Mastercard: Extended Item Amount

Visa: Line Item Total

Visa Platform Connect: totalAmount

Worldpay VAP: lineItemTotal

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

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

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 Cybersource.

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 Cybersource. 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. 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

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

jpo_paymentMethod

field is set to

2

,

4

,

5

, or

6

.

Specifications

Data Type:
Integer

Data Length:
2

Mapping Information

REST API Field:

processingInformation.japanPaymentOptions.installments

SCMP API Field:

jpo_installments

Simple Order API Field:

jpo_installments

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

deviceInformation. userAgentBrowserValue

Value of the User-Agent header sent by the customer’s web browser.

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

Specifications

Data Type:
String

Data Length:
2048

Mapping Information

REST API Field:

deviceInformation.userAgentBrowserValue

SCMP API Field:

pa_http_user_agent

Simple Order API Field:

payerAuthEnrollService_httpUserAgent

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

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

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

: Unclassified.

For information about these values, contact Mastercard or your acquirer.

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

Record: CP01 TCR6

Position: 136-137

Field: Mastercard Transaction Integrity Classification

Specifications

Data Type:
String

Data Length:
2

Mapping Information

REST API Field:

processorInformation.transactionIntegrityCode

SCMP API Field:

auth_transaction_integrity

Simple Order API Field:

ccAuthReply_transactionIntegrity

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.commerceIndicator

field set to

recurring

(for recurring transactions) or

install

(for installment transactions).

The

subsequentAuthReason

field set to any value supported for that field.

Possible values:

true

: Merchant-initiated transaction.

false

: 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:
5

Mapping Information

REST API Field:

processingInformation.authorizationOptions.initiator.type

SCMP API Field:

subsequent_auth

Simple Order API Field:

subsequentAuth

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

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

ccAuthReply_processorResponse

field or the

ccAuthReversalReply_processorResponse

field, depending on which service you requested.

Specifications

Data Type:
Integer

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

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

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

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

travelInformation.lodging. nonRoomTaxAmount

Tax on non-room purchases.

Specifications

Data Type:
String

Data Length:
12

Mapping

REST Field Name:

travelInformation.lodging.nonRoomTaxAmount

Simple Order Field Name:

lodgingData_nonRoomTax

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

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

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.

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, Cybersource 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

addressVerificationInformation. standardAddress.iso.Country

Standardized two-character ISO country or region code.

Specifications

Data Type:
String

Data Length:
255

Mapping Information

REST API Field:

addressVerificationInformation.standardAddress.iso.Country

SCMP API Field:

dav_standard_iso_country

Simple Order API Field:

davReply_standardizedISOCountry

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

merchantInformation. merchantDescriptor. postalCode

Postal code for your business location.

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

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

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

Simple Order

octService_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

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

This field is optional if your account is configured for relaxed requirements for address data.

For details about relaxed requirements, see the support article Relaxed Requirements for Address Data and Expiration Date in Credit Card Transactions.

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:

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

travelInformation.lodging. adjustmentAmount

Adjusted amount charged in addition to the reservation amount after the stay is complete.

Specifications

Data Type:
string

Data Length:
12

Mapping Information

REST API Field:

travelInformation.lodging.adjustmentAmount

Simple Order API Field:

lodgingData_adjustmentAmount

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

orderInformation. taxAmount

Total tax for all items.

Specifications

Data Type:
String

Data Length:
15

Mapping Information

REST API Field:

orderInformation.taxAmount

SCMP API Field:

tax_total_tax

Simple Order API Field:

taxReply_totalTaxAmount

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

addressVerificationInformation. standardAddress.address3

Third line of the standardized address.

Specifications

Data Type:
String

Data Length:
255

Mapping Information

REST API Field:

addressVerificationInformation.standardAddress.address3

SCMP API Field:

dav_standard_address3

Simple Order API Field:

davReply_standardizedAddress3

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. 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

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.

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

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

travelInformation. transit.airline. exchangeTicketFeeAmount

Fee amount for changing the destination or departure time of the original ticket.

Specifications

Data Type:
Numerical

Data Length:
12

Mapping Information

REST API Field:

travelInformation.transit.airline.exchangeTicketFeeAmount

SCMP API Field:

airline_exchange_ticket_fee

Simple Order API Field:

airlineData_exchangeTicketFee

orderInformation. billTo. address1

First line of the billing street address as it appears in the payment card issuer records.

This field is optional if your account is configured for relaxed requirements for address data.

For details about relaxed requirements, see the support article Relaxed Requirements for Address Data and Expiration Date in Credit Card Transactions.

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

processingInformation. japanPaymentOptions. businessNameKatakana

Business name in Katakana characters.

This field is available only on the JCN Gateway processor, and for the Sumitomo Mitsui Card Co. acquirer on the Visa Platform Connect processor.

Specifications

Data Type:
String

Data Length:
25

Mapping Information

REST API Field:

processingInformation.japanPaymentOptions.businessNameKatakana

SCMP API Field:

jpo_business_name_katakana

Simple Order API Field:

jpo_businessNameKatakana

addressVerificationInformation. standardAddress.administrativeArea

United States Postal Service standardized state or province abbreviation.

Specifications

Data Type:
String

Data Length:
255

Mapping Information

REST API Field:

addressVerificationInformation.standardAddress.administrativeArea

SCMP API Field:

dav_standard_state

Simple Order API Field:

davReply_standardizedState

paymentInformation. card.cardType

Three-digit value that indicates the card type. This field is required for the Payer Authentication Check Enrollment and Validation services.

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 Cybersource 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 Cybersource. 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

orderInformation. lineItems[].taxableAmount

Taxable amount for the item.

Specifications

Data Type:
String

Data Length:
15

Mapping Information

REST API Fields:

orderInformation.lineItems[].taxableAmount

SCMP API Field:

tax_taxable_amount0..N

Simple Order API Field:

taxReply_item_#_taxableAmount

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 ccAuthService_networkTokenCryptogram 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 `Visa Platform Connect` 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.
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
payerAuthValidateReply_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

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

travelInformation.lodging. internetAccessCost

Cost of internet access.

Specifications

Data Type:
String

Data Length:
12

Mapping Information

REST API Field:

travelInformation.lodging.internetAccessCost

Simple Order API Field:

lodgingData_internetAccessCost

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

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

travelInformation. autoRental. promotion.additionalCouponCode

This field notes any rental agency coupons that discount the normal rental rate of the vehicle.

Specifications

Data Type:
String

Data Length:
12

Mapping

REST Field Name:

travelInformation.autoRental.promotion.additionalCouponCode

SCMP Field Name:

promotion_additional_code

Simple Order Field Name:

autoRental_promotion_additionalCode

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

Simple Order API Field:

ecAVSReply_overallMatchScore

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

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

ccAuthReply_paymentNetworkTransactionID

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

When you use this field, you must also include the

ccAuthService_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

installmentInformation. paymentType

Payment plan for installments.

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

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.

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 Cybersource. 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 Cybersource. 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

paymentInformation. card.expirationYear

Four-digit year in which the payment card expires.

Format: yyyy

This field is optional if your account is configured for relaxed requirements for expiration date.

For details about relaxed requirements, see the support article Relaxed Requirements for Address Data and Expiration Date in Credit Card Transactions

.

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 Cybersource to reject a request. However, an invalid expiration date might cause the issuer to reject a request.
Chase Paymentech Solutions: For encoded account numbers (
card_cardType
=
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 Cybersource 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

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
ccCreditService_refundReason
field to
pow
), the merchant city in your merchant configuration on the Cybersource platform is used by default as your merchant city in a Mastercard Payment of Winnings
stand-alone 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.

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

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

travelInformation. transit.airline.legs[]. fareBasis

Code assigned by carrier to indicate ticket type, such as business class, discounted, or non-refundable.

Specifications

Data Type:
String

Data Length:

FDC Nashville Global: 15

All other processors: 6

Mapping Information

REST API Field:

travelInformation.transit.airline.legs[].fareBasis

SCMP API Field:

airline_leg#_fare_basis

Simple Order API Field:

airlineData_leg_#_fareBasis

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, RBS WorldPay Atlanta, 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

item_#_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

items

in your request:

item_0_unitPrice=10.00
item_0_quantity=1
item_0_taxAmount=0.80
item_1_unitPrice=20.00
item_1_quantity=1
item_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

item_#_taxAmount

.

For more information, see the

Tax Calculation Developer Guide

.

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

GPX: localTax Amount

OmniPay Direct: Tax Amount / Total Tax Amount

RBS WorldPay Atlanta: Tax Amount

Visa Platform Connect: localTax Amount

TSYS Acquiring Solutions

Mastercard: Tax Amount

Visa: VAT / Tax Amount

Worldpay VAP: taxAmount

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

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 Cybersource platform for reporting purposes.

Possible values:

001

: Apple Pay

004

: Cybersource 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

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

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

orderInformation. invoiceDetails. transactionAdviceAddendum[].data

Transaction Advice Addendum (TAA) fields.

This topic provides a description of the sequence of fields from

invoiceHeader_amexDataTAA1

to

invoiceHeader_amexDataTAA4

.

These fields provide a description to display on the customer’s American Express card statement. They are frequently used for Level II transactions. When you provide TAA fields, first use

invoiceHeader_amexDataTAA1

, then

invoiceHeader_amexDataTAA2

, then

amexdata_taa2

, and so on. Before using these fields, 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. 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

travelInformation.lodging. miniBarCost

Cost of mini-bar purchases.

Specifications

Data Type:
String

Data Length:
12

Mapping Information

REST API Field:

travelInformation.lodging.miniBarCost

Simple Order API Field:

lodgingData_miniBarCost

pointOfSaleInformation. amexCAPNData

Point-of-sale details for the transaction.

This field enables you to comply with American Express CAPN requirements.

Cybersource 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 Cybersource, Cybersource passes this value from the authorization service to the subsequent services for you. However, when you perform authorizations through Cybersource 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 Cybersource uses a default value. Cybersource 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

travelInformation. duration

Number of days of the auto rental or lodging rental.

Auto rental: This field is supported for Visa, Mastercard, and American Express.
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
.; 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

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

travelInformation.lodging. numberOfGuests

Number of guests staying in the room.

Specifications

Data Type:
Integer

Data Length:
2

Mapping

REST Field Name:

travelInformation.lodging.numberOfGuests

Simple Order Field Name:

lodgingData_numberOfGuests

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

purchaseTotals_discountAmount

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

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

buyerInformation. gender

The gender of the customer.

Specifications

Data Type:
String

Data Length:
10

Mapping

REST Field Name:

buyerInformation.gender

Simple Order Field Name:

billTo_gender

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:

card_accountNumber

card_expirationMonth

card_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

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. 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 Visa Platform Connect.

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

Type:
String

Length:
5

Mapping Information

REST API Field:

processingInformation.authorizationOptions. initiator.storedCredentialUsed

SCMP API Field:

subsequent_auth_stored_credential

Simple Order API Field:

subsequentAuthStoredCredential

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.

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

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

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

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

travelInformation. transit.airline.legs[]. flightNumber

Flight number for a leg of a trip. Number assigned by operating or marketing carrier.

Specifications

Data Type:
String

Data Length:

FDC Nashville Global: 5

All other processors: 6

Mapping Information

REST API Field:

travelInformation.transit.airline.legs[].flightNumber

SCMP API Field:

airline_leg#_flight_number

Simple Order API Field:

airlineData_leg_#_flightNumber

orderInformation. billTo.firstName

The customer name.

Value should match value on card.

This field is optional if your account is configured for relaxed requirements for address data.

For details about relaxed requirements, see the support article Relaxed Requirements for Address Data and Expiration Date in Credit Card Transactions.

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. lineItems[].orderAcceptance. postalCode

Postal code where you accept the customer’s order.

This

item-level

field overrides the corresponding request-level field.

This field is not used for Tax Calculation unless the

taxService_orderAcceptanceCity

,

taxService orderAcceptanceState

, and

taxService_orderAcceptanceCountry

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[].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. shippingDetails. shipFromAdministrativeArea

State from which the product is shipped.

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

See State, Province, and Territory Codes for the United States 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
shipFrom_city
and
shipFrom_country
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

processingInformation. captureOptions. totalCaptureCount

Total number of captures when requesting multiple partial captures for one authorization.

This value is used along with

ccCaptureService_sequence

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

ccCaptureService_sequence

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:

ccCaptureService_sequence=2
ccCaptureService_totalCount=5

Visa Platform Connect

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

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

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

otherTax_vatTaxAmount

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

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

payerAuthEnrollReply_directoryServerTransactionID

or

payerAuthValidateReply_directoryServerTransactionID

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 Cybersource. 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

addressVerificationInformation. standardAddress.csz

Standardized city, state, or province and ZIP + 4 code or postal code line.

Specifications

Data Type:
String

Data Length:
255

Mapping Information

REST API Field:

addressVerificationInformation.standardAddress.csz

SCMP API Field:

dav_standard_csz

Simple Order API Field:

davReply_standardizedCSP

travelInformation.lodging. audioVisualCost

Cost of audio visual services.

Specifications

Data Type:
String

Data Length:
12

Mapping Information

REST API Field:

travelInformation.lodging.audioVisualCost

Simple Order API Field:

lodgingData_audioVisualCost

clientReferenceInformation. partner. solutionId

Identifier for pre-built partner solution that is integrated to Cybersource.

Send this value in all requests that are sent through the partner solution. Cybersource 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

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

issuer_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

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

travelInformation. autoRental. odometerReading

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

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.

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

payerAuthValidateReply_xid

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. 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

taxInformation. noNexus

List of states or provinces in which merchandise is not taxable.

Do not use both the

taxService_nexus

and

taxService_noNexus

fields in your request. The default value for

taxService_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.

See State, Province, and Territory Codes for the United States and Canada.

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

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

travelInformation. transit. airline. creditReasonIndicator

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

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

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

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

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.

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

travelInformation.lodging. roomTaxAmount

Total tax for the room.

Specifications

Data Type:
String

Data Length:
12

Mapping Information

REST API Field:

travelInformation.lodging.roomTaxAmount

Simple Order API Field:

lodgingData_roomTax

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 Cybersource 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

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

Replace the # character with a sequential number from

0

to

4

.

Send this field with a corresponding

healthCare#_amount

field.

Example:

<healthCare id="0">
        <amountType>vision</amountType>
        <amount>60.00</amount>

Specifications

Data Type:
String

Data Length:
35

Mapping Information

REST API Field:

healthCareInformation.amountDetails.amountType

SCMP API Field:

health_care_#_amount_type

Simple Order API Field:

healthCare#_amountType

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:

2

,

4

,

5

, or

6

.

Possible values:

1

(default): Single payment.

2

: Bonus payment.

4

: Installment payment.

5

: Revolving payment.

6

: Combination of bonus payment and installment payment.

Specifications

Data Type:
Integer

Data Length:
1

Mapping Information

REST API Field:

processingInformation.japanPaymentOptions.paymentMethod

SCMP API Field:

jpo_payment_method

Simple Order API Field:

jpo_paymentMethod

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

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

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.

See State, Province, and Territory Codes for the United States 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.

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

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

recurringPaymentInformation. endDate

The date after which no further recurring authorizations should be performed.

Format:
yyyyMMDD.

Specifications

Data Type:
Integer

Data Length:
8

Mapping Information

REST API Field:

recurringPaymentInformation.endDate

SCMP API Field:

pa_recurring_end_date

Simple Order API Field:

payerAuthEnrollService_recurringEndDate

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

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

payerAuthValidateReply_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
ccAuthService_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

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 Cybersource reporting software.

This field is available only for Cybersource 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

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 Cybersource. 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
recipient_city
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

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

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

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

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.
Visa Platform Connect: 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

travelInformation. transit. airline. totalClearingAmount

The total amount for all transactions in the clearing count set.

This value cannot exceed 99,999,999,999,999,999,999 (twenty 9s) (comma added for readability).

Specifications

Data Type:
String

Data Length:
20

Mapping Information

REST API Field:

travelInformation.transit.airline.totalClearingAmount

Simple Order API Field:

airlineData_totalClearingAmount

consumerAuthenticationInformation. customerCardAlias

An alias that uniquely identifies the customer's account and credit card on file.

This field is required if Tokenization is enabled in the merchant profile settings.

Specifications

Data Type:
String

Data Length:
128

Mapping Information

REST API Field:

consumerAuthenticationInformation. customerCardAlias

SCMP API Field:

pa_customer_cc_alias

Simple Order API Field:

payerAuthEnrollService_customerCCAlias

refundAmountDetails. refundAmount

Amount refunded to the cardholder.

Specifications

Data Type:
Decimal

Data Length:
15

Mapping Information

REST API Fields:

creditAmountDetails.creditAmount

refundAmountDetails.refundAmount

SCMP API Field:

credit_credit_amount

Simple Order API Field:

ccCreditReply_amount

travelInformation. transit.airline.legs[]. endorsementsRestrictions

Notations of an endorsement or restriction for a leg of a trip.

Endorsements can be notations added by the travel agency, including mandatory government required notations, such as value added tax.

Restrictions are limitations for the ticket based on fare type, such as nonrefundable tickets.

Specifications

Data Type:
String

Data Length:
20

Mapping Information

REST API Field:

travelInformation.transit.airline.legs[].endorsementsRestrictions

SCMP API Field:

airline_leg#_endorsements_restrictions

Simple Order API Field:

airlineData_leg_#_endorsementsRestrictions

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

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 Visa Platform Connect, HSBC, and Streamline processors.

Set the value for this field to the value for the

ccAuthReply_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

paymentNetworkTransactionInformation

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. 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.

Do not use this field to evaluate the result of the request.

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
additionalProcessorResponse
Simple Order 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 a decline reason code in the
ccAuthReply_merchantAdviceCode
Simple Order API field.

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

deviceInformation. httpBrowserScreenHeight

Total height of the cardholder's screen in pixels.

Example
:

864

Specifications

Data Type:
String

Data Length:
6

Mapping Information

REST API Field:

deviceInformation.httpBrowserScreenHeight

SCMP API Field:

http_browser_screen_height

Simple Order API Field:

billTo_httpBrowserScreenHeight

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%)
RBS WorldPay Atlanta: Maximum amount is 99.99. Example 5.25 (=5.25%)

Specifications

Data Type:
String

Data Length:
5

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

RBS WorldPay Atlanta: Discount Rate

TSYS Acquiring Solutions: Item Discount Rate

Visa Platform Connect: discountRate

travelInformation.lodging. businessCenterCost

Cost of business center services.

Specifications

Data Type:
String

Data Length:
12

Mapping Information

REST API Field:

travelInformation.lodging.businessCenterCost

Simple Order API Field:

lodgingData_businessCenterCost

recipientInformation. administrativeArea

State or province of the recipient.

This field is available only on these processors:

FDC Compass

First Data Merchant Solutions

LloydsTSB Cardnet International

Streamline

See State, Province, and Territory Codes for the United States and Canada.

First Data Merchant Solutions and LloydsTSB Cardnet International: Required with Visa when the
recipient_state
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

issuerInformation. country

Country where the card was issued.

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

Use two-character ISO Standard Country Codes.

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

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
ccCreditService_refundReason
field to
pow
), the street name in your merchant configuration on the Cybersource platform is used by default as your default street address in a Mastercard Payment of Winnings
stand-alone 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

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

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:
String

Data Length:
5

Mapping Information

REST API Field:

watchlistScreeningInformation.proceedOnMatch

SCMP API Field:

ignore_export_result

Simple Order API Field:

businessRules_ignoreExportResult

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

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

processorInformation. electronicVerificationResults. phoneNumberRaw

Raw electronic verification response code from the processor for the customer’s phone number.

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

processorInformation.electronicVerificationResults.phoneNumberRaw

SCMP API Field:

auth_ev_phone_number_raw

Simple Order API Field:

ccAuthReply_evPhoneNumberRaw

agreementInformation. agreementId

Identifier for the billing agreement.

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

Set to the value returned in the

apReply_billingAgreementID

field.

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

paymentInformation. accountFeatures.category

Card type category.

GPN: Visa or Mastercard product ID.
Visa Platform Connect: Visa product ID.
RBS WorldPay Atlanta: 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.
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

RBS WorldPay Atlanta: 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

merchantInformation. serviceLocation.Locality

City name where a merchant provides a service that is not the merchant location.

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: 108–157; Field: Service Location City Name

Specifications

Data Type:
String

Data Length:
20

Mapping Information

REST API Field:

merchantInformation.serviceLocation.Locality

SCMP API Field:

merchant_service_locality

Simple Order API Field:

invoiceHeader_serviceLocality

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 Cybersource. 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

orderInformation. lineItems[].orderOrigin.postalCode

Postal code where you receive the customer’s order.

This

item-level

field overrides the corresponding request-level field.

This field is not used for Tax Calculation unless the

taxService_orderOriginCity

,

taxService_orderOriginState

, and

taxService_orderOriginCountry

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

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

addressVerificationInformation. standardAddress.address4

Fourth line of the standardized address.

Specifications

Data Type:
String

Data Length:
255

Mapping Information

REST API Field:

addressVerificationInformation.standardAddress.address4

SCMP API Field:

dav_standard_address4

Simple Order API Field:

davReply_standardizedAddress4

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).

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

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

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

purchaseTotals_ 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

travelInformation.lodging. roomRateType

Type of rate, such as corporate or senior citizen.

Specifications

Data Type:
String

Data Length:
12

Mapping Information

REST API Field:

travelInformation.lodging.roomRateType

Simple Order API Field:

lodgingData_roomRateType

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

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
ccCreditService_refundReason
field to
pow
), the merchant country in your merchant configuration on the Cybersource platform is used by default as your default country code in a Mastercard Payment of Winnings
stand-alone 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

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

paymentInformation. binCountry

Country associated with the BIN of the customer's card used for the payment.

Use the two-character ISO country code.

See ISO Standard Country Codes

.

Returned if the information is available. Use this field for additional information when reviewing orders. This information is also displayed in the details page of the Business Center.

Specifications

Data Type:
String

Data Length:
255

Mapping Information

REST API Field:

paymentInformation.binCountry

SCMP API Field:

bin_country

Simple Order API Field:

afsReply_binCountry

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

validationInformation.bank. accountStatus. fcraDisputeCode

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

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

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

travelInformation.lodging. phoneCost

Cost of telephone services.

Specifications

Data Type:
String

Data Length:
12

Mapping

REST Field Name:

travelInformation.lodging.phoneCost

Simple Order Field Name:

lodgingData_phoneCost

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
item_#_productName
field instead.
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. lineItems[].shippingLastName

Last name of the shipping recipient.

Specifications

Data Type:
String

Data Length:
128

Mapping Information

REST API Field:

orderInformation.lineItems[].shippingLastName

SCMP API Field:

shipping_last_name

Simple Order API Field:

item_#_shippingLastName

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.

See ISO Standard Country Codes.

This item-level field overrides the corresponding request-level field.

Tax Calculation: The value in this field is used for tax calculations only when the
shipFrom_city
and
shipFrom_state
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

travelInformation. agency.code

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

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 Cybersource. 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
ccCreditService_refundReason
field to
pow
), the value in the
billTo_lastName
field is used by default as the last name of the Mastercard Payment of Winnings
stand-alone 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
recipient_firstname
,
recipient_middlename
, and
recipient_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
sender_firstname
,
sender_middlename
, and
sender_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

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

deviceInformation. httpBrowserJavaScriptEnabled

Indicates the ability of the cardholder browser to execute JavaScript.

This value is available from the fingerprint details of the cardholder's browser. This field can contain one of these values:

true

: Cardholder's browser can execute JavaScript.

false

: Cardholder's browser cannot execute JavaScript.

Specifications

Data Type:
Boolean

Data Length:
1

Mapping Information

REST API Field:

deviceInformation.httpBrowserJavaScriptEnabled

SCMP API Field:

http_browser_javascript_enabled

Simple Order API Field:

billTo_httpBrowserJavaScriptEnabled

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:
Integer

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

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

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

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

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, Cybersource 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

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

travelInformation. autoRental. rentalAddress.city

This value is the city in which the vehicle was rented.

For the authorization service, this field is supported for Visa, Mastercard, and American Express.

For the capture service, this field is supported only for American Express.

Specifications

Data Type:
String

Data Length:
18

Mapping

REST Field Name:

travelInformation.autoRental.rentalAddress.city

SCMP Field Name:

auto_rental_pick_up_city

Simple Order Field Name:

autoRentalData_pickUpCity

orderInformation. shipTo.email

Email address of the recipient, including full domain name.

Format:
name@host.domain

Specifications

Data Type:
String

Data Length:
255

Mapping Information

REST API Field:

orderInformation.shipTo.email

SCMP API Field:

ship-to-email

Simple Order API Field:

shipTo_email

senderInformation. identificationNumber

Acquirer-populated value associated with the

sender_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

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 with numbers only

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

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

travelInformation.lodging. room[].numberOfNights

Number of nights billed at the rate specified by

lodgingData_dailyRoomRate1, lodgingData_dailyRoomRate2, and lodgingData_dailyRoomRate3

.

Specifications

Data Type:
Integer

Data Length:
4

Mapping

REST Field Name:

travelInformation.lodging.room[].numberOfNights

Simple Order Field Name:

lodgingData_roomNights#

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

Fee the issuer charges when the recipient’s currency is not the same as the sender’s currency. When this fee is charged, the grand total amount must include the fee.

Specifications

Data Type:
String

Data Length:
12

Mapping Information

REST API Field:

orderInformation.amountDetails.foreignExchangeFee

SCMP API Field:

aft_foreign_exchange_fee

Simple Order API Field:

aft_foreignExchangeFee

validationInformation.bank. accountStatus. addedOrClosedDate

Date on which the bank account was added or closed.

For closed accounts, this is the date on which the account was closed. For added accounts, this is the date that the account was added to the National Shared Database.

Format: YYYYMMDD.

Specifications

Data Type:
String

Data Length:
8

Mapping Information

REST API Field:

validationInformation.bank.accountStatus.addedOrClosedDate

SCMP API Field:

ecp_avs_added_or_closed_date

Simple Order API Field:

ecAVSReply_addedOrClosedDate

aggregatorInformation. name

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

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.

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

travelInformation. transit.airline.ancillaryInformation. passengerName

Passenger name or the cardholder name if the passenger is unavailable. If neither names are available, this value is a description of the ancillary purchase.

Specifications

Data Type:
String

Data Length:
20

Mapping Information

REST API Field:

travelInformation.transit.airline.ancillaryInformation.passengerName

SCMP API Field:

ancillary_passenger_name

Simple Order API Field:

ancillaryData_passengerName

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.

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

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 Cybersource Advanced
guide.

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

merchantInformation. taxId

Merchant tax ID number.

Cielo: This field is available for aggregator authorizations.
Getnet: This field is available for aggregator authorizations. All characters must be numbers.
Rede: This field is available for aggregator authorizations.
Visa Platform Connect: This field is available for these types of payments:

Authorizations with Mastercard. The value for this field corresponds to the following data in the TC 33 capture file:
Record: CP12 TCR4
Position: 21–55
Field: Acceptor Tax ID
Authorizations with Mastercard in Argentina, Chile, and Paraguay. The value for this field corresponds to the following data in the TC 33 capture file:
Record: CP01 TCR8
Position: 110–124
Field: Merchant Tax ID
BNDES transactions in Brazil. The value for this field is your Cadastro Nacional da Pessoa Jurídica (CNPJ) number. The value for this field corresponds to the following data in the TC 33 capture file:
Record: CP07 TCR6
Position: 40–59
Field: BNDES Reference Field 1
Installment payments with Mastercard in Croatia. The value for this field corresponds to the following data in the TC 33 capture file:
Record: CP01 TCR5
Position: 79–98
Field: Mastercard Croatia Domestic Card Acceptor Tax ID

Specifications

Data Type:
String

Data Length:
15

Mapping Information

REST API Field:

merchantInformation.taxId

SCMP API Field:

bill_merchant_tax_id

Simple Order API Field:

billTo_merchantTaxID

orderInformation. amountDetails.currencyConversion. indicator

Enables Dynamic Currency Conversion during an authorization.

Available values:

0
: Not enabled (default)

1
: Enabled

Syntax

This syntax is used with this field:

dcc_dccIndicator=1

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

consumerAuthenticationInformation. threeDSServerOperatorId

The Directory Server-assigned 3-D Secure server identifier.

When checking enrollment and during validation for payer authentication, each Directory Server can provide a unique ID to each 3-D Secure server on an individual basis in the response.

Required for mada transactions.

Specifications

Data Type:
String

Data Length:
32

Mapping Information

REST API Field:

consumerAuthenticationInformation.threeDSServerOperatorId

SCMP API Field:

pa_enroll_pa_three_ds_server_operator_id

pa_validate_pa_three_ds_server_operator_id

Simple Order API Field:

payerAuthEnrollReply_threeDSServerOperatorId

payerAuthValidateReply_threeDSServerOperatorId

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

billTo_lastName

field. The authorization request should include these additional request fields if the information is available:

billTo_firstName

billTo_lastName

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

Simple Order API Field:

ccAuthReply_nameMatch

travelInformation. autoRental. distanceTraveled

originalTransaction_amount

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.

Specifications

Data Type:
String

Data Length:
2

Mapping Information

REST API Field:

travelInformation.transit.airline.legs[].carrierCode

SCMP API Field:

airline_leg#_carrier_code

Simple Order API Field:

airlineData_leg_#_carrierCode

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

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, eftpos, 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
card_usage
field is
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 Cybersource. 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

ccCreditService_overridePaymentMethod

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

consumerAuthenticationInformation. merchantScore

Risk score provided by merchants.

Specifications

Data Type:
String

Data Length:
20

Mapping Information

REST API Field:

consumerAuthenticationInformation. merchantScore

SCMP API Field:

pa_merchant_score

Simple Order API Field:

payerAuthEnrollService_merchantScore

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

travelInformation. transit.airline.legs[]. feeAmount

Fee amount for a leg of a trip, such as an airport fee or country fee.

Specifications

Data Type:
String

Data Length:

FDC Nashville Global: 9

All other processors: 12

Mapping Information

REST API Field:

travelInformation.transit.airline.legs[].feeAmount

SCMP API Field:

airline_leg#_fee

Simple Order API Field:

airlineData_leg_#_fee

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

consumerAuthenticationInformation. marketingOptIn

export_matchN_name1

to

export_matchN_nameN

Simple Order API Fields:

deniedPartiesMatch_N_name_0

through

deniedPartiesMatch_N_name_N

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

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:
Integer

Data Length:
2

Mapping Information

REST API Field:

consumerAuthenticationInformation.merchantFraudRate

SCMP API Field:

pa_merchant_fraud_rate

Simple Order API Field:

payerAuthEnrollService_merchantFraudRate

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 Cybersource reporting software.

This field is available only for Cybersource 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

validationInformation.bank. accountStatus. scoredAccountProcessorResponse3

Scored account processor response 3.

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.scoredAccountProcessorResponse3

SCMP API Field:

ecp_avs_scored_account_processor_response3

Simple Order API Field:

ecAVSReply_scoredAccountProcessorResponse3

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

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 Cybersource. 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

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

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

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
card_usage
field is
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 Cybersource. 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

ccCreditService_overridePaymentMethod

is set to the value of

CR

or

DB

and there is a value in the

ccCreditService_overridePaymentMethod

field, the value in the

ccCreditService_overridePaymentMethod

field takes precedence.

If

ccCreditService_overridePaymentMethod

is set to

CR/DB

and there is a value in the

ccCreditService_overridePaymentMethod

field, the value in the

ccCreditService_overridePaymentMethod

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. tokenizedCard.requestorId

Value that identifies your business and indicates that the cardholder’s account number is tokenized.

This value is assigned by the token service provider and is unique within the token service provider’s database.

This field is available only on the FDC Nashville Global and Visa Platform Connect processor.

Specifications

Data Type:
String

Data Length:
11

Mapping Information

REST API Field:

paymentInformation.tokenizedCard.requestorId

SCMP API Field:

payment_network_token_requestor_id

Simple Order API Field:

paymentNetworkToken_requestorID

orderInformation. lineItems[].restrictedExportCountries[]

List of countries to which the product cannot be exported.

Use the two-character ISO country codes.

See ISO Standard Country Codes

.

Specifications

Data Type:
Array of strings

Data Length:
2,147,483,647

Mapping Information

REST API Field:

orderInformation.lineItems[].restrictedExportCountries[]

SCMP API Field:

no_export

Simple Order API Field:

item_#_noExport

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

paymentInformation. card.passPhrase

Card password.

The card password consists of 2 digits and is considered Personally Identifiable Information (PII).

Specifications

Data Type:
Numeric String

Data Length:
2

Mapping Information

REST API Field:

paymentInformation.card.passPhrase

SCMP API Field:

card_pass_phrase

Simple Order API Field:

card_passPhrase

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

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

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

payerAuthValidateReply_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.

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 with numbers only

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

travelInformation. autoRental. returnAddress.locationId

This value is the agency code, address, and phone number, that identifies the location where the vehicle was returned. 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.returnAddress.locationId

SCMP Field Name:

auto_rental_return_location_id

Simple Order Field Name:

autoRentalData_returnLocationId

processorInformation. masterCardServiceReplyCode

Result of the Mastercard card-on-file token service.

Mastercard provides this value to Cybersource.

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

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 (^).

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

orderInformation. rewardPointsDetails. pointsValueRedeemed

Value of the loyalty points that were redeemed in the local currency.

Specifications

Data Type:
String

Data Length:
12

Mapping Information

REST API Field:

orderInformation.rewardPointsDetails.pointsValueRedeemed

SCMP API Field:

points_value_redeemed

Simple Order API Field:

payByPoints_pointsValueRedeemed

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.

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, Cybersource recommends that you also include these fields in the request:

invoiceHeader_merchantDescriptorCountry

(merchant descriptor country)

invoiceHeader_merchantDescriptorState

(merchant descriptor state)

invoiceHeader_merchantDescriptorPostalCode

(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

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

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

acquirerInformation. country

Country code of the acquiring bank.

Issuers should be aware of the acquirer's country code when the acquirer country differs from the merchant country, and the acquirer is in the European Economic Area (EEA).

Specifications

Data Type:
String

Data Length:
2

Mapping Information

REST API Field:

acquirerInformation.country

SCMP API Field:

pa_acquirer_country

Simple Order API Field:

payerAuthEnrollService_acquirerCountry

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 Cybersource 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_#

travelInformation.lodging. totalTaxAmount

Total tax amount.

Specifications

Data Type:
String

Data Length:
12

Mapping Information

REST API Field:

travelInformation.lodging.totalTaxAmount

Simple Order API Field:

lodgingData_tax

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

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

paymentInformation. card.productName

Name of the card product.

REST Field Name:

travelInformation.autoRental.phoneCharge

SCMP Field Name:

auto_rental_phone_charge

Simple Order Field Name:

autoRentalData_phoneCharge

merchantInformation. serviceLocation. countryCode

Code for country where a merchant provides a service. The country is not the merchant location.

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: 161–163; Field: Service Location Country Code

Specifications

Data Type:
String

Data Length:
2

Mapping Information

REST API Field:

merchantInformation.serviceLocation.countryCode

SCMP API Field:

merchant_service_country_code

Simple Order API Field:

invoiceHeader_serviceCountryCode

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.

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

paymentInformation. tokenizedCard.prefix

First six digits of token.

This field is available only for merchant-initiated transactions using 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:
6

Mapping Information

REST API Field:

paymentInformation.tokenizedCard.prefix

SCMP API Field:

token_prefix

Simple Order API Field:

token_prefix

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, Cybersource 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.

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

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

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

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

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

processorInformation. electronicVerificationResults. postalCodeRaw

Raw electronic verification response code from the processor for the customer’s postal code.

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

processorInformation.electronicVerificationResults.postalCodeRaw

SCMP API Field:

auth_ev_postal_code_raw

Simple Order API Field:

ccAuthReply_evPostalCodeRaw

orderInformation. shipTo.lastName

Last name of the person receiving the shipment.

The field is available for these processors: AIBMS, American Express Direct, Bank of America ACH, Banque de France et Tresor Public, Barclays, BNP Paribas France, Chase Paymentech Solutions, Chase Paymentech Tandem, China UnionPay, Cielo, Comercio Latino, Credit Mutuel-CIC, Cybersource ACH Service, Elavon, Elavon Americas, FDC Compass, FDC Nashville Global, FDI Australia, FDMS Nashville, First Data Merchant Solutions, Getnet, GPN, HBoS, HSBC, JCN Gateway, Korean Cyber Payments, Lloyds-OmniPay, LloydsTSB Cardnet, Moneris, OmniPay Direct, Prosa, RBS WorldPay Atlanta, Rede, RuPay, SIX, Streamline, TeleCheck, UATP, ValueLink, Vero, TSYS Acquiring Solutions, Visa Platform Connect, Worldpay VAP, Wells Fargo ACH.

Specifications

Data Type:
Request

Data Format:
String

Data Length

Worldpay VAP: 35

Other processors: 60

Mapping Information

REST API Field:

orderInformation.shipTo.lastName

SCMP API Field:

ship_to_lastname

Simple Order API Field:

shipTo_lastName

orderInformation. exemptAmount

Total amount of exempt amounts.

This value is the sum of the values for all the

taxReply_item_#_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

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, Cybersource 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

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 Cybersource 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

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

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 Cybersource. 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

travelInformation. autoRental. rentalAddress.locationId

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

orderInformation. invoiceDetails.purchaseOrderDate

Date the order was processed.

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

Barclays: Format: yyyyMMdd
Worldpay VAP: Format: yyyy-MM-DD
Other processors: Format: YYMMDD

Specifications

Data Type:
String

Data Length

Barclays: 8

Worldpay VAP: 10

Other processors: 6

Mapping Information

REST API Field:

orderInformation.invoiceDetails.purchaseOrderDate

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

RBS WorldPay Atlanta: Order Date

TSYS Acquiring Solutions: Order Date

Visa Platform Connect: purchaserOrderDate

Worldpay VAP: orderDate

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

travelInformation. autoRental. numberOfAdditionalDrivers

This value is the number of additional drivers included on the rental agreement, not including the individual who signed the rental agreement.

Specifications

Data Type:
Integer

Data Length:
1

Mapping

REST Field Name:

travelInformation.autoRental.numberOfAdditionalDrivers

SCMP Field Name:

auto_rental_additional_drivers

Simple Order Field Name:

autoRentalData_additionalDrivers

acquirerInformation. merchantId

User name on the Visa directory server.

The Visa directory server that is created when your acquirer sets up your account. This ID might be the same as your merchant ID. The user name can be 15 or 23 characters.

Specifications

Data Type:
Number

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

Mapping Information

REST API Field:

acquirerInformation.merchantId

SCMP API Field:

pa_merchant_id

pa_ds_login_id

Simple Order API Field:

payerAuthEnrollService_merchantId

travelInformation.lodging. nonRoomCost

Cost of non-room purchases, such as meals and gifts.

Specifications

Data Type:

String

Data Length:

12

Mapping

REST Field Name:

travelInformation.lodging.nonRoomCost

Simple Order Field Name:

lodgingData_nonRoomCost

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. lineItems[].allowedExportCountries[]

List of countries where the product can be exported.

Use the two-character ISO country code.

See ISO Standard Country Codes

.

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

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

travelInformation. autoRental. distanceUnit

The value that you enter into this field determines whether the distance traveled is measured in miles or kilometers.

Possible values:

M

: Miles

K

: Kilometers

Specifications

Data Type:
String

Data Length:
1

Mapping

REST Field Name:

travelInformation.autoRental.distanceUnit

SCMP Field Name:

auto_rental_distance_unit

Simple Order Field Name:

autoRentalData_distanceUnit

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
recipient_accountType
value must be either
01
,
02
,
03
or
06
.
FT
: Funds transfer where OCT not available. The
recipient_accountType
value must be either
00
,
01
,
02
,
03
or
06
.
PD
: Payroll disbursement. The
recipient_accountType
value must be
03
.
TU
: Top Up: Prepaid load. The
recipient_accountType
value must be either
01
,
02
,
03
or
06
.
WT
: Wallet transfer. The
recipient_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

senderInformation. type

Type of tax identifier (business or individual) when Tag 9F20 IDType (the

sender_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

travelInformation. autoRental. ratePerMile

This value indicates the rate charged for each mile.

This field is supported only for the capture service and only for Mastercard and American Express.

Mastercard: This field is required to get the best rate.

American Express: This field is optional but is recommended.

Specifications

Data Type:
String

Data Length:
25

Mapping

REST Field Name:

travelInformation.autoRental. ratePerMile

SCMP Field Name:

auto_rental_rate_per_mile

Simple Order Field Name:

autoRentalData_ratePerMile

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, Cybersource 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, Cybersource 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. japanPaymentOptions. secondBonusAmount

If this field is included in a Japanese payment transaction, it specifies the amount of the second bonus.

Specifications

Data Length:
12

Mapping Information

REST API Field:

processingInformation.japanPaymentOptions.secondBonusAmount

SCMP API Field:

jpo_second_bonus_amount

Simple Order API Field:

jpo_secondBonusAmount

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

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

orderInformation. lineItems[].passenger.status

Your company's passenger classification, such as with a frequent flyer program.

In this case, you might use values such as standard, gold, or platinum.

Specifications

Data Type:
String

Data Length:
32

Mapping Information

REST API Field:

orderInformation.lineItems[].passenger.status

SCMP API Field:

passenger_status

Simple Order API Field:

item_#_passengerStatus

deviceInformation. appUrl

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.

This field is required for recurring payments using cards issued in India.

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. 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

deviceInformation. httpAcceptBrowserValue

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

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:

payerAuthEnrollService_httpAccept

travelInformation.lodging. roomServiceCost

Cost of room service.

Specifications

Data Type:
String

Data Length:
12

Mapping Information

REST API Field:

travelInformation.lodging.roomServiceCost

Simple Order API Field:

lodgingData_roomServiceCost

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

consumerAuthenticationInformation. deviceChannel

Indicates the channel used for the transaction.

Required for SDK integration. Possible Values:

SDK

Browser

3RI (3-D Secure Integrator Request)

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

SDK

. If you use the JavaScript code, this field is dynamically set to

Browser

. For merchant-initiated or 3RI transactions, you must set the field to

3RI

. If you use this field in addition to JavaScript code, you must set the field to

Browser

.

Specifications

Data Type:
String

Data Length:
10

Mapping Information

REST API Field:

consumerAuthenticationInformation. deviceChannel

SCMP API Field:

pa_device_channel

Simple Order API Field:

payerAuthEnrollService_deviceChannel

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

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

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

apSessionsReply_processorToken

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

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

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.

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

If you are not using Cybersource 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

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

consumerAuthenticationInformation. requestorName

The 3-D Secure requestor name value assigned by the directory server.

Specifications

Data Type:
String

Data Length:
40

Mapping Information

REST API Field:

consumerAuthenticationInformation. requestorName

SCMP API Field:

pa_requestor_name

Simple Order API Field:

payerAuthEnrollService_requestorName

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

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. 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

payerAuthEnrollReply_dsReferenceNumber

or

payerAuthValidateReply_dsReferenceNumber

response field.

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

orderInformation. lineItems[].jurisdiction[]. taxAmount

Jurisdiction taxable amount for the item.

Returned only when the 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. 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

item-level

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, RBS WorldPay Atlanta, 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

RBS WorldPay Atlanta:
Origin ZIP

TSYS Acquiring Solutions:
Ship From Postal/ZIP Code

Visa Platform Connect:
shipFromAddress

Worldpay VAP:
shipFromPostalCode

travelInformation. transit.airline.ancillaryInformation. connectedTicketNumber

Airline ticket number connected to ancillary purchase.

If purchase has connection or relation to another purchase, such as a baggage fee for a passenger transport ticket, this field must contain the ticket number for the other purchase.

For stand-alone purchases, the value for this field must be the same value used for the

ancillaryData_ticketNumber

field.

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

pointOfSaleInformation. emv.isRepeat

Indicates the authorization is a duplicate authorization request.

When the

ccAuthReply_issuerPINrequest

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. 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 Cybersource 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

orderInformation. lineItems[].jurisdiction[]. name

Free-text description of the jurisdiction for the item. For example, San Mateo County

Returned only when the 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

processingInformation. japanPaymentOptions.terminalId

Unique Japan Credit Card Association (JCCA) terminal identifier that is provided by Cybersource.

The difference between this field and the

pos_ terminalID

field is that you can define the

pos_ terminalID

field, but the

jpo_jccaTerminalID

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 Cybersource. 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

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
: Cybersource software timed out.

When you request the payer authentication and authorization services separately, get the value for this field from the
payerAuthEnrollReply_challengeCancelCode
or
payerAuthValidateReply_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

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

travelInformation.lodging. prepaidCost

Prepaid amount, such as a deposit.

Specifications

Data Type:
String

Data Length:
12

Mapping

REST Field Name:

travelInformation.lodging.prepaidCost

Simple Order Field Name:

lodgingData_prepaidCost

processingInformation. japanPaymentOptions. bonuses

The number of bonuses included in a Japanese payment transaction.

Specifications

Mapping Information

REST API Field:

processingInformation.japanPaymentOptions.bonuses

SCMP API Field:

jpo_bonuses

Simple Order API Field:

jpo_bonuses

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

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[]. originatingAirportCode

International Air Transport Association (IATA) code for originating airport for the first leg of the trip.

Specifications

Data Type:
String

Data Length:
5

Mapping Information

REST API Field:

travelInformation.transit.airline.legs[].originatingAirportCode

SCMP API Field:

airline_leg#_originating_airport_code

Simple Order API Field:

airlineData_leg_#_originatingAirportCode

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

travelInformation. autoRental. lateFeeAmount

This field is the amount that charged for a late return of the rented vehicle.

This field is only supported for Visa.

Specifications

Data Type:
String

Data Length:
12

Mapping

REST Field Name:

travelInformation.autoRental.lateFeeAmount

SCMP Field Name:

auto_rental_late_return_cost

Simple Order Field Name:

autoRentalData_lateReturnCost

orderInformation. shipTo.address1

First line of the shipping address.

When

ship_to_address1

is not included in the request and the service defaults to

billTo_street1

, the value for

ship_to_address1

is left blank in the Tax Detail Report.

This field is available on these processors: AIBMS, American Express Direct, Bank of America ACH, Banque de France et Tresor Public, Barclays, BNP Paribas France, Chase Paymentech Solutions, Chase Paymentech Tandem, China UnionPay, Cielo, Comercio Latino, Credit Mutuel-CIC, Cybersource ACH Service, Elavon, Elavon Americas, FDC Compass, FDC Nashville Global, FDI Australia, FDMS Nashville, First Data Merchant Solutions, Getnet, GPN, HBoS, HSBC, JCN Gateway, Korean Cyber Payments, Lloyds-OmniPay, LloydsTSB Cardnet, Moneris, OmniPay Direct, Prosa, RBS WorldPay Atlanta, Rede, RuPay, SIX, TeleCheck, UATP, ValueLink, Vero, Visa Platform Connect, Worldpay VAP, TSYS Acquiring Solutions, and Wells Fargo ACH.

Specifications

Data Type:
Request

Data Format:
String

Data Length

TSYS Acquiring Solutions: 36

Other processors: 60

Mapping Information

REST API Field:

orderInformation.shipTo.address1

SCMP API Field:

ship_to_address1

Simple Order API Field:

shipTo_street1

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

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, RBS WorldPay Atlanta, TSYS Acquiring Solutions, Visa Platform Connect, and Worldpay VAP processors.

Specifications

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

RBS WorldPay Atlanta: 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

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

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

travelInformation. transit.airline.legs[]. exchangeTicketNumber

New ticket number issued when a ticket is exchanged.

Specifications

Data Type:
String

Data Length:
15

Mapping Information

REST API Field:

travelInformation.transit.airline.legs[].exchangeTicketNumber

SCMP API Field:

airline_leg#_exchange_ticket

Simple Order API Field:

airlineData_leg_#_exchangeTicket

paymentInformation. bank.checkDigit

Code used to validate the customer's account number.

Required for some countries if you do not or are not allowed to provide the IBAN instead. You may use this field only when scoring a direct debit transaction.

Specifications

Data Type:
String

Data Length:
2

Mapping Information

REST API Field:

paymentInformation.bank.checkDigit

SCMP API Field:

bank_check_digit

Simple Order API Field:

fundTransfer_bankCheckDigit

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. invoiceDetails.referenceDataNumber

Reference number associated with the

invoiceHeader_referenceDataCode

field.

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

The meaning of this reference number is defined by the

invoiceHeader_referenceDataCode

field.

This field is a pass-through. The value in this field is not verified or modified in any way before it is sent to the processor.

Specifications

Data Type:
String

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

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. 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:
String

Data Length:
5

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

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

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

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

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

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, Cybersource 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

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

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

orderInformation. lineItems[].productCode

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

item_#_ quantity

,

item_#_productName

, and

item_#_ 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

RBS WorldPay Atlanta:
Product Code

TSYS Acquiring Solutions:
Product Code

Visa Platform Connect:
productCode

Worldpay VAP:
productCode

addressVerificationInformation. standardAddress.postalCode

Standardized US ZIP + 4 postal code.

Specifications

Data Type:
String

Data Length:
10

Mapping Information

REST API Field:

addressVerificationInformation.standardAddress.postalCode

SCMP API Field:

dav_standard_zip

Simple Order API Field:

davReply_standardizedPostalCode

orderInformation. lineItems[]. referenceDataCode

Code that identifies the value of the corresponding

item_#_referenceData_#_number

field.

This field is a pass-though field. This means Cybersource 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

merchantInformation. serviceLocation. countrySubdivisionCode

Code for state or province where a merchant provides a service. The state or province is not the merchant location.

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: 158–160; Field: Service Location State/Province Code

Specifications

Data Type:
String

Data Length:
9

Mapping Information

REST API Field:

merchantInformation.serviceLocation.countrySubdivisionCode

SCMP API Field:

merchant_service_country_subdivision_code

Simple Order API Field:

invoiceHeader_serviceCountrySubdivisionCode

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

Data Type:
String

Data Length:
14

Data Format:
yyyyMMDDhhmmss

Mapping Information

REST API Field:

orderInformation.amountDetails.exchangeRateTimeStamp

SCMP API Field:

exchange_rate_timestamp

Simple Order API Field:

purchaseTotals_exchangeRateTimeStamp

processorInformation. avs. code

Code returned by the Address Verification Service (AVS) during authorization.

See AVS Codes

.

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

acquirerInformation. acquirerBin

Acquirer bank ID number that corresponds to a certificate that Cybersource already has.

Visa format:

4XXXXX

Mastercard format:

5XXXXX

Specifications

Data Type:
Positive Integer

Data Length:
6

Mapping Information

REST API Field:

acquirerInformation.acquirerBin

SCMP API Field:

pa_acquirer_bin

Simple Order API Field:

payerAuthEnrollService_acquirerBin

validationInformation.bank. accountStatus. scoredAccountProcessorResponse5

Scored account processor response 5.

Used with scored accounts only. A scored account is a bank account residing at a financial institution that does not contribute to the National Shared Database. Reason code 5 represents the reason provided to the National Shared Database for one or more incoming returns.

Specifications

Data Type:
String

Data Length:
2

Mapping Information

REST API Field:

validationInformation.bank.accountStatus.scoredAccountProcessorResponse5

SCMP API Field:

ecp_avs_scored_account_processor_response5

Simple Order API Field:

ecAVSReply_scoredAccountProcessorResponse5

pointOfSaleInformation. emv.chipValidationResult

Cryptogram validation results returned by the entity or service specified in

emvReply_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

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

travelInformation.lodging. laundryCost

Cost of laundry services.

Specifications

Data Type:
String

Data Length:
12

Mapping Information

REST API Field:

travelInformation.lodging.laundryCost

Simple Order API Field:

lodgingData_laundryCost

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

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:

sender_personalIDType

sender_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

orderInformation. lineItems[].jurisdiction[]. country

Jurisdiction country for the item.

Returned only when the 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

taxInformation. nexus

List of states or provinces in which merchandise is taxable.

Do not use both the

taxService_nexus

and

taxService_noNexus

fields in your request. The default value for

taxService_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.

Use the State, Province, and Territory Codes for the United States and Canada.

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

consumerAuthenticationInformation. eciRaw

Raw electronic commerce indicator (ECI).

The field is absent if authentication fails.

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

payerAuthValidateReply_eciRaw

response field.

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

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 Length:
1

Mapping Information

REST API Field:

processingInformation.japanPaymentOptions.preapprovalType

SCMP API Field:

jpo_preapproval_type

Simple Order API Field:

jpo_preapprovalType

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:
String

Data Length:
2

Mapping Information

REST API Field:

orderInformation.reordered

SCMP API Field:

pa_reorder

Simple Order API Field:

payerAuthEnrollService_reorder

orderInformation. lineItems[].jurisdiction[]. code

installment_downPayment

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

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

orderInformation. lineItems[].shippingPhone

Recipient's phone number.

Specifications

Data Type:
Integer

Data Length:
20

Mapping Information

REST API Field:

orderInformation.lineItems[].shippingPhone

SCMP API Field:

shipping_phone

Simple Order API Field:

item_#_shippingPhone

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

processorInformation. enhancedDataEnabled

Flag returned by Cybersource 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

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.

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 Cybersource. 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.initiator.credentialStoredOnFile

SCMP API Field:

subsequent_auth_first

Simple Order API Field:

subsequentAuthFirst

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. 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. threeDSServerTransactionId

Unique transaction identifier assigned by the 3-D Secure server to identify a single transaction.

Specifications

Data Type:
String

Data Length:
36

Mapping Information

REST API Field:

consumerAuthenticationInformation. threeDSServerTransactionId

SCMP API Field:

pa_three_ds_server_transaction_id

Simple Order API Fields:

ccAuthService_threeDSServerTransactionID

payerAuthEnrollReply_threeDSServerTransactionID

payerAuthValidateReply_threeDSServerTransactionID

travelInformation.lodging. roomBedType

Type of room, such as queen, king, or two doubles.

Specifications

Data Type:
String

Data Length:
12

Mapping

REST Field Name:

travelInformation.lodging.roomBedType

Simple Order Field Name:

lodgingData_roomBedType

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:

Visa Platform Connect: typeOfSupply

paymentInformation. bank. iban

The International Bank Account Number (IBAN) for the bank account.

For some countries you can provide this number instead of the traditional bank account information. 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.iban

SCMP API Field:

bank_iban

Simple Order API Field:

fundTransfer_iban

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

creditAmountDetails. creditAmount

Amount credited to the cardholder.

Specifications

Data Type:
Decimal

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

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

travelInformation. transit.airline.legs[]. departureTimeMeridian

Indicates whether departure 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[].departureTimeMeridian

SCMP API Field:

airline_leg#_departure_time_segment

Simple Order API Field:

airlineData_leg_#_departureTimeSegment

orderInformation. lineItems[].orderOrigin.locality

City where you receive the customer’s order.

This

item-level

field overrides the corresponding request-level field.

This field is not used for tax calculation unless the

taxService_orderOriginState

and

taxService_orderOriginCountry

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

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

consumerAuthenticationInformation. responseAccessToken

JSON Web Token (JWT) returned by the 3-D Secure provider when the authentication is complete.

Specifications

Data Type:
String

Data Length:
2048

Mapping Information

REST API Field:

consumerAuthenticationInformation.responseAccessToken

SCMP API Field:

pa_response_access_token

Simple Order API Field:

payerAuthValidateService_responseAccessToken

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

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

addressVerificationInformation. careOf

Care of data dropped from the standard address.

Specifications

Data Type:
String

Data Length:
255

Mapping Information

REST API Field:

addressVerificationInformation.careOf

SCMP API Field:

dav_careof

Simple Order API Field:

davReply_careOf

deviceInformation. httpBrowserColorDepth

Indicates the bit depth of the color palette for displaying images, in bits per pixel.

Example
:

24

Specifications

Data Type:
String

Data Length:
2

Mapping Information

REST API Field:

deviceInformation.httpBrowserColorDepth

SCMP API Field:

http_browser_color_depth

Simple Order API Field:

billTo_httpBrowserColorDepth

travelInformation.lodging. customerServicePhoneNumber

Your toll-free customer service phone number.

Specifications

Data Type:
String

Data Length:
27

Mapping Information

REST API Field:

travelInformation.lodging.customerServicePhoneNumber

Simple Order API Field:

lodgingData_customerServicePhoneNumber

travelInformation. autoRental. rentalAddress.address1

This value is the street address of the vehicle rental agency.

Specifications

Data Type:
String

Data Length:
26

Mapping

REST Field Name:

travelInformation.autoRental.rentalAddress.address1

SCMP Field Name:

auto_rental_address

Simple Order Field Name:

autoRentalData_rentalAddress

orderInformation. lineItems[].passenger.nationality

Passenger's nationality.

Use the two-character ISO country code.

See ISO Standard Country Codes

.

Specifications

Data Type:
String

Data Length:
2

Mapping Information

REST API Field:

orderInformation.lineItems[].passenger.nationality

SCMP API Field:

passenger_nationality

Simple Order API Field:

item_#_passengerNationality

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. interactionCounter

Indicates the number of authentication cycles that the cardholder attempted. The cycles are tracked by the issuing bank’s ACS.

Example
: The customer receives the challenge window, enters the one-time password, and clicks

Submit

. This sequence counts as one interaction.

Example:
The customer receives the challenge window, receives the bank message asking if the one-time password should be sent to their phone or email. The customer makes a selection before going to the next screen to enter the one-time password. This sequence counts as two interactions. The first interaction occurs when the customer chooses how to have the one-time password delivered. The second interaction occurs when the customer enters the one-time password and clicks

Submit

.

Specifications

Data Type:
Integer

Data Length:
2

Mapping Information

REST API Field:

consumerAuthenticationInformation.interactionCounter

SCMP API Field:

pa_interaction_counter

Simple Order API Field:

payerAuthValidateReply_interactionCounter

deviceInformation. httpBrowserEmail

Email address set in the customer's browser, which may differ from

billTo_email

.

Specifications

Data Type:
String

Data Length:
100

Mapping Information

REST API Field:

deviceInformation.httpBrowserEmail

SCMP API Field:

http_browser_email

Simple Order API Field:

billTo_httpBrowserEmail

orderInformation. lineItems.passenger.lastName

Passenger's last name.

Specifications

Data Type:
String

Data Length:
60

Mapping Information

REST API Field:

orderInformation.lineItems.passenger.lastName

SCMP API Field:

passenger_lastname

Simple Order API Field:

item_#_passengerLastName

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.

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

processorInformation. networkTransactionId

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

orderInformation. lineItems[].shippingMiddleName

Middle name of the shipping recipient.

Specifications

Data Type:
String

Data Length:
128

Mapping Information

REST API Field:

orderInformation.lineItems[].shippingMiddleName

SCMP API Field:

shipping_middle_name

Simple Order API Field:

item_#_shippingMiddleName

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 Cybersource. 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
ccCreditService_refundReason
field to
pow
), the value in the
billTo_firstName
field is used by default as the first name of the Mastercard Payment of Winnings
stand-alone 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
recipient_firstname
,
recipient_middlename
, and
recipient_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
sender_firstname
,
sender_middlename
, and
sender_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

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

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

orderInformation. lineItems[].jurisdiction[]. rate

Jurisdiction tax rate for the item.

Returned only when the 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. 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

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 Cybersource 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

.

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

payerAuthEnrollService_challengeCode

request field.

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

addressVerificationInformation. statusCode

Four-to-ten-character status code.

Specifications

Data Type:
String

Data Length:
255

Mapping Information

REST API Field:

addressVerificationInformation.statusCode

SCMP API Fields:

dav_ca_info

dav_intl_info

dav_us_info

Simple Order API Fields:

davReply_caInfo

davReply_intlInfo

davReply_usInfo

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. 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:
Integer

Data Length:
2

Mapping Information

REST API Field:

consumerAuthenticationInformation. priorAuthenticationMethod

SCMP API Field:

pa_prior_authentication_method

Simple Order API Field:

payerAuthEnrollService_priorAuthenticationMethod

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, RBS WorldPay Atlanta, 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

RBS WorldPay Atlanta: VAT Invoice Number

TSYS Acquiring Solutions: Unique VAT Invoice Reference Number

Visa Platform Connect: vatInvoiceReferenceNumber

Worldpay VAP: Invoice Reference Number

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

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 Cybersource. 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

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.; The
ccCreditService_aggregatorID
field is optional in a request for an AFT with aggregator support. The
octService_aggregatorID
field is optional in a request for 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

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

All other processors:
20

Mapping Information

REST API Field:

aggregatorInformation.aggregatorId

SCMP API Field:

aggregator_id

Simple Order API Fields:

ccAuthService_aggregatorID

ccCaptureService_aggregatorID

ccCreditService_aggregatorID

octService_aggregatorID

(for Chase Paymentech Solutions)

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

addressVerificationInformation. standardAddress.address2

Second line of the standardized address.

Specifications

Data Type:
String

Data Length:
255

Mapping Information

REST API Field:

addressVerificationInformation.standardAddress.address2

SCMP API Field:

dav_standard_address2

Simple Order API Field:

davReply_standardizedAddress2

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.

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)

travelInformation.lodging. specialProgramCode

Code that identifies special circumstances.

Possible values:

1

: Lodging (default)

2

: No show reservation

3

: Advanced deposit

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

travelInformation.lodging.specialProgramCode

Simple Order API Field:

lodgingData_specialProgramCode

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:
No length limit.

Mapping Information

REST API Field:

consumerAuthenticationInformation. acsUrl

SCMP API Field:

pa_enroll_acs_url

Simple Order API Field:

payerAuthEnrollReply_acsURL

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

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

processorInformation. masterCardServiceCode

Mastercard service that was used for the transaction.

Mastercard provides this value to Cybersource.

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 Cybersource. 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

orderInformation. billTo.district

Customer’s neighborhood, community, or region (a barrio in Brazil) within the city or municipality.

Comercio Latino: Boleto Bancário payments
on 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

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

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: Cybersource 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

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

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

travelInformation.lodging. roomTaxType

Type of tax, such as tourist or hotel.

Specifications

Data Type:
String

Data Length:
10

Mapping Information

REST API Field:

travelInformation.lodging.roomTaxType

Simple Order API Field:

lodgingData_roomTaxElements

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:

true

false

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

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

Moneris:
50

Worldpay VAP:
35

Visa Platform Connect:
40

All other processors:
60

Mapping Information

REST API Field:

orderInformation.billTo.address2

SCMP API Field:

bill_address2

Simple Order API Field:

billTo_street2

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

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

RBS WorldPay Atlanta: Commodity Code

TSYS Acquiring Solutions: Does not apply

Visa Platform Connect: summaryCommodityCode

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

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 Cybersource. 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

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

Position: 106-116

Field: Independent Sales Organization ID

Specifications

Data Type:
Nonnegative integer

Data Length:
11

Mapping Information

REST API Field:

merchantInformation.salesOrganizationId

SCMP API Field:

sales_organization_id

Simple Order API Field:

invoiceHeader_salesOrganizationID

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

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 Cybersource. 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

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

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

paymentInformation. fluidData.value

Card-present transactions:
encrypted payment data.

Digital payment transactions:
encrypted payment data value. If you are using the Cybersource decryption option, populate this field with the encrypted payment data value returned by the Full Wallet request.

Specifications

Data Type:
String

Data Length:
3072

Mapping Information

REST API Field:

paymentInformation.fluidData.value

SCMP API Field:

encrypted_payment_data

Simple Order API Field:

encryptedPayment_data

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

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

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

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:

true

: Authorization reversal was successfully submitted.

false

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

Specifications

Data Type:
String

Data Length:
5

Mapping Information

REST API Field:

authorizationInformation.reversalSubmitted

SCMP API Field:

reversal_submitted

Simple Order API Field:

voidReply_reversalSubmitted

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. 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

orderInformation. invoiceDetails.purchaseOrderNumber

Value used by your customer to identify the order.

This value is typically a purchase order number.

Cybersource 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, RBS WorldPay Atlanta, 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
merchantReferenceCode
field.

Specifications

Data Type:
String

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

RBS WorldPay Atlanta: 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:

American Express Direct: does not apply

Chase Paymentech Solutions: Customer Reference Number

Elavon Americas: Purchase Identifier

FDC Compass: Customer Reference Number

FDC Nashville Global: Customer Code

FDMS Nashville: does not apply

GPN: Market Data - Customer Code and Reference Number

OmniPay Direct: Customer Code / Customer Reference ID

RBS WorldPay Atlanta: PC2 Customer ID

TSYS Acquiring Solutions: does not apply

Visa Platform Connect: customerCode

Worldpay VAP: customerReference

pointOfSaleInformation. terminalCardCaptureCapability

Indicates whether the terminal can capture the card.

This field is available only for Cybersource 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:
5

Mapping Information

REST API Field:

pointOfSaleInformation.terminalCardCaptureCapability

SCMP API Field:

terminal_card_capture_capability

Simple Order API Field:

pos_terminalCardCaptureCapability

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

paymentInformation. card.bin

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

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

clientReferenceInformation. partner. originalTransactionId

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

This field is available only for Cybersource 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 Cybersource. Therefore, you can use this value to reconcile transactions between Cybersource and the terminal’s software.

This value is not sent to the processor. Instead, the value is forwarded to the Cybersource 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

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

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, RBS WorldPay Atlanta, TSYS Acquiring Solutions, Visa Platform Connect, and Worldpay VAP processors.

Specifications

Data Type:
String

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

RBS WorldPay Atlanta: 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

RBS WorldPay Atlanta: Commodity Code

TSYS Acquiring Solutions: Item Commodity Code

Visa Platform Connect: commodityCode

Worldpay VAP: commodityCode

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.

Cybersource 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

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

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:
String

Data Length:
5

Mapping Information

REST API Field:

processingInformation.payByPointsIndicator

SCMP API Field:

pay_by_points_indicator

Simple Order API Field:

payByPoints_indicator

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

payerAuthEnrollReply_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

travelInformation.lodging. foodAndBeverageCost

Cost for all food and beverages.

Specifications

Data Type:
String

Data Length:
12

Mapping Information

REST API Field:

travelInformation.lodging.foodAndBeverageCost

Simple Order API Field:

lodgingData_foodAndBeverageCost

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

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

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 Cybersource 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

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.

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

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. rentalAddress.country

This value is the country where the vehicle was rented.

Use one of the two-character ISO Standard Country Codes. This field is supported only for American Express.

This field is optional but recommended for the authorization service.

Specifications

Data Type:
String

Data Length:
3

Mapping

REST Field Name:

travelInformation.autoRental.rentalAddress.country

SCMP Field Name:

auto_rental_pick_up_country

Simple Order Field Name:

autoRentalData_pickUpCountry

orderInformation. lineItems[].quantity

Quantity of the product.

The default is

1

.

Specifications

Data Type:
Integer

Data Length:
10

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.

American Express Direct: Does not apply

Barclays: Quantity

Chase Paymentech Solutions: Quantity

Elavon Americas: Quantity

FDC Compass: Quantity

FDC Nashville Global: Item Quantity

GPN: Item Quantity

OmniPay Direct: Quantity / Item Quantity

RBS WorldPay Atlanta: Quantity

TSYS Acquiring Solutions

Mastercard: Item Quantity

Visa: Quantity

Visa Platform Connect: quantity

Worldpay VAP: quantity

orderInformation. amountDetails.taxTypeCode

Contains the tax type code that corresponds to the entry in the

item_#_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. lineItems[].orderAcceptance. country

Country where you accept the customer’s order.

Use the two-character ISO standard country code.

See ISO Standard Country Codes.

This

item-level

field overrides the corresponding request-level field.

This field is not used for tax calculation unless the

taxService_orderAcceptanceState

and

taxService_orderAcceptanceCity

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

watchlistScreeningInformation. watchList.matches[].sanctionList

List on which the first Denied Parties List match appears.

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

orderInformation. invoiceDetails. taxable

Flag that indicates whether an order is taxable.

This field is available only for FDMS Nashville, Visa Platform Connect, and RBS WorldPay Atlanta.

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
RBS WorldPay Atlanta: This field is required for Level II Mastercard and Visa transactions. If
item_#_taxAmount
=
0
, set this field to
false
. If
item_#_taxAmount
> 0, set this field to
true
.
Visa Platform Connect: This value must be
true
if the the
item_#_taxAmount
value > 0.

If you do not include any
item_#_taxAmount
values in your request, the
invoiceHeader_taxable
field value is not included in the request.
Worldpay VAP: This field is required if
item_#_taxAmount
= 0. This field is optional if
item_#_taxAmount
> 0.

Specifications

Data Type:
String

Data Length:
5

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

RBS WorldPay Atlanta: Tax Exempt

Visa Platform Connect: localTaxIncluded

Worldpay VAP: taxExempt

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.

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.

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 Barclays processor:

00

: No information, or response not provided.

01

: Updated or additional information needed.

02

: Cannot approve at this time; try again later.

03

: Do not try again.

05

: Payment blocked by card scheme.

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

aggregatorInformation. city

The city name of the payment facilitator.

This field is applicable to the Visa card type.

Specifications

Data Type:
String

Data Length:
50

Mapping Information

REST API Field:

aggregatorInformation.city

SCMP API Field:

aggregator_city

Simple Order API Fields:

ccAuthService_aggregatorCity

octService_aggregatorCity

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.

See ISO Standard Country 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.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.administrativeArea

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 the US and Canada, see State, Province, and Territory Codes for the United States and Canada.

For all countries, use the ISO 3166-2 format when using this field for Payer Authentication.

This field is optional if your account is configured for relaxed requirements for address data.

For details about relaxed requirements, see the support article Relaxed Requirements for Address Data and Expiration Date in Credit Card Transactions.

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

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

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.

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

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

Cybersource Codes

In addition to standard Visa codes, Cybersource provides the following numeric codes:

Cybersource 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 `Cybersource` 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:
255

Mapping Information

REST API Field:

processingInformation.authorizationOptions.declineAvsFlags

SCMP API Field:

decline_avs_flags

Simple Order API Field:

businessRules_declineAVSFlags

orderInformation. lineItems[].productName

Name of product.

Specifications

Data Type:
String

Data Length

Barclays: 35

Other processors: 255

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.

Chase Paymentech Solutions: Description

Elavon Americas: Item Description

FDC Compass: Description

FDC Nashville Global: Description

OmniPay Direct: Item Description

RBS WorldPay Atlanta: Description

TSYS Acquiring Solutions:

Mastercard: Item Description

Visa: Item Descriptor

Visa Platform Connect: productName

Worldpay VAP: itemDescription

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

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:
Integer

Data Length:
2

Mapping Information

REST API Field:

consumerAuthenticationInformation. acsWindowSize

SCMP API Field:

pa_acs_window_size

Simple Order API Field:

payerAuthEnrollService_acsWindowSize

buyerInformation. hashedPassword

Customer's account password.

This value is for merchant velocity use only. It is not stored, displayed, or returned.

Do not add random strings of characters to passwords (salting) that are used with this field because that prevents accurate velocity tests.

Specifications

Data Type:
String

Data Length:
255

Mapping Information

REST API Field:

buyerInformation.hashedPassword

SCMP API Field:

customer_password

Simple Order API Field:

billTo_customerPassword

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

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

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

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

RBS WorldPay Atlanta: Alternate Tax ID

TSYS Acquiring Solutions: Alternate Tax Identifier

Worldpay VAP: cardAcceptorTaxId

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

paymentInformation. bank.account.type

Account type.

Possible values:

C

: Checking.

G

: General ledger.

This value is supported only on Wells Fargo ACH.

S

: Savings

X

: Corporate checking

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

paymentInformation.bank.account.type

SCMP API Field:

ecp-account-type

Simple Order API Field:

check_accountType

processingInformation. japanPaymentOptions. bonusMonth

If a bonus is to be paid, this value specifies the month that a bonus is paid.

This field is only used with Japanese payments.

Possible values:

1-12

Specifications

Data Length:
2

Mapping Information

REST API Field:

processingInformation.japanPaymentOptions.bonusMonth

SCMP API Field:

jpo_bonus_month

Simple Order API Field:

jpo_bonusMonth

travelInformation.lodging. earlyCheckOutCost

Service fee for early departure.

Specifications

Data Type:
String

Data Length:
12

Mapping Information

REST API Field:

travelInformation.lodging.earlyCheckOutCost

Simple Order API Field:

lodgingData_earlyCheckOutCost

orderInformation.billTo. middleName

The customer's middle name.

Specifications

Data Type:
String

Data Length:
40

Mapping Information

REST API Field:

orderInformation.billTo.middleName

SCMP API Field:

customer_middlename

Simple Order API Field:

billTo_middleName

processorInformation. avs.codeRaw

AVS result code sent directly from the processor.

This field is returned only when the processor sends this value.

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

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:

payerAuthEnrollReply_idciScore

payerAuthEnrollReply_idciDecision

payerAuthEnrollReply_idciReasonCode1

payerAuthEnrollReply_idciReasonCode2

This field is used only with Mastercard transactions.

Specifications

Data Type:

String

Data Length:
1

Mapping Information

REST API Field:

consumerAuthenticationInformation. scoreRequest

SCMP API Field:

pa_score_request

Simple Order API Field:

payerAuthEnrollService_scoreRequest

taxInformation. dateOverrideReason

When a past or future date is specified in

invoiceHeader_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

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

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:

true

: Request that the processor use least-cost routing for the transaction

false

(default): Do not request that the processor use least-cost routing for the transaction

Specifications

Data Type:
String

Data Length:
5

Mapping Information

REST API Field:

processingInformation.leastCostRouting

SCMP API Field:

auth_least_cost_routing

Simple Order API Field:

ccAuthService_leastCostRouting

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

orderInformation. lineItems.shippingDestinationTypes

Item's shipping destination type.

Example
: Commercial, residential, store

Specifications

Data Type:
String

Data Length:
50

Mapping Information

REST API Field:

orderInformation.lineItems.shippingDestinationTypes

SCMP API Field:

shipping_destination_types

Simple Order API Field:

item_#_shippingDestinationTypes

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

orderInformation. lineItems[].shippingCountryCode

Country to which the item will be shipped.

Specifications

Data Type:
String

Data Length:
2

Mapping Information

REST API Field:

orderInformation.lineItems[].shippingCountryCode

SCMP API Field:

shipping_country_code

Simple Order API Field:

item_#_shippingCountryCode

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

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

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

travelInformation.lodging. gratuityAmount

Amount of the lodging gratuity.

Specifications

Data Type:
String

Data Length:
12

Mapping Information

REST API Field:

travelInformation.lodging.gratuityAmount

Simple Order API Field:

lodgingData_gratuityCost

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

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

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

item_#_nationalTax

values > 0.

If you do not include any

item_#_nationalTax

values in your request, Cybersource does not include

otherTax_ nationalTaxIndicator

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

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

payerAuthEnrollReply_authenticationStatusReason

or

payerAuthValidateReply_authenticationStatusReason

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

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

Simple Order API Field:

bankInfo_swiftCode

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

receiptNumber

field is that Cybersource generates the receipt number for the

receiptNumber

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 Cybersource. 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

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

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

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.

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

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
Visa Platform Connect 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 Cybersource. 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

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

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:
16

Mapping Information

REST API Field:

orderInformation.amountDetails.exchangeRate

SCMP API Field:

exchange_rate

Simple Order API Field:

purchaseTotals_exchangeRate

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.

For more information, see State, Province, and Territory Codes for the United States and Canada.

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

travelInformation.lodging. room[].dailyRate

Daily cost of the room.

Specifications

Data Type:
String

Data Length:
8

Mapping

REST Field Name:

travelInformation.lodging.room[].dailyRate

Simple Order Field Name:

lodgingData_dailyRoomRate#

travelInformation. autoRental. extraCharge

This field value records any extra charges that are associated with the vehicle rental and not included in other values.

Specifications

Data Type:
Number

Data Length:
12

Mapping

REST Field Name:

travelInformation.autoRental.extraCharge

SCMP Field Name:

auto_rental_extra_charge

Simple Order Field Name:

autoRentalData_extraCharge

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

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

pos_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

processorInformation. routing. customerSignatureRequired

orderInformation.lineItems[].shippingAddress2

SCMP API Field:

shipping_address2

Simple Order API Field:

item_#_shippingAddress2

consumerAuthenticationInformation. strongAuthentication.transactionMode

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

Possible values:

M

: MOTO (Mail Order Telephone Order)

R

: Retail

S

: E-commerce

P

: Mobile Device

T

: Tablet

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

consumerAuthenticationInformation.strongAuthentication.transactionMode

SCMP API Field:

pa_transaction_mode

Simple Order API Field:

payerAuthEnrollService_transactionMode

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

sender_referenceNumber

or

sender_accountNumber

is present. If you do not include this tag,

sender_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
ccCreditService_refundReason
field to
pow
), you can use this field if you need to provide your merchant account number to process a Mastercard Payment of Winnings
stand-alone 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

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, RBS WorldPay Atlanta, 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

orderInformation.shipTo.address4

The fourth line of the shipping address.

Specifications

Data Type:
String

Data Length:
50

Mapping Information

REST API Field:

orderInformation.shipTo.address4

SCMP API Field:

ship_to_address4

Simple Order API Field:

shipTo_street4

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

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

consumerAuthenticationInformation. challengeRequired

Indicates whether a challenge is required in order to complete authentication.

Regional mandates might determine that a challenge is required. Used by the Hybrid integration.

Possible values:

Y

: Challenge required.

N

: Challenge not required.

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

consumerAuthenticationInformation.challengeRequired

SCMP API Field:

challenge_required

Simple Order API Field:

payerAuthEnrollReply_challengeRequired

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

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

consumerAuthenticationInformation. decoupledAuthenticationMaxTime

SCMP API Fields:

ap_initiate_product_description

product_description

Simple Order API Fields:

apInitiateService_productDescription

item_#_productDescription

paymentInformation. bank.account. correctedRoutingnumber

Corrected routing number from the ACH verification service, which is described in ACH Verification.

Specifications

Data Type:
String

Data Length:
9

Mapping Information

REST API Field:

paymentInformation.bank.account.correctedRoutingnumber

SCMP API Field:

ecp_debit_corrected_routing_number

Simple Order API Field:

ecDebitReply_correctedRouting Number

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:
String

Data Length:
5

Mapping Information

REST API Field:

processingInformation.authorizationOptions.splitPaymentTransaction

SCMP API Field:

split_payment_transaction

Simple Order API Field:

ccAuthService_splitPaymentTransaction

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.

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

ccAuthService_overridePaymentMethod

or

ccCreditService_overridePaymentMethod

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. 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

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 Cybersource. 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
purchaseTotals_grandTotalAmount
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

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

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.ancillaryInformation.service[]. categoryCode

Category code for ancillary service provided. Obtain the codes from the International Air Transport Association (IATA).

Replace the

#

character with a sequential number from

0

to

3

.

Specifications

Data Type:
String

Data Length:
4

Mapping Information

REST API Field:

travelInformation.transit.airline.ancillaryInformation.service[].categoryCode

SCMP API Field:

ancillary_service#_category_code

Simple Order API Field:

ancillaryData_service_#_categoryCode

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.

consumerAuthenticationInformation. stepUpUrl

SCMP API Field:

pa_step_up_url

Simple Order API Field:

payerAuthEnrollReply_stepUpURL

pointOfSaleInformation. emv.chipValidationType

Entity or service that provided the validation results returned in the

emvReply_chipValidationResults

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.

This field value is the identifier assigned by the rental agency to the purchase. This code categorizes the purchase into a standardized commodity group.

Specifications

Data Type:
String

Data Length:
15

Mapping

REST Field Name:

travelInformation.autoRental.commodityCode

SCMP Field Name:

auto_rental_commodity_code

Simple Order Field Name:

autoRental_commodityCode

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, RBS WorldPay Atlanta, 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

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

RBS WorldPay Atlanta: 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:

American Express Direct: Does not apply

Barclays: Unit of Measure

Chase Paymentech Solutions: Unit of Measure

Elavon Americas: Unit of Measure

FDC Compass: Unit of Measure

FDC Nashville Global: Item Bulk / Unit of Measure

GPN: Unit of Measure

OmniPay Direct: Unit of Measure Code / Item Unit of Measure

RBS WorldPay Atlanta: Unit of Measure

TSYS Acquiring Solutions:

Mastercard: Item Unit of Measure

Visa: Unit of Measure/Code

Visa Platform Connect: unitOfMeasure

Worldpay VAP: unitOfMeasure

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

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, RBS WorldPay Atlanta, 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

,

Data Type:
String

Data Length:
15

Mapping Information

REST API Field:

paymentInformation.bank.code

SCMP API Field:

bank_code

Simple Order API Field:

bankInfo_bankCode

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, RBS WorldPay Atlanta, TSYS Acquiring Solutions, and Visa Platform Connect processors.


American Express Direct, RBS WorldPay Atlanta, TSYS Acquiring Solutions, and Visa Platform Connect: 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

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

RBS WorldPay Atlanta: Tax Rate

TSYS Acquiring Solutions:

Mastercard: Tax Rate Applied

Visa: VAT/Tax Rate

Visa Platform Connect: taxRate

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. autoRental. agreementNumber

This field value is the rental agency’s agreement (invoice) number. The rental company provides this number to the customer.

This number is used to trace information for any inquiries about transactions. This field is required for the authorization serviice with Visa, Mastercard, and American Express.

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:

Visa: 12

Mastercard and American Express: 9

Mapping

REST Field Name:

travelInformation.autoRental.agreementNumber

SCMP Field Name:

auto_rental_agreement_number

Simple Order Field Name:

autoRentalData_agreementNumber

travelInformation. autoRental. corporateClientCode

This field value is the code that is assigned to the corporation or business entity that rents the car. The rental agency uses this code to identify corporate rates or discounts.

Specifications

Data Type:
String

Data Length:
8

Mapping

REST Field Name:

travelInformation.autoRental.corporateClientCode

SCMP Field Name:

cutomer_corporate_client_code

Simple Order Field Name:

autoRental_corporateClientCode

Additional amount type.

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

Sequence

of fields from

purchaseTotals_additionalAmountType0

to

purchaseTotals_additionalAmountType4

.

For the possible values, see Additional Amount Types.

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

Fee you are charging for the transaction.

When this fee is charged, the grand total amount must include the fee.

Specifications

Data Type:
String

Data Length:
12

Mapping Information

REST API Field:

orderInformation.amountDetails.serviceFeeAmount

SCMP API Field:

aft_service_fee

Simple Order API Field:

aft_serviceFee

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

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

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

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

ccCreditReply_merchantAdviceCode

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.

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.

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 Barclays processor:

00

: No information, or response not provided.

01

: Updated or additional information needed.

02

: Cannot approve at this time; try again later.

03

: Do not try again.

05

: Payment blocked by card scheme.

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

ccCreditReply_merchantAdviceCodeRaw

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 Barclays processor:

0

: No information, or response not provided.

1

: Updated or additional information needed.

2

: Cannot approve at this time; try again later.

4

: Do not try again.

8

: Payment blocked by card scheme.

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

octService__merchantAdviceCode

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.

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.

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 Barclays processor:

00

: No information, or response not provided.

01

: Updated or additional information needed.

02

: Cannot approve at this time; try again later.

03

: Do not try again.

05

: Payment blocked by card scheme.

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

octService__merchantAdviceCodeRaw

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 Barclays processor:

0

: No information, or response not provided.

1

: Updated or additional information needed.

2

: Cannot approve at this time; try again later.

4

: Do not try again.

8

: Payment blocked by card scheme.

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

payerAuthEnrollService_countryCode

Two-character ISO standard country code.

See ISO Standard Country Codes.

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

Simple Order API Field Reference

Recent Revisions to This Document

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.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 Simple Order API Fields

Data Type Definitions

accountHolder_type

Specifications

Mapping Information

acquirerMerchantNumber

Specifications

Mapping Information

additionalData

Specifications

Mapping Information

additionalProcessorResponse

Specifications

Mapping Information

additionalToken_responseInformation

Specifications

Mapping Information

afsReply_binCountry

Specifications

Mapping Information

afsService_avsCode

Specifications

Mapping Information

afsService_cvCode

Specifications

Mapping Information

aft_foreignExchangeFee

Specifications

Mapping Information

aft_indicator

Specifications

Mapping Information

aft_serviceFee

Specifications

Mapping Information

agencyInformation_name

agreementID

Specifications

Mapping Information

airlineData_agentCode

Specifications

`Simple Order API` Field Reference