TokenEx : EMVCo Property Mapping

TokenEx Property3DS version 2.1/2.2 EMVCoData Type (TokenEx)Description
DeviceChanneldeviceChannelintIndicates the type of channel interface being used to initiate the transaction.

2 = BRW
3 = 3RI
MessageCategorymessageCategoryintIdentifies the category of the message for a specific use case.

1 = Payment
2 = Non Payment
MessageVersionmessageVersionstringIndicates the Protocol Version Number of the specification utilized by the system creating this message. The Message Version Number does not change during a 3DS transaction.

For backwards compatibility, these values will be mapped to the following 3DS versions:
1 = 3DS 2.1.0
2 = 3DS 2.2.0
MethodCompletionIndicatorthreeDSCompIndEnum MethodCompletionIndicators1 = ThreeDSMethodSuccessfullyCompleted
2 = ThreeDSMethodUnSuccessful
3 = ResultUnavailable
AuthenticationIndicatorthreeDSRequestorAuthenticationIndIntIndicates the type of Authentication request. This data element provides additional information to the ACS to determine the best approach for handing an authentication request.

Values accepted:
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

* Required for
Device Channel - 02-Browser
RequestorIdthreeDSRequestorIDstringRequired only if dsIdentifier is JCB or CB
RequestorNamethreeDSRequestorNamestringRequired only if dsIdentifier is JCB or CB
ServerTransactionIdthreeDSServerTransIDstringUniversally unique transaction identifier assigned by the 3DS Server to identify a single transaction
DirectoryServerIdentifierdsIdentifierstringIndicates the Directory Server for which the card range is enrolled/eligible.

AMEX
CB
DISCOVER
JCB
MASTERCARD
VISA
AcquirerBinacquirerBINstringAcquiring institution identification code as assigned by the DS receiving the AReq message.

* Required if
Message Category is 1 Payment. Required by Visa for Message Categories 1 and 2. See Brand Specific Guidelines
GenerateChallengeRequestgenerateCReqboolIndicator as to whether or not the 3DS Server should generate and return a Base64 encoded CReq message to be used to initiate the challenge with the ACS.

* default set to true
NotificationUrlnotificationURLstringFully qualified URL of the system that receives the CRes message or Error Message. The CRes message is posted by the ACS through the Cardholder browser at the end of the challenge and receipt of the RRes message.
TransactionTypetransTypeEnum TransactionTypesIdentifies the type of transaction being authenticated.

1 = GoodsServicePurchase
3 = CheckAcceptance
10 = AccountFunding
11 = CashTransaction
28 = PrepaidActivationAndLoad
WhiteListStatuswhiteListStatusboolEnables the communication of trusted beneficiary/whitelist status between the ACS, the DS and the 3DS Requestor.
WhiteListStatusSourcewhiteListStatusSourceintThis data element will be populated by the system setting Whitelist Status.

Only applicable to 3DS v2.2.0
and required if Whitelist Status is present.

01 = 3DS Server
02 = DS
03 = ACS
ThreeDSecureRequestorAuthenticationInformationthreeDSRequestorAuthenticationInfoThreeDSecureRequestorAuthenticationInformation - ObjectInformation about how the 3DS Requestor authenticated the cardholder before or during the transaction.

Only applicable if Device Channel is 2 - Browser
-- MethodthreeDSReqAuthMethodstringMechanism used by the Cardholder to authenticate to the 3DS Requestor
-- DatathreeDSReqAuthDatastringData that documents and supports a specific authentication process.
-- TimestampthreeDSReqAuthTimestampstringDate and time in UTC of the cardholder authentication.
PriorAuthenticationInformationthreeDSRequestorPriorAuthenticationInfoThreeDSecureRequestorPriorAuthenticationInformation - ObjectInformation about how the 3DS Requestor authenticated the cardholder as part of a previous 3DS transaction.
-- PriorTransactionReferencethreeDSReqPriorRefstringThis data element provides additional information to the ACS to determine the best approach for handling a request.

