API Reference

On this page:

/3ds2/lookup Request: parameters description

Element
Length | Type | Required
Description
messageId
1-50 | String | Optional
Unique message identifier assigned by client.
acctNumber
String | Required
Account or card number of the card holder.
Note: Enter the acctNumber as digits without any space or special character between the digits.
threeDSMethodNotificationURL
String | Required
3DS Method Notification URL
The URL that will receive the notification of 3DS Method completion from the ACS. This is sent in the initial request (/3ds2/lookup) to the ACS from the 3DS Requestor executing the 3DS Method. Note: The default value is the 3DS Server URL. To receive a notification on a custom URL, send the custom URL as the field value.
doBinLookup
Optional
Optional feature to retrieve key characteristics of the card used in the transaction. Unless set to true, the default is false.
clientStartProtocolVersion
String | Required
The earliest (i.e. oldest) active 3DS protocol version that is supported by the client.
Valid values:
• 2.1.0
• 1.0.2 (If set to 1.0.2, the 3DS server attempts 3DS 1 fallback)
clientEndProtocolVersion
String | Required
The most recent active 3DS protocol version that is supported by the client.
Valid values:
• 2.1.0
• 1.0.2 (Set to 1.0.2 only if the client does not support 3DS 2.1.0)

/3ds2/lookup Response: parameters description

Element
Length | Type | Required
Description
messageId
1-50 | String | Optional
Message ID
Unique message identifier assigned by client.
threeDSServerTransID
36 | String | Required
3DS Server Transaction ID
Universally unique transaction identifier assigned by the 3DS Server to identify a single transaction.
Note: Use the threeDSServerTransID value you received in the /3ds2/lookup response in the /3ds2/authenticate request you send to the 3DS Server.
dsStartProtocolVersion
5-8 | String | Optional
DS Start Protocol Version.
The earliest (i.e. oldest) active protocol version that is supported by the DS.
dsEndProtocolVersion
5-8 | String | Optional
DS End Protocol Version.
The most recent active protocol version that is supported for the DS.
acsStartProtocolVersion
5-8 | String | Optional
ACS Start Protocol Version
The earliest (i.e. oldest) active protocol version that is supported by the ACS.
acsEndProtocolVersion
5-8 | String | Optional
ACS End Protocol Version
The most recent active protocol version that is supported for the ACS URL.
threeDSMethodURL
256 | String | Optional
3DS Method URL
The ACS URL that will be used by the 3DS Method
Note: The threeDSMethodURL data element may be omitted if not supported by the ACS for this specific card range.
threeDSMethodData
String | Conditional
3DS Method Data
Data elements sent in the threeDSMethodData field.
Note: The threeDSMethodURL data element may be omitted if not supported by the ACS for this specific card range.
acsInfoInd
2 | Array of string | Optional
ACS Information Indicator
The 3DS Server uses the data in this field to identify the features that the Account Range supports. It lists all applicable values for the card range.
Valid values:
• 01 = Authentication Available at ACS
• 02 = Attempts Supported by ACS or DS
• 03 = Decoupled Authentication Supported
• 04 = Whitelisting Supported
Note: The response returns the acsInfoInd field only if the user is using a VISA card.
binInfo
Optional
Bin Lookup Information
Displays additional information related to the card used in the transaction.
bin
String
Issuer bank identification number
Usually the initial four, six, or more digits that appear on a card. These numbers uniquely identify the institution issuing the card.
scheme
String
Card scheme
Displays additional information related to the card used in the transaction.
Valid values:
• American Express
• UnionPay
• Discover
• JCB
• MasterCard
• Visa
• Unknown
brand
String
Card brand
To distinguish different brands of the same card scheme.
Valid values:
• American Express
• Diners Club
• UnionPay
• Discover
• JCB
• Maestro
• MasterCard
• MasterCard Credit
• MasterCard Debit
• Visa
• Visa Debit
• Visa Credit
• Visa Electron
• Unknown
fundingSource
String
Card funding source
Valid values:
• charge
• credit
• debit
• deferredDebit
• prepaid
• unknown
issuingBank
String
Issuing bank of the card.
issuingCountry
String
Issuing country code as an ISO 3166-1 three-character alpha code.
issuingCurrency
String
Issuing country currency as an ISO 4217 three-character alpha code. The cardholder is billed in this currency.
isDebit
String
If the card is a debit card.
Valid values:
• true
• false
• unknown
isCorporate
String
Indicates the customer type of the card.
Valid values:
• true
• false
• unknown
isDccAllowed
String
If DCC (dynamic currency conversion) is allowed for the card.
Note: This parameter will only be true if the card belongs to a Visa or a MasterCard scheme.
Valid values:
• true
• false
• unknown
serverStartProtocolVersion
String
The earliest (i.e. oldest) active 3DS protocol version that is supported by the 3DS Server.
Valid values:
• 2.1.0
• 1.0.2
serverEndProtocolVersion
String
The most recent active 3DS protocol version that is supported by the 3DS Server.
Valid value:
• 2.1.0

/3ds2/authenticate Request: parameters description

