Lookup Request (cmpi_lookup)

Owned by Brennan Keller (Unlicensed)
Last updated: Aug 30, 2024 by Kayleigh LaSalle
18 min read

cmpi_lookup Request Message

  • All Field Names are case sensitive

  • All fields use ASCII character set (0-9, A-Z, a-z, special characters)

    • Use of special characters is allowed in most fields defined as Alpha Numeric (AN)

    • The following special characters must be escaped before using: & <  >  "  ' 

  • The required field contains one of the following values

    • Y = Yes (Required field)

    • C = Conditional (Conditions of transaction to determine if it's required)

    • O = Optional (Not required but recommended to send)

    • Boolean = True or False

Field Name

Description

Required

Condition

Field Definition

Field Name

Description

Required

Condition

Field Definition

Algorithm

The hash algorithm that was used to generate the Signature for the request.

Possible Values:

  • SHA-256

  • SHA-512

Y

 

AN(7)

Identifier

The unique identifier representing the API Key being used to generate the Signature that is specified on the request. This value will be provided by Cardinal at the time the API Key is generated.

Y

 

AN(255)

OrgUnit

The unique organizational unit for which the request is being processed for. Each merchant within the system will be assigned a unique OrgUnit value by Cardinal.

Y

 

AN(24)

Signature

The signature for the request being submitted. This value is generated by hashing the combination of the Timestamp and your API Key. For more information on this, please refer to Cardinal (cmpi) Messages | Generating a Signature Value

Y

 

AN(255)

Timestamp

The unix epoch time in milliseconds for the point in time that the request is generated.

Example:

1467122891960

Y

 

N(13)

Amount

Unformatted total transaction amount without any decimalization.

Example: 

$100.00 = 10000, $123.67 = 12367, $.99 = 99

Some currencies may not have a decimal separator and can only send whole numbers like the Chilean Peso or Icelandic Krono meaning they would send amounts like this:

$100.00 = 100

Y

 

N(17)

BillingAddress1

Consumer's billing address information.

Note:  If the value passed is greater than the field definition, it will be truncated to the maximum allowable value.

Y

 

AN(50)

BillingCity

Consumer's city on their billing address.

Note:  If the value passed is greater than the field definition, it will be truncated to the maximum allowable value.

Y

 

AN(50)

BillingState

Consumer's state or province of their billing address. 

Note: Should be the country subdivision code defined in ISO 3166-2. The subdivision is code is what follows the hyphen separator in the full ISO 3166-2 code.

For example, the subdivision code for state of Ohio in the United States and Aichi in Japan is respectively;

  • Code: US-OH | Subdivision Code: OH

  • Code: JP-23 | Subdivision Code: 23

C

Required if information is available and BillingCountryCode is present.

AN(2)

BillingCountryCode

Consumer's numeric 3-digit ISO 3166-1 country code.

Example:

United States = 840

Note: Please see the Visa Required mapping for countries such as Saint Barthelemy, Guernsey, Jersey, Isle of Man & Aland Islands below.

Y

 

N(3)

BillingFullName

Consumer's billing name as indicated on the issuing card. This field can be used by systems that do not support separate field names and is used in place of the BillingFirstName, BillingMiddleName and BillingLastName fields.

Note:  If the value passed is greater than the field definition, it will be truncated to the maximum allowable value.

O

 

Min: AN(2)
Max: AN(45)

 

Alphanumeric characters must follow the Common Character Set as defined in EMV Book 4, Annex B.

BillingFirstName

Consumer's first name as indicated on the issuing card.

Y

 

Min: AN(2)

Max: AN(22)

 

Alphanumeric characters must follow the Common Character Set as defined in EMV Book 4, Annex B.

BillingLastName

Consumer's last name as indicated on the issuing card.

Y

 

Min: AN(2)
Max: AN(22)

 

Alphanumeric characters must follow the Common Character Set as defined in EMV Book 4, Annex B.

BillingPostalCode

Consumer's postal code of their billing address.

Y

 

AN(16)

BillingPhone

Consumer's phone number for billing address. This should be unformatted without hyphens. 

Note: This information will be passed to the Directory Server if the phone has a + sign and a country code.

Examples:

(US) + 1-222-234-5678 = +12222345678

(UK) + 44-1234-123456 = +441234123456

Note: The BillingPhone field is required per EMVCo specifications; however, only one type of phone number needs to be passed, i.e. if BillingPhone is passed, it is not necessary to pass additional phone fields. Failure to include a phone number may result in higher challenges or frictionless failures.

Y

 

N(20)

CardExpMonth

Card number expiration month. Formatted MM

Example:

January = 01

C

This is required for all card brands aside from UPI debit issued in mainland China (still applies to credit).

N(2)

CardExpYear

Card number expiration year. Formatted YYYY

Example: 

YYYY = 2016

C

 

This is required for all card brands aside from UPI debit issued in mainland China (still applies to credit).

N(4)

CardNumber

Consumer's account/card number or network issued token value.

Y

 

N(19)

CurrencyCode

3 digit numeric ISO 4217 currency code for the sale amount.

When CardType is EFTPOS, you are required to pass “036” in CurrencyCode to indicate AUD as the currency used.

Y

 

N(3)

DFReferenceId

Reference Id that relates to the device data that was previously collected. DFreferenceId is generated as part of the Device Data Collection call.

Merchants must pass a unique value of DFReferenceId on each Lookup request.

Note: In the Cruise Hybrid Integration or Cardinal Cruise API Integration, this field will need to match the ReferenceId claim in the JWT or the sessionId from the payments.setupComplete event handler.

Y

 

AN(50)

Email

Consumer's email address.

Y

 

AN(254)

MobilePhone

Consumer's phone number for mobile phone. This should be unformatted without hyphens. 

Note: This information will be passed to the Directory Server if the phone has a + sign and a country code.

Examples:

(US) + 1-222-234-5678 = +12222345678

(UK) + 44-1234-123456 = +441234123456

Note: This field is required for VISA Brazil extensions.

Note: The MobilePhone field is required per EMVCo specifications; however, only one type of phone number needs to be passed, i.e. if MobilePhone is passed, it is not necessary to pass additional phone fields. Failure to include a phone number may result in higher challenges or frictionless failures.

Y

 

N(25)

Version

Application message identifier. Current Version - 1.7

Y

 

AN(3)

TransactionMode

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

Available Options:

M - Moto (Mail Order Telephone Order)

P - Mobile Device

R - Retail (Physical Store)

S - Computer Device

T - Tablet Device

O

 

A(1)

MsgType

cmpi_lookup

Y

 

AN(50)

TransactionType

Identifies the transaction type used for processing.

Possible Values:

C - Credit Card/Debit Card Authentication 

Y

 

AN(3)

OrderNumber

Order Number or transaction identifier from the Merchant commerce website.

Y

 

AN(50)

AcquirerCountryCode

Issuers need to be aware of the Acquirer's Country Code when the Acquirer country differs from the Merchant country.

This should be in alignment with ISO 3166-1.

C

Required for a merchant acquiring in India and EEA

N(3)

ShippingAddress1

Consumer's shipping address information.

Note:  If the value passed is greater than the field definition, it will be truncated to the maximum allowable value.

C

Required if information is available.

AN(50)

ShippingState

Consumer's state or province of their billing address. 

Note: Should be the country subdivision code defined in ISO 3166-2. The subdivision is code is what follows the hyphen separator in the full ISO 3166-2 code.

For example, the subdivision code for state of Ohio in the United States and Aichi in Japan is respectively;

  • Code: US-OH | Subdivision Code: OH

  • Code: JP-23 | Subdivision Code: 23

C

Required if information is available and ShippingCountryCode is present.

AN(2)

ShippingCity

Consumer's city of their shipping address.

Note:  If the value passed is greater than the field definition, it will be truncated to the maximum allowable value.

C

Required if information is available.

AN(50)

ShippingCountryCode

Consumer's 3-digit ISO 3166-1 country code.

Note: Please see the Visa Required mapping for countries such as Saint Barthelemy, Guernsey, Jersey, Isle of Man & Aland Islands below.

C

Required if information is available.

AN(3)

ShippingAddress2

Consumer's shipping address information.

Note:  If the value passed is greater than the field definition, it will be truncated to the maximum allowable value.

C

Required if information is available.

AN(50)

ShippingAddress3

Consumer's shipping address information.

Note:  If the value passed is greater than the field definition, it will be truncated to the maximum allowable value.

C

Required if information is available.

AN(50)

ShippingPostalCode

Consumer's postal code of their shipping address.

C

Required if information is available.

AN(16)

WorkPhone

Consumer's work phone number.

Note: The WorkPhone field is required per EMVCo specifications; however, only one type of phone number needs to be passed, i.e. if WorkPhone is passed, it is not necessary to pass additional phone fields. Failure to include a phone number may result in higher challenges or frictionless failures.

Y

 

N(25)

BillingAddress2

Consumer's billing address information.

Note:  If the value passed is greater than the field definition, it will be truncated to the maximum allowable value.

C

Required if information is available.

AN(50)

BillingAddress3

Consumer's billing address information.

Note:  If the value passed is greater than the field definition, it will be truncated to the maximum allowable value.

C

Required if information is available.

AN(50)

AuthenticationIndicator

Indicates the type of Authentication request.

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

C

Required if not a Payment transaction.

N(2)

ProductCode

Merchant product code.

Possible Values:

PHY - Goods/Service Purchase

CHA - Check Acceptance

ACF - Account Funding

QCT - Quasi-Cash Transaction 

PAL - Prepaid Activation and Load



Note: This value defaults to PHY. This field can be used to override that value if applicable.

C

Required if the value is anything other than PHY.

This field is required in some markets (e.g. for Merchants in Brazil). Otherwise, optional.

Note: This field is known to be required for Discover processing.

AN(3)

CardType 

Type of cards used for purchase.

Possible Values:

CB - Cartes Bancaires 

UPI - UnionPay International

ITMX - Interbank Transaction Management and Exchange

EFTPOS - eftpos Australia

MADA -Saudi Arabian Monetary Authority

C

Required for CB, ITMX, eftpos, UPI, and mada

AN(20)

ShippingMethodIndicator

Indicates shipping method 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

O

 

N(2)

DeliveryTimeframe

Indicates the delivery timeframe.

Possible Values:

01 - Electronic delivery

02 - Same day shipping

03 - Overnight shipping

04 - Two or more day shipping

O

 

N(2)

DeliveryEmail

For electronic delivery, email address to which the merchandise was delivered.

O

 

AN(254)

ReorderIndicator

Indicates whether the cardholder is reordering previously purchased merchandise.

Possible Values:

01 - First time ordered

02 - Reordered

O

 

N(2)

PreOrderIndicator

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

Possible Values:

01 - Merchandise available 

02 - Future availability 

O

 

N(2)

PreOrderDate

Expected date that a pre-ordered purchase will be available.

Format:

YYYYMMDD

O

 

N(8)

GiftCardAmount

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

Example:

$123.45 USD = 12345

O

 

N(15)

GiftCardCurrencyCode

ISO 4217 currency code for the gift card purchased.

O

 

N(3)

GiftCardCount

Total count of individual prepaid gift cards purchased.

Note: The value passed in should be exactly 2-digit numeric.

O

 

N(2)

App Fields

CardinalEncryptedDeviceData

A field that encapsulates SDK specific transaction data elements deemed necessary for processing APP based transactions

Y

CMSDK v3.0 and above

AN(256)

Browser Fields

BrowserJavaEnabled

A Boolean value that represents the ability of the cardholder browser to execute Java.

Value is returned from the navigator.javaEnabled property.

Possible Values:

True

False

Y

 

Required when the DeviceChannel = Browser

 



BrowserHeader

The exact content of the HTTP accept headers sent from the cardholder's browser.

Example: 

text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8

Y

Required when the DeviceChannel = Browser

 

AN(2048)

BrowserLanguage

Value represents the browser language as defined in IETF BCP47 . 

Example:

en-US

Y

Required when the DeviceChannel = Browser

 

AN(8)

BrowserColorDepth

Value represents the bit depth of the color palette for displaying images, in bits per pixel

Possible Values: (based on EMVCo spec)

  • 1

  • 4

  • 8

  • 15

  • 16

  • 24

  • 32

  • 48

Note: Modern devices are beginning to provide values outside of the specified list above. Based on direction from EMVCo, Cardinal has implemented logic on the BrowserColorDepth field which will map any provided value to the closest lower value in the Possible Values list. This ensures the ACS receives a valid value for screen rendering and the transaction can proceed without error.

Y

 

Required when the DeviceChannel = Browser

 

AN(2)

 

Value must be a positive integer and greater than zero.

BrowserScreenHeight

Total height of the Cardholder's scree in pixels

Example:

864

Y

Required when the DeviceChannel = Browser

 

AN(6)

BrowserScreenWidth

Total width of the cardholder's screen in pixels.

Example:

1536

Y

Required when the DeviceChannel = Browser

 

AN(6)

BrowserTimeZone

Time difference between UTC time and the cardholder browser local time, in minutes 

Example:

300

Y

Required when the DeviceChannel = Browser

 

AN(5)

UserAgent

The exact content of the HTTP user agent header.

Example:

Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/71.0.3578.98 Safari/537.36

Y

Required when the DeviceChannel = Browser

 

AN(2048)

IPAddress

The IP address of the Consumer.

Note:   IPv4 and IPv6 are supported.

Example:

IPv4 address:  <IPAddress>1.12.123.255</IPAddress>

IPv6 address: <IPAddress>2011:0db8:85a3:0101:0101:8a2e:03 70:7334</IPAddress>

Y

 

AN(45)

DeviceChannel

Determines the channel that the transaction came through.

Possible Values: 

SDK

Browser

3RI

Note: Cardinal will dynamically set 'Browser' when customer is using our Cardinal Cruise JavaScript. However, if the merchant is not running Device Data Collection, they need to pass Device Channel as 'Browser' along with the required browser fields in the Lookup Request.

Y

Client will need to set Device Channel as:

  • 3RI for Merchant Initiated or 3RI transactions and; 

  • SDK for transactions initiated with Cardinal Mobile SDK

AN(10)

BrowserJavascriptEnabled

A Boolean value that represents represents the ability of the cardholder browser to execute JavaScript.

Possible Values:

True

False

Y

 

Required when the DeviceChannel = Browser

 

Boolean

Cardholder Information

AccountAgeIndicator

Length of time cardholder has had account.

Possible Values:

01 - No Account

02 - Created during transaction

03 - Less than 30 days

04 - 30-60 days

05 - More than 60 days

O

 

N(2)

AccountCreateDate

Date the cardholder opened the account.

Format:

YYYYMMDD

O

 

N(8)

AccountChangeIndicator

Length of time since the last change to the cardholder account. This includes shipping address, new payment account or new user added.

Possible Values:

01 - Changed during transaction

02 - Less than 30 days

03 - 30-60 days

04 - More than 60 days

O

 

N(2)

AccountChangeDate

Date the cardholder's account was last changed. This includes changes to the billing or shipping address, new payment accounts or new users added.

Format:

YYYYMMDD

O

 

N(8)

AccountPwdChangeIndicator

Length of time since the cardholder changed or reset the password on the account.

Possible Values: 

01 - No change

02 - Changed during transaction

03 - Less than 30 days

04 - 30-60 days

05 - More than 60 days

O

 

N(2)

AccountPwdChangeDate

Date the cardholder last changed or reset password on account.

Format:

YYYYMMDD

O

 

N(8)

ShippingAddressUsageIndicator

Indicates when the shipping address used for transaction was first used.

Possible Values:

01 - This transaction

02 - Less than 30 days

03 - 30-60 days

04 - More than 60 days

O

 

N(2)

ShippingAddressUsageDate

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

Format:

YYYYMMDD

O

 

N(8)

TransactionCountDay

Number of transactions (successful or abandoned) for this cardholder account within the last 24 hours.

O

 

N(3)

TransactionCountYear

Number of transactions (successful or abandoned) for this cardholder account within the last year.

O

 

N(3)

AddCardAttempts

Number of add card attempts in the last 24 hours.

O

 

N(3)

AccountPurchases

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

O

 

N(4)

FraudActivity

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

Possible Values:

01 - No suspicious activity

02 - Suspicious activity observed

O

 

N(2)

ShippingNameIndicator

Indicates if the cardholder name on the account is identical to the shipping name used for the transaction.

Possible Values:

01 - Account name identical to shipping name

02 - Account name different than shipping name

O

 

N(2)

PaymentAccountIndicator

Indicates the length of time that the payment account was enrolled in the merchant account.

Possible Values:

01 - No account (guest checkout)

02 - During the transaction 

03 - Less than 30 days

04 - 30-60 days

05 - More than 60 days

O

 

N(2)

PaymentAccountAge

Date the payment account was added to the cardholder account.

Format:

YYYYMMDD

O

 

N(8)

Requestor Authentication 

AlternateAuthenticationMethod

Mechanism used by the cardholder to authenticate to the 3DS requestor.

Possible Values:

01 - No authentication occurred (e.g. Guest Checkout)

02 - Login to the cardholder account at the Merchant system using Merchant system credentials

03 - Login to the cardholder account at the Merchant system using a Federated ID

04 - Login to the cardholder account at the Merchant system using Issuer credentials

05 - Login to the cardholder account at the Merchant system using third-party authentication

06 - Login to the cardholder account at the Merchant system using FIDO Authenticator

O

 

N(2)

AlternateAuthenticationDate

Date and time in UTC of the cardholder authentication. 

Format:

YYYYMMDDHHMM

O

 

N(12)

AlternateAuthenticationData

Data that documents and supports a specific authentication process that was sent in the AlternateAuthenticationMethod field.  

O

 

AN(20000)

Requestor Prior Authentication

AlternatePriorAuthenticationData

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

O

 

AN(2048)

AlternatePriorAuthenticationMethod

Mechanism used by the Cardholder to previously authenticate to the 3DS Requestor.

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 DS use

O

 

N(2)

AlternatePriorAuthenticationTime

Date and time in UTC of the prior cardholder authentication.

Format

YYYYMMDDHHMM

O

 

N(12)

AlternatePriorAuthenticationRef

This data element contains a ACS Transaction ID for a prior authenticated transaction

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

O

 

AN(36)

Tokenization

Alias

An alias that uniquely identifies the account.

O

 

AN(128)

Token

The third-party token that will be used to process the transaction in place of the actual card number. If the token value was issued by the network, the CardNumber field should still be used.

Note: This field is required if Tokenization is enabled in the Merchant profile setting AND the Merchant is using a third-party token.

O

 

AN(100)

SDK

SdkMaxTimeout

This field indicates the maximum amount of time for all 3DS 2.0 messages to be communicated between all components (in minutes). 

Possible Values:

Greater than or equal to 05 (05 is the minimum timeout to set)

Cardinal Default is set to 15

Note: This field is a required 3DS 2.0 field and Cardinal sends in a default of 15 if nothing is passed

O

 

N(2)

SDKFlowType

Override the SDK Flow Type configured in the Merchant Profile.

O

 

AN(100)

Additional and Override Fields

ChallengeIndicator

Possible Values:

01 - No preference

02 - No challenge requested

03 - Challenge requested (3DS Requestor Preference)

04 - Challenge requested (Mandate)

05 - No challenge requested (transactional risk analysis is already performed)

06 - No challenge requested (Data share only)

07 - No challenge requested (strong consumer authentication is already performed)

08 - No challenge requested (utilise trustlist exemption if no challenge required)

09 - Challenge requested (trustlist prompt requested if challenge required)

Note: Cardinal will default to 01 on Merchant Configuration - 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.

O

 

N(2)

ACSWindowSize

An override field that a merchant can pass in to set the challenge window size to display to the end cardholder.  The ACS will reply with content that is formatted appropriately to 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 window.

01 - 250x400

02 - 390x400

03 - 500x600

04 - 600x400

05 - Full page

Note:  Since this is a 2.0 browser required field, Cardinal will set this value based on what is configured in the profile or passed in on the cmpi_lookup request.

O

 

N(2)

MerchantName

Override the Merchant name configured in the Centinel Merchant profile.

Note: Characters used must be valid UTF-8. It is recommended that the value sent in this field be the same name used in the authorisation message as defined in ISO 8583 (or as you have registered with your acquirer).

O

 

AN(40)

AcquirerId

Override the acquiring institution identification code (the Acquirer BIN) that is currently configured in the Centinel profile.

Tip: This field is numeric only.

O

 

N(11)

AcquirerMerchantId

Override the Acquirer Merchant identifier configured in the Merchant's profile.

O

 

AN(35)

AcquirerPassword

The value in this field is used to facilitate Merchant Authentication File (MAF) authentication processing.

Note: This is required only when processing within certain VISA regions. If this value is passed it will override the password value configured on the Merchant's configuration profile.

O

 

AN(50)

RequestorId

This value is a Directory Server assigned 3DS Requestor ID value, each DS may provide a unique ID. 

Note:  This is a 2.0 value only and if passed will override the Requestor Id value that is configured on the Merchant's profile.

O

 

AN(35)

RequestorName

This value is a Directory Server assigned 3DS Requestor Name value, each DS may provide a unique ID. 

Note:  This is a 2.0 value only and if passed will override the Requestor Name value that is configured on the Merchant's  profile.

O

 

AN(40)

CategoryCode

Merchant category code (MCC)

Note: This field is required by Mastercard and Visa Brazil extensions.

O

 

N(4)

CountryCodeOverride

Override the country code configured in the Centinel Merchant profile. This should be in alignment with ISO 3166-1.

Note: Please see the Visa Required mapping for countries such as Saint Barthelemy, Guernsey, Jersey, Isle of Man & Aland Islands below.

O

 

N(3)

MessageCategory

Category of the message for a specific use case.

Possible Values:

01 - PA

02 - NPA

03-79 - Reserved for EMVCo future use (values invalid until defined by EMVCo)

80-99 - Reserved for DS use

Note: Default is payment (01). Configured on Merchant account, or can be overridden on transaction. 

O

 

N(2)

MerchantURL

Override the Merchant URL configured in the Centinel Merchant profile. 

Example:
https://www.cardinalcommerce.com
http://www.cardinalcommerce.com

O

 

AN(2048)

AddressMatch

Indicates whether cardholder billing and shipping addresses match.

Possible Values:

Y - Shipping address matches billing address

N - Shipping address does not match billing address

O

 

AN(1)

AccountId

Additional cardholder account information.

O

 

AN(64)

Custom_X

A custom field used to accept merchant data to be used within our rules engine. Limit of 5 Custom fields per request.

Example:

Custom_1, Custom_2, etc. for multiple custom fields

O

 

AN(175)

Item_Desc_X

Brief description of item.

O

 

AN(256)

Item_Name_X

Name of item purchased.

O

 

AN(128)

Item_Price_X

Unformatted price of item X transaction amount without any decimalization. 

O

 

N(20)

Item_Quantity_X

Number of items purchased.

O

 

N(20)

Item_ShippingAddress1_X

Address where item will be shipped.

O

 

AN(50)

Item_ShippingAddress2_X

Address where item will be shipped.

O

 

AN(128)

Item_ShippingCity_X

City where item will be shipped.

O

 

AN(50)

Item_ShippingCountryCode_X

Country where item will be shipped.

O

 

AN(2)

Item_ShippingDestination_X

Shipping destination of item.

Example:

Commercial, Residential, Store

O

 

AN(50)

Item_ShippingFirstName_X

Consumer's first name.

O

 

AN(128)

Item_ShippingLastName_X

Consumer's last name.

O

 

AN(128)

Item_ShippingMiddleName_X

Consumer's middle name.

O

 

AN(128)

Item_ShippingPhone_X

Phone number where item will be shipped.

O

 

N(20)

Item_ShippingPostalCode_X

Postal code where item will be shipped.

O

 

AN(16)

Item_ShippingState_X

State where item will be shipped.

Note: Should be the country subdivision code defined in ISO 3166-2. The subdivision is code is what follow the hyphen separator in the full ISO 3166-2 code. For example, the state of Ohio in the United States is:
Full ISO 3166-2 Code: US-OH
Subdivision Code: OH

O

 

AN(3)

Item_SKU_X

Item SKU number.

O

 

AN(20)

MerchantReferenceNumber

Merchant specified data.

O

 

AN(20)

OrderDescription

Brief Description of items purchased.

O

 

AN(256)

ShippingDestination_X

Destination to where the item will be shipped.

Example:

Commercial, Residential, Store

O

 

AN(25)

ShippingFirstName

Consumer's first name.

O

 

AN(50)

ShippingLastName

Consumer's last name.

O

 

AN(50)

ShippingMiddleName

Consumer's middle name.

O

 

AN(50)

ShippingPhone

Consumer's phone number for shipping address. This should be unformatted without hyphens. 

Note: This information will be passed to the Directory Server if the phone has a + sign and a country code.

Examples:

(US) + 1-222-234-5678 = +12222345678

(UK) + 44-1234-123456 = +441234123456

Note: The ShippingPhone field is required per EMVCo specifications; however, only one type of phone number needs to be passed, i.e. if ShippingPhone is passed, it is not necessary to pass additional phone fields. Failure to include a phone number may result in higher challenges or frictionless failures.

Y

 

N(20)

TaxAmount

Unformatted tax amount without any decimalization. 

Example:

$100.00 = 10000, $123.67 = 12367, $.99 = 99

O

 

N(20)

OverridePaymentMethod

Override the payment method.

Possible Values:

NA - Not Applicable

CR - Credit

DB - Debit

VSAVR--Visa Vale Refeicao (Only applicable to 3DS 1.0)

VSAVA - Visa Vale Alimentacao (Only applicable to 3DS 1.0)

If OverridePaymentMethod has values ‘VSAVR’ or ‘VSAVA’ on the Lookup Request for an EMV 3DS transaction, the transaction will result in an error.

C

This field is required in some markets (e.g. for Merchants in Brazil). Otherwise, optional.

Note: This field is known to be required for Discover processing.

AN(10)

ShippingFullName

Consumer's shipping name. This field can be used by systems that do not support separate field names and is used in place of the ShippingFirstName, ShippingMiddleName and ShippingLastName fields. 

O

 

AN(150)

DecoupledMaxTime

Indicates the maximum amount of time that the 3DS Requestor will wait for an ACS to provide the results of a Decoupled Authentication transaction (in minutes).

Possible Values: 

Numeric values between 1 and 10080 accepted.

Note:  Decoupled authentication is not supported at this time.

O

 

N(5)

DecoupledIndicator

Indicates whether the 3DS Requestor requests the ACS to utilise Decoupled Authentication and agrees to utilise Decoupled Authentication if the ACS confirms its use.

Possible Values: 

Y - Decoupled Authentication is supported and preferred if challenge is necessary

N - Do not use Decoupled Authentication

Default Value: N

Note: If the element is not provided, the expected action is for the ACS to interpret as N, DO NOT use Decoupled Authentication.  Decoupled authentication is not supported at this time.

O

 

AN(1)


Conditional Lookup Fields

Field Set

Condition

Field Set

Condition

Merchant Initiated (3RI) Conditional Lookup Fields

When the DeviceChannel of the transaction is set to “3RI” these additional fields must be sent

Trustlisted Exemption Conditional Lookup Fields

Required when you are attempting to leverage the Trustlist Exemption available within EMV 3DS programs

Mastercard PSD2 Extension Conditional Lookup Fields

Required to leverage exemptions offered within the Mastercard Identity Check program, beginning with EMV 3DS version 2.1.0

Mastercard Identity Check Express Conditional Fields

Required when leveraging Mastercard’s Identity Check Express solution for delegated authentication

Mastercard Identity Check Insights Conditional Lookup Fields

Required when running data only via Mastercard Identity Check Insights

Visa Delegated Authentication Conditional Lookup Fields

Required to access and perform delegated authentication within the Visa Secure EMV 3DS program

American Express SafeKey Conditional Lookup Fields

Required when the Card Brand of the transaction is AMEX

Recurring/Installment Conditional Lookup Fields

Required when the transaction is a subscription or installment payment

Brazil Extensions Conditional Lookup Fields

Required when the Merchant and the Issuer are originating within the country of Brazil

Cartes Bancaires Conditional Lookup Fields

Required when the Card Brand of the transaction is CB (Cartes Bancaires)

India IVR Conditional Lookup Fields

Only required when you are looking to leverage an IVR form of authentication

Virtual SDK Conditional Lookup Fields

Required when leveraging the Virtual SDK for non-traditional device authentication

Travel Industry Extensions Conditional Fields

Optional extensions for use by travel industry merchants to provide additional risk decisioning data to the issuer for assessment

Visa Required CountryCode Mapping

Visa is currently requiring merchants to pass the below country codes in place of the respective ISO-3166-1 Spec. Visa requires this while all other card brands do NOT require this and therefore should only be mapped from an integration standpoint for Visa only. Cartes Bancaires is not included in the Visa spec for requirement.

ISO Standard

Visa Requirement

Country

ISO Country Code

Country

ISO Country Code

Saint Barthelemy

652

France

250

Guernsey

831

United Kingdom

826

Jersey

832

United Kingdom

826

Isle of Man

833

United Kingdom

826

Aland Islands

248

Finland

246