This data element is an ACS Transaction ID for a prior authenticated transaction (for example, the first recurring transaction that was authenticated with the cardholder).

Format: 36 character GUID (Canonical format as defined in IETF RFC 4122)
-- MethodthreeDSReqPriorAuthMethodstringMechanism 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
-- DatathreeDSReqPriorAuthDatastringData that documents and supports a specific authentication process.
-- TimestampthreeDSReqPriorAuthTimestampstringDate and time in UTC of the prior cardholder authentication.

Format: YYYYMMDDHHMM
ThreeRIIndicatorthreeRIIndIntIndicates the type of 3RI request. This data element provides additional information to the ACS to determine the best approach for handing a 3RI request.
* Required only if Device channel is set to 3 (3RI)

Values accepted:
1 = Recurring transaction
2 = Instalment transaction
3 = Add card
4 = Maintain card information
5 = Account verification
6 = Split/delayed shipment
7 = Top–up
8 = Mail Order
9 = Telephone Order
10 = Whitelist status check
11 = Other payment
12 = Billing Agreement
13–79 = Reserved for EMVCo future use (values invalid until defined by EMVCo)
80–99 = Reserved for DS use
ChallengeWindowSizechallengeWindowSizeEnum ChallengeWindowSizesDimensions of the challenge window that has been displayed to the Cardholder. The ACS shall reply with content that is formatted to appropriately render in this window to provide the best possible user experience. Preconfigured sizes are width x height in pixels of the window displayed in the Cardholder browser window.

1 = _250x400,
2 = _390x400,
3 = _500x600,
4 = _600x400,
5 = FullScreen
DecoupledAuthenticationDetailsDecoupledAuthenticationDetails - Object
-- DecoupledIndicatorthreeDSRequestorDecReqIndboolIndicates whether the 3DS Requestor requests the ACS to use Decoupled Authentication and agrees to use Decoupled Authentication if the ACS confirms its use.

Defaults to false.
-- DecoupledMaxTimethreeDSRequestorDecMaxTimeIntIndicates 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). Acceptable range: Between 1 and 10080.

Required if 3DS Requestor Decoupled Request Indicator = true available in 3DS v2.2.0
PurchaseDetailsPurchaseDetails - Object
-- AmountpurchaseAmountIntPurchase amount in minor units of currency with all punctuation removed. When used in conjunction with the Purchase Currency Exponent field, proper punctuation can be calculated.
-- CurrencypurchaseCurrencystringCurrency in which purchase amount is expressed, using ISO 4217 three-digit currency code.
-- ExponentpurchaseExponentIntMinor units of currency as specified in the ISO 4217 currency exponent.
Example:- USD = 2, Yen = 0
-- DatepurchaseDatestringDate and time of the purchase, expressed in UTC.
-- RecurringExpiryrecurringExpirystringDate after which no further authorizations shall be performed.

V1 Conditions: Required if 3DS Requestor Authentication Indicator= 02 or 03.

V2 Conditions: Required if 3DS Requestor Authentication Indicator= 02 or 03 OR
3RI Indicator = 01 or 02

Format: YYYYMMDD
-- RecurringFrequencyrecurringFrequencyIntIndicates the minimum number of days between authorizations.

V1 Conditions: Required if 3DS Requestor Authentication Indicator= 02 or 03.

V2 Conditions: Required if 3DS Requestor Authentication Indicator= 02 or 03 OR 3RI Indicator = 01 or 02
AddressMatchIndicatoraddrMatchboolIndicates whether the Cardholder Shipping Address and Cardholder Billing Address are the same.

If Address match indicator = true then shipping and billing address information must be present