Element
Length | Type | Required
Description
messageId
1-50 | String | Optional
Unique message identifier assigned by client
aReq
Object
Authentication Request Message Object
threeDSCompInd
1 | String | Optional
3DS Method Completion Indicator
Indicates whether 3DS Method completed successfully
Valid Values:
• Y - Successfully completed
• N - Did not successfully complete
• U - Unavailable. 3DS Method URL was not present in the PRes message data for the card range associated with the Cardholder Account Number.
Note: The 3DS Server auto-populates the field value from the data collected during the merchant boarding process.
addrMatch
1 | String | Optional
Address Match Indicator
Indicates whether the Cardholder Shipping Address and Cardholder Billing Address are the same.
Valid values:
• Y - Shipping Address matches Billing Address
• N - Shipping Address does not match Billing Address
cardExpiryDate
4 | String | Conditional
Card/Token Expiry Date
Expiry Date of the account number (PAN) or token supplied to the 3DS Requestor by the Cardholder.
Format: YYMM
Note: The requirements for the presence of this field are DS specific.
acctNumber
13 - 19 | String | Required
Cardholder Account Number (PAN or token)
Valid values: Format represented as per ISO 7812.
Note: Enter the acctNumber as digits without any space or special character between the digits.
billAddrCity
Max. 50 | String | Conditional
Cardholder Billing Address City
The city of the cardholder billing address associated with the card used for this purchase.
Note: Required unless market or regional mandate restricts sending this information.
billAddrCountry
3 | String | Conditional
Cardholder Billing Address Country
The country of the cardholder billing address associated with the card used for this purchase.
Valid values: ISO 3166-1 numeric three-digit country code
Note: Required unless market or regional mandate restricts sending this information.
billAddrLine1
Max. 50 | String | Conditional
Cardholder Billing Address Line 1
First line of the street address or equivalent local portion of the cardholder billing address associated with the card used for this purchase.
Note: Required unless market or regional mandate restricts sending this information.
billAddrLine2
Max. 50 | String | Conditional
Cardholder Billing Address Line 2
Second line of the street address or equivalent local portion of the cardholder billing address associated with the card used for this purchase.
Note: Required unless market or regional mandate restricts sending this information.
billAddrLine3
Max. 50 | String | Conditional
Cardholder Billing Address Line 3
Third line of the street address or equivalent local portion of the cardholder billing address associated with the card used for this purchase.
Note: Required unless market or regional mandate restricts sending this information.
billAddrPostCode
Max. 16 | String | Conditional
Cardholder Billing Address Postal Code
ZIP or other postal code of the cardholder billing address associated with the card used for this purchase.
Note: Required unless market or regional mandate restricts sending this information.
billAddrState
Max. 3 | String | Conditional
Cardholder Billing Address State
The state or province of the Cardholder billing address associated with the card used for this purchase.
Valid values: Should be the country subdivision code defined in ISO 3166-2
Note: Required unless market or regional mandate restricts sending this information.
email
Max. 254 | String | Conditional
Cardholder Email Address
The email address associated with the account that is either entered by the cardholder, or is on file with the 3DS Requestor.
Note: Required unless market or regional mandate restricts sending this information.
homePhone
Object | Conditional
Cardholder Home Phone Number
The home phone number provided by the cardholder.
Note: Required unless market or regional mandate restricts sending this information.
cc
1 - 3 | String
Country code of the phone
subscriber
Max. 15 | String
Home phone number of the subscriber
mobilePhone
Object | Conditional
Cardholder Mobile Phone Number
The mobile phone number provided by the cardholder.
Note: Required unless market or regional mandate restricts sending this information.
cc
1 - 3 | String
Country code of the phone
subscriber
Max. 15 | String
Mobile phone number of the subscriber
cardholderName
2 - 45 | String | Conditional
Name of the cardholder.
Note: Required unless market or regional mandate restricts sending this information.
shipAddrCity
Max. 50 | String | Conditional
Cardholder Shipping Address City
City portion of the shipping address requested by the cardholder.
Note: Required unless market or regional mandate restricts sending this information.
shipAddrCountry
3 | String | Conditional
Cardholder Shipping Address Country
Country of the shipping address requested by the cardholder.
Valid values: ISO 3166-1 three-digit numeric country code
Note: Required unless market or regional mandate restricts sending this information.
shipAddrLine1
Max. 50 | String | Conditional
Cardholder Shipping Address Line 1
First line of the street address or equivalent local portion of the shipping address requested by the cardholder.
Note: Required unless market or regional mandate restricts sending this information.
shipAddrLine2
Max. 50 | String | Conditional
Cardholder Shipping Address Line 2
Second line of the street address or equivalent local portion of the shipping address requested by the cardholder.
Note: Required unless market or regional mandate restricts sending this information.
shipAddrLine3
Max. 50 | String | Conditional
Cardholder Shipping Address Line 3
Third line of the street address or equivalent local portion of the shipping address requested by the cardholder.
Note: Required unless market or regional mandate restricts sending this information.
shipAddrPostCode
Max. 16 | String | Conditional
Cardholder Shipping Address Postal Code
The ZIP or other postal code of the shipping address requested by the cardholder.
Note: Required unless market or regional mandate restricts sending this information.
shipAddrState
Max. 3 | String | Conditional
Cardholder Shipping Address State
The state or province of the shipping address associated with the card being used for this purchase.
Valid values: Should be the country subdivision code defined in ISO 3166-2
Note: Required unless market or regional mandate restricts sending this information.
workPhone
Object | Conditional
Cardholder Work Phone Number
The work phone number provided by the cardholder.
Note: Required unless market or regional mandate restricts sending this information.
cc
1 - 3 | String
Country code of the phone
subscriber
Max. 15 | String
Work phone number of the subscriber
deviceChannel
2 | String | Required
Device Channel
Indicates the type of channel interface being used to initiate the transaction.
Valid values:
• 01 - App-based (iOS / Android)
• 02 - Browser-based (Direct integration to 3DS Server)
• 03 - 3DS Requestor Initiated (3RI)
browserAcceptHeader
Max. 2048 | String | Required
Browser Accept Headers
Exact content of the HTTP accept headers as sent to the 3DS Requestor from the cardholder’s browser.
Valid values: If the total length of the accept header sent by the browser exceeds 2048 characters, the 3DS Server truncates the excess portion.
browserIP
Max. 45 | String | Conditional
Browser IP Address
IP address of the browser as returned by the HTTP headers to the 3DS Requestor.
Note: Include where regionally acceptable.
browserJavaEnabled
Boolean | Required
Browser Java Enabled
Boolean that represents the ability of the cardholder browser to execute Java.
Valid values:
• true
• false
browserLanguage
1 - 8 | String | Required
Browser Language
Language set for the browser as defined in IETF BCP47.
browserColorDepth
1 - 8 | String | Required
Browser Screen Color Depth
Value representing the bit depth of the color palette for displaying images, in bits per pixel.
Valid values:
• 1 - 1 bit
• 4 - 4 bits
• 8 - 8 bits
• 15 -15 bits
• 16 -16 bits
• 24 - 24 bits
• 32 - 32 bits
• 48 - 48 bits
Note: Some OS/Browser combinations return a colorDepth value that is not accepted by the EMV 3D Secure 2.1/2.2 specifications. In such cases, we recommend that you send the closest value listed in the 'Valid values' list that is smaller than the colorDepth returned by the cardholder's browser. For example, if the Chrome browser running on a Mac OS reports a colorDepth of 30 for some screens, send the browserColorDepth value as 24 because 30 is not a valid value according to the EMVco specification.
browserScreenHeight
1 - 6 | String | Required
Browser Screen Height
Total height of the cardholder’s screen.
browserScreenWidth
1 - 6 | String | Required
Browser Screen Width
Total width of the cardholder’s screen.
browserTZ
1 - 5 | String | Required
Browser Time Zone
Time difference between UTC time and the cardholder browser local time.
Valid values: Value is returned from the getTimezoneOffset() method.
browserUserAgent
Max. 2048 | String | Required
Browser User-Agent
Exact content of the HTTP user-agent header.
Valid values: If the total length of the accept header sent by the browser exceeds 2048 characters, the 3DS Server truncates the excess portion.
messageCategory
2 | String | Required
Message Category
Identifies the authentication type used in the transaction.
Valid values:
• 01 – Payment authentication
• 02 – Non-payment authentication
Note: Non-payment authentication is supported only for requestor-initiated (3RI) flows.
purchaseAmount
Max. 48 | String | Required
Purchase Amount
Purchase amount in minor units of currency with all punctuation removed.
Example: If the purchase amount is USD 123.45, the element will contain the value as 12345.
purchaseCurrency
3 | String | Required
Purchase Currency
Currency in which purchase amount is expressed.
Valid values: ISO 4217 three-digit currency code
purchaseExponent
1 | String | Required
Purchase Currency Exponent
Minor units of currency as specified in the ISO 4217 currency exponent.
Example:
• USD - 2
• Yen - 0
purchaseDate
14 | String | Required
Purchase date and time expressed in UTC
Format: YYYYMMDDHHmmss
transType
2 | String | Conditional
Transaction Type
Identifies the type of transaction being authenticated.
Valid values:
• 01 - Goods/ Service Purchase
• 03 - Check Acceptance
• 10 - Account Funding
• 11 - Quasi-Cash Transaction
• 28 - Prepaid Activation and Load
Note: This field is required in some markets. For example, for Merchants in Brazil.
threeDSRequestorAuthenticationInd
36 | String | Required
3DS Requestor Authentication Indicator
Indicates the type of authentication request
This data element provides additional information to the ACS to determine the best approach for handing an authentication request.
Valid 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
threeDSRequestorAuthenticationInfo
Object | Optional but recommended to include
3DS Requestor Authentication Information
Information about how the 3DS Requestor authenticated the cardholder before or during the transaction.
threeDSReqAuthMethod
2 | String
3DS Requestor Authentication Method
Mechanism used by the cardholder to authenticate to the 3DS Requestor.
Valid values:
• 01 - No 3DS Requestor authentication occurred. The cardholder “logged in” as guest
• 02 - Login to the cardholder account at the 3DS Requestor system using 3DS Requestor’s own credentials
• 03 - Login to the cardholder account at the 3DS Requestor system using federated ID
• 04 - Login to the cardholder account at the 3DS Requestor system using issuer credentials
• 05 - Login to the cardholder account at the 3DS Requestor system using third-party authentication
• 06 - Login to the cardholder account at the 3DS Requestor system using FIDO Authenticator
threeDSReqAuthTimestamp
12 | String
3DS Requestor Authentication Timestamp
Date and time in UTC of the cardholder authentication.
Format: YYYYMMDDHHmm
threeDSReqAuthData
Max. 2048 | String
3DS Requestor Authentication Data
Data that documents and supports a specific authentication process.
threeDSRequestorChallengeInd
2 | String | Optional
3DS Requestor Challenge Indicator
Indicates whether a challenge is requested for this transaction.
Valid values:
• 01 - No preference
• 02 - No challenge requested
• 03 - Challenge requested: 3DS Requestor Preference
• 04 - Challenge requested: Mandate
Default value is 01.
threeDSRequestorPriorAuthenticationInfo
Object | Optional but recommended to include
3DS Requestor Prior Transaction Authentication Information
Information about how the 3DS Requestor authenticated the cardholder as part of a previous 3DS transaction.
threeDSReqPriorRef
36 | String | Optional, but recommended to include
3DS Requestor Prior Transaction Reference.
This data element provides additional information to the ACS to determine the best approach for handing a request.
Valid values: An ACS Transaction ID for a prior authenticated transaction.
threeDSReqPriorAuthMethod
2 | String
3DS Requestor Prior Transaction Authentication Method
Mechanism used by the cardholder to previously authenticate to the 3DS Requestor.
Valid values:
• 01 - Frictionless authentication occurred by ACS
• 02 - Cardholder challenge occurred by ACS
• 03 - AVS verified
• 04 - Other issuer methods
threeDSReqPriorAuthTimestamp
12 | String
3DS Requestor Authentication Timestamp
Date and time in UTC of the prior cardholder authentication.
Format: YYYYMMDDHHmm
threeDSReqPriorAuthData
Max. 2048 | String
3DS Requestor Prior Transaction Authentication Data
Data that documents and supports a specific authentication process.
acctType
2 | String | Conditional
Account Type
Indicates the type of account. For example, for a multi-account card product.
Valid values:
• 01 - Not Applicable
• 02 - Credit
• 03 - Debit
Note: Required if 3DS Requestor is asking cardholder which Account Type they are using before making the purchase.
acctInfo
Object | Optional, but recommended to include
Cardholder Account Information
Additional information about the cardholder’s account provided by the 3DS Requestor.
chAccAgeInd
2 | String
Cardholder account age indicator.
Length of time that the cardholder has had the account with the 3DS Requestor.
Valid values:
• 01 - No account (guest check-out)
• 02 - Created during this transaction
• 03 - Less than 30 days
• 04 - 30 to 60 days
• 05 - More than 60 days
chAccDate
8 | String
Cardholder account opening date
Date that the cardholder opened the account with the 3DS Requestor.
Format: YYYYMMDD
chAccChangeInd
2 | String
Cardholder account change indicator
Length 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.
Valid values:
• 01 - Changed during this transaction
• 02 - Less than 30 days
• 03 - 30 to 60 days
• 04 - More than 60 day
chAccChange
8 | String
Cardholder account change date
Date 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.
Format: YYYYMMDD
chAccPwChangeInd
2 | String
Cardholder account password change indicator
Indicates the length of time since the cardholder’s account with the 3DS Requestor had a password change or account reset.
Valid values:
• 01 - No change
• 02 - Changed during this transaction
• 03 - Less than 30 days
• 04 - 30 to 60 days
• 05 - More than 60 days
chAccPwChange
8 | String
Cardholder account password change date
Date that cardholder’s account with the 3DS Requestor had a password change or account reset.
Format: YYYYMMDD
shipAddressUsageInd
2 | String
Shipping address first usage indicator
Indicates when the shipping address used for this transaction was first used with the 3DS Requestor.
Valid values:
• 01 - This transaction
• 02 - Less than 30 days
• 03 - 30 to 60 days
• 04 - More than 60 day
shipAddressUsage
8 | String
Shipping address first usage date
Date when the shipping address used for this transaction was first used with the 3DS Requestor.
Format: YYYYMMDD
txnActivityDay
Max. 3 | String
Number of Transactions Day
Number of transactions for this cardholder in last 24 hours.
txnActivityYear
Max. 3 | String
Number of Transactions Year
Number of transactions for this cardholder in the previous 12 months.
provisionAttemptsDay
Max. 3 | String
Number of Provisioning Attempts Day
Number of Add Card attempts in last 24 hours.
nbPurchaseAccount
Max. 4 | String
Cardholder Account Purchase Count
Number of purchases with this cardholder account during the previous six months.
suspiciousAccActivity
2 | String
Suspicious Account Activity Indicator
Indicates whether the 3DS Requestor has experienced suspicious activity (including previous fraud) on the cardholder account.
Valid values:
• 01 - No suspicious activity has been observed
• 02 - Suspicious activity has been observed
shipNameIndicator
2 | String
Shipping Name Indicator
Indicates if the cardholder Name on the account is identical to the shipping Name used for this transaction.
Valid values:
• 01 - Account Name identical to shipping Name
• 02 - Account Name different than shipping name
paymentAccInd
2 | String
Payment Account Age Indicator
Indicates the length of time that the payment account was enrolled in the cardholder’s account with the 3DS Requestor.
Valid values:
• 01 - No account (guest check-out)
• 02 - During this transaction
• 03 - Less than 30 days
• 04 - 30 to 60 days
• 05 - More than 60 day
paymentAccAge
8 | String
Payment Account Age date
Date that the payment account was enrolled in the cardholder’s account with the 3DS Requestor.
Format: YYYYMMDD
acctID
Max. 64 | String | Optional
Cardholder Account Identifier
Additional information about the account optionally provided by the 3DS Requestor.
purchaseInstalData
Max. 3 | String | Conditional
Installment Payment Data
Indicates the maximum number of authorizations permitted for installment payments.
Valid values: Value shall be greater than 1
Note: Required if the Merchant and cardholder have agreed to installment payments, i.e. if 3DS Requestor Authentication Indicator = 03. Omitted if not an instalment payment authentication.
merchantRiskIndicator
Object | Optional, but recommended to include
Merchant Risk Indicator
Merchant’s assessment of the level of fraud risk for the specific authentication for both the cardholder and the authentication being conducted.
shipIndicator
2 | String
Shipping Indicator
Indicates shipping method chosen for the transaction.
Valid values:
• 01 - Ship to cardholder’s billing address
• 02 - Ship to another verified address on file with merchant
• 03 - Ship to address that is different than the cardholder’s billing address
• 04 - “Ship to Store” / Pick-up at local store (Store address shall be populated in shipping address fields)
• 05 - Digital goods (includes online services, electronic gift cards and redemption codes)
• 06 - Travel and Event tickets, not shipped
• 07 - Other (for example, Gaming, digital services not shipped, media subscriptions, etc.)
deliveryTimeframe
2 | String
Delivery Timeframe
Indicates the merchandise delivery timeframe.
Valid values:
• 01 - Electronic Delivery
• 02 - Same day shipping
• 03 - Overnight shipping
• 04 - Two-day or more shipping
deliveryEmailAddress
Max. 254 | String
Delivery Email Address
For Electronic delivery, the email address to which the merchandise was delivered.
reorderItemsInd
2 | String
Reorder Items Indicator
Indicates whether the cardholder is reordering previously purchased merchandise.
Valid values:
• 01 - First time ordered
• 02 - Reordered
preOrderPurchaseInd
2 | String
Pre-Order Purchase Indicator
Indicates whether cardholder is placing an order for merchandise with a future availability or release date.
Valid values:
• 01 - Merchandise available
• 02 - Future availability
preOrderDate
8 | String
Pre-Order Date
For a pre-ordered purchase, the expected date that the merchandise will be available.
Format: YYYYMMDD
giftCardAmount
Max. 15 | String
Gift Card Amount in major units
For prepaid or gift card purchase, the purchase amount total of prepaid or gift card(s) in major units.
Example: USD123.45 is 123
giftCardCurr
3 | String
Gift Card Currency
For prepaid or gift card purchase, the currency code of the card as defined in ISO 4217.
giftCardCount
2 | String
Gift Card Count
For prepaid or gift card purchase, total count of individual prepaid or gift cards/codes purchased.
messageExtension
Max. 81920 | Array | Conditional
Message Extension
Data necessary to support requirements not otherwise defined in the 3D Secure message are carried in a Message Extension.
Note: Conditions to be set by each DS.
name
Max. 64 | String | Required
The name of the extension data set as defined by the extension owner.
id
Max. 64 | String | Required
A unique identifier for the extension
criticalityIndicator
Boolean | Required
A Boolean value indicating whether the recipient must understand the contents of the extension to interpret the entire message.
Valid values:
• true
• false
data
Max. 8059 | Object | Required
The data carried in the extension.
recurringExpiry
8 | String | Conditional
Recurring Expiry
Date after which no further authorizations shall be performed.
Format: YYYYMMDD
Note: Required if 3DS Requestor Authentication Indicator = 02 or 03.
recurringFrequency
Max. 4| String | Conditional
Recurring Frequency
Indicates the minimum number of days between authorizations.
Note: Required if 3DS Requestor Authentication Indicator = 02 or 03.
broadInfo
4096 | Object | Conditional
Broadcast Information
Unstructured information sent between the 3DS Server, the DS and the ACS.
Note: Requirements for the presence of this field are DS specific.
message
String
Broadcast message content.
challengeParameters
Object | Optional
Challenge parameters
Object that contains the details of any challenge parameter. These parameters can affect the display of the challenge window on user's browser.
Note: This field is required only if you are integrating with the 3DS Server directly or through the Web SDK. If you do not specify a value in the request, the 3DS server will set the value of the challengeWindowSize to 05 (which means 'Full screen') in the challenge request it sends to the ACS (issuer).
challengeWindowSize
2 | String
Dimensions of the challenge window that will be displayed to the cardholder in case of a challenge. 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.
Valid values:
• 01 - 250 X 400
• 02 - 390 X 400
• 03 - 500 X 600
• 04 - 600 X 400
• 05 - Full screen
clientStartProtocolVersion
String | Required
The earliest (i.e. oldest) active 3DS protocol version that is supported by the client.
Valid values:
• 2.1.0
• 1.0.2 ( If set to 1.0.2, the server attempts 3DS 1 fallback)
clientEndProtocolVersion
String | Required
The most recent active 3DS protocol version that is supported by the client.
Valid values:
• 2.1.0
• 1.0.2 (Set to 1.0.2 when the client does not support 3DS 2.1.0)

