API Reference

On this page

Requests and responses for deviceChannel = 02 i.e., browser

The direct integration to the 3DS Server and the integration through the 3DS Web SDK uses deviceChannel = 02.

/3ds2/lookup Request: parameters description

Direct integration to 3DS Server: /3ds2/lookup - Sample request

Integration through the Web SDK in toolkit workflow: /3ds2/lookup - Sample request

Field Name Description Required Length Data Type
messageId Unique message identifier assigned by the client. Optional 1-50 String
acctNumber Account or card number of the cardholder.
Note: Enter the acctNumber as digits without any space or special character between the digits.
Required 13-19 String
threeDSMethodNotificationURL 3DS Method Notification URL
The URL that will receive the notification of the 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.
Optional NA String
doBinLookup Optional feature to retrieve key characteristics of the card used in the transaction. Unless set to true, the default is false. Optional NA Object
clientStartProtocolVersion The earliest (i.e., oldest) active 3DS protocol version that the client supports.
Valid values:
  • 2.1.0
  • 1.0.2 (If set to 1.0.2, the 3DS Server attempts 3DS 1 fallback)
Required NA String
clientEndProtocolVersion The most recent active 3DS protocol version that the client supports.
Valid values:
  • 2.1.0
  • 1.0.2 (Set to 1.0.2 only if the client does not support 3DS 2.1.0)
Required NA String

/3ds2/lookup Response: parameters description

Direct integration to 3DS Server: /3ds2/lookup - Sample response

Integration through the Web SDK in toolkit workflow: /3ds2/lookup - Sample response

Field Name Description Required Length Data Type
messageId Unique message identifier assigned by the client. Optional 1-50 String
threeDSServerTransID 3DS Server Transaction ID
Universally unique transaction identifier assigned by the 3DS Server to identify a single transaction.
Note: In the /3ds2/authenticate request, use the threeDSServerTransID value you received in the /3ds2/lookup response.
Required 36 String
dsStartProtocolVersion DS Start Protocol Version.
The earliest (i.e., oldest) active protocol version that the DS supports.
Optional 5-8 String
dsEndProtocolVersion DS End Protocol Version.
The most recent active protocol version that the DS supports.
Optional 5-8 String
acsStartProtocolVersion ACS Start Protocol Version
The earliest (i.e., oldest) active protocol version that the ACS supports.
Optional 5-8 String
acsEndProtocolVersion ACS End Protocol Version
The most recent active protocol version that the ACS URL supports.
Optional 5-8 String
threeDSMethodURL 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.
Optional 256 String
threeDSMethodData 3DS Method Data
Data elements sent in the threeDSMethodData field.
Note: The threeDSMethodData data element may be omitted if not supported by the ACS for this specific card range.
Conditional NA String
acsInfoInd 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.
Note: The response returns the acsInfoInd field only for card schemes that support 3D Secure 2.2.0 for card ranges cache. At present, this field is returned only if the user is using a VISA card.
Valid values:
  • 01 = Authentication Available at ACS
  • 02 = Attempts Supported by ACS or DS
  • 03 = Decoupled Authentication Supported
  • 04 = Whitelisting Supported
Optional 2 Array of string
binInfo Bin Lookup Information
Displays additional information related to the card used in the transaction.
Optional NA Object
bin 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.
Optional NA String
scheme Card scheme
Displays additional information related to the card used in the transaction.
Valid values:
  • American Express
  • UnionPay
  • Discover
  • JCB
  • MasterCard
  • Visa
  • Unknown