Values accepted:
true = Shipping Address matches Billing Address
false = Shipping Address does not match Billing Address
CardDetailsCardDetails - Object
-- *NumberacctNumberstringAccount number that will be used in the authorization request for payment transactions. Represented by PAN/Credit card.
-- CardExpiryDatecardExpiryDatestringExpiry Date of the PAN or token supplied to the 3DS Requestor by the Cardholder, in YYMM format
-- AccountTypeacctTypeEnum AccountTypesIndicates the type of account. For example, a multi–account card product.
1 = NotApplicable
2 = Credit
3 = Debit
CardholderDetailsCardholderDetails - Object
-- NamecardholderNamestringName of the Cardholder.
-- EmailAddressemailstringThe email address associated with the account that is either entered by the Cardholder, or is on file with the 3DS Requestor.
-- BillingAddressAddress - Object
---- CitybillAddrCitystringThe city of the Cardholder billing address associated with the card used for this purchase.
---- CountrybillAddrCountrystringThe country of the Cardholder billing address associated with the card used for this purchase.

3 characters
ISO 3166–1 numeric three–digit country code.
---- Line1billAddrLine1stringFirst line of the street address or equivalent local portion of the Cardholder billing address associated with the card used for this purchase.
---- Line2billAddrLine2stringSecond line of the street address or equivalent local portion of the Cardholder billing address associated with the card used for this purchase.
---- Line3billAddrLine3stringThird line of the street address or equivalent local portion of the Cardholder billing address associated with the card used for this purchase.
---- PostalCodebillAddrPostCodestringZIP or other postal code of the Cardholder billing address associated with the card used for this purchase.
---- StatebillAddrStatestringThe state or province of the Cardholder billing address associated with the card used for this purchase.
-- ShippingAddressAddress - Object
---- CityshipAddrCitystringCity portion of the shipping address requested by the Cardholder.
---- CountryshipAddrCountrystringCountry of the shipping address requested by the Cardholder.

3 characters
ISO 3166–1 numeric three–digit country code.
---- Line1shipAddrLine1stringFirst line of the street address or equivalent local portion of the shipping address requested by the Cardholder.
---- Line2shipAddrLine2stringThe second line of the street address or equivalent local portion of the shipping address requested by the Cardholder.
---- Line3shipAddrLine3stringThe third line of the street address or equivalent local portion of the shipping address requested by the Cardholder.
---- PostalCodeshipAddrPostCodestringThe ZIP or other postal code of the shipping address requested by the Cardholder.
---- StateshipAddrStatestringThe state or province of the shipping address associated with the card being used for this purchase.
-- MobilePhonemobilePhoneCardholderPhoneNumber - ObjectThe mobile phone number provided by the Cardholder.
---- CountryCodeccstring1–3 characters
---- SubscribersubscriberstringMaximum 15 characters
-- HomePhonehomePhoneCardholderPhoneNumber - ObjectThe home phone number provided by the Cardholder.
---- CountryCodeccstring1–3 characters
---- SubscribersubscriberstringMaximum 15 characters
-- WorkPhoneworkPhoneCardholderPhoneNumber - ObjectThe work phone number provided by the Cardholder.
---- CountryCodeccstring1–3 characters
---- SubscribersubscriberstringMaximum 15 characters
BrowserInfoBrowserInfo - ObjectDevice Channel:
02–BRW

Message Category:
01–PA
02–NPA
-- AcceptHeadersbrowserAcceptHeaderstringExact content of the HTTP accept headers as sent to the 3DS Requestor from the Cardholder’s browser.
-- JavaEnabledbrowserJavaEnabledboolBoolean that represents the ability of the cardholder browser to execute Java. Value is returned from the navigator.javaEnabled property.
-- JavascriptEnabledbrowserJavascriptEnabledboolBoolean that represents the ability of the cardholder browser to execute JavaScript. Value is returned from the navigator.javaEnabled property.
-- ColorDepthbrowserColorDepthstringValue representing the bit depth of the color palette for displaying images, in bits per pixel. Obtained from Cardholder browser using the screen.colorDepth property.
-- ScreenHeightbrowserScreenHeightstringTotal height of the Cardholder’s screen in pixels. Value is returned from the screen.height property.
-- ScreenWidthbrowserScreenWidthstringTotal width of the cardholder’s screen in pixels. Value is returned from the screen.width property.
-- TimeZonebrowserTZstringTime difference–zone offset in minutes between UTC time and the Cardholder browser local time, in minutes.
-- LanguagebrowserLanguagestringValue representing the browser language as defined in IETF BCP47. Returned from navigator.language property.
-- UserAgentbrowserUserAgentstringExact content of the HTTP user–agent header.
-- IpAddressbrowserIPstringIP address of the browser as returned by the HTTP headers to the 3DS Requestor.
MerchantDetailsMerchantDetails - Object
-- NamemerchantNamestringMerchant name assigned by the Acquirer or Payment System.
-- CategoryCodemccstringDS–specific code describing the Merchant’s type of business, product or service.
-- CountryCodemerchantCountryCodestringCountry Code of the Merchant. This value correlates to the Merchant Country Code as defined by each Payment System or DS.