/3ds2/authenticate Response: parameters description

Element
Length | Type | Required
Description
messageId
1-50 | String | Optional
Message ID
Unique message identifier assigned by client.
aRes
Object
Authentication Response Message
messageType
4 | String | Required
Message Type
Identifies the type of message that is passed.
Valid values:
• AReq
• ARes
• CReq
• CRes
• RReq
• RRes
• Erro
messageVersion
5 - 8 | String | Required
Message Version Number
The protocol version that will be used by all components to process the 3D Secure transaction. Set by the 3DS Server which originates the protocol with the authentication request message.
Note: Message version is always consistent across all 3D Secure protocol messages for a specific transaction
threeDSServerTransID
36 | String | Required
3DS Server Transaction ID
Universally unique transaction identifier (UUID) assigned by the 3DS Server to identify a single transaction.
Note: The field value must be the same field value you received in  the /3ds2/authenticate response.
dsTransID
36 | String | Required
DS Transaction ID
UUID assigned by the Directory Server to identify a single transaction
acsTransID
36 | String | Required
ACS Transaction ID
Universally Unique transaction identifier (UUID) assigned by the ACS to identify a single transaction.
acsReferenceNumber
Max. 32 | String | Required
ACS Reference Number.
It is the unique identifier assigned by the EMVCo Secretariat upon Testing and Approval.
acsOperatorID
Max. 32 | String | Conditional
ACS Operator ID
DS assigned ACS identifier. Each DS can provide a unique ID to each ACS on an individual basis.
Note: Requirements for the presence of this field are DS specific.
dsReferenceNumber
Max. 32 | String | Required
DS reference number.
EMVCo-assigned unique identifier to track approved DS.
transStatus
1 | String | Required
Transaction Status
Indicates whether a transaction qualifies as an authenticated transaction or account verification.
Valid values:
• Y - Authentication/ Account Verification Successful
• N - Not Authenticated/Account Not Verified; Transaction denied
• U - Authentication/ Account Verification Could Not Be Performed; Technical or other problem, as indicated in authentication request
• A - Attempts Processing Performed; Not Authenticated/Verified, but a proof of attempted authentication/verification is provided
• C - Challenge Required; Additional authentication is required using the challenge request or challenge response
• R - Authentication/ Account Verification Rejected; Issuer is rejecting authentication/verification and request that authorization not be attempted Note: If the 3DS Requestor Challenge Indicator = 06 (No challenge requested; Data share only), then a Transaction Status of C is not valid.
transStatusReason
2 | String | Conditional
Transaction Status Reason
Note: Conditional as defined by the DS. Required if transStatus is N, U, or R .
Valid values:
01 - Card authentication failed
02 - Unknown Device
03 - Unsupported Device
04 - Exceeds authentication frequency limit
05 - Expired card
06 - Invalid card number
07 - Invalid transaction
08 - No Card record
09 - Security failure
10 - Stolen card
11 - Suspected fraud
12 - Transaction not permitted to cardholder
13 - Cardholder not enrolled in service
14 - Transaction timed out at the ACS
15 - Low confidence
16 - Medium confidence
17 - High confidence
18 - Very High confidence
19 - Exceeds ACS maximum challenges
20 - Non-Payment transaction not supported
21 - 3RI transaction not supported
acsSignedContent
Object | Conditional
ACS Signed Content.
Contains the JWS object created by the ACS for the authentication response message.
Note: Required if transStatus = C.
authenticationType
2 | String | Conditional
Authentication Type
Indicates the type of authentication method the Issuer will use to challenge the cardholder, whether in the authentication response message or what was used by the ACS when in the result request message.
Valid values:
• 01 - Static
• 02 - Dynamic
• 03 - OOB
Note: Required in the authentication response message if the transStatus = C in the authentication response.
acsChallengeMandated
2 | String | Conditional
ACS Challenge Mandated Indicator
Indication of whether a challenge is required for the transaction to be authorized due to local/regional mandates or other variable.
Valid values:
• Y - Challenge is mandated
• N - Challenge is not mandated
Note: Required if transStatus = C.
acsURL
Max. 2048 | String | Conditional
ACS URL
Fully qualified URL of the ACS to be used for the challenge. For browser, 3DS Requestor will post the challenge request to this URL via the challenge window.
Note: For browser, required if transStatus = C.
eci
2 | String | Conditional
Electronic Commerce Indicator (ECI)
Payment System-specific value provided by the ACS to indicate the results of the attempt to authenticate the cardholder.
Note: The requirements for the presence of this field are DS specific.
creq
Base64 | Required
Base64 encoded challenge request message
cardHolderInfo
Max. 128 | String | Optional
Cardholder Information Text
Text provided by the ACS/Issuer to cardholder during a Frictionless transaction that was not authenticated by the ACS (transStatus is U, N, or R). The Issuer can optionally provide information to cardholder. For example, "Additional authentication is needed for this transaction, please contact (Issuer Name) at xxx-xxx-xxxx."
Note: If this field is populated, the information provided by the Issuer shall optionally be displayed to the cardholder by the merchant.
authenticationValue
28 | String | Conditional
Authentication Value
Payment System-specific value provided as part of the ACS registration for each supported DS.
Valid values: A 20-byte value that has been Base64 encoded, giving a 28-byte result.
Note: Required if transStatus = Y or A.