Optional NA String
brand 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
    Optional NA String
    fundingSource Card funding source
    Valid values:
    • charge
    • credit
    • debit
    • deferredDebit
    • prepaid
    • unknown
    Optional NA String
    issuingBank Issuing bank of the card. Optional NA String
    issuingCountry Issuing country code open_in_new as an ISO 3166-1 three-character alpha code. Optional NA String
    issuingCurrency Issuing country currency open_in_new as an ISO 4217 three-character alpha code. The cardholder is billed in this currency. Optional NA String
    isDebit If the card is a debit card.
    Valid values:
    • true
    • false
    • unknown
    Optional NA String
    isCorporate Indicates the customer type of the card.
    Valid values:
    • true
    • false
    • unknown
    Optional NA String
    isDccAllowed 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
    Optional NA String
    serverStartProtocolVersion The earliest (i.e., oldest) active 3DS protocol version that the 3DS Server supports.
    Valid values: 1.0.2
    Optional NA String
    serverEndProtocolVersion The most recent active 3DS protocol version that the 3DS Server supports.
    Valid values:
    • 2.1.0
    Optional NA String

    /3ds2/authenticate Request: parameters description

    Direct integration to the 3DS Server: /3ds2/authenticate - Sample request

    Integration through the Web SDK in the toolkit workflow: /3ds2/authenticate - Sample request

    Integration through the Web SDK in the all-in-one workflow: /3ds2/authenticate - Sample request

    Field Name Description Required Length Data Type
    messageId Unique message identifier assigned by the client. Optional 1-50 String
    messageVersion 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 if not specified by the requestor.
    Note: Message version is always consistent across all 3D Secure protocol messages for a specific transaction
    Valid values:
    • 2.1.0
    • 1.0.2
    The default value is 2.1.0. To force the 3DS Server to use the 3DS 1 authentication protocol, set it to 1.0.2.
    Optional 5 - 8 String
    aReq Authentication Request Message Object Required NA Object
    threeDSCompInd 3DS Method Completion Indicator
    Indicates whether the 3DS Method completed successfully
    Note: The 3DS Server auto-populates this field value based on whether the 3DS Method step (browser and device information collection) was successful or not. If the merchant did not perform the 3DS Method step, the 3DS Server will set the field to N. If the ACS does not support the 3DS Method i.e., the /lookup response does not have the threeDSMethodURL field, the 3DS Server sets this field to U. For details on how to perform the 3DS Method, see Step 3 (scenario 3) in the Direct integration to the 3DS Server topic.
    Valid values:
    • Y - Successfully completed
    • N - Did not successfully complete
    • U - Unavailable. 3DS Method URL was not present in the /lookup response for the card range associated with the Cardholder Account Number.
    Optional 1 String
    addrMatch Address Match Indicator
    Indicates whether the Cardholder Shipping Address and Cardholder Billing Address are the same.
    Valid value:
    • Y - Shipping Address matches Billing Address
    • N - Shipping Address does not match Billing Address
    Optional 1 String
    cardExpiryDate Card/Token Expiry Date
    Expiry Date of the account number (PAN) or token supplied to the 3DS Requestor by the Cardholder.
    Note: The requirements for the presence of this field are DS specific.
    Format: YYMM
    Conditional 4 String
    acctNumber Cardholder Account Number (PAN or token) Format represented as per ISO 7812.
    Note: Enter the acctNumber as digits without any space or special character between the digits.
    Required 13 - 19 String
    billAddrLine1 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: For messageCategory = 01, required unless market or regional mandate restricts sending this information. For messageCategory = 02, required (if available) unless market or regional mandate restricts sending this information.
    Conditional Max. 50 String
    billAddrLine2 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 (if available) unless market or regional mandate restricts sending this information.
    Conditional Max. 50 String
    billAddrLine3 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 (if available) unless market or regional mandate restricts sending this information.
    Conditional Max. 50 String
    billAddrPostCode Cardholder Billing Address Postal Code
    ZIP or other postal code of the cardholder billing address associated with the card used for this purchase.
    Note: For messageCategory = 01, required unless market or regional mandate restricts sending this information. For messageCategory = 02, required (if available) unless market or regional mandate restricts sending this information.
    Conditional Max. 16 String
    billAddrCity Cardholder Billing Address City
    The city of the cardholder billing address associated with the card used for this purchase.
    Note: For messageCategory = 01, required unless market or regional mandate restricts sending this information. For messageCategory = 02, required (if available) unless market or regional mandate restricts sending this information.
    Conditional Max. 50 String
    billAddrState Cardholder Billing Address State
    The state or province of the Cardholder billing address associated with the card used for this purchase.
    Note: For messageCategory = 01, required unless market or regional mandate restricts sending this information, or State is not applicable for this country. For messageCategory = 02, required (if available) unless market or regional mandate restricts sending this information, or State is not applicable for this country.
    Valid value: Should be the country subdivision code defined in ISO 3166-2 open_in_new
    Conditional Max. 3 String
    billAddrCountry Cardholder Billing Address Country
    The country of the cardholder billing address associated with the card used for this purchase.
    Note: Required if Cardholder Billing Address State is present. For messageCategory = 01, required unless market or regional mandate restricts sending this information. For messageCategory = 02, required (if available) unless market or regional mandate restricts sending this information.
    Valid value: ISO 3166-1 numeric three-digit country code open_in_new
    Conditional 3 String
    shipAddrLine1 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 (if available) unless market or regional mandate restricts sending this information.
    Conditional Max. 50 String
    shipAddrLine2 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 (if available) unless market or regional mandate restricts sending this information.
    Conditional Max. 50 String
    shipAddrLine3 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 (if available) unless market or regional mandate restricts sending this information.
    Conditional Max. 50 String
    shipAddrPostCode Cardholder Shipping Address Postal Code
    The ZIP or other postal code of the shipping address requested by the cardholder.
    Note: Required (if available) unless market or regional mandate restricts sending this information.
    Conditional Max. 16 String
    shipAddrCity Cardholder Shipping Address City
    City portion of the shipping address requested by the cardholder.
    Note: Required (if available) unless market or regional mandate restricts sending this information.
    Conditional Max. 50 String
    shipAddrState Cardholder Shipping Address State
    The state or province of the shipping address associated with the card being used for this purchase.
    Note: Required (if available) unless market or regional mandate restricts sending this information, or State is not applicable for this country.
    Valid value: Should be the country subdivision code defined in ISO 3166-2 open_in_new
    Conditional Max. 3 String
    shipAddrCountry Cardholder Shipping Address Country
    Country of the shipping address requested by the cardholder.
    Note: Required if Cardholder Shipping Address State is present. Required (if available) unless market or regional mandate restricts sending this information.
    Valid value: ISO 3166-1 three-digit numeric country code open_in_new
    Conditional 3 String
    email 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.
    Conditional Max. 254 String
    cardholderName Name of the cardholder.
    Note: Required unless market or regional mandate restricts sending this information.
    Conditional 2 - 45 String
    homePhone Cardholder Home Phone Number
    The home phone number provided by the cardholder.
    Note: Required (if available) unless market or regional mandate restricts sending this information.
    Conditional NA Object
    cc Country code of the phone Conditional 1 - 3 String
    subscriber Home phone number of the subscriber Conditional Max. 15 String
    mobilePhone Cardholder Mobile Phone Number
    The mobile phone number provided by the cardholder.
    Note: Required (if available) unless market or regional mandate restricts sending this information.
    Conditional NA Object
    cc Country code of the phone Conditional 1 - 3 String
    subscriber Mobile phone number of the subscriber Conditional Max. 15 String
    workPhone Cardholder Work Phone Number
    The work phone number provided by the cardholder.
    Note: Required (if available), unless market or regional mandate restricts sending this information.
    Conditional NA Object
    cc Country code of the phone Conditional 1 - 3 String
    subscriber Mobile phone number of the subscriber Conditional Max. 15 String
    deviceChannel Device Channel
    Indicates the type of channel interface being used to initiate the transaction.
    Valid value: 02 - Browser-based (Direct integration to 3DS Server)/ WebSDK
    Required 2 String
    browserAcceptHeader Browser Accept Headers
    Exact content of the HTTP accept headers as sent to the 3DS Requestor from the cardholder’s browser.
    If the total length of the accept header sent by the browser exceeds 2048 characters, the 3DS Server truncates the excess portion.
    Required Max. 2048 String
    browserIP Browser IP Address
    IP address of the browser as returned by the HTTP headers to the 3DS Requestor.
    Note: Include where regionally acceptable.
    Conditional Max. 45 String
    browserJavaEnabled Browser Java Enabled
    Boolean that represents the ability of the cardholder browser to execute Java.
    Valid values:
    • true
    • false
    Conditional NA Boolean
    browserLanguage Browser Language
    Language set for the browser as defined in IETF BCP47.
    Required 1 - 8 String
    browserColorDepth Browser Screen Color Depth
    Value representing the bit depth of the color palette for displaying images, in bits per pixel.
    Note:
    • Some OS/Browser combinations return a colorDepth value that is not accepted by the EMV 3D Secure 2.1 specifications. In such cases, we recommend that you send the closest value listed in the 'Valid values' column 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.

    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
    Conditional 1 - 8 String
    browserScreenHeight Browser Screen Height
    Total height of the cardholder’s screen.
    Conditional 1 - 6 String
    browserScreenWidth Browser Screen Width
    Total width of the cardholder’s screen.
    Conditional 1 - 6 String
    browserTZ Browser Time Zone
    Time-zone offset in minutes between UTC and the Cardholder browser local time. Note that the offset is positive if the local time zone is behind UTC and negative if it is ahead.
    Valid value: Value is returned from the getTimezoneOffset() method.

    Example time zone offset values in minutes:

    • If UTC -5 hours:
      • 300
      • +300
    • If UTC +5 hours:
      • -300
    Conditional 1 - 5 String
    browserUserAgent Browser User-Agent
    Exact content of the HTTP user-agent header.
    Valid value: If the total length of the accept header sent by the browser exceeds 2048 characters, the 3DS Server truncates the excess portion.
    Required Max. 2048 String
    messageCategory Message Category
    Identifies the authentication type used in the transaction.
    Valid values:
    • 01 – Payment authentication
    • 02 – Non-payment authentication
    Required 2 String
    purchaseAmount 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.
    Note: Required for messageCategory = 01. Required for messageCategory = 02 if 3DS Requestor Authentication Indicator = 02 or 03.
    Required Max. 48 String
    purchaseCurrency Purchase Currency
    Currency in which purchase amount is expressed.
    Note: Required for messageCategory = 01. Required for messageCategory = 02 if 3DS Requestor Authentication Indicator = 02 or 03.
    Valid value: ISO 4217 three-digit currency code open_in_new
    Required 3 String
    purchaseExponent Purchase Currency Exponent
    Minor units of currency as specified in the ISO 4217 currency exponent.
    Example:
    • USD - 2
    • Yen - 0
    Note: Required for messageCategory = 01. Required for messageCategory = 02 if 3DS Requestor Authentication Indicator = 02 or 03.
    Required 1 String
    purchaseDate Purchase date and time expressed in UTC
    Note: Required for messageCategory = 01. Required for messageCategory = 02 if 3DS Requestor Authentication Indicator = 02 or 03.
    Format: YYYYMMDDHHmmss
    Required 14 String
    transType Transaction Type
    Identifies the type of transaction being authenticated.
    Note: This field is required in some markets. For example, for merchants in Brazil. Otherwise, optional.
    Valid values:
    • 01 - Goods/ Service Purchase
    • 03 - Check Acceptance
    • 10 - Account Funding
    • 11 - Quasi-Cash Transaction
    • 28 - Prepaid Activation and Load
    Conditional 2 String
    threeDSRequestorAuthenticationInd 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 handling 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
    Required 36 String
    threeDSRequestorAuthenticationInfo 3DS Requestor Authentication Information
    Information about how the 3DS Requestor authenticated the cardholder before or during the transaction.
    Optional but recommended to include NA Object
    threeDSReqAuthMethod 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 a 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
    NA 2 String
    threeDSReqAuthTimestamp 3DS Requestor Authentication Timestamp
    Date and time in UTC of the cardholder authentication.
    NA 12 String
    threeDSReqAuthData 3DS Requestor Authentication Data
    Data that documents and supports a specific authentication process.
    NA Max. 20,000 String
    threeDSRequestorChallengeInd 3DS Requestor Challenge Indicator
    Indicates whether a challenge is requested for this transaction.
    Valid value:
    • 01 - No preference
    • 02 - No challenge requested
    • 03 - Challenge requested: 3DS Requestor Preference
    • 04 - Challenge requested: Mandate

    Default value is 01.

    Optional 2 String
    threeDSRequestorPriorAuthenticationInfo 3DS Requestor Prior Transaction Authentication Information
    Information about how the 3DS Requestor authenticated the cardholder as part of a previous 3DS transaction.
    Optional but recommended to include NA Object
    threeDSReqPriorRef 3DS Requestor Prior Transaction Reference.
    This data element provides additional information to the ACS to determine the best approach for handling a request.
    Valid value: An ACS Transaction ID for a prior authenticated transaction.
    Optional but recommended to include 36 String
    threeDSReqPriorAuthMethod 3DS Requestor Prior Transaction Authentication Method
    Mechanism used by the cardholder to previously authenticate to the 3DS Requestor.
    Valid value:
    • 01 - Frictionless authentication occurred by ACS
    • 02 - Cardholder challenge occurred by ACS
    • 03 - AVS verified
    • 04 - Other issuer methods
    NA 2 String
    threeDSReqPriorAuthTimestamp 3DS Requestor Authentication Timestamp
    Date and time in UTC of the prior cardholder authentication.
    Format: YYYYMMDDHHmm
    NA 12 String
    threeDSReqPriorAuthData 3DS Requestor Prior Transaction Authentication Data
    Data that documents and supports a specific authentication process.
    NA Max. 2048 String
    acctType Account Type
    Indicates the type of account. For example, for a multi-account card product.
    Note: Required if 3DS Requestor is asking cardholder which Account Type they are using before making the purchase. Required in some markets. For example, for merchants in Brazil. Otherwise, Optional.
    Valid value:
    • 01 - Not Applicable
    • 02 - Credit
    • 03 - Debit
    Conditional 2 String
    acctInfo Cardholder Account Information
    Additional information about the cardholder’s account provided by the 3DS Requestor.
    Optional but recommended to include NA Object
    chAccAgeInd Cardholder account age indicator.
    Length of time that the cardholder has had the account with the 3DS Requestor.
    Valid value:
    • 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
    NA 2 String
    mcc Merchant Category Code
    DS-specific code describing the Merchant’s type of business, product, or service. The 3DS Server populates the value of this field when it passes the authentication request to the issuer via the DS.
    Optional 4 String
    merchantCountryCode Merchant Country Code
    Country Code of the Merchant. This value correlates to the Merchant Country Code as defined by each Payment System or DS. The 3DS Server populates the value of this field when it passes the authentication request to the issuer via the DS.
    Format: ISO 3166-1 numeric three-digit country code open_in_new
    Optional 3 String
    merchantName Merchant name
    Merchant name assigned by the Acquirer or Payment System. The 3DS Server populates the value of this field when it passes the authentication request to the issuer via the DS.
    Optional Max 40 String
    chAccDate Cardholder account opening date
    Date that the cardholder opened the account with the 3DS Requestor.
    Format: YYYYMMDD
    NA 8 String
    chAccChangeInd 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 value:
    • 01 - Changed during this transaction
    • 02 - Less than 30 days
    • 03 - 30 to 60 days
    • 04 - More than 60 day
    Optional 2 String
    chAccChange 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
    NA 8 String
    chAccPwChangeInd 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 value:
    • 01 - No change
    • 02 - Changed during this transaction
    • 03 - Less than 30 days
    • 04 - 30 to 60 days
    • 05 - More than 60 days
    NA 2 String
    chAccPwChange Cardholder account password change date
    Date that cardholder’s account with the 3DS Requestor had a password change or account reset.
    Format: YYYYMMDD
    NA 8 String
    shipAddressUsageInd Shipping address first usage indicator
    Indicates when the shipping address used for this transaction was first used with the 3DS Requestor.
    Valid value:
    • 01 - This transaction
    • 02 - Less than 30 days
    • 03 - 30 to 60 days
    • 04 - More than 60 day
    NA 2 String
    shipAddressUsage Shipping address first usage date
    Date when the shipping address used for this transaction was first used with the 3DS Requestor.
    Format: YYYYMMDD
    NA 8 String
    txnActivityDay Number of Transactions Day
    Number of transactions for this cardholder in the last 24 hours.
    NA Max. 3 String
    txnActivityYear Number of Transactions Year
    Number of transactions for this cardholder in the previous 12 months.
    NA Max. 3 String
    provisionAttemptsDay Number of Provisioning Attempts Day
    Number of Add Card attempts in the last 24 hours.
    NA Max. 3 String
    nbPurchaseAccount Cardholder Account Purchase Count
    Number of purchases with this cardholder account during the previous six months.
    NA Max. 4 String
    suspiciousAccActivity Suspicious Account Activity Indicator
    Indicates whether the 3DS Requestor has experienced suspicious activity (including previous fraud) on the cardholder account.
    Valid value:
    • 01 - No suspicious activity has been observed
    • 02 - Suspicious activity has been observed
    NA 2 String
    shipNameIndicator Shipping Name Indicator
    Indicates if the cardholder Name on the account is identical to the shipping Name used for this transaction.
    Valid value:
    • 01 - Account Name identical to shipping Name
    • 02 - Account Name different than shipping Name
    NA 2 String
    paymentAccInd 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 value:
    • 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
    NA 2 String
    paymentAccAge Payment Account Age date
    Date that the payment account was enrolled in the cardholder’s account with the 3DS Requestor.
    NA 8 String
    acctID Cardholder Account Identifier
    Additional information about the account optionally provided by the 3DS Requestor.
    Format: YYYYMMDD
    Optional Max. 64 String
    purchaseInstalData Installment Payment Data
    Indicates the maximum number of authorizations permitted for installment payments.
    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.
    Valid value: Value shall be greater than 1
    Conditional Max. 3 String
    merchantRiskIndicator 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.
    Optional but recommended to include NA Object
    shipIndicator 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.)
    NA 2 String
    deliveryTimeframe 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
    NA 2 String
    deliveryEmailAddress Delivery Email Address
    For Electronic delivery, the email address to which the merchandise was delivered.
    NA Max. 254 String
    reorderItemsInd Reorder Items Indicator
    Indicates whether the cardholder is reordering previously purchased merchandise.
    Valid values:
    • 01 - First time ordered
    • 02 - Reordered
    NA 2 String
    preOrderPurchaseInd Pre-Order Purchase Indicator
    Indicates whether the cardholder is placing an order for merchandise with a future availability or release date.
    Valid values:
    • 01 - Merchandise available
    • 02 - Future availability
    NA 2 String
    preOrderDate Pre-Order Date
    For a pre-ordered purchase, the expected date that the merchandise will be available.
    Format: YYYYMMDD
    NA 8 String
    giftCardAmount Gift Card Amount in major units
    For prepaid or gift card purchases, the purchase amount total of prepaid or gift card(s) in major units.
    Example: USD123.45 is 123
    NA Max. 15 String
    giftCardCurr Gift Card Currency
    For prepaid or gift card purchases, the currency code open_in_new of the card as defined in ISO 4217.
    NA 3 String
    giftCardCount Gift Card Count
    For prepaid or gift card purchases, the total count of individual prepaid or gift cards/codes purchased.
    NA 2 String
    messageExtension 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.
    Merchants who operate in the travel industry can send additional travel-related data in the messageExtension object of the /authenticate request. For a sample of the messageExtension object and field details, see the 'Message extension elements for the travel industry' topic.
    Conditional Max. 81920 Array
    name The name of the extension data set as defined by the extension owner. Required Max. 64 String
    id A unique identifier for the messageExtension Required Max. 64 String
    criticalityIndicator A Boolean value indicating whether the recipient must understand the contents of the extension to interpret the entire message.
    Valid value:
    • true
    • false
    Required NA Boolean
    data The data carried in the extension. Required Max. 8059 Object
    recurringExpiry Recurring Expiry
    Date after which no further authorizations shall be performed.
    Note: Required if 3DS Requestor Authentication Indicator = 02 or 03.
    Format: YYYYMMDD
    Conditional 8 String
    recurringFrequency Recurring Frequency
    Indicates the minimum number of days between authorizations.
    Note: Required if 3DS Requestor Authentication Indicator = 02 or 03.
    Conditional Max. 4 String
    broadInfo 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.
    Conditional 4096 Object
    message Broadcast message content. NA NA String
    challengeParameters Challenge parameters
    Object that contains the details of any challenge parameter. These parameters can affect the display of the challenge window on the 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).
    Optional NA Object
    challengeWindowSize 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
    NA 2 String
    clientStartProtocolVersion The earliest (i.e., oldest) active 3DS protocol version that the client supports.
    Valid value:
    • 2.1.0
    • 1.0.2 (If set to 1.0.2, the 3DS Server attempts 3DS 1 fallback)
    Required NA String
    clientEndProtocolVersion The most recent active 3DS protocol version that the client supports.
    Valid value:
    • 2.1.0
    • 1.0.2 (Set to 1.0.2 only if the client does not support 3DS 2.1.0)
    Required NA String
    acquirerBIN Acquirer BIN
    Acquiring institution identification code as assigned by the DS receiving the AReq message. This value correlates to the Acquirer BIN as defined by each Payment System or DS.
    Note: For merchants who process payment with Elavon, the 3DS Server auto-populates and appends this field value in the authentication request it sends to the ACS (issuer) in addition to the data you send.
    Optional Max 11 String
    acquirerMerchantID Acquirer Merchant ID
    Acquirer-assigned Merchant identifier. This may be the same value that is used in authorisation requests sent on behalf of the 3DS Requestor and is represented in ISO 8583 formatting requirements.
    Note: For merchants who process payment with Elavon, the 3DS Server auto-populates and appends this field value in the authentication request it sends to the ACS (issuer) in addition to the data you send.
    Optional Max 35 String
    threeDSRequestorID 3DS Requestor ID
    DS assigned 3DS Requestor identifier. Each DS will provide a unique ID to each 3DS Requestor on an individual basis.
    Note: For merchants who process payment with Elavon, the 3DS Server auto-populates and appends this field value in the authentication request it sends to the ACS (issuer) in addition to the data you send.
    Optional Max 35 String
    threeDSRequestorName 3DS Requestor Name
    DS assigned 3DS Requestor name. Each DS will provide a unique name to each 3DS Requestor on an individual basis.
    Note: For merchants who process payment with Elavon, the 3DS Server auto-populates and appends this field value in the authentication request it sends to the ACS (issuer) in addition to the data you send.
    Optional Max 40 String
    threeDSRequestorURL 3DS Requestor URL
    Fully qualified URL of 3DS Requestor website or customer care site. This data element provides additional information to the receiving 3D Secure system if a problem arises and should provide contact information.
    Example: http://server.domainname.com
    Note: The 3DS Server auto-populates and appends this field value in the authentication request it sends to the ACS (issuer) in addition to the data you send.
    Valid value: A fully qualified URL
    Required Max 2048 String
    threeDSServerURL 3DS Server URL
    Fully qualified URL of the 3DS Server to which the DS will send the RReq message after the challenge has been completed.
    Example: http://server.domainname.com
    Note: The 3DS Server auto-populates and appends this field value in the authentication request it sends to the ACS (issuer) in addition to the data you send.
    Valid value: A fully qualified URL
    Required Max 2048 String
    threeDSServerOperatorID 3DS Server Operator ID
    DS assigned 3DS Server identifier. Each DS can provide a unique ID to each 3DS Server on an individual basis. The 3DS Server auto-populates and appends this field value in the authentication request it sends to the ACS (issuer) in addition to the data you send.
    Note: Requirements for the presence of this field are DS specific.
    Conditional Max 32 String
    threeDSServerRefNumber 3DS Server Reference Number
    Unique identifier assigned by the EMVCo secretariat upon testing and approval. The 3DS Server auto-populates and appends this field value in the authentication request it sends to the ACS (issuer) in addition to the data you send.
    Required Max 32 String
    messageType Message Type
    Identifies the type of message that is passed. The 3DS Server auto-populates and appends this field value in the authentication request it sends to the ACS (issuer) in addition to the data you send.
    Valid value: AReq
    Required 4 String
    threeDSServerTransID 3DS Server Transaction ID
    Universally unique transaction identifier assigned by the 3DS Server to identify a single transaction.
    Note: The 3DS Server auto-populates and appends this field value in the authentication request it sends to the ACS (issuer) in addition to the data you send. However, if you are manually entering this field value, use the threeDSServerTransID value you received in the /3ds2/lookup response.
    Required 36 String
    notificationURL Notification URL
    Fully 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.
    Note: By default, the 3DS Server receives the callbacks from the ACS. But if you want to opt-out from the default challenge callback capability and implement your own challenge response landing page, set the value of this field to a custom URL, where you can receive and monitor notifications. In such cases, you are responsible for handling notifications and continuing with the 3DS flow. In case the authentication response returns the transStatus = C, then to fetch the challenge result data from the ACS, send the /3ds2/validate request instead of the /3ds2/challenge_result request.
    Required Max 256 String

    /3ds2/authenticate Response: parameters description

    Direct integration to the 3DS Server: /3ds2/authenticate - Sample response

    Integration through the Web SDK in the toolkit workflow: /3ds2/authenticate - Sample response

    Integration through the Web SDK in the all-in-one workflow: /3ds2/authenticate - Sample response

    Field Name Description Required Length Data Type
    messageId Unique message identifier assigned by the client. Optional 1-50 String
    aRes Authentication Response Message Required NA Object
    messageType Message Type
    Identifies the type of message that is passed.
    Valid value:
    • ARes
    • Erro
    Required 4 String
    messageVersion 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 if not specified by the requestor.
    Note: Message version is always consistent across all 3D Secure protocol messages for a specific transaction
    Valid value:
    • 2.1.0
    • 1.0.2
    The default value is 2.1.0.
    Required 5 - 8 String
    threeDSServerTransID 3DS Server Transaction ID
    Universally unique transaction identifier 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/lookup response.
    Required 36 String
    dsTransID DS Transaction ID
    UUID assigned by the Directory Server to identify a single transaction.
    Required 36 String
    acsTransID ACS Transaction ID
    Universally Unique transaction identifier (UUID) assigned by the ACS to identify a single transaction.
    Required 36 String
    acsReferenceNumber ACS Reference Number
    It is the unique identifier assigned by the EMVCo Secretariat upon Testing and Approval.
    Required Max. 32 String
    acsOperatorID 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.
    Conditional Max. 32 String
    dsReferenceNumber DS reference number
    EMVCo-assigned unique identifier to track approved DS.
    Required Max. 32 String
    transStatus Transaction Status
    Indicates whether a transaction qualifies as an authenticated transaction or account verification.
    Notes:
    • transStatus = C is not valid if the authenticate request has 3DS Requestor Challenge Indicator = 06 (No challenge requested; Data share only)
    • For messageCategory = 02, conditional as defined by the DS.

    Valid value:
    • 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
    Required 1 String
    transStatusReason Transaction Status Reason
    Note: For messageCategory = 01, required if transStatus is N, U, or R. For messageCategory = 02, conditional as defined by the DS.
    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
    Conditional 2 String
    acsSignedContent ACS Signed Content.
    Contains the JWS object created by the ACS for the authentication response message.
    Note: Required if transStatus = C.
    Conditional NA Object
    authenticationType 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.
    Note: Required in the authentication response message if the transStatus = C in the authentication response.
    Valid values:
    • 01 - Static
    • 02 - Dynamic
    • 03 - OOB
    Conditional 2 String
    acsChallengeMandated ACS Challenge Mandated Indicator
    Indication of whether a challenge is required for the transaction to be authorized due to local/regional mandates or other variables.
    Note: Required if transStatus = C.
    Valid values:
    • Y - Challenge is mandated
    • N - Challenge is not mandated
    Required 2 String
    acsURL ACS URL
    Fully qualified URL of the ACS to be used for the challenge. For browser (deviceChannel = 2), 3DS Requestor will post the challenge request to this URL via the challenge window.
    Note: For browser, required if transStatus = C.
    Conditional Max. 2048 String
    eci Electronic Commerce Indicator (ECI)
    Payment System-specific value provided by the ACS or DS to indicate the results of the attempt to authenticate the Cardholder.
    Note: The requirements for the presence of this field are DS specific.
    Conditional 2 String
    creq Base64 encoded challenge request message Required NA Base64
    cardholderInfo Cardholder Information Text
    Text provided by the ACS/Issuer to Cardholder during a Frictionless (transStatus is U, N, or R) transaction. For example, “Additional authentication is needed for this transaction, please contact (Issuer Name) at xxx-xxx-xxxx.”
    Notes:
    • If this field is populated, the merchant must convey the information in this field to the cardholder.
    Conditional Max. 128 String
    authenticationValue Authentication Value
    Payment System-specific value provided by the ACS or the DS using an algorithm defined by Payment System. Authentication Value may be used to provide proof of authentication.
    Note: For messageCategory = 01, required if transStatus = Y or A. For messageCategory = 02, conditional based on DS rules.
    Valid value: A 20-byte value that has been base64 encoded, giving a 28-byte result.
    Conditional 28 String

    /3ds2/challenge_result Response: parameters description

    Direct integration to 3DS Server: /3ds2/challenge_result - Sample response

    Integration through the Web SDK in toolkit workflow: /3ds2/challenge_result - Sample response

    Field Name Description Required Length Data Type
    messageType Message Type
    Identifies the type of message that is passed.
    Valid value:
    • RReq
    • Erro
    Required 4 String
    messageVersion 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 if not specified by the requestor.
    Note: Message version is always consistent across all 3D Secure protocol messages for a specific transaction
    Valid value:
    • 2.1.0
    Required 5 - 8 String
    threeDSServerTransID 3DS Server Transaction ID
    Universally unique transaction identifier 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.
    Required 36 String
    dsTransID DS Transaction ID
    UUID assigned by the Directory Server to identify a single transaction.
    Required 36 String
    acsTransID ACS Transaction ID
    Universally Unique transaction identifier (UUID) assigned by the ACS to identify a single transaction.
    Required 36 String
    authenticationType 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.
    Note: Required in the result request message if the transStatus = Y or N in the result request.
    Valid value:
    • 01 - Static
    • 02 - Dynamic
    • 03 - OOB
    Conditional 2 String
    authenticationValue Authentication Value
    Payment System-specific value provided by the ACS or the DS using an algorithm defined by Payment System. Authentication Value may be used to provide proof of authentication.
    Note: Required if transStatus = Y or A. Omitted from the result request message when sent as an abandonment notification.
    Valid value: A 20-byte value that has been base64 encoded, giving a 28-byte result.
    Conditional 28 String
    eci Electronic Commerce Indicator (ECI)
    Payment System-specific value provided by the ACS or DS 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.
    Conditional 2 String
    interactionCounter Interaction Counter
    Indicates the number of authentication cycles attempted by the Cardholder.
    Required 2 String
    messageCategory Message Category
    Identifies the category of the message for a specific use case.
    Valid value:
    • 01 - Payment Authentication (PA)
    • 02 - Non Payment Authentication (NPA)
    Required 2 String
    transStatus Transaction Status
    Indicates whether a transaction qualifies as an authenticated transaction or account verification.
    Valid value:
    • Y - Authentication/ Account Verification Successful
    • N - Not Authenticated /Account Not Verified; Transaction denied
    Required 1 String
    challengeCancel Challenge Cancelation Indicator
    Indicator informing the ACS and the DS that the authentication has been canceled.
    Note: Required in the RReq if the ACS identifies that the authentication transaction was canceled for reasons as indicated. If Transaction Status Reason = 14, the value must be either 04 or 05.
    Valid values:
    • 01 - Cardholder selected “Cancel”
    • 04 - Transaction Timed Out at ACS—other timeouts
    • 05 - Transaction Timed Out at ACS—First CReq not received by ACS
    • 06 - Transaction Error
    • 07 - Unknown
    Conditional 2 String

    /3ds2/validate Request: parameters description

    Direct integration to 3DS Server: /3ds2/validate - Sample request

    Integration through the Web SDK in toolkit workflow: /3ds2/validate - Sample request

    Field Name Description Required Length Data Type
    messageId Unique message identifier assigned by the client. Optional 1-50 String
    cres 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.
    Required NA Base64-encoded

    /3ds2/validate Response: parameters description

    Direct integration to 3DS Server: /3ds2/validate - Sample response

    Integration through the Web SDK in toolkit workflow: /3ds2/validate - Sample response

    Field Name Description Required Length Data Type
    messageId Unique message identifier assigned by the client. Optional 1-50 String
    threeDSServerTransID 3DS Server Transaction ID
    Universally unique transaction identifier assigned by the 3DS Server to identify a single transaction.
    Note: In the /3ds2/authenticate request, use the threeDSServerTransID value you received in the /3ds2/lookup response.
    Required 36 String
    valid The /validate method validates cres body sent in the request before retrieving the result data (rReq). If the cres validation fails, the field value is false and error details are returned in an error message.
    Valid value:
    • true
    • false
    Required NA Boolean
    rReq Result request Required NA Object
    messageType Message Type
    Identifies the type of message that is passed.
    Valid value: rReq
    Required 4 String
    messageVersion 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 if not specified by the requestor.
    Note: Message version is always consistent across all 3D Secure protocol messages for a specific transaction
    Valid value:
    • 2.1.0
    Optional 5 - 8 String
    dsTransID DS Transaction ID
    UUID assigned by the Directory Server to identify a single transaction.
    Required 36 String
    acsTransID ACS Transaction ID
    Universally Unique transaction identifier (UUID) assigned by the ACS to identify a single transaction.
    Required 36 String
    authenticationType 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.
    Note: Required in the result request message if the transStatus = Y or N in the result request.
    Valid value:
    • 01 - Static
    • 02 - Dynamic
    • 03 - OOB
    Conditional 2 String
    authenticationValue Authentication Value
    Payment System-specific value provided by the ACS or the DS using an algorithm defined by Payment System. Authentication Value may be used to provide proof of authentication.
    Note: Required if transStatus = Y or A. Omitted from the result request message when sent as an abandonment notification.
    Valid value: A 20-byte value that has been base64 encoded, giving a 28-byte result.
    Conditional 28 String
    eci Electronic Commerce Indicator (ECI)
    Payment System-specific value provided by the ACS or DS 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.
    Conditional 2 String
    interactionCounter Interaction Counter
    Indicates the number of authentication cycles attempted by the Cardholder.
    Required 2 String
    messageCategory Message Category
    Identifies the category of the message for a specific use case.
    Valid value:
    • 01 - Payment Authentication (PA)
    • 02 - Non Payment Authentication (NPA)
    Required 2 String
    transStatus Transaction Status
    Indicates whether a transaction qualifies as an authenticated transaction or account verification.
    Valid value:
    • Y - Authentication/ Account Verification Successful
    • N - Not Authenticated /Account Not Verified; Transaction denied
    Required 1 String
    challengeCancel Challenge Cancelation Indicator
    Indicator informing the ACS and the DS that the authentication has been canceled.
    Note: Required in the RReq if the ACS identifies that the authentication transaction was canceled for reasons as indicated. If Transaction Status Reason = 14, the value must be either 04 or 05.
    Valid value:
    • 01 - Cardholder selected “Cancel”
    • 04 - Transaction Timed Out at ACS—other timeouts
    • 05 - Transaction Timed Out at ACS—First CReq not received by ACS
    • 06 - Transaction Error
    • 07 - Unknown
    Conditional 2 String

    Requests and responses for deviceChannel = 03 i.e., 3RI

    The requests initiated directly by the merchant's server are called Merchant initiated or 3RI. Such requests uses deviceChannel = 03.

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

    /3ds2/lookup - Sample request
    Field Name Description Required Length Data Type
    messageId Unique message identifier assigned by the client. Optional 1-50 String
    acctNumber Account or card number of the cardholder.
    Note: Enter the acctNumber as digits without any space or special character between the digits.
    Required 13-19 String
    doBinLookup Optional feature to retrieve key characteristics of the card used in the transaction. Unless set to true, the default is false. Optional NA Object
    clientStartProtocolVersion The earliest (i.e., oldest) active 3DS protocol version that the client supports.
    Valid value:
    • 2.1.0
    Required NA String
    clientEndProtocolVersion The most recent active 3DS protocol version that the client supports.
    Valid value:
    • 2.1.0
    Required NA String

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

    /3ds2/lookup - Sample request
    Field Name Description Required Length Data Type
    messageId Unique message identifier assigned by the client. Optional 1-50 String
    threeDSServerTransID 3DS Server Transaction ID
    Universally unique transaction identifier assigned by the 3DS Server to identify a single transaction.
    Note: In the /3ds2/authenticate request, use the threeDSServerTransID value you received in the /3ds2/lookup response.
    Required 36 String
    dsStartProtocolVersion DS Start Protocol Version.
    The earliest (i.e., oldest) active protocol version that the DS supports.
    Optional 5-8 String
    dsEndProtocolVersion DS End Protocol Version.
    The most recent active protocol version that the DS supports.
    Optional 5-8 String
    acsStartProtocolVersion ACS Start Protocol Version
    The earliest (i.e., oldest) active protocol version that the ACS supports.
    Optional 5-8 String
    acsEndProtocolVersion ACS End Protocol Version
    The most recent active protocol version that the ACS URL supports.
    Optional 5-8 String
    threeDSMethodURL 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.
    Ignore this field value if the subsequent /authenticate request is for a merchant-initiated i.e., a 3RI transaction.
    Optional 256 String
    threeDSMethodData 3DS Method Data
    Data elements sent in the threeDSMethodData field.
    Note: The threeDSMethodData data element may be omitted if not supported by the ACS for this specific card range.
    Ignore this field value if the subsequent /authenticate request is for a merchant-initiated i.e., a 3RI transaction.
    Conditional NA String
    acsInfoInd 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.
    Note: The response returns the acsInfoInd field only for card schemes that support 3D Secure 2.2.0 for card ranges cache. At present, this field is returned only if the user is using a VISA card.
    Valid value:
    • 01 = Authentication Available at ACS
    • 02 = Attempts Supported by ACS or DS
    • 03 = Decoupled Authentication Supported
    • 04 = Whitelisting Supported
    Optional 2 Array of string
    binInfo Bin Lookup Information
    Displays additional information related to the card used in the transaction.
    Optional NA Object
    bin 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.
    Optional NA String
    scheme Card scheme
    Displays additional information related to the card used in the transaction.
    Valid value:
    • American Express
    • UnionPay
    • Discover
    • JCB
    • MasterCard
    • Visa
    • Unknown
    Optional NA String
    brand Card brand
    To distinguish different brands of the same card scheme.
    Valid value:
    • American Express
    • Diners Club
    • UnionPay
    • Discover
    • JCB
    • Maestro
    • MasterCard
    • MasterCard Credit
    • MasterCard Debit
    • Visa
    • Visa Debit
    • Visa Credit
    • Visa Electron
    • Unknown
    Optional NA String
    fundingSource Card funding source
    Valid value:
    • charge
    • credit
    • debit
    • deferredDebit
    • prepaid
    • unknown
    Optional NA String
    issuingBank Issuing bank of the card. Optional NA String
    issuingCountry Issuing country code open_in_new as an ISO 3166-1 three-character alpha code. Optional NA String
    issuingCurrency Issuing country currency open_in_new as an ISO 4217 three-character alpha code. The cardholder is billed in this currency. Optional NA String
    isDebit If the card is a debit card.
    Valid value:
    • true
    • false
    • unknown
    Optional NA String
    isCorporate Indicates the customer type of the card.
    Valid value:
    • true
    • false
    • unknown
    Optional NA String
    isDccAllowed 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 value:
    • true
    • false
    • unknown
    Optional NA String
    serverStartProtocolVersion The earliest (i.e., oldest) active 3DS protocol version that the 3DS Server supports.
    Valid value: 1.0.2
    Optional NA String
    serverEndProtocolVersion The most recent active 3DS protocol version that the 3DS Server supports.
    Valid value:
    • 2.1.0
    Optional NA String

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

    /3ds2/authenticate - Sample request
    Field Name Description Required Length Data Type
    deviceChannel Device Channel
    Identifies the inclusion of a data element in a message based on the Device Channel used for a specific transaction.
    Valid value: 03
    Required 2 String
    messageCategory Message Category
    Identifies the authentication type used in the transaction.
    Valid value:
    • 01 – Payment authentication
    • 02 – Non-payment authentication
    Required 2 String
    threeRIInd 3RI Indicator
    Indicates the type of 3RI request. This field value provides additional information to the ACS to determine the best approach for handling a 3RI request.
    Valid value:
    • 01 - Recurring transaction
    • 02 - Installment transaction
    • 03 - Add card
    • 04 - Maintain card information
    • 05 - Account verification
    Required 2 String
    acctNumber Account or card number of the cardholder.
    Note: Enter the acctNumber as digits without any space or special character between the digits.
    Required 13-19 String
    acctType Account Type
    Indicates the type of account. For example, for a multi-account card product.
    Note: Required if 3DS Requestor is asking cardholder which Account Type they are using before making the purchase. Required in some markets. For example, for merchants in Brazil. Otherwise, Optional.
    Valid value:
    • 01 - Not Applicable
    • 02 - Credit
    • 03 - Debit
    Conditional 2 String
    acctInfo Cardholder Account Information
    Additional information about the cardholder’s account provided by the 3DS Requestor.
    Optional but recommended to include NA Object
    chAccAgeInd Cardholder account age indicator.
    Length of time that the cardholder has had the account with the 3DS Requestor.
    Valid value:
    • 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
    NA 2 String
    chAccDate Cardholder account opening date
    Date that the cardholder opened the account with the 3DS Requestor.
    Format: YYYYMMDD
    NA 8 String
    chAccChangeInd 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 value:
    • 01 - Changed during this transaction
    • 02 - Less than 30 days
    • 03 - 30 to 60 days
    • 04 - More than 60 day
    Optional 2 String
    chAccChange 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
    NA 8 String
    chAccPwChangeInd 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 value:
    • 01 - No change
    • 02 - Changed during this transaction
    • 03 - Less than 30 days
    • 04 - 30 to 60 days
    • 05 - More than 60 days
    NA 2 String
    chAccPwChange Cardholder account password change date
    Date that cardholder’s account with the 3DS Requestor had a password change or account reset.
    Format: YYYYMMDD
    NA 8 String
    shipAddressUsageInd Shipping address first usage indicator
    Indicates when the shipping address used for this transaction was first used with the 3DS Requestor.
    Valid value:
    • 01 - This transaction
    • 02 - Less than 30 days
    • 03 - 30 to 60 days
    • 04 - More than 60 day
    NA 2 String
    shipAddressUsage Shipping address first usage date
    Date when the shipping address used for this transaction was first used with the 3DS Requestor.
    Format: YYYYMMDD
    NA 8 String
    txnActivityDay Number of Transactions Day
    Number of transactions for this cardholder in the last 24 hours.
    NA Max. 3 String
    txnActivityYear Number of Transactions Year
    Number of transactions for this cardholder in the previous 12 months.
    NA Max. 3 String
    provisionAttemptsDay Number of Provisioning Attempts Day
    Number of Add Card attempts in the last 24 hours.
    NA Max. 3 String
    nbPurchaseAccount Cardholder Account Purchase Count
    Number of purchases with this cardholder account during the previous six months.
    NA Max. 4 String
    suspiciousAccActivity Suspicious Account Activity Indicator
    Indicates whether the 3DS Requestor has experienced suspicious activity (including previous fraud) on the cardholder account.
    Valid value:
    • 01 - No suspicious activity has been observed
    • 02 - Suspicious activity has been observed
    NA 2 String
    shipNameIndicator Shipping Name Indicator
    Indicates if the cardholder Name on the account is identical to the shipping Name used for this transaction.
    Valid value:
    • 01 - Account Name identical to shipping Name
    • 02 - Account Name different than shipping Name
    NA 2 String
    paymentAccInd 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 value:
    • 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
    NA 2 String
    paymentAccAge Payment Account Age date
    Date that the payment account was enrolled in the cardholder’s account with the 3DS Requestor.
    Format: YYYYMMDD
    NA 8 String
    acctID Cardholder Account Identifier
    Additional information about the account optionally provided by the 3DS Requestor.
    Optional Max. 64 String
    merchantRiskIndicator 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.
    Optional but recommended to include NA Object
    shipIndicator Shipping Indicator
    Indicates shipping method chosen for the transaction.
    Valid value:
    • 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.)
    NA 2 String
    deliveryTimeframe Delivery Timeframe
    Indicates the merchandise delivery time frame.
    Valid value:
    • 01 - Electronic Delivery
    • 02 - Same day shipping
    • 03 - Overnight shipping
    • 04 - Two-day or more shipping
    NA 2 String
    deliveryEmailAddress Delivery Email Address
    For Electronic delivery, the email address to which the merchandise was delivered.
    NA Max. 254 String
    reorderItemsInd Reorder Items Indicator
    Indicates whether the cardholder is reordering previously purchased merchandise.
    Valid value:
    • 01 - First time ordered
    • 02 - Reordered
    NA 2 String
    preOrderPurchaseInd Pre-Order Purchase Indicator
    Indicates whether the cardholder is placing an order for merchandise with a future availability or release date.
    Valid value:
    • 01 - Merchandise available
    • 02 - Future availability
    NA 2 String
    preOrderDate Pre-Order Date
    For a pre-ordered purchase, the expected date that the merchandise will be available.
    Format: YYYYMMDD
    NA 8 String
    giftCardAmount Gift Card Amount in major units
    For prepaid or gift card purchases, the purchase amount total of prepaid or gift card(s) in major units.
    Example: USD123.45 is 123
    NA Max. 15 String
    giftCardCurr Gift Card Currency
    For prepaid or gift card purchases, the currency code open_in_new of the card as defined in ISO 4217.
    NA 3 String
    giftCardCount Gift Card Count
    For prepaid or gift card purchases, the total count of individual prepaid or gift cards/codes purchased.
    NA 2 String
    cardExpiryDate Card/Token Expiry Date
    Expiry Date of the account number (PAN) or token supplied to the 3DS Requestor by the Cardholder.
    Note: The requirements for the presence of this field are DS specific.
    Format: YYMM
    Conditional 4 String
    cardholderName Name of the cardholder.
    Note: Required unless market or regional mandate restricts sending this information.
    Conditional 2 - 45 String
    email 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.
    Conditional Max. 254 String
    billAddrLine1 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: For messageCategory = 01, required unless market or regional mandate restricts sending this information. For messageCategory = 02, required (if available) unless market or regional mandate restricts sending this information.
    Conditional Max. 50 String
    billAddrLine2 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 (if available) unless market or regional mandate restricts sending this information.
    Conditional Max. 50 String
    billAddrLine3 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 (if available) unless market or regional mandate restricts sending this information.
    Conditional Max. 50 String
    billAddrCity Cardholder Billing Address City
    The city of the cardholder billing address associated with the card used for this purchase.
    Note: For messageCategory = 01, required unless market or regional mandate restricts sending this information. For messageCategory = 02, required (if available) unless market or regional mandate restricts sending this information.
    Conditional Max. 50 String
    billAddrPostCode Cardholder Billing Address Postal Code
    ZIP or other postal code of the cardholder billing address associated with the card used for this purchase.
    Note: For messageCategory = 01, required unless market or regional mandate restricts sending this information. For messageCategory = 02, required (if available) unless market or regional mandate restricts sending this information.
    Conditional Max. 16 String
    billAddrState Cardholder Billing Address State
    The state or province of the Cardholder billing address associated with the card used for this purchase.
    Note: For messageCategory = 01, required unless market or regional mandate restricts sending this information, or State is not applicable for this country. For messageCategory = 02, required (if available) unless market or regional mandate restricts sending this information, or State is not applicable for this country.
    Valid value: Should be the country subdivision code open_in_new defined in ISO 3166-2
    Conditional Max. 3 String
    billAddrCountry Cardholder Billing Address Country
    The country of the cardholder billing address associated with the card used for this purchase.
    Note: Required if Cardholder Billing Address State is present. For messageCategory = 01, required unless market or regional mandate restricts sending this information. For messageCategory = 02, required (if available) unless market or regional mandate restricts sending this information.
    Valid value: ISO 3166-1 numeric three-digit country code open_in_new
    Conditional 3 String
    shipAddrLine1 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 (if available) unless market or regional mandate restricts sending this information.
    Conditional Max. 50 String
    shipAddrLine2 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 (if available) unless market or regional mandate restricts sending this information.
    Conditional Max. 50 String
    shipAddrLine3 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 (if available) unless market or regional mandate restricts sending this information.
    Conditional Max. 50 String
    shipAddrCity Cardholder Shipping Address City
    City portion of the shipping address requested by the cardholder.
    Note: Required (if available) unless market or regional mandate restricts sending this information.
    Conditional Max. 50 String
    shipAddrPostCode Cardholder Shipping Address Postal Code
    The ZIP or other postal code of the shipping address requested by the cardholder.
    Note: Required (if available) unless market or regional mandate restricts sending this information.
    Conditional Max. 16 String
    shipAddrState Cardholder Shipping Address State
    The state or province of the shipping address associated with the card being used for this purchase.
    Note: Required (if available) unless market or regional mandate restricts sending this information, or State is not applicable for this country.
    Valid value: Should be the country subdivision code open_in_new defined in ISO 3166-2
    Conditional Max. 3 String
    shipAddrCountry Cardholder Shipping Address Country
    Country of the shipping address requested by the cardholder.
    Note: Required if Cardholder Shipping Address State is present. Required (if available) unless market or regional mandate restricts sending this information.
    Valid value: ISO 3166-1 three-digit numeric country code open_in_new
    Conditional 3 String
    homePhone Cardholder Home Phone Number
    The home phone number provided by the cardholder.
    Note: Required (if available) unless market or regional mandate restricts sending this information.
    Conditional NA Object
    cc Country code of the phone Conditional 1 - 3 String
    subscriber Home phone number of the subscriber Conditional Max. 15 String
    mobilePhone Cardholder Mobile Phone Number
    The mobile phone number provided by the cardholder.
    Note: Required (if available) unless market or regional mandate restricts sending this information.
    Conditional NA Object
    cc Country code of the phone Conditional 1 - 3 String
    subscriber Mobile phone number of the subscriber Conditional Max. 15 String
    workPhone Cardholder Work Phone Number
    The work phone number provided by the cardholder.
    Note: Required (if available), unless market or regional mandate restricts sending this information.
    Conditional NA Object
    cc Country code of the phone Conditional 1 - 3 String
    clientStartProtocolVersion The earliest (i.e., oldest) active 3DS protocol version that the client supports.
    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.
    Valid value:
    • 2.1.0
    Required NA String
    clientEndProtocolVersion The most recent active 3DS protocol version that the client supports.
    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.
    Valid value:
    • 2.1.0
    Required NA String
    threeDSRequestorURL 3DS Requestor URL
    Fully qualified URL of 3DS Requestor website or customer care site. This data element provides additional information to the receiving 3D Secure system if a problem arises and should provide contact information.
    Example: http://server.domainname.com
    Note: The 3DS Server auto-populates and appends this field value in the authentication request it sends to the ACS (issuer) in addition to the data you send.
    Valid value: A fully qualified URL
    Required Max 2048 String
    threeDSServerURL 3DS Server URL
    Fully qualified URL of the 3DS Server to which the DS will send the RReq message after the challenge has been completed.
    Example: http://server.domainname.com
    Note: The 3DS Server auto-populates and appends this field value in the authentication request it sends to the ACS (issuer) in addition to the data you send.
    Valid value: A fully qualified URL
    Required Max 2048 String
    threeDSServerOperatorID 3DS Server Operator ID
    DS assigned 3DS Server identifier. Each DS can provide a unique ID to each 3DS Server on an individual basis. The 3DS Server auto-populates and appends this field value in the authentication request it sends to the ACS (issuer) in addition to the data you send.
    Note: Requirements for the presence of this field are DS specific.
    Conditional Max 32 String
    threeDSServerRefNumber 3DS Server Reference Number
    Unique identifier assigned by the EMVCo secretariat upon testing and approval. The 3DS Server auto-populates and appends this field value in the authentication request it sends to the ACS (issuer) in addition to the data you send.
    Required Max 32 String
    threeDSRequestorID 3DS Requestor ID
    DS assigned 3DS Requestor identifier. Each DS will provide a unique ID to each 3DS Requestor on an individual basis.
    Optional Max 35 String
    threeDSRequestorName 3DS Requestor Name
    DS assigned 3DS Requestor name. Each DS will provide a unique name to each 3DS Requestor on an individual basis.
    Optional Max 40 String
    acquirerBIN Acquirer BIN
    Acquiring institution identification code as assigned by the DS receiving the AReq message. This value correlates to the Acquirer BIN as defined by each Payment System or DS.
    Optional Max 11 String
    acquirerMerchantID Acquirer Merchant ID
    Acquirer-assigned Merchant identifier. This may be the same value that is used in authorisation requests sent on behalf of the 3DS Requestor and is represented in ISO 8583 formatting requirements.
    Optional Max 35 String
    messageType Message Type
    Identifies the type of message that is passed. The 3DS Server auto-populates and appends this field value in the authentication request it sends to the ACS (issuer) in addition to the data you send.
    Valid value: AReq
    Required 4 String
    threeDSServerTransID 3DS Server Transaction ID
    Universally unique transaction identifier assigned by the 3DS Server to identify a single transaction.
    Note: The 3DS Server auto-populates and appends this field value in the authentication request it sends to the ACS (issuer) in addition to the data you send. However, if you are manually entering this field value, use the threeDSServerTransID value you received in the /3ds2/lookup response.
    Required 36 String
    messageVersion 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 if not specified by the requestor.
    Note: Message version is always consistent across all 3D Secure protocol messages for a specific transaction
    Valid value:
    • 2.1.0
    Optional 5 - 8 String

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

    /3ds2/authenticate - Sample response
    Field Name Description Required Length Data Type
    messageType Message Type
    Identifies the type of message that is passed.
    Valid value:
    • ARes
    • Erro
    Required 4 String
    messageVersion 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 if not specified by the requestor.
    Note: Message version is always consistent across all 3D Secure protocol messages for a specific transaction
    Valid value:
    • 2.1.0
    Required 5 - 8 String
    threeDSServerTransID 3DS Server Transaction ID
    Universally unique transaction identifier 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/lookup response.
    Required 36 String
    dsTransID DS Transaction ID
    UUID assigned by the Directory Server to identify a single transaction.
    Required 36 String
    acsTransID ACS Transaction ID
    Universally Unique transaction identifier (UUID) assigned by the ACS to identify a single transaction.
    Required 36 String
    acsReferenceNumber ACS Reference Number
    It is the unique identifier assigned by the EMVCo Secretariat upon Testing and Approval.
    Required Max. 32 String
    acsOperatorID 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.
    Conditional Max. 32 String
    dsReferenceNumber DS reference number
    EMVCo-assigned unique identifier to track approved DS.
    Required Max. 32 String
    transStatus Transaction Status
    Indicates whether a transaction qualifies as an authenticated transaction or account verification.
    Notes:
    • For messageCategory = 02, conditional as defined by the DS.

    Valid value:
    • 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
    Required 1 String
    transStatusReason Transaction Status Reason
    Note: For messageCategory = 01, required if transStatus is N, U, or R. For messageCategory = 02, conditional as defined by the DS.
    Valid value:
    • 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
    Conditional 2 String
    authenticationValue Authentication Value
    Payment System-specific value provided by the ACS or the DS using an algorithm defined by Payment System. Authentication Value may be used to provide proof of authentication.
    Note: For messageCategory = 01, required if transStatus = Y or A. For messageCategory = 02, conditional based on DS rules.
    Valid value: A 20-byte value that has been base64 encoded, giving a 28-byte result.
    Conditional 28 String
    eci Electronic Commerce Indicator (ECI)
    Payment System-specific value provided by the ACS or DS to indicate the results of the attempt to authenticate the Cardholder.
    Note: The requirements for the presence of this field are DS specific.
    Conditional 2 String
    cardholderInfo Cardholder Information Text
    Text provided by the ACS/Issuer to Cardholder during a Frictionless (transStatus is U, N, or R) transaction. The Issuer can provide information to cardholder. For example, “Additional authentication is needed for this transaction, please contact (Issuer Name) at xxx-xxx-xxxx.”
    Notes:
  • If this field is populated, the merchant must convey the information in this field to the cardholder.
  • Conditional Max. 128 String

    Related topics