3 characters
ISO 3166–1 numeric three–digit country code
-- AcquirerMerchantIdacquirerMerchantIDstringAcquirer–assigned Merchant identifier. This may be the same value that is used in authorization requests sent on behalf of the 3DS Requestor and is represented in ISO 8583 formatting requirements.
-- RiskIndicatormerchantRiskIndicatorObjectMerchant’s assessment of the level of fraud risk for the specific authentication for both the cardholder and the authentication being conducted.
---- DeliveryEmailAddressdeliveryEmailAddressstringFor Electronic delivery, the email address to which the merchandise was delivered.
---- DeliveryTimeframedeliveryTimeframestringIndicates the merchandise delivery timeframe.

1 = Electronic Delivery
2 = Same day shipping
3 = Overnight shipping
4 = Two–day or more shipping
---- GiftCardAmountgiftCardAmountstringFor prepaid or gift card purchase, the purchase amount total of prepaid or gift card(s) in major units (for example, USD 123.45 is 123). Example: gift card amount is USD 123.45:
Values accepted:
123
0123
00123
---- GiftCardCountgiftCardCountstringFor prepaid or gift card purchase, total count of individual prepaid or gift cards/codes purchased.
---- GiftCardCurrencygiftCardCurrencystringFor prepaid or gift card purchase, ISO 4217 three–digit currency code of the gift card
---- PreOrderDatepreOrderDatestringFor a pre–ordered purchase, the expected date that the merchandise will be available.

Format accepted: Date format = YYYYMMDD
---- PreOrderPurchaseIndicatorpreOrderPurchaseIndstringIndicates whether Cardholder is placing an order for merchandise with a future availability or release date.

Values accepted:
1 = Merchandise available
2 = Future availability
---- ReOrderItemsIndicatorreorderItemsIndstringIndicates whether the cardholder is reordering previously purchased merchandise.

1 = First time ordered
2 = Reordered
---- ShippingIndicatorshipIndicatorstringIndicates shipping method chosen for the transaction. Merchants must choose the Shipping Indicator code that most accurately describes the cardholder’s specific transaction, not their general business. If one or more items are included in the sale, use the Shipping Indicator code for the physical goods, or if all digital goods, use the Shipping Indicator code that describes the most expensive item.
AccountInfoacctInfoObjectAdditional information about the account optionally provided by the 3DS Requestor.
-- AccountAgeIndicatorchAccAgeIndstringLength of time that the cardholder has had the account with the 3DS Requestor.

Values accepted:
01 = No account (guest check–out)
02 = Created during this transaction
03 = Less than 30 days
04 = 30−60 days
05 = More than 60 days
-- AccountChangechAccChangestringDate that the cardholder’s account with the 3DS Requestor was last changed, including Billing or Shipping address, new payment account, or new user(s) added.

Date format = YYYYMMDD
-- AccountChangeIndicatorchAccChangeIndstringLength of time since the cardholder’s account information with the 3DS Requestor was last changed, including Billing or Shipping address, new payment account, or new user(s) added.