/3ds2/challenge_result Response: parameters description

Element
Length | Type | Required
Description
messageType
4 | String | Required
Message Type
Identifies the type of message that is passed.
Valid values:
• RReq
• Erro
messageVersion
5-8 | String | Required
Message Version Number
The protocol version that will be used by all components to process the 3D Secure transaction. Set by the 3DS Server which originates the protocol with the authentication request message.
threeDSServerTransID
36 | String | Required
3DS Server Transaction ID
Universally unique transaction identifier (UUID) assigned by the 3DS Server to identify a single transaction.
Note: The field value must be the same field value you received in /3ds2/authenticate response.
dsTransID
36 | String | Required
DS Transaction ID
Universally unique transaction identifier assigned by the DS to identify a single transaction.
acsRenderingType
Object | Required
Identifies the ACS UI Template that the ACS will first present to the consumer
acsInterface
2 | String
ACS Interface
The ACS interface that the challenge will present to the cardholder.
Valid values:
• 01 - Native UI
• 02 - HTML UI
acsUiTemplate
2 | String
ACS UI Template.
Identifies the UI Template format that the ACS first presents to the consumer.
Valid values:
• 01 - Text
• 02 - Single Select
• 03 - Multi Select
• 04 - OOB
• 05 - HTML Other (valid only for HTML UI)
Valid values for each Interface:
• Native UI: 01 – 04
• HTML UI: 01 – 05
acsTransID
36 | String | Required
ACS Transaction ID
Universally Unique transaction identifier (UUID) assigned by the ACS to identify a single transaction.
authenticationType
2 | String | Conditional
Indicates the type of authentication method the Issuer will use to challenge the Cardholder, whether in the authentication response message or what was used by the ACS when in the result request message.
Valid values:
• 01 - Static
• 02 - Dynamic
• 03 - OOB
Note: Required in the result request message if the transStatus = Y or N in the result request.
authenticationValue
28 | String | Conditional
Authentication Value
Payment System-specific value provided as part of the ACS registration for each supported DS.
Valid values: A 20-byte value that has been Base64 encoded, giving a 28-byte result.
Note: Required if transStatus = Y or A. Omitted from the result request message when sent as an abandonment notification.
eci
2 | String | Conditional
Electronic Commerce Indicator (ECI).
Payment System-specific value provided by the ACS to indicate the results of the attempt to authenticate the Cardholder.
Note: The requirements for the presence of this field are DS specific.
Example: For Visa, 05 means successful authentication, 06 means merchant attempted to authenticate the cardholder, and 07 means transaction was not authenticated.
interactionCounter
2 | String | Required
Interaction Counter
Indicates the number of authentication cycles attempted by the Cardholder.
messageCategory
2 | String | Required
Message Category
Identifies the category of the message for a specific use case.
Valid values:
• 01 - Payment Authentication (PA)
• 02 - Non Payment Authentication (NPA)
Note: The NPA is supported only for requestor-initiated flow (3RI).
transStatus
1 | String | Required
Transaction Status
Indicates whether a transaction qualifies as an authenticated transaction or account verification.
Valid values:
• Y - Authentication/ Account Verification Successful
• N - Not Authenticated /Account Not Verified; Transaction denied
Note: The final CRes message can contain only a value of Y or N.

/3ds2/validate Request: parameters description

Element
Length | Type | Required
Description
messageId
1-50 | String | Optional
Message ID
Unique message identifier assigned by client to each transaction.
cres
Base64-encoded
Challenge result
cres is the ACS response sent via an HTTP POST to the notificationURL specified in the authenticate request. It indicates the result of the authentication and is a Base64 encoded message.

/3ds2/validate Response: parameters description

Element
Length | Type | Required
Description
messageId
1-50 | String | Optional
Message ID
Unique message identifier assigned by client to each transaction.
threeDSServerTransID
36 | String | Required
3DS Server Transaction ID
Universally unique transaction identifier (UUID) assigned by the 3DS Server to identify a single transaction.
Note: The field value must be the same field value you received in /3ds2/authenticate response.
Valid
Boolean
The /validate method validates cres body sent in the request before retrieving the result data (rReq). If the cres validation fails, the valid field value will be false and error details will be returned as an error message.
Valid values:
• true
• false
rReq
Object
Result request
messageType
4 | String | Required
Message Type
Identifies the type of message that is passed.
Valid values:
• rReq
messageVersion
5 - 8 | String | Required
Message Version Number
The protocol version that will be used by all components to process the 3D Secure transaction. Set by the 3DS Server which originates the protocol with the authentication request message.
threeDSServerTransID
36 | String | Required
3DS Server Transaction ID
Universally unique transaction identifier (UUID) assigned by the 3DS Server to identify a single transaction.
dsTransID
36 | String | Required
DS Transaction ID
UUID assigned by the Directory Server to identify a single transaction.
acsRenderingType
Object | Conditional
Contains information about the rendering type that the ACS is sending for the cardholder authentication.
acsInterface
2 | String
ACS Interface
The ACS interface that the challenge will present to the cardholder.
Valid values:
• 01 - Native UI
• 02 - HTML UI
acsUiTemplate
2 | String
ACS UI Template
Identifies the UI Template format that the ACS first presents to the consumer.
Valid values:
• 01 - Text
• 02 - Single Select
• 03 - Multi Select
• 04 - OOB
• 05 - HTML Other (valid only for HTML UI)
Valid values for each Interface:
• 01 - 04 - Native UI
• 01 - 05 - HTML UI
acsTransID
36 | String | Required
ACS Transaction ID
Universally Unique transaction identifier (UUID) assigned by the ACS to identify a single transaction.
authenticationType
2 | String | Conditional
Authentication Type
Indicates the type of authentication method the Issuer will use to challenge the Cardholder, whether in the authentication response message or what was used by the ACS when in the result request message.
Valid values:
• 01 - Static
• 02 - Dynamic
• 03 - OOB
authenticationValue
28 | String | Conditional
Authentication Value
Payment System-specific value provided as part of the ACS registration for each supported DS.
Valid values: A 20-byte value that has been Base64 encoded, giving a 28-byte result.
Note: Required if transStatus = Y or A.
eci
2 | String | Conditional
Electronic Commerce Indicator (ECI)
Payment System-specific value provided by the ACS to indicate the results of the attempt to authenticate the Cardholder.
Note: The requirements for the presence of this field are DS specific.
Example: For Visa, 05 means successful authentication, 06 means merchant attempted to authenticate the cardholder, and 07 means transaction was not authenticated.
interactionCounter
2 | String | Required
Interaction CounterAuthentication Value
Indicates the number of authentication cycles attempted by the Cardholder.
messageCategory
2 | String | Required
Message Category
Identifies the category of the message for a specific use case.
Valid values:
• 01 - Payment Authentication (PA)
• 02 - Non Payment Authentication (NPA)
Note: The NPA value is supported only for requestor-initiated flow (3RI).
transStatus
1 | String | Required
Transaction Status
Indicates whether a transaction qualifies as an authenticated transaction or account verification.
Valid values:
• Y - Authentication/ Account Verification Successful
• N - Not Authenticated /Account Not Verified; Transaction denied
Note: The final CRes message can contain only a value of Y or N.