Values accepted:
01 = Changed during this transaction
02 = Less than 30 days
03 = 30−60 days
04 = More than 60 days
-- AccountDatechAccDatestringDate that the cardholder opened the account with the 3DS Requestor.
-- PasswordChangechAccPWChangestringDate that cardholder’s account with the 3DS Requestor had a password change or account reset.

Date format = YYYYMMDD
-- PasswordChangeIndicatorchAccPWChangeIndstringIndicates the length of time since the cardholder’s account with the 3DS Requestor had a password change or account reset.

Values accepted:
01 = No change
02 = Changed during this transaction
03 = Less than 30 days
04 = 30−60 days
05 = More than 60 days
-- PurchaseCountnbPurchaseAccountstringNumber of purchases with this cardholder account during the previous six months.
-- ProvisioningAttemptsPerDayprovisionAttemptsDaystringNumber of Add Card attempts in the last 24 hours.

values:
2
02
* 002
-- TransactionsPerDaytxnActivityDaystringNumber of transactions (successful and abandoned) for this cardholder account with the 3DS Requestor across all payment accounts in the previous 24 hours.

values:
2
02
* 002
-- TransactionsPerYeartxnActivityYearstringNumber of transactions (successful and abandoned) for this cardholder account with the 3DS Requestor across all payment accounts in the previous year.

values:
2
02
002
-- PaymentAccountAgepaymentAccAgestringDate that the payment account was enrolled in the cardholder’s account with the 3DS Requestor.
-- PaymentAccountAgeIndicatorpaymentAccIndstringIndicates the length of time that the payment account was enrolled in the cardholder’s account with the 3DS Requestor

Values accepted:
01 = No account (guest check–out)
02 = During this transaction
03 = Less than 30 days
04 = 30−60 days
05 = More than 60 days
-- ShippingAddressUsageshipAddressUsagestringDate when the shipping address used for this transaction was first used with the 3DS Requestor.

Date format = YYYYMMDD
-- ShippingAddressUsageIndicatorshipAddressUsageIndstringIndicates when the shipping address used for this transaction was first used with the 3DS Requestor.

1 = This transaction
2 = Less than 30 days
3 = 30−60 days
4 = More than 60 days
-- ShippingNameIndicatorshipNameIndicatorstringIndicates if the Cardholder Name on the account is identical to the shipping Name used for this transaction.

Values accepted:
01 = Account Name identical to shipping Name
02 = Account Name different than shipping Name
-- SuspiciousAccountActivitysuspiciousAccActivitystringIndicates whether the 3DS Requestor has experienced suspicious activity (including previous fraud) on the cardholder account.

Values accepted:
01 = No suspicious activity has been observed
02 = Suspicious activity has been observed
MessageExtensionmessageExtensionObjectData necessary to support requirements not otherwise defined in the 3–D Secure message are carried in a Message Extension.
-- IdidstringA unique identifier for the extension. Note: Payment System Registered Application Provider Identifier (RID) is required as prefix of the ID.
-- DatadatastringThe data carried in the extension.
-- CriticalityIndicatorcriticalityIndicatorboolA Boolean value indicating whether the recipient must understand the contents of the extension to interpret the entire message.
-- NamenamestringThe name of the extension data set as defined by the extension owner.
AccountIdacctIDstringAdditional information about the account optionally provided by the 3DS Requestor.
InstallmentPaymentDatapurchaseInstalDatastringIndicates the maximum number of authorizations permitted for installment payments.

Required if the Merchant and Cardholder have agreed to installment payments.
ChallengeIndicatorthreeDSRequestorChallengeIndstringIndicates whether a challenge is requested for this transaction.

01 = No preference
02 = No challenge requested
03 = Challenge requested: 3DS Requestor Preference
04 = Challenge requested: Mandate

The below values are applicable to version 2.2.0

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 (utilize whitelist exemption if no challenge required)
09 – Challenge requested (whitelist prompt requested if challenge required)

If this field is not provided, the expected action is that the ACS would interpret as 01 = No preference.