3RI - /3ds2/authenticate Request: parameters description

Element
Length | Type | Required
Description
deviceChannel
2 | String | Required
Device Channel
Identifies the inclusion of a data element in a message based on the Device Channel used for a specific transaction.
Valid value for a 3RI transaction: 03
messageCategory
2 | String | Required
Message Category
Identifies the inclusion of a data element in a Message based on the type of transaction.
Valid value for a 3RI transaction: 02
threeRIInd
2 | String | Required
3RI Indicator
Indicates the type of 3RI request. This field value provides additional information to the ACS to determine the best approach for handing a 3RI request.
Valid values:
• 01 - Recurring transaction
• 02 - Installment transaction
• 03 - Add card
• 04 - Maintain card information
• 05 - Account verification
acctNumber
13 - 19 | String | Required
Cardholder Account Number (PAN or token)
Valid values: Format represented as per ISO 7812.
Note: Enter the acctNumber as digits without any space or special character between the digits.
acctType
2 | String | Conditional
Account Type
Indicates the type of account. For example, for a multi-account card product.
Valid values:
• 01 - Not Applicable
• 02 - Credit
• 03 - Debit
Note: Required if 3DS Requestor is asking Cardholder which Account Type (acctType) they are using before making the purchase.
acctInfo
Object | Optional
Cardholder Account Information
Additional information about the Cardholder’s account provided by the 3DS Requestor.
chAccAgeInd
2 | String
Cardholder account age indicator.
Length of time that the cardholder has had the account with the 3DS Requestor.
Valid values:
• 01 - No account (guest check-out)
• 02 - Created during this transaction
• 03 - Less than 30 days
• 04 - 30 to 60 days
• 05 - More than 60 days
chAccDate
8 | String
Cardholder account opening date
Date that the cardholder opened the account with the 3DS Requestor.
Format: YYYYMMDD
chAccChangeInd
2 | String
Cardholder account change indicator
Length 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.
Valid values:
• 01 - Changed during this transaction
• 02 - Less than 30 days
• 03 - 30 to 60 days
• 04 - More than 60 day
chAccChange
8 | String
Cardholder account change date
Date 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.
Format: YYYYMMDD
chAccPwChangeInd
2 | String
Cardholder account password change indicator
Indicates the length of time since the cardholder’s account with the 3DS Requestor had a password change or account reset.
Valid values:
• 01 - No change
• 02 - Changed during this transaction
• 03 - Less than 30 days
• 04 - 30 to 60 days
• 05 - More than 60 days
ChAccPwChange
8 | String
Cardholder account password change date
Date that cardholder’s account with the 3DS Requestor had a password change or account reset.
Format: YYYYMMDD
shipAddressUsageInd
2 | String
Shipping address first usage indicator
Indicates when the shipping address used for this transaction was first used with the 3DS Requestor.
Valid values:
• 01 - This transaction
• 02 - Less than 30 days
• 03 - 30 to 60 days
• 04 - More than 60 day
shipAddressUsage
8 | String
Shipping address first usage date
Date when the shipping address used for this transaction was first used with the 3DS Requestor.
Format: YYYYMMDD
txnActivityDay
Max. 3 | String
Number of Transactions Day
Number of transactions for this cardholder in last 24 hours.
txnActivityYear
Max. 3 | String
Number of Transactions Year
Number of transactions for this cardholder in the previous 12 months.
provisionAttemptsDay
Max. 3 | String
Number of Provisioning Attempts Day
Number of Add Card attempts in last 24 hours.
nbPurchaseAccount
Max. 4 | String
Cardholder Account Purchase Count
Number of purchases with this cardholder account during the previous six months.
suspiciousAccActivity
2 | String
Suspicious Account Activity Indicator
Indicates whether the 3DS Requestor has experienced suspicious activity (including previous fraud) on the cardholder account.
Valid values:
• 01 - No suspicious activity has been observed
• 02 - Suspicious activity has been observed
shipNameIndicator
2 | String
Shipping Name Indicator
Indicates if the Cardholder Name on the account is identical to the shipping Name used for this transaction.
Valid values:
• 01 - Account Name identical to shipping Name
• 02 - Account Name different than shipping name
paymentAccInd
2 | String
Payment Account Age Indicator
Indicates the length of time that the payment account was enrolled in the cardholder’s account with the 3DS Requestor.
Valid values:
• 01 - No account (guest check-out)
• 02 - During this transaction
• 03 - Less than 30 days
• 04 - 30 to 60 days
• 05 - More than 60 day
paymentAccAge
8 | String
Payment Account Age Date
Date that the payment account was enrolled in the cardholder’s account with the 3DS Requestor.
Format: YYYYMMDD
acctID
Max. 64 | String | Optional
Cardholder Account Identifier
Additional information about the account optionally provided by the 3DS Requestor.
merchantRiskIndicator
Object | Optional
Merchant Risk Indicator
Merchant’s assessment of the level of fraud risk for the specific authentication for both the cardholder and the authentication being conducted.
shipIndicator
2 | String
Shipping Indicator
Indicates shipping method chosen for the transaction.
Valid values:
• 01 - Ship to cardholder’s billing address
• 02 - Ship to another verified address on file with merchant
• 03 - Ship to address that is different than the cardholder’s billing address
• 04 - “Ship to Store” / Pick-up at local store (Store address shall be populated in shipping address fields)
• 05 - Digital goods (includes online services, electronic gift cards and redemption codes)
• 06 - Travel and Event tickets, not shipped
• 07 - Other (for example, Gaming, digital services not shipped, media subscriptions, etc.)
deliveryTimeframe
2 | String
Delivery Timeframe
Indicates the merchandise delivery timeframe.
Valid values:
• 01 - Electronic Delivery
• 02 - Same day shipping
• 03 - Overnight shipping
• 04 - Two-day or more shipping
deliveryEmailAddress
Max. 254 | String
Delivery Email Address
For Electronic delivery, the email address to which the merchandise was delivered.
reorderItemsInd
2 | String
Reorder Items Indicator
Indicates whether the cardholder is reordering previously purchased merchandise.
Valid values:
• 01 - First time ordered
• 02 - Reordered
preOrderPurchaseInd
2 | String
Pre-Order Purchase Indicator
Indicates whether Cardholder is placing an order for merchandise with a future availability or release date.
Valid values:
• 01 - Merchandise available
• 02 - Future availability
preOrderDate
8 | String
Pre-Order Date
For a pre-ordered purchase, the expected date that the merchandise will be available.
Format: YYYYMMDD
giftCardAmount
Max. 15 | String
Gift Card Amount in major units
For prepaid or gift card purchase, the purchase amount total of prepaid or gift card(s) in major units.
Example: USD123.45 is 123
giftCardCurr
3 | String
Gift Card Currency
For prepaid or gift card purchase, the currency code of the card as defined in ISO 4217.
giftCardCount
2 | String
Gift Card Count
For prepaid or gift card purchase, total count of individual prepaid or gift cards/codes purchased.
cardExpiryDate
4 | String | Conditional
Card/Token Expiry Date
Expiry Date of the card number (PAN or token) supplied to the 3DS Requestor by the Cardholder.
Format: YYMM
Note: The requirements for the presence of this field are DS specific.
cardholderName
2 - 45 | String | Conditional
Name of the Cardholder.
Note: Required unless market or regional mandate restricts sending this information.
billAddrLine1
Max. 50 | String | Conditional
Cardholder Billing Address Line 1
First line of the street address or equivalent local portion of the Cardholder billing address associated with the card used for this purchase.
Note: Required unless market or regional mandate restricts sending this information.
billAddrLine2
Max. 50 | String | Conditional
Cardholder Billing Address Line 2
Second line of the street address or equivalent local portion of the Cardholder billing address associated with the card used for this purchase.
Note: Required unless market or regional mandate restricts sending this information.
billAddrLine3
Max. 50 | String | Conditional
Cardholder Billing Address Line 3
Third line of the street address or equivalent local portion of the Cardholder billing address associated with the card used for this purchase.
Note: Required unless market or regional mandate restricts sending this information.
billAddrPostCode
Max. 16 | String | Conditional
Cardholder Billing Address Postal Code
ZIP or other postal code of the Cardholder billing address associated with the card used for this purchase.
Note: Required unless market or regional mandate restricts sending this information.
billAddrState
Max. 3 | String | Conditional
Cardholder Billing Address State
The state or province of the Cardholder billing address associated with the card used for this purchase.
Valid values: Should be the country subdivision code defined in ISO 3166-2.
Note: Required unless market or regional mandate restricts sending this information.
billAddrCity
Max. 50 | String | Conditional
Cardholder Billing Address City
The city of the Cardholder billing address associated with the card used for this purchase.
Note: Required unless market or regional mandate restricts sending this information.
billAddrCountry
3 | String | Conditional
Cardholder Billing Address Country
The country of the Cardholder billing address associated with the card used for this purchase.
Valid values: ISO 3166-1 numeric three-digit country code
Note: Required unless market or regional mandate restricts sending this information.
homePhone
Object | Conditional
Cardholder Home Phone Number
The home phone number provided by the Cardholder.
Note: Required unless market or regional mandate restricts sending this information.
cc
1 - 3 | String
Country code of the phone.
subscriber
Max. 15 | String
Home phone number of the subscriber.
mobilePhone
Object | Conditional
Cardholder Mobile Phone Number
The mobile phone number provided by the Cardholder.
Note: Required unless market or regional mandate restricts sending this information.
cc
1 - 3 | String
Country code of the phone.
subscriber
Max. 15 | String
Mobile phone number of the subscriber.
workPhone
Object | Conditional
Cardholder Work Phone Number
The work phone number provided by the Cardholder.
Note: Required unless market or regional mandate restricts sending this information.
cc
1 - 3 | String
Country code of the phone.
subscriber
Max. 15 | String
Work phone number of the subscriber.
shipAddrLine1
Max. 50 | String | Conditional
Cardholder Shipping Address Line 1
First line of the street address or equivalent local portion of the shipping address requested by the Cardholder.
Note: Required unless market or regional mandate restricts sending this information.
shipAddrLine2
Max. 50 | String | Conditional
Cardholder Shipping Address Line 2
Second line of the street address or equivalent local portion of the shipping address requested by the Cardholder.
Note: Required unless market or regional mandate restricts sending this information.
shipAddrLine3
Max. 50 | String | Conditional
Cardholder Shipping Address Line 3
Third line of the street address or equivalent local portion of the shipping address requested by the Cardholder.
Note: Required unless market or regional mandate restricts sending this information.
shipAddrCity
Max. 50 | String | Conditional
Cardholder Shipping Address City
City portion of the shipping address requested by the Cardholder.
Note: Required unless market or regional mandate restricts sending this information.
shipAddrCountry
3 | String | Conditional
Cardholder Shipping Address Country
Country of the shipping address requested by the Cardholder.
Valid values: ISO 3166-1 three-digit numeric country code
Note: Required unless market or regional mandate restricts sending this information.
shipAddrPostCode
Max. 16 | String | Conditional
Cardholder Shipping Address Postal Code
The ZIP or other postal code of the shipping address requested by the Cardholder.
Note: Required unless market or regional mandate restricts sending this information.
shipAddrState
Max. 3 | String | Conditional
Cardholder Shipping Address State
The state or province of the shipping address associated with the card being used for this purchase.
Valid values: Should be the country subdivision code defined in ISO 3166-2.
Note: Required unless market or regional mandate restricts sending this information.
email
Max. 254 | String | Conditional
Cardholder Email Address
The email address associated with the account that is either entered by the Cardholder, or is on file with the 3DS Requestor.
Note: Required unless market or regional mandate restricts sending this information.
clientStartProtocolVersion
String | Required
Client start protocol version
The earliest (i.e. oldest) active 3DS protocol version that is supported by the client.
Valid value:
• 2.1.0 Note: The 3DS Server will return an error message if you set the value to 1.0.2 to enable 3DS 1 fallback. It is not a supported scenario for 3RI transactions.
clientEndProtocolVersion
String | Required
Client end protocol version
The most recent active 3DS protocol version that is supported by the client.
Valid value:
• 2.1.0 Note: The 3DS Server will return an error message if you set the value to 1.0.2 to enable 3DS 1 fallback. It is not a supported scenario for 3RI transactions.

3RI - /3ds2/authenticate Response: parameters description

Element
Length | Type | Required
Description
messageType
4 | String | Required
Message Type
Identifies the type of message that is passed.
Valid values:
• ARes
• Erro
messageVersion
5 - 8 | String | Required
Message Version Number
The protocol version that will be used by all components to process the 3D Secure transaction. Set by the 3DS Server which originates the protocol with the authentication request message.
threeDSServerTransID
36 | String | Required
3DS Server Transaction ID
Universally unique transaction identifier (UUID) assigned by the 3DS Server to identify a single transaction.
dsTransID
36 | String | Required
DS Transaction ID
UUID assigned by the Directory Server to identify a single transaction.
acsTransID
36 | String | Required
ACS Transaction ID
Universally Unique transaction identifier (UUID) assigned by the ACS to identify a single transaction.
acsReferenceNumber
Max. 32 | String | Required
ACS Reference Number.
It is the unique identifier assigned by the EMVCo Secretariat upon Testing and Approval.
acsOperatorID
Max. 32 | String | Conditional
ACS Operator ID
DS assigned ACS identifier. Each DS can provide a unique ID to each ACS on an individual basis.
Note: Requirements for the presence of this field are DS specific.
dsReferenceNumber
Max. 32 | String | Required
DS reference number.
EMVCo-assigned unique identifier to track approved DS.
transStatus
1 | String | Required
Transaction Status
Indicates whether a transaction qualifies as an authenticated transaction or account verification.
Valid values:
• Y - Authentication/ Account Verification Successful
• N - Not Authenticated /Account Not Verified; Transaction denied
• U - Authentication/ Account Verification Could Not Be Performed; Technical or other problem, as indicated in authentication request
• A - Attempts Processing Performed; Not Authenticated/Verified, but a proof of attempted authentication/verification is provided
• R - Authentication/ Account Verification Rejected; Issuer is rejecting authentication/verification and request that authorization not be attempted.
transStatusReason
2 | String | Conditional
Transaction Status Reason
Note: Conditional as defined by the DS. Required if transStatus is N, U, or R.
Valid values:
01 - Card authentication failed
02 - Unknown Device
03 - Unsupported Device
04 - Exceeds authentication frequency limit
05 - Expired card
06 - Invalid card number
07 - Invalid transaction
08 - No Card record
09 - Security failure
10 - Stolen card
11 - Suspected fraud
12 - Transaction not permitted to cardholder
13 - Cardholder not enrolled in service
14 - Transaction timed out at the ACS
15 - Low confidence
16 - Medium confidence
17 - High confidence
18 - Very High confidence
19 - Exceeds ACS maximum challenges
20 - Non-Payment transaction not supported
21 - 3RI transaction not supported
authenticationValue
28 | String | Conditional
Authentication Value
Payment System-specific value provided as part of the ACS registration for each supported DS.
Valid values: A 20-byte value that has been Base64 encoded, giving a 28-byte result.
Note: Required if transStatus = Y or A. Conditional based on DS rules.
eci
2 | String | Conditional
Electronic Commerce Indicator (ECI)
Payment System-specific value provided by the ACS to indicate the results of the attempt to authenticate the Cardholder.
Note: The requirements for the presence of this field are DS specific.
Example: For Visa card scheme, 05 means successful authentication, 06 means merchant attempted to authenticate the cardholder, and 07 means transaction was not authenticated.

Related topics