{"title":"3D Secure 2 API reference","category":"default","creationDate":1689162960,"content":"<p>For 3D Secure 2, you include additional parameters in your payment requests that provide additional information to authenticate your shoppers. You include these parameters when you make a request to one of the following endpoints:<\/p>\n<ul>\n<li>\n <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Checkout\/latest\/post\/payments\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">\/payments<\/a>\n<\/li>\n<li>\n <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Checkout\/latest\/post\/payments\/details\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">\/payments\/details<\/a>\n<\/li>\n<li>\n <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Checkout\/latest\/post\/sessions\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">\/sessions<\/a>\n<\/li>\n<\/ul>\n<p>This page describes payload structures and objects for  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Checkout\/latest\/overview\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">Checkout API<\/a> <strong>v41<\/strong> or later. If you are using a classic integration, see\u00a0<a href=\"\/pt\/online-payments\/classic-integrations\/classic-api-integration\/3d-secure-authentication\/native-3ds2\/api-reference-3d-secure-2\">3D Secure 2 classic integration<\/a>.<\/p>\n<h3>Parameter types<\/h3>\n<p>There are various parameters you can include in your requests for 3D Secure 2 authentication. The tables on this page specify the parameters that are required, conditionally required, recommended, and optional to include in your requests.<\/p>\n<table>\n<thead>\n<tr>\n<th>Icon<\/th>\n<th>Type<\/th>\n<th>Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td><span class=\"hint--bottom\" data-hint=\"Required\" markdown=\"1\"><img style=\"width: 25px;\" alt=\"Required\" src=\"\/user\/pages\/reuse\/image-library\/01.icons\/required\/required.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/span><\/td>\n<td>Required<\/td>\n<td>Parameters that are required to complete 3D Secure 2 authentication.<\/td>\n<\/tr>\n<tr>\n<td><span class=\"hint--bottom\" data-hint=\"Conditionally required\" markdown=\"1\"><img style=\"width: 25px;\" alt=\"Conditionally required\" src=\"\/user\/pages\/reuse\/image-library\/01.icons\/conditionally-required\/conditionally-required.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/span><\/td>\n<td>Conditionally required<\/td>\n<td>Parameters that are required for particular setups, or issuers and card schemes.<\/td>\n<\/tr>\n<tr>\n<td><span class=\"hint--bottom\" data-hint=\"Recommended\" markdown=\"1\"><img style=\"width: 25px;\" alt=\"Recommended\" src=\"\/user\/pages\/reuse\/image-library\/01.icons\/recommended\/recommended.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/span><\/td>\n<td>Recommended<\/td>\n<td>Parameters that are not required to send in your requests, but including them may increase the authentication performance.<\/td>\n<\/tr>\n<tr>\n<td><\/td>\n<td>Optional<\/td>\n<td>Parameters that map to a field in the EMVCo Authentication Response (<code>Areq<\/code>), but are optional to include in your requests.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h2 id=\"3d-secure-2-additional-data-objects\">3D Secure 2 objects<\/h2>\n<p>In addition to the regular fields you provide in your payment requests, we recommend that you provide all available information to increase the likelihood of achieving a frictionless flow and a higher authorisation rate.<\/p>\n<p>Some of these objects are mandatory for some issuers and card schemes, and not providing them in your payment request can result in a failed authentication. Some fields have sub-fields where you can, or need to, provide more information.<\/p>\n<table>\n<thead>\n<tr>\n<th>Object<\/th>\n<th style=\"text-align: center;\">Required<\/th>\n<th>Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Checkout\/latest\/post\/payments#request-accountInfo\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">accountInfo<\/a><\/td>\n<td style=\"text-align: center;\"><span class=\"hint--bottom\" data-hint=\"Recommended\" markdown=\"1\"><img style=\"width: 25px;\" alt=\"Recommended\" src=\"\/user\/pages\/reuse\/image-library\/01.icons\/recommended\/recommended.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/span><\/td>\n<td>Shopper account information for 3D Secure 2. See <a href=\"#accountinfo\">the reference<\/a> to learn its sub-fields.<\/td>\n<\/tr>\n<tr>\n<td> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Checkout\/latest\/post\/payments#request-authenticationData\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">authenticationData<\/a><\/td>\n<td style=\"text-align: center;\"><span class=\"hint--bottom\" data-hint=\"Conditionally required\" markdown=\"1\"><img style=\"width: 25px;\" alt=\"Conditionally required\" src=\"\/user\/pages\/reuse\/image-library\/01.icons\/conditionally-required\/conditionally-required.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/span><\/td>\n<td><strong>Use case<\/strong>: required for certain 3D Secure 2 setups. <br> The data for the 3D secure 2 authentication. See <a href=\"#authenticationdata\">the reference<\/a> to learn its sub-fields.<\/td>\n<\/tr>\n<tr>\n<td> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Checkout\/latest\/post\/payments#request-billingAddress\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">billingAddress<\/a><\/td>\n<td style=\"text-align: center;\"><span class=\"hint--bottom\" data-hint=\"Recommended\" markdown=\"1\"><img style=\"width: 25px;\" alt=\"Recommended\" src=\"\/user\/pages\/reuse\/image-library\/01.icons\/recommended\/recommended.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/span><\/td>\n<td>The address where to send the invoice. We recommend to include it in your requests when available to improve authentication performance See <a href=\"#billingaddress\">the reference<\/a> to learn its required sub-fields.<\/td>\n<\/tr>\n<tr>\n<td> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Checkout\/latest\/post\/payments#request-browserInfo\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">browserInfo<\/a><\/td>\n<td style=\"text-align: center;\"><span class=\"hint--bottom\" data-hint=\"Required\" markdown=\"1\"><img style=\"width: 25px;\" alt=\"Required\" src=\"\/user\/pages\/reuse\/image-library\/01.icons\/required\/required.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/span><\/td>\n<td>The shopper's browser information. <br> See <a href=\"#browserinfo\">the reference<\/a> to learn its sub-fields and the requirements depending on your integration type.<\/td>\n<\/tr>\n<tr>\n<td> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Checkout\/latest\/post\/payments#request-channel\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">channel<\/a><\/td>\n<td style=\"text-align: center;\"><span class=\"hint--bottom\" data-hint=\"Required\" markdown=\"1\"><img style=\"width: 25px;\" alt=\"Required\" src=\"\/user\/pages\/reuse\/image-library\/01.icons\/required\/required.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/span><\/td>\n<td>The platform where a payment transaction takes place. Possible values: <ul><li markdown=\"1\"><strong>Web<\/strong><\/li><li markdown=\"1\"><strong>iOS<\/strong><\/li><li markdown=\"1\"><strong>Android<\/strong><\/li><\/ul><\/td>\n<\/tr>\n<tr>\n<td> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Checkout\/latest\/post\/payments#request-deliveryAddress\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">deliveryAddress<\/a><\/td>\n<td style=\"text-align: center;\"><span class=\"hint--bottom\" data-hint=\"Recommended\" markdown=\"1\"><img style=\"width: 25px;\" alt=\"Recommended\" src=\"\/user\/pages\/reuse\/image-library\/01.icons\/recommended\/recommended.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/span><\/td>\n<td>The address where the purchased goods must be delivered. Include this in your request whenever available. See <a href=\"#deliveryaddress\">the reference<\/a> to learn about its required sub-fields.<\/td>\n<\/tr>\n<tr>\n<td> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Checkout\/latest\/post\/payments#request-installments\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">installments<\/a><\/td>\n<td style=\"text-align: center;\"><\/td>\n<td>If you want to split the payment into <a href=\"\/pt\/payment-methods\/cards\/credit-card-installments\/\">installments<\/a>, include this object to specify the installment settings. See <a href=\"#installments\">the reference<\/a> to learn about its required sub-fields.<\/td>\n<\/tr>\n<tr>\n<td> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Checkout\/latest\/post\/payments#request-merchantRiskIndicator\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">merchantRiskIndicator<\/a><\/td>\n<td style=\"text-align: center;\"><span class=\"hint--bottom\" data-hint=\"Recommended\" markdown=\"1\"><img style=\"width: 25px;\" alt=\"Recommended\" src=\"\/user\/pages\/reuse\/image-library\/01.icons\/recommended\/recommended.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/span><\/td>\n<td>Additional risk fields for 3D Secure 2. Include this in your request whenever available. See <a href=\"#merchantriskindicator\">the reference<\/a> to learn about its sub-fields.<\/td>\n<\/tr>\n<tr>\n<td> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Checkout\/latest\/post\/payments#request-mpiData\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">mpiData<\/a><\/td>\n<td style=\"text-align: center;\"><span class=\"hint--bottom\" data-hint=\"Conditionally required\" markdown=\"1\"><img style=\"width: 25px;\" alt=\"Conditionally required\" src=\"\/user\/pages\/reuse\/image-library\/01.icons\/conditionally-required\/conditionally-required.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/span><\/td>\n<td><strong>Use case<\/strong>: required if you are making a request to authorize a payment using <a href=\"\/pt\/online-payments\/3d-secure\/authorize-mpidata\">third-party authentication data<\/a> from another 3D Secure 2 provider. <br> This is the authentication data produced by a merchant plug-in (MPI). See <a href=\"#mpidata\">the reference<\/a> to learn its required sub-fields.<\/td>\n<\/tr>\n<tr>\n<td> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Checkout\/latest\/post\/payments#request-origin\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">origin<\/a><\/td>\n<td style=\"text-align: center;\"><span class=\"hint--bottom\" data-hint=\"Conditionally required\" markdown=\"1\"><img style=\"width: 25px;\" alt=\"Conditionally required\" src=\"\/user\/pages\/reuse\/image-library\/01.icons\/conditionally-required\/conditionally-required.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/span><\/td>\n<td><strong>Use case<\/strong>: required for browser-based (<code>channel<\/code>: <strong>Web<\/strong>) transactions. <br> The origin URL of the page where you are rendering the Drop-in\/Component. When this field is not set, or set incorrectly, the 3D Secure 2 action can not be handled correctly. <br> <strong>Format<\/strong>: <ul><li markdown=\"1\">Maximum characters: 80<\/li><li markdown=\"1\">Do not include subdirectories and a trailing slash.<\/li><\/ul> <strong>Example<\/strong>: If you are rendering on <code>https:\/\/your-company.example.com\/checkout\/payment<\/code>, set to <code>https:\/\/your-company.example.com<\/code>.<\/td>\n<\/tr>\n<tr>\n<td> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Checkout\/latest\/post\/payments#request-paymentMethod\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">paymentMethod<\/a><\/td>\n<td style=\"text-align: center;\"><span class=\"hint--bottom\" data-hint=\"Required\" markdown=\"1\"><img style=\"width: 25px;\" alt=\"Required\" src=\"\/user\/pages\/reuse\/image-library\/01.icons\/required\/required.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/span><\/td>\n<td>The type and required details for a card payment method. See <a href=\"#paymentMethod\">the reference<\/a> to learn about its required sub-fields.<\/td>\n<\/tr>\n<tr>\n<td> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Checkout\/latest\/post\/payments#request-telephoneNumber\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">telephoneNumber<\/a><\/td>\n<td style=\"text-align: center;\"><span class=\"hint--bottom\" data-hint=\"Conditionally required\" markdown=\"1\"><img style=\"width: 25px;\" alt=\"Conditionally required\" src=\"\/user\/pages\/reuse\/image-library\/01.icons\/conditionally-required\/conditionally-required.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/span><\/td>\n<td><strong>Use case<\/strong>: required for Visa and JCB transactions if you did not include the <code>shopperEmail<\/code> field. <br>The shopper's phone number. To be more specific, you can use the <code>mobilePhone<\/code>, <code>homePhone<\/code>, and <code>workPhone<\/code> fields in the <code>threeDS2RequestData<\/code> object. <br> <strong>Format<\/strong>: The phone number must include a plus sign (+) and a country code (1-3 digits), followed by the number (4-15 digits). <br>  <strong>Example<\/strong>: <strong>+4912345678901<\/strong> <div class=\"sc-notice note\"><div> If the value you provide does not follow the guidelines, we drop the value and do not submit it for authentication. <\/div><\/div><\/td>\n<\/tr>\n<tr>\n<td> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Checkout\/latest\/post\/payments#request-returnUrl\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">returnUrl<\/a><\/td>\n<td style=\"text-align: center;\"><span class=\"hint--bottom\" data-hint=\"Required\" markdown=\"1\"><img style=\"width: 25px;\" alt=\"Required\" src=\"\/user\/pages\/reuse\/image-library\/01.icons\/required\/required.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/span><\/td>\n<td>The URL where the shopper is redirected back to after completing authentication to support cases where the payment is routed to the <a href=\"\/pt\/online-payments\/3d-secure\/redirect-3ds2\/\">3D Secure 2 redirect flow<\/a>. See our <a href=\"\/pt\/online-payments\/3d-secure\/native-3ds2\">integration guides<\/a> to learn how to set this URL depending on your platform.<\/td>\n<\/tr>\n<tr>\n<td> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Checkout\/latest\/post\/payments#request-additionalData-listOfValues-scaExemption\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">scaExemption<\/a><\/td>\n<td style=\"text-align: center;\"><span class=\"hint--bottom\" data-hint=\"Conditionally required\" markdown=\"1\"><img style=\"width: 25px;\" alt=\"Conditionally required\" src=\"\/user\/pages\/reuse\/image-library\/01.icons\/conditionally-required\/conditionally-required.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/span><\/td>\n<td><strong>Use case<\/strong>: required if you want to request exemptions through the API request, or when making a Cartes Bancaires transaction. We do not recommend to use this field, because it overrides our exemption logic. <br> The <a href=\"\/pt\/online-payments\/psd2-sca-compliance-and-implementation-guide\/sca-options#apply-exemption\">exemption type<\/a> that you want to request for the particular transaction.  Possible values:<ul><li markdown=\"1\"><strong>lowValue<\/strong><\/li><li markdown=\"1\"><strong>secureCorporate<\/strong><\/li> <li markdown=\"1\"><strong>trustedBeneficiary<\/strong><\/li><li markdown=\"1\"><strong>transactionRiskAnalysis<\/strong><\/li><\/ul><\/td>\n<\/tr>\n<tr>\n<td> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Checkout\/latest\/post\/payments#request-shopperEmail\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">shopperEmail<\/a><\/td>\n<td style=\"text-align: center;\"><span class=\"hint--bottom\" data-hint=\"Conditionally required\" markdown=\"1\"><img style=\"width: 25px;\" alt=\"Conditionally required\" src=\"\/user\/pages\/reuse\/image-library\/01.icons\/conditionally-required\/conditionally-required.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/span><\/td>\n<td><strong>Use case<\/strong>: required for Visa and JCB transactions; if you don't include this, you have to send the phone number in  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Checkout\/latest\/post\/payments#request-telephoneNumber\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">telephoneNumber<\/a>. We strongly recommend to include the email address for all transactions. <br> The cardholder's email address.<\/td>\n<\/tr>\n<tr>\n<td> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Checkout\/latest\/post\/payments#request-shopperIP\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">shopperIP<\/a><\/td>\n<td style=\"text-align: center;\"><span class=\"hint--bottom\" data-hint=\"Conditionally required\" markdown=\"1\"><img style=\"width: 25px;\" alt=\"Conditionally required\" src=\"\/user\/pages\/reuse\/image-library\/01.icons\/conditionally-required\/conditionally-required.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/span><\/td>\n<td><strong>Use case<\/strong>: required for Visa and JCB transactions for all web and mobile integrations. You must include <code>shopperIP<\/code> for native mobile integrations to support cases where the transaction is routed to the redirect flow.  We recommend to include this field for all transactions, because it is used in a number of risk checks.   <br> The IP address of the shopper.<\/td>\n<\/tr>\n<tr>\n<td> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Checkout\/latest\/post\/payments#request-socialSecurityNumber\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">socialSecurityNumber<\/a><\/td>\n<td style=\"text-align: center;\"><span class=\"hint--bottom\" data-hint=\"Recommended\" markdown=\"1\"><img style=\"width: 25px;\" alt=\"Recommended\" src=\"\/user\/pages\/reuse\/image-library\/01.icons\/recommended\/recommended.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/span><\/td>\n<td>The shopper's CPF or CNPJ number. We strongly recommend that you include this for shoppers in Brazil. Supported from <strong>v50<\/strong> and later of our API.<\/td>\n<\/tr>\n<tr>\n<td> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Checkout\/latest\/post\/payments#request-threeDS2RequestData\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">threeDS2RequestData<\/a><\/td>\n<td style=\"text-align: center;\"><span class=\"hint--bottom\" data-hint=\"Conditionally required\" markdown=\"1\"><img style=\"width: 25px;\" alt=\"Conditionally required\" src=\"\/user\/pages\/reuse\/image-library\/01.icons\/conditionally-required\/conditionally-required.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/span><\/td>\n<td><strong>Use case<\/strong>: required for certain 3D Secure 2 setups. See <a href=\"#threeds2requestdata\">the reference<\/a> to learn about its required sub-fields depending on integration type.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h2 id=\"accountinfo\">accountInfo<\/h2>\n<p>The  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Checkout\/latest\/post\/payments#request-accountInfo\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">accountInfo<\/a> object is not required, but we recommend to include it in your requests to increase the chances of achieving the <a href=\"\/pt\/online-payments\/3d-secure\/#frictionless-flow\">frictionless flow<\/a>.<\/p>\n<table>\n<thead>\n<tr>\n<th>Field<\/th>\n<th>Type<\/th>\n<th>Required<\/th>\n<th>Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td><code>accountAgeIndicator<\/code><\/td>\n<td>String<\/td>\n<td><img alt=\"\" src=\"\/user\/pages\/reuse\/3ds2-reuse-pages\/reference-account-info\/optional.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/td>\n<td>Indicator for the length of time since this shopper account was created.<br> Possible values: <ul><li markdown=\"1\"><span translate=\"no\"><strong>notApplicable<\/strong><\/span><\/li><li markdown=\"1\"><span translate=\"no\"><strong>thisTransaction<\/strong><\/span><\/li><li markdown=\"1\"><span translate=\"no\"><strong>lessThan30Days<\/strong><\/span><\/li><li markdown=\"1\"><span translate=\"no\"><strong>from30To60Days<\/strong><\/span><\/li><li markdown=\"1\"><span translate=\"no\"><strong>moreThan60Days<\/strong><\/span><\/li><\/ul><\/td>\n<\/tr>\n<tr>\n<td><code>accountChangeDate<\/code><\/td>\n<td>String<\/td>\n<td><img alt=\"\" src=\"\/user\/pages\/reuse\/3ds2-reuse-pages\/reference-account-info\/optional.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/td>\n<td>Date when the shopper's account was last changed.<br> <strong>Format<\/strong>: <a href=\"http:\/\/www.w3.org\/TR\/NOTE-datetime\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">ISO 8601<\/a> <em>YYYY-MM-DDThh:mm:ssTZD<\/em><br> <strong>Example<\/strong>: <code>2017-07-17T13:42:40+01:00<\/code><\/td>\n<\/tr>\n<tr>\n<td><code>accountChangeIndicator<\/code><\/td>\n<td>String<\/td>\n<td><img alt=\"\" src=\"\/user\/pages\/reuse\/3ds2-reuse-pages\/reference-account-info\/optional.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/td>\n<td>Indicator for when the shopper's account was last changed.<br> Possible values: <ul><li markdown=\"1\"><span translate=\"no\"><strong>thisTransaction<\/strong><\/span><\/li><li markdown=\"1\"><span translate=\"no\"><strong>lessThan30Days<\/strong><\/span><\/li><li markdown=\"1\"><span translate=\"no\"><strong>from30To60Days<\/strong><\/span><\/li><li markdown=\"1\"><span translate=\"no\"><strong>moreThan60Days<\/strong><\/span><\/li><\/ul><\/td>\n<\/tr>\n<tr>\n<td><code>accountCreationDate<\/code><\/td>\n<td>String<\/td>\n<td><img alt=\"\" src=\"\/user\/pages\/reuse\/3ds2-reuse-pages\/reference-account-info\/optional.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/td>\n<td>Date when the shopper's account was created.<br> <strong>Format<\/strong>: <a href=\"http:\/\/www.w3.org\/TR\/NOTE-datetime\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">ISO 8601<\/a> <em>YYYY-MM-DDThh:mm:ssTZD<\/em><br> <strong>Example<\/strong>: <code>2017-07-17T13:42:40+01:00<\/code><\/td>\n<\/tr>\n<tr>\n<td><code>accountType<\/code><\/td>\n<td>String<\/td>\n<td><img alt=\"\" src=\"\/user\/pages\/reuse\/3ds2-reuse-pages\/reference-account-info\/optional.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/td>\n<td>The type of the shopper's account. For example, for a multi-account card product. Possible values: <ul><li markdown=\"1\"><span translate=\"no\"><strong>notApplicable<\/strong><\/span><\/li><li markdown=\"1\"><span translate=\"no\"><strong>credit<\/strong><\/span><\/li><li markdown=\"1\"><span translate=\"no\"><strong>debit<\/strong><\/span><\/li><\/ul><\/td>\n<\/tr>\n<tr>\n<td><code>addCardAttemptsDay<\/code><\/td>\n<td>Integer<\/td>\n<td><img alt=\"\" src=\"\/user\/pages\/reuse\/3ds2-reuse-pages\/reference-account-info\/optional.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/td>\n<td>Number of attempts the shopper made to add a card to their account in the last day.<br> Maximum value: <strong>999<\/strong><\/td>\n<\/tr>\n<tr>\n<td><code>passwordChangeDate<\/code><\/td>\n<td>String<\/td>\n<td><img alt=\"\" src=\"\/user\/pages\/reuse\/3ds2-reuse-pages\/reference-account-info\/optional.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/td>\n<td>Date when the shopper last changed their password.<br> <strong>Format<\/strong>: <a href=\"http:\/\/www.w3.org\/TR\/NOTE-datetime\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">ISO 8601<\/a> <em>YYYY-MM-DDThh:mm:ssTZD<\/em><br> <strong>Example<\/strong>: <code>2017-07-17T13:42:40+01:00<\/code><\/td>\n<\/tr>\n<tr>\n<td><code>passwordChangeIndicator<\/code><\/td>\n<td>String<\/td>\n<td><img alt=\"\" src=\"\/user\/pages\/reuse\/3ds2-reuse-pages\/reference-account-info\/optional.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/td>\n<td>Indicator for when the shopper's account password was last changed.<br> Possible values: <ul><li markdown=\"1\"><span translate=\"no\"><strong>thisTransaction<\/strong><\/span><\/li><li markdown=\"1\"><span translate=\"no\"><strong>lessThan30Days<\/strong><\/span><\/li><li markdown=\"1\"><span translate=\"no\"><strong>from30To60Days<\/strong><\/span><\/li><li markdown=\"1\"><span translate=\"no\"><strong>moreThan60Days<\/strong><\/span><\/li><\/ul><\/td>\n<\/tr>\n<tr>\n<td><code>purchasesLast6Months<\/code><\/td>\n<td>Integer<\/td>\n<td><img alt=\"\" src=\"\/user\/pages\/reuse\/3ds2-reuse-pages\/reference-account-info\/optional.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/td>\n<td>Number of purchases in the last 6 months.<br> Maximum value: <strong>9999<\/strong><\/td>\n<\/tr>\n<tr>\n<td><code>pastTransactionsDay<\/code><\/td>\n<td>Integer<\/td>\n<td><img alt=\"\" src=\"\/user\/pages\/reuse\/3ds2-reuse-pages\/reference-account-info\/optional.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/td>\n<td>Number of transactions from this shopper in the past 24 hours.<br> Maximum value: <strong>999<\/strong><\/td>\n<\/tr>\n<tr>\n<td><code>pastTransactionsYear<\/code><\/td>\n<td>Integer<\/td>\n<td><img alt=\"\" src=\"\/user\/pages\/reuse\/3ds2-reuse-pages\/reference-account-info\/optional.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/td>\n<td>Number of transactions from this shopper in the past year.<br> Maximum value: <strong>999<\/strong><\/td>\n<\/tr>\n<tr>\n<td><code>paymentAccountAge<\/code><\/td>\n<td>String<\/td>\n<td><img alt=\"\" src=\"\/user\/pages\/reuse\/3ds2-reuse-pages\/reference-account-info\/optional.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/td>\n<td>Date this payment method was added to the shopper's account.<br> <strong>Format<\/strong>: <a href=\"http:\/\/www.w3.org\/TR\/NOTE-datetime\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">ISO 8601<\/a> <em>YYYY-MM-DDThh:mm:ssTZD<\/em><br> <strong>Example<\/strong>: <code>2017-07-17T13:42:40+01:00<\/code><\/td>\n<\/tr>\n<tr>\n<td><code>paymentAccountIndicator<\/code><\/td>\n<td>String<\/td>\n<td><img alt=\"\" src=\"\/user\/pages\/reuse\/3ds2-reuse-pages\/reference-account-info\/optional.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/td>\n<td>Indicator for the length of time since this payment method was added to the shopper's account.<br> Possible values: <ul><li markdown=\"1\"><span translate=\"no\"><strong>notApplicable<\/strong><\/span><\/li><li markdown=\"1\"><span translate=\"no\"><strong>thisTransaction<\/strong><\/span><\/li><li markdown=\"1\"><span translate=\"no\"><strong>lessThan30Days<\/strong><\/span><\/li><li markdown=\"1\"><span translate=\"no\"><strong>from30To60Days<\/strong><\/span><\/li><li markdown=\"1\"><span translate=\"no\"><strong>moreThan60Days<\/strong><\/span><\/li><\/ul><\/td>\n<\/tr>\n<tr>\n<td><code>deliveryAddressUsageDate<\/code><\/td>\n<td>String<\/td>\n<td><img alt=\"\" src=\"\/user\/pages\/reuse\/3ds2-reuse-pages\/reference-account-info\/optional.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/td>\n<td>Date when the selected delivery address was first used with the 3DS Requestor.<br> <strong>Format<\/strong>: <a href=\"http:\/\/www.w3.org\/TR\/NOTE-datetime\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">ISO 8601<\/a> <em>YYYY-MM-DDThh:mm:ssTZD<\/em><br> <strong>Example<\/strong>: <code>2017-07-17T13:42:40+01:00<\/code><\/td>\n<\/tr>\n<tr>\n<td><code>deliveryAddressUsageIndicator<\/code><\/td>\n<td>String<\/td>\n<td><img alt=\"\" src=\"\/user\/pages\/reuse\/3ds2-reuse-pages\/reference-account-info\/optional.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/td>\n<td>Indicator for when this delivery address was first used with the 3DS Requestor.<br> Possible values: <ul><li markdown=\"1\"><span translate=\"no\"><strong>thisTransaction<\/strong><\/span><\/li><li markdown=\"1\"><span translate=\"no\"><strong>lessThan30Days<\/strong><\/span><\/li><li markdown=\"1\"><span translate=\"no\"><strong>from30To60Days<\/strong><\/span><\/li><li markdown=\"1\"><span translate=\"no\"><strong>moreThan60Days<\/strong><\/span><\/li><\/ul><\/td>\n<\/tr>\n<tr>\n<td><code>suspiciousActivity<\/code><\/td>\n<td>Boolean<\/td>\n<td><img alt=\"\" src=\"\/user\/pages\/reuse\/3ds2-reuse-pages\/reference-account-info\/optional.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/td>\n<td>Whether suspicious activity was recorded on this account.<\/td>\n<\/tr>\n<tr>\n<td><code>homePhone<\/code> <br> <div data-component-wrapper=\"tag\">\n    <tag :variant=&quot;warning&quot;>\n        Deprecated in Checkout API v68\n    <\/tag>\n<\/div>\n<\/td>\n<td>String<\/td>\n<td><\/td>\n<td>Use <a href=\"#threeds2requestdata\">\n  <code>threeDSRequestData.homePhone<\/code>\n<\/a> instead. Shopper's home phone number, including the country code.<\/td>\n<\/tr>\n<tr>\n<td><code>mobilePhone<\/code> <br><div data-component-wrapper=\"tag\">\n    <tag :variant=&quot;warning&quot;>\n        Deprecated in Checkout API v68\n    <\/tag>\n<\/div>\n<\/td>\n<td>String<\/td>\n<td><\/td>\n<td>Use <a href=\"#threeds2requestdata\">\n  <code>threeDSRequestData.mobilePhone<\/code>\n<\/a> instead. <br> Shopper's mobile phone number, including the country code.<\/td>\n<\/tr>\n<tr>\n<td><code>workPhone<\/code>     <br> <div data-component-wrapper=\"tag\">\n    <tag :variant=&quot;warning&quot;>\n        Deprecated in Checkout API v68\n    <\/tag>\n<\/div>\n<\/td>\n<td>String<\/td>\n<td><\/td>\n<td>Use <a href=\"#threeds2requestdata\">\n  <code>threeDSRequestData.workPhone<\/code>\n<\/a> instead. <br> Shopper's work phone number, including the country code.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h3 id=\"adyen-emvco-map-accountinfo\">Mapping Adyen parameters to EMVCo fields<\/h3>\n<p>The Adyen <code>accountInfo<\/code> parameters map to the <a href=\"https:\/\/www.emvco.com\/emv-technologies\/3-d-secure\/\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">EMVCo specifications<\/a> as follows.<\/p>\n<table>\n<thead>\n<tr>\n<th style=\"text-align: left;\">Adyen parameter<\/th>\n<th style=\"text-align: left;\">EMVCo parameter<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td style=\"text-align: left;\"><code>accountAgeIndicator<\/code><\/td>\n<td style=\"text-align: left;\"><code>chAccAgeInd<\/code><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>accountChangeDate<\/code><\/td>\n<td style=\"text-align: left;\"><code>chAccDate<\/code><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>accountChangeIndicator<\/code><\/td>\n<td style=\"text-align: left;\"><code>chAccChangeInd<\/code><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>accountCreationDate<\/code><\/td>\n<td style=\"text-align: left;\"><code>chAccDate<\/code><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>passwordChangeDate<\/code><\/td>\n<td style=\"text-align: left;\"><code>chAccPwChange<\/code><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>passwordChangeIndicator<\/code><\/td>\n<td style=\"text-align: left;\"><code>chAccPwChangeInd<\/code><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>purchasesLast6Months<\/code><\/td>\n<td style=\"text-align: left;\"><code>nbPurchaseAccount<\/code><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>addCardAttemptsDay<\/code><\/td>\n<td style=\"text-align: left;\"><code>provisionAttemptsDay<\/code><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>pastTransactionsDay<\/code><\/td>\n<td style=\"text-align: left;\"><code>txnActivityDay<\/code><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>pastTransactionsYear<\/code><\/td>\n<td style=\"text-align: left;\"><code>txnActivityYear<\/code><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>paymentAccAge<\/code><\/td>\n<td style=\"text-align: left;\"><code>paymentAccountAge<\/code><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>paymentAccountIndicator<\/code><\/td>\n<td style=\"text-align: left;\"><code>paymentAccInd<\/code><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>deliveryAddressUsageDate<\/code><\/td>\n<td style=\"text-align: left;\"><code>shipAddressUsage<\/code><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>deliveryAddressUsageIndicator<\/code><\/td>\n<td style=\"text-align: left;\"><code>shipAddressUsageInd<\/code><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h2 id=\"authenticationdata\">authenticationData<\/h2>\n<p>The  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Checkout\/latest\/post\/payments#request-authenticationData\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">authenticationData<\/a> object contains sub-fields that are required to include for certain 3D Secure 2 authentication scenarios.<\/p>\n<table>\n<thead>\n<tr>\n<th>Field<\/th>\n<th>Type<\/th>\n<th>Required<\/th>\n<th>Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td><code>authenticationOnly<\/code><\/td>\n<td>Boolean<\/td>\n<td><span class=\"hint--bottom\" data-hint=\"Conditionally required\" markdown=\"1\"><img style=\"width: 25px;\" alt=\"Conditionally required\" src=\"\/user\/pages\/reuse\/image-library\/01.icons\/conditionally-required\/conditionally-required.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/span><\/td>\n<td><strong>Use case<\/strong>: required to trigger <a href=\"\/pt\/online-payments\/3d-secure\/standalone-authentication\/\">standalone authentication<\/a>.<br>  When set to <strong>true<\/strong>, you only perform the 3D Secure 2 authentication, and will not proceed to the payment authorization. The default value is <strong>false<\/strong>.<\/td>\n<\/tr>\n<tr>\n<td><code>attemptAuthentication<\/code><\/td>\n<td>String<\/td>\n<td><\/td>\n<td>Indicates whether to attempt 3D Secure 2 authentication for a transaction. We do not recommend to use this field. This overrides your <a href=\"\/pt\/risk-management\/dynamic-3d-secure\/#override-using-the-payment-request\">Dynamic 3D Secure<\/a> settings. Possible values: <ul><li markdown=\"1\"><strong>always<\/strong>: attempt 3D Secure 2.<\/li><li markdown=\"1\"><strong>never<\/strong>: do not attempt 3D Secure 2. If regulations require authentication, the transaction gets declined.<\/li><\/ul><\/td>\n<\/tr>\n<tr>\n<td><code>threeDSRequestData.challengeWindowSize<\/code><\/td>\n<td>String<\/td>\n<td><\/td>\n<td>The size of the challenge window displayed to the shopper in the <a href=\"\/pt\/online-payments\/3d-secure\/#challenge-flow\">challenge flow<\/a>. Possible values: <ul><li markdown=\"1\"><strong>01<\/strong>: ['250px', '400px']<\/li><li markdown=\"1\"><strong>02<\/strong>: ['390px', '400px']<\/li><li markdown=\"1\"><strong>03<\/strong>: ['500px', '600px']<\/li><li markdown=\"1\"><strong>04<\/strong>: ['600px', '400px']<\/li><li markdown=\"1\"><strong>05<\/strong>: ['100%', '100%']<\/li><\/ul><\/td>\n<\/tr>\n<tr>\n<td><code>threeDSRequestData.dataOnly<\/code> <br> <div data-component-wrapper=\"tag\">\n    <tag :variant=&quot;warning&quot;>\n        Available on Checkout API v69\n    <\/tag>\n<\/div>\n<\/td>\n<td>String<\/td>\n<td><span class=\"hint--bottom\" data-hint=\"Conditionally required\" markdown=\"1\"><img style=\"width: 25px;\" alt=\"Conditionally required\" src=\"\/user\/pages\/reuse\/image-library\/01.icons\/conditionally-required\/conditionally-required.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/span><\/td>\n<td><strong>Use case<\/strong>: required to trigger the <a href=\"\/pt\/online-payments\/3d-secure\/data-only\/\">data-only flow<\/a>. <br> When set to <strong>true<\/strong>, forces the 3D Secure 2 data-only flow for all transactions where it is possible. <br> If you are using Checkout API v68 or earlier, use the <code>additionalData.threeDSDataOnly<\/code> field instead.<\/td>\n<\/tr>\n<tr>\n<td><code>threeDSRequestData.nativeThreeDS<\/code><\/td>\n<td>String<\/td>\n<td><span class=\"hint--bottom\" data-hint=\"Conditionally required\" markdown=\"1\"><img style=\"width: 25px;\" alt=\"Conditionally required\" src=\"\/user\/pages\/reuse\/image-library\/01.icons\/conditionally-required\/conditionally-required.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/span><\/td>\n<td><strong>Use case<\/strong>: required to trigger the native flow when using the  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Checkout\/latest\/post\/payments\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">\/payments<\/a> endpoint, or to trigger the redirect flow when using the  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Checkout\/latest\/post\/sessions\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">\/sessions<\/a> endpoint. <br> Indicates if <a href=\"\/pt\/online-payments\/3d-secure\/#implement-3d-secure-2\">native 3D Secure 2<\/a> should be used when available. Adyen can still select to fallback to the redirect flow to optimize authorization rates and improve the shopper's experience. Possible values: <ul><li markdown=\"1\"><strong>preferred<\/strong>: use native 3D Secure 2 when available.<\/li><li markdown=\"1\"><strong>disabled<\/strong>: only use the redirect 3D Secure 2 flow.<\/li><\/ul><\/td>\n<\/tr>\n<tr>\n<td><code>threeDSRequestData.threeDSVersion<\/code><\/td>\n<td>String<\/td>\n<td><\/td>\n<td>The version of 3D Secure 2 to use. Possible values: <ul><li markdown=\"1\"><strong>2.1.0<\/strong><\/li><li markdown=\"1\"><strong>2.2.0<\/strong><\/li><\/ul><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h2 id=\"billingaddress\">billingAddress<\/h2>\n<p>The  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Checkout\/latest\/post\/payments#request-billingAddress\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">billingAddress<\/a> object is not required, but we recommend to include it in your requests when available to improve authentication performance. This object includes some required sub-fields.<\/p>\n<p>When using our Drop-in\/Components, the billing address is returned in an event. For example, on web integrations, this is the <code>state.data.billingAddress<\/code> object from the <code>onSubmit<\/code> event.<\/p>\n<table>\n<thead>\n<tr>\n<th>Field<\/th>\n<th>Type<\/th>\n<th style=\"text-align: center;\">Required<\/th>\n<th>Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td><code>city<\/code><\/td>\n<td>String<\/td>\n<td style=\"text-align: center;\"><img alt=\"\" src=\"\/user\/pages\/reuse\/3ds2-reuse-pages\/reference-billing-address\/required.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/td>\n<td>The name of the city.<\/td>\n<\/tr>\n<tr>\n<td><code>country<\/code><\/td>\n<td>String<\/td>\n<td style=\"text-align: center;\"><img alt=\"\" src=\"\/user\/pages\/reuse\/3ds2-reuse-pages\/reference-billing-address\/required.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/td>\n<td>The country code. <br>Format: the two-letter <a href=\"https:\/\/en.wikipedia.org\/wiki\/ISO_3166-1_alpha-2\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">ISO-3166-1 alpha-2<\/a> country code. Exception: <strong>QZ<\/strong> (Kosovo).<\/td>\n<\/tr>\n<tr>\n<td><code>houseNumberOrName<\/code><\/td>\n<td>String<\/td>\n<td style=\"text-align: center;\"><img alt=\"\" src=\"\/user\/pages\/reuse\/3ds2-reuse-pages\/reference-billing-address\/required.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/td>\n<td>The number or name of the house.<\/td>\n<\/tr>\n<tr>\n<td><code>postalCode<\/code><\/td>\n<td>String<\/td>\n<td style=\"text-align: center;\"><img alt=\"\" src=\"\/user\/pages\/reuse\/3ds2-reuse-pages\/reference-billing-address\/required.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/td>\n<td>The postal code consisting of a maximum of five digits for an address in the US, or a maximum of ten characters for an address in all other countries\/regions.<\/td>\n<\/tr>\n<tr>\n<td><code>stateOrProvince<\/code><\/td>\n<td>String<\/td>\n<td style=\"text-align: center;\"><img alt=\"\" src=\"\/user\/pages\/reuse\/3ds2-reuse-pages\/reference-billing-address\/conditionally-required.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/td>\n<td><strong>Use case<\/strong>: required for addresses in the US and Canada. <br> The state or province code of the billing address as defined in <a href=\"https:\/\/en.wikipedia.org\/wiki\/ISO_3166-2\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">ISO 3166-2<\/a>. <br> <strong>Example<\/strong>: <span translate=\"no\"><strong>CA<\/strong><\/span> in US, or <span translate=\"no\"><strong>ON<\/strong><\/span> in Canada.<\/td>\n<\/tr>\n<tr>\n<td><code>street<\/code><\/td>\n<td>String<\/td>\n<td style=\"text-align: center;\"><img alt=\"\" src=\"\/user\/pages\/reuse\/3ds2-reuse-pages\/reference-billing-address\/required.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/td>\n<td>The name of the street.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h2 id=\"browserinfo\">browserInfo<\/h2>\n<p>For web integrations  ( <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Checkout\/latest\/post\/payments#request-channel\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">channel<\/a>: <strong>Web<\/strong>): the full object, except <code>javaScriptEnabled<\/code>, is required.<\/p>\n<p>For mobile integrations ( <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Checkout\/latest\/post\/payments#request-channel\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">channel<\/a>: <strong>iOS<\/strong>\/<strong>Android<\/strong>): the object is not required but recommended to support cases where the payment is routed to <a href=\"\/pt\/online-payments\/3d-secure\/redirect-3ds2\">3D Secure 2 redirect<\/a>.<\/p>\n<table>\n<thead>\n<tr>\n<th>Field<\/th>\n<th>Type<\/th>\n<th>Required<\/th>\n<th>Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td><code>acceptHeader<\/code><\/td>\n<td>String<\/td>\n<td><img alt=\"\" src=\"\/user\/pages\/reuse\/3ds2-reuse-pages\/reference-browser-info\/required.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/td>\n<td>The accept header value of the shopper's browser.<\/td>\n<\/tr>\n<tr>\n<td><code>colorDepth<\/code><\/td>\n<td>Int<\/td>\n<td><img alt=\"\" src=\"\/user\/pages\/reuse\/3ds2-reuse-pages\/reference-browser-info\/conditionally-required.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/td>\n<td><strong>Use case<\/strong>: web integrations. <br> The color depth of the shopper's browser in bits per pixel. Use the browser's <code>screen.colorDepth<\/code> property to obtain the value. Accepted values: <strong>1<\/strong>, <strong>4<\/strong>, <strong>8<\/strong>, <strong>15<\/strong>, <strong>16<\/strong>, <strong>24<\/strong>, <strong>32<\/strong>, or <strong>48<\/strong> bit.<\/td>\n<\/tr>\n<tr>\n<td><code>javaEnabled<\/code><\/td>\n<td>Boolean<\/td>\n<td><img alt=\"\" src=\"\/user\/pages\/reuse\/3ds2-reuse-pages\/reference-browser-info\/conditionally-required.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/td>\n<td><strong>Use case<\/strong>: web integrations. <br> Boolean value indicating if the shopper's browser is able to execute Java.<\/td>\n<\/tr>\n<tr>\n<td><code>javaScriptEnabled<\/code><\/td>\n<td>Boolean<\/td>\n<td><\/td>\n<td>Boolean value indicating if the shopper's browser is able to execute JavaScript. If not present, the default value is <span translate=\"no\"><strong>true<\/strong><\/span>.<\/td>\n<\/tr>\n<tr>\n<td><code>language<\/code><\/td>\n<td>String<\/td>\n<td><img alt=\"\" src=\"\/user\/pages\/reuse\/3ds2-reuse-pages\/reference-browser-info\/conditionally-required.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/td>\n<td><strong>Use case<\/strong>: web integrations. <br> The name of the browser language used by the shopper. This is the <code>navigator.language<\/code> value of the shopper's browser as defined in <a href=\"https:\/\/en.wikipedia.org\/wiki\/IETF_language_tag\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">IETF BCP 47<\/a>. <br> <strong>Examples<\/strong>: <code>nl-NL<\/code>, <code>fr-FR<\/code>, <code>en-US<\/code>.<\/td>\n<\/tr>\n<tr>\n<td><code>screenHeight<\/code><\/td>\n<td>Int<\/td>\n<td><img alt=\"\" src=\"\/user\/pages\/reuse\/3ds2-reuse-pages\/reference-browser-info\/conditionally-required.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/td>\n<td><strong>Use case<\/strong>: web integrations. <br> The pixel height of the shopper's screen.<\/td>\n<\/tr>\n<tr>\n<td><code>screenWidth<\/code><\/td>\n<td>Int<\/td>\n<td><img alt=\"\" src=\"\/user\/pages\/reuse\/3ds2-reuse-pages\/reference-browser-info\/conditionally-required.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/td>\n<td><strong>Use case<\/strong>: web integrations. <br>  The pixel width of the shopper's screen.<\/td>\n<\/tr>\n<tr>\n<td><code>timeZoneOffset<\/code><\/td>\n<td>String<\/td>\n<td><img alt=\"\" src=\"\/user\/pages\/reuse\/3ds2-reuse-pages\/reference-browser-info\/conditionally-required.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/td>\n<td><strong>Use case<\/strong>: web integrations. <br> Time difference between UTC time and the shopper's browser local time, in minutes. <br> <strong>Example<\/strong>: <strong>-120<\/strong><\/td>\n<\/tr>\n<tr>\n<td><code>userAgent<\/code><\/td>\n<td>String<\/td>\n<td><img alt=\"\" src=\"\/user\/pages\/reuse\/3ds2-reuse-pages\/reference-browser-info\/required.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/td>\n<td>The user agent value of the shopper's browser.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h2 id=\"deliveryaddress\">deliveryAddress<\/h2>\n<p>Include the  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Checkout\/latest\/post\/payments#request-deliveryAddress\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">deliveryAddress<\/a> object in your request if you want to submit the shopper's delivery address. If you include this object in your request, provide the required fields.<\/p>\n<table>\n<thead>\n<tr>\n<th>Field<\/th>\n<th>Type<\/th>\n<th style=\"text-align: center;\">Required<\/th>\n<th>Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td><code>city<\/code><\/td>\n<td>String<\/td>\n<td style=\"text-align: center;\"><img alt=\"\" src=\"\/user\/pages\/reuse\/3ds2-reuse-pages\/reference-delivery-address\/required.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/td>\n<td>The name of the city.<\/td>\n<\/tr>\n<tr>\n<td><code>country<\/code><\/td>\n<td>String<\/td>\n<td style=\"text-align: center;\"><img alt=\"\" src=\"\/user\/pages\/reuse\/3ds2-reuse-pages\/reference-delivery-address\/required.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/td>\n<td>The country code. <br>Format: the two-letter <a href=\"https:\/\/en.wikipedia.org\/wiki\/ISO_3166-1_alpha-2\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">ISO-3166-1 alpha-2<\/a> country code. Exception: <strong>QZ<\/strong> (Kosovo).<\/td>\n<\/tr>\n<tr>\n<td><code>houseNumberOrName<\/code><\/td>\n<td>String<\/td>\n<td style=\"text-align: center;\"><img alt=\"\" src=\"\/user\/pages\/reuse\/3ds2-reuse-pages\/reference-delivery-address\/required.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/td>\n<td>The number or name of the house.<\/td>\n<\/tr>\n<tr>\n<td><code>postalCode<\/code><\/td>\n<td>String<\/td>\n<td style=\"text-align: center;\"><img alt=\"\" src=\"\/user\/pages\/reuse\/3ds2-reuse-pages\/reference-delivery-address\/required.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/td>\n<td>The postal code consisting of a maximum of five digits for an address in the US, or a maximum of ten characters for an address in all other countries\/regions.<\/td>\n<\/tr>\n<tr>\n<td><code>stateOrProvince<\/code><\/td>\n<td>String<\/td>\n<td style=\"text-align: center;\"><img alt=\"\" src=\"\/user\/pages\/reuse\/3ds2-reuse-pages\/reference-delivery-address\/conditionally-required.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/td>\n<td><strong>Use case<\/strong>: required for addresses in the US and Canada. <br> The state or province code of the billing address as defined in <a href=\"https:\/\/en.wikipedia.org\/wiki\/ISO_3166-2\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">ISO 3166-2<\/a>. <br> <strong>Example<\/strong>: <span translate=\"no\"><strong>CA<\/strong><\/span> in US, or <span translate=\"no\"><strong>ON<\/strong><\/span> in Canada.<\/td>\n<\/tr>\n<tr>\n<td><code>street<\/code><\/td>\n<td>String<\/td>\n<td style=\"text-align: center;\"><img alt=\"\" src=\"\/user\/pages\/reuse\/3ds2-reuse-pages\/reference-delivery-address\/required.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/td>\n<td>The name of the street.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h2 id=\"installments\">installments<\/h2>\n<p>Include the  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Checkout\/latest\/post\/payments#request-installments\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">installments<\/a> object in your request when you want to split the payment into <a href=\"\/pt\/payment-methods\/cards\/credit-card-installments\/\">installments<\/a>. If you include this object in your request, some sub-fields are required.<\/p>\n<table>\n<thead>\n<tr>\n<th>Field<\/th>\n<th>Type<\/th>\n<th style=\"text-align: center;\">Required<\/th>\n<th>Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td><code>value<\/code><\/td>\n<td>Integer<\/td>\n<td style=\"text-align: center;\"><img alt=\"\" src=\"\/user\/pages\/reuse\/3ds2-reuse-pages\/reference-installments\/required.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/td>\n<td>The number of installments. For Mexico, the value can be <strong>0<\/strong>, for other countries, the value must be greater than zero. See <a href=\"\/pt\/payment-methods\/cards\/credit-card-installments\/#installment-options\">installment options in supported countries\/regions<\/a> for possible values. Usually, the acquirer sets the maximum allowed number of installments. For example, it may not be possible to split a payment in more than 24 installments.<\/td>\n<\/tr>\n<tr>\n<td><code>extra<\/code><\/td>\n<td>Integer<\/td>\n<td style=\"text-align: center;\"><\/td>\n<td>The bonus percentage, refund percentage, or if the transaction is completed with a Buy Now Pay Later payment method for transactions processed in Mexico.<\/td>\n<\/tr>\n<tr>\n<td><code>plan<\/code><\/td>\n<td>String<\/td>\n<td style=\"text-align: center;\"><img alt=\"\" src=\"\/user\/pages\/reuse\/3ds2-reuse-pages\/reference-installments\/conditionally-required.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/td>\n<td><strong>Use case<\/strong>: required for installments in Japan, and Mexico. The installment plan. Possible values: <ul><li markdown=\"1\"><span translate=\"no\"><strong>regular<\/strong><\/span><\/li><li markdown=\"1\"><span translate=\"no\"><strong>revolving<\/strong><\/span><\/li><li markdown=\"1\"><span translate=\"no\"><strong>bonus<\/strong><\/span><\/li><\/ul> The default value is <span translate=\"no\"><strong>regular<\/strong><\/span>.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h2 id=\"merchantriskindicator\">merchantRiskIndicator<\/h2>\n<p>The  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Checkout\/latest\/post\/payments#request-merchantRiskIndicator\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">merchantRiskIndicator<\/a> object is not required, but we recommend to include it in your requests to increase the chances of achieving the <a href=\"\/pt\/online-payments\/3d-secure\/#frictionless-flow\">frictionless flow<\/a>.<\/p>\n<table>\n<thead>\n<tr>\n<th>Field<\/th>\n<th>Type<\/th>\n<th>Required<\/th>\n<th>Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td><code>addressMatch<\/code><\/td>\n<td>Boolean<\/td>\n<td><img alt=\"\" src=\"\/user\/pages\/reuse\/3ds2-reuse-pages\/reference-merchant-risk-indicator\/optional.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/td>\n<td>Whether the chosen delivery address is identical to the billing address.<\/td>\n<\/tr>\n<tr>\n<td><code>deliveryEmail<\/code> <div data-component-wrapper=\"tag\">\n    <tag :variant=&quot;warning&quot;>\n        Deprecated in Checkout API v68\n    <\/tag>\n<\/div>\n<\/td>\n<td>String<\/td>\n<td><img alt=\"\" src=\"\/user\/pages\/reuse\/3ds2-reuse-pages\/reference-merchant-risk-indicator\/optional.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/td>\n<td>Use <code>deliveryEmailAddress<\/code> instead. The delivery email address (for digital goods).<\/td>\n<\/tr>\n<tr>\n<td><code>deliveryEmailAddress<\/code><\/td>\n<td>String<\/td>\n<td><img alt=\"\" src=\"\/user\/pages\/reuse\/3ds2-reuse-pages\/reference-merchant-risk-indicator\/optional.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/td>\n<td>The delivery email address (for digital goods).<\/td>\n<\/tr>\n<tr>\n<td><code>deliveryTimeframe<\/code><\/td>\n<td>String<\/td>\n<td><img alt=\"\" src=\"\/user\/pages\/reuse\/3ds2-reuse-pages\/reference-merchant-risk-indicator\/optional.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/td>\n<td>The estimated delivery time for the shopper to receive the goods. Possible values:<ul><li markdown=\"1\"><span translate=\"no\"><strong>electronicDelivery<\/strong><\/span><\/li><li markdown=\"1\"><span translate=\"no\"><strong>sameDayShipping<\/strong><\/span><\/li><li markdown=\"1\"><span translate=\"no\"><strong>overnightShipping<\/strong><\/span><\/li><li markdown=\"1\"><span translate=\"no\"><strong>twoOrMoreDaysShipping<\/strong><\/span><\/li><\/ul><\/td>\n<\/tr>\n<tr>\n<td><code>giftCardAmount<\/code><\/td>\n<td>Integer<\/td>\n<td><img alt=\"\" src=\"\/user\/pages\/reuse\/3ds2-reuse-pages\/reference-merchant-risk-indicator\/optional.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/td>\n<td>For prepaid or gift card purchase, the purchase amount total of prepaid or gift card(s).<\/td>\n<\/tr>\n<tr>\n<td><code>giftCardCurr<\/code><\/td>\n<td>Integer<\/td>\n<td><img alt=\"\" src=\"\/user\/pages\/reuse\/3ds2-reuse-pages\/reference-merchant-risk-indicator\/optional.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/td>\n<td>For prepaid or gift card purchase, <a href=\"https:\/\/www.iso.org\/iso-4217-currency-codes.html\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">ISO 4217 three-digit currency code<\/a> of the gift card, other than those listed in Table A.5 of the <a href=\"https:\/\/www.emvco.com\/emv-technologies\/3-d-secure\/\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">EMVCo 3D Secure Protocol and Core Functions Specification<\/a>.<\/td>\n<\/tr>\n<tr>\n<td><code>giftCardCount<\/code><\/td>\n<td>String<\/td>\n<td><img alt=\"\" src=\"\/user\/pages\/reuse\/3ds2-reuse-pages\/reference-merchant-risk-indicator\/optional.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/td>\n<td>For prepaid or gift card purchase, total count of individual prepaid or gift cards\/codes purchased.<\/td>\n<\/tr>\n<tr>\n<td><code>preOrderDate<\/code><\/td>\n<td>String<\/td>\n<td><img alt=\"\" src=\"\/user\/pages\/reuse\/3ds2-reuse-pages\/reference-merchant-risk-indicator\/optional.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/td>\n<td>For pre-order purchases, the expected date this product will be available to the shopper.<ul><li markdown=\"1\"><strong>Format<\/strong>: <a href=\"http:\/\/www.w3.org\/TR\/NOTE-datetime\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">ISO 8601<\/a> <em>YYYY-MM-DDThh:mm:ssTZD<\/em><\/li><li markdown=\"1\"><strong>Example<\/strong>: <em>2017-07-17T13:42:40+01:00<\/em><\/li><\/ul><\/td>\n<\/tr>\n<tr>\n<td><code>preOrderPurchase<\/code><\/td>\n<td>Boolean<\/td>\n<td><img alt=\"\" src=\"\/user\/pages\/reuse\/3ds2-reuse-pages\/reference-merchant-risk-indicator\/optional.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/td>\n<td>Whether this transaction is for pre-ordering a product.<\/td>\n<\/tr>\n<tr>\n<td><code>preOrderPurchaseInd<\/code><\/td>\n<td>String<\/td>\n<td><img alt=\"\" src=\"\/user\/pages\/reuse\/3ds2-reuse-pages\/reference-merchant-risk-indicator\/optional.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/td>\n<td>Indicates if this transaction is for placing an order for merchandise with a future availability or release date.<\/td>\n<\/tr>\n<tr>\n<td><code>reorderItems<\/code><\/td>\n<td>Boolean<\/td>\n<td><img alt=\"\" src=\"\/user\/pages\/reuse\/3ds2-reuse-pages\/reference-merchant-risk-indicator\/optional.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/td>\n<td>Whether the shopper has already purchased the same items in the past.<\/td>\n<\/tr>\n<tr>\n<td><code>reorderItemsInd<\/code><\/td>\n<td>Boolean<\/td>\n<td><img alt=\"\" src=\"\/user\/pages\/reuse\/3ds2-reuse-pages\/reference-merchant-risk-indicator\/optional.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/td>\n<td>Indicates if the he cardholder is reordering previously purchased merchandise.<\/td>\n<\/tr>\n<tr>\n<td><code>deliveryAddressIndicator<\/code><\/td>\n<td>String<\/td>\n<td><img alt=\"\" src=\"\/user\/pages\/reuse\/3ds2-reuse-pages\/reference-merchant-risk-indicator\/optional.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/td>\n<td>Indicator regarding the delivery address. Possible values:<ul><li markdown=\"1\"><span translate=\"no\"><strong>shipToBillingAddress<\/strong><\/span><\/li><li markdown=\"1\"><span translate=\"no\"><strong>shipToVerifiedAddress<\/strong><\/span><\/li><li markdown=\"1\"><span translate=\"no\"><strong>shipToNewAddress<\/strong><\/span><\/li><li markdown=\"1\"><span translate=\"no\"><strong>shipToStore<\/strong><\/span><\/li><li markdown=\"1\"><span translate=\"no\"><strong>digitalGoods<\/strong><\/span><\/li><li markdown=\"1\"><span translate=\"no\"><strong>goodsNotShipped<\/strong><\/span><\/li><li markdown=\"1\"><span translate=\"no\"><strong>other<\/strong><\/span><\/li><\/ul><\/td>\n<\/tr>\n<tr>\n<td><code>shipIndicator<\/code><\/td>\n<td>String<\/td>\n<td><img alt=\"\" src=\"\/user\/pages\/reuse\/3ds2-reuse-pages\/reference-merchant-risk-indicator\/optional.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/td>\n<td>Indicates the shipping method for the purchase.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h3 id=\"adyen-emvco-map-merchantriskindicator\">Mapping Adyen parameters to EMVCo fields<\/h3>\n<p>The Adyen <code>merchantRiskIndicator<\/code> parameters map to the <a href=\"https:\/\/www.emvco.com\/emv-technologies\/3-d-secure\/\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">EMVCo specifications<\/a> as follows.<\/p>\n<table>\n<thead>\n<tr>\n<th style=\"text-align: left;\">Adyen parameter<\/th>\n<th style=\"text-align: left;\">EMVCo parameter<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td style=\"text-align: left;\"><code>deliveryEmail<\/code><\/td>\n<td style=\"text-align: left;\"><code>deliveryEmailAddress<\/code><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>deliveryTimeframe<\/code><\/td>\n<td style=\"text-align: left;\"><code>deliveryTimeframe<\/code><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>giftCardAmount<\/code><\/td>\n<td style=\"text-align: left;\"><code>giftCardAmount<\/code><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>giftCardCount<\/code><\/td>\n<td style=\"text-align: left;\"><code>giftCardCount<\/code><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>preOrderDate<\/code><\/td>\n<td style=\"text-align: left;\"><code>preOrderDate<\/code><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>preOrderPurchase<\/code><\/td>\n<td style=\"text-align: left;\"><code>preOrderPurchaseInd<\/code><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>reorderItems<\/code><\/td>\n<td style=\"text-align: left;\"><code>reorderItemsInd<\/code><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h2 id=\"mpidata\">mpiData<\/h2>\n<p>The  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Checkout\/latest\/post\/payments#request-mpiData\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">mpiData<\/a> object is required in your authorization requests with Adyen if you use authentication data from a <a href=\"\/pt\/online-payments\/3d-secure\/authorize-mpidata\/\">third-party<\/a> to authorize payments. Get the values from the authentication data produced by a 3D Secure 2 provider. When you make the request to Adyen, include all the fields you receive from the third-party authentication provider.<\/p>\n<table>\n<thead>\n<tr>\n<th style=\"text-align: left;\">Field<\/th>\n<th style=\"text-align: left;\">Type<\/th>\n<th style=\"text-align: center;\">Required<\/th>\n<th style=\"text-align: left;\">Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td style=\"text-align: left;\"><code>authenticationResponse<\/code><\/td>\n<td style=\"text-align: left;\">String<\/td>\n<td style=\"text-align: center;\"><\/td>\n<td style=\"text-align: left;\">The <a href=\"#possible-transstatusreason-values\">\n  <code>transStatus<\/code>\n<\/a> from the last <code>CRes<\/code> (Challenge Response) message or in the <code>RReq<\/code> (Results Request) sent after the shopper completes the challenge. If the transaction was frictionless there is no <code>RReq<\/code>, so omit this parameter.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>cavv<\/code><\/td>\n<td style=\"text-align: left;\">String<\/td>\n<td style=\"text-align: center;\"><\/td>\n<td style=\"text-align: left;\">The cardholder authentication value (base64 encoded, 20 bytes in a decoded form). This is the <code>authenticationValue<\/code> returned in the Authentication Response (<code>ARes<\/code>) for the <a href=\"\/pt\/online-payments\/3d-secure\/#frictionless-flow\">frictionless flow<\/a>, or the <code>RReq<\/code> for the <a href=\"\/pt\/online-payments\/3d-secure\/#challenge-flow\">challenge flow<\/a>.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>challengeCancel<\/code><\/td>\n<td style=\"text-align: left;\">String<\/td>\n<td style=\"text-align: center;\"><\/td>\n<td style=\"text-align: left;\">Indicator informing the Access Control Server (ACS) and the Directory Server (DS) that the authentication has been cancelled. See <a href=\"\/pt\/online-payments\/3d-secure\/api-reference#possible-challengecancel-values\">possible values<\/a>.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>directoryResponse<\/code><\/td>\n<td style=\"text-align: left;\">String<\/td>\n<td style=\"text-align: center;\"><\/td>\n<td style=\"text-align: left;\">The result of the initial authentication response. This is the <code>transStatus<\/code> from the <code>ARes<\/code>.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>dsTransID<\/code><\/td>\n<td style=\"text-align: left;\">String<\/td>\n<td style=\"text-align: center;\"><\/td>\n<td style=\"text-align: left;\">The unique transaction identifier assigned by the Directory Server to identify a single transaction.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>eci<\/code><\/td>\n<td style=\"text-align: left;\">String<\/td>\n<td style=\"text-align: center;\"><\/td>\n<td style=\"text-align: left;\">The electronic commerce indicator (ECI). This is a scheme specific indicator of the authentication result.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>riskScore<\/code><\/td>\n<td style=\"text-align: left;\">String<\/td>\n<td style=\"text-align: center;\"><img alt=\"\" src=\"\/user\/pages\/reuse\/3ds2-reuse-pages\/reference-mpidata\/conditionally-required.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/td>\n<td style=\"text-align: left;\"><strong>Use case<\/strong>: required for Cartes Bancaires transactions. <br> Risk score calculated by Directory Server (DS).<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>threeDSVersion<\/code><\/td>\n<td style=\"text-align: left;\">String<\/td>\n<td style=\"text-align: center;\"><\/td>\n<td style=\"text-align: left;\">The version of 3D Secure 2 used. Possible values: <ul><li markdown=\"1\"><strong>2.1.0<\/strong><\/li><li markdown=\"1\"><strong>2.2.0<\/strong><\/li><\/ul><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>transStatusReason<\/code><\/td>\n<td style=\"text-align: left;\">String<\/td>\n<td style=\"text-align: center;\"><\/td>\n<td style=\"text-align: left;\">Provides information on why the <code>transStatus<\/code> field has the specified value. See <a href=\"#possible-transstatusreason-values\">possible values<\/a>.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>tokenAuthenticationVerificationValue<\/code><\/td>\n<td style=\"text-align: left;\">String<\/td>\n<td style=\"text-align: center;\"><\/td>\n<td style=\"text-align: left;\">The network token authentication verification value (TAVV). This is the <a href=\"\/pt\/online-payments\/network-tokenization\">network token<\/a> cryptogram.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h3 id=\"possible-transstatusreason-values\"><code>transStatus<\/code> and <code>transStatusReason<\/code> values<\/h3>\n<p>You receive the <code>transStatus<\/code> value in the response of your payment request. This field indicates whether a transaction was authenticated, or whether additional verification is required.<\/p>\n<table>\n<thead>\n<tr>\n<th><code>transStatus<\/code> value<\/th>\n<th>Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td><span translate=\"no\"><strong>Y<\/strong><\/span><\/td>\n<td>Authentication \/ account verification successful.<\/td>\n<\/tr>\n<tr>\n<td><span translate=\"no\"><strong>I<\/strong><\/span><\/td>\n<td>Authentication \/ exemption granted by Issuer.<\/td>\n<\/tr>\n<tr>\n<td><span translate=\"no\"><strong>N<\/strong><\/span><\/td>\n<td>Not Authenticated \/ account not verified. Transaction denied.<\/td>\n<\/tr>\n<tr>\n<td><span translate=\"no\"><strong>U<\/strong><\/span><\/td>\n<td>Authentication \/ account verification could not be performed.<\/td>\n<\/tr>\n<tr>\n<td><span translate=\"no\"><strong>A<\/strong><\/span><\/td>\n<td>Authentication \/ verification was attempted but could not be verified.<\/td>\n<\/tr>\n<tr>\n<td><span translate=\"no\"><strong>C<\/strong><\/span><\/td>\n<td>Challenge Required. Additional authentication is required using a challenge.<\/td>\n<\/tr>\n<tr>\n<td><span translate=\"no\"><strong>R<\/strong><\/span><\/td>\n<td>Authentication \/ account verification rejected by the Issuer.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<p><div class=\"sc-notice info\"><div>This field is called <strong>3DS challenged<\/strong> in your <a href=\"https:\/\/ca-test.adyen.com\/\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Customer Area<\/a>.<\/div><\/div> The <code>transStatusReason<\/code> field informs you why the <code>transStatus<\/code> field has the specified value.<\/p>\n<table>\n<thead>\n<tr>\n<th><code>transStatusReason<\/code> value<\/th>\n<th>Scheme<\/th>\n<th>Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td><code>01<\/code><\/td>\n<td>All<\/td>\n<td>Card authentication failed.<\/td>\n<\/tr>\n<tr>\n<td><code>02<\/code><\/td>\n<td>All<\/td>\n<td>Unknown device.<\/td>\n<\/tr>\n<tr>\n<td><code>03<\/code><\/td>\n<td>All<\/td>\n<td>Unsupported device.<\/td>\n<\/tr>\n<tr>\n<td><code>04<\/code><\/td>\n<td>All<\/td>\n<td>Exceeds authentication frequency limit.<\/td>\n<\/tr>\n<tr>\n<td><code>05<\/code><\/td>\n<td>All<\/td>\n<td>Expired card.<\/td>\n<\/tr>\n<tr>\n<td><code>06<\/code><\/td>\n<td>All<\/td>\n<td>Invalid card number.<\/td>\n<\/tr>\n<tr>\n<td><code>07<\/code><\/td>\n<td>All<\/td>\n<td>Invalid transaction.<\/td>\n<\/tr>\n<tr>\n<td><code>08<\/code><\/td>\n<td>All<\/td>\n<td>No card record.<\/td>\n<\/tr>\n<tr>\n<td><code>09<\/code><\/td>\n<td>All<\/td>\n<td>Security failure.<\/td>\n<\/tr>\n<tr>\n<td><code>10<\/code><\/td>\n<td>All<\/td>\n<td>Stolen card.<\/td>\n<\/tr>\n<tr>\n<td><code>11<\/code><\/td>\n<td>All<\/td>\n<td>Suspected fraud.<\/td>\n<\/tr>\n<tr>\n<td><code>12<\/code><\/td>\n<td>All<\/td>\n<td>Transaction not permitted for cardholder.<\/td>\n<\/tr>\n<tr>\n<td><code>13<\/code><\/td>\n<td>All<\/td>\n<td>Cardholder not enrolled in service.<\/td>\n<\/tr>\n<tr>\n<td><code>14<\/code><\/td>\n<td>All<\/td>\n<td>Transaction timed out at ACS.<\/td>\n<\/tr>\n<tr>\n<td><code>15<\/code><\/td>\n<td>All<\/td>\n<td>Low confidence.<\/td>\n<\/tr>\n<tr>\n<td><code>16<\/code><\/td>\n<td>All<\/td>\n<td>Medium confidence.<\/td>\n<\/tr>\n<tr>\n<td><code>17<\/code><\/td>\n<td>All<\/td>\n<td>High confidence.<\/td>\n<\/tr>\n<tr>\n<td><code>18<\/code><\/td>\n<td>All<\/td>\n<td>Very high confidence.<\/td>\n<\/tr>\n<tr>\n<td><code>19<\/code><\/td>\n<td>All<\/td>\n<td>Exceeds ACS maximum challenges.<\/td>\n<\/tr>\n<tr>\n<td><code>20<\/code><\/td>\n<td>All<\/td>\n<td>Non-payment transaction not supported.<\/td>\n<\/tr>\n<tr>\n<td><code>21<\/code><\/td>\n<td>All<\/td>\n<td>3RI transaction not supported.<\/td>\n<\/tr>\n<tr>\n<td><code>22<\/code><\/td>\n<td>All<\/td>\n<td>ACS technical issue.<\/td>\n<\/tr>\n<tr>\n<td><code>23<\/code><\/td>\n<td>All<\/td>\n<td>Decoupled Authentication required by ACS but not requested by 3DS Requestor.<\/td>\n<\/tr>\n<tr>\n<td><code>24<\/code><\/td>\n<td>All<\/td>\n<td>3DS Requestor decoupled max expiry time exceeded.<\/td>\n<\/tr>\n<tr>\n<td><code>25<\/code><\/td>\n<td>All<\/td>\n<td>Decoupled Authentication was provided insufficient time to authenticate cardholder. ACS will not make attempt.<\/td>\n<\/tr>\n<tr>\n<td><code>26<\/code><\/td>\n<td>All<\/td>\n<td>Authentication attempted but not performed by the cardholder.<\/td>\n<\/tr>\n<tr>\n<td><code>80<\/code><\/td>\n<td>Visa<\/td>\n<td>Error connecting to ACS.<\/td>\n<\/tr>\n<tr>\n<td><code>80<\/code><\/td>\n<td>Mastercard<\/td>\n<td>Returned on all Data Only authentications.<\/td>\n<\/tr>\n<tr>\n<td><code>80<\/code><\/td>\n<td>American Express<\/td>\n<td>Safekey is not available for this type of card.<\/td>\n<\/tr>\n<tr>\n<td><code>81<\/code><\/td>\n<td>Visa<\/td>\n<td>ACS timed out.<\/td>\n<\/tr>\n<tr>\n<td><code>81<\/code><\/td>\n<td>Mastercard<\/td>\n<td>Challenge exemption accepted.<\/td>\n<\/tr>\n<tr>\n<td><code>82<\/code><\/td>\n<td>Visa<\/td>\n<td>Invalid response from ACS.<\/td>\n<\/tr>\n<tr>\n<td><code>82<\/code><\/td>\n<td>Mastercard<\/td>\n<td>Challenge Mandate requested but could not be performed.<\/td>\n<\/tr>\n<tr>\n<td><code>83<\/code><\/td>\n<td>Mastercard, Visa<\/td>\n<td>System Error response from ACS.<\/td>\n<\/tr>\n<tr>\n<td><code>84<\/code><\/td>\n<td>Mastercard, Visa<\/td>\n<td>Internal error while generating CAVV.<\/td>\n<\/tr>\n<tr>\n<td><code>85<\/code><\/td>\n<td>Visa<\/td>\n<td>VMID not eligible for requested program.<\/td>\n<\/tr>\n<tr>\n<td><code>86<\/code><\/td>\n<td>Visa<\/td>\n<td>Protocol version not supported by ACS<\/td>\n<\/tr>\n<tr>\n<td><code>87<\/code><\/td>\n<td>Visa<\/td>\n<td>Transaction is excluded from Attempts Processing (includes non- reloadable pre-paid cards and non-payments (NPA)).<\/td>\n<\/tr>\n<tr>\n<td><code>88<\/code><\/td>\n<td>Visa<\/td>\n<td>Requested program not supported by ACS.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h3 id=\"possible-challengecancel-values\"><code>challengeCancel<\/code> values<\/h3>\n<table>\n<thead>\n<tr>\n<th>Value<\/th>\n<th>Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td><code>00<\/code><\/td>\n<td>Data element is absent or value has been sent back with the key <code>challengeCancel<\/code>.<\/td>\n<\/tr>\n<tr>\n<td><code>01<\/code><\/td>\n<td>Cardholder selected <span translate=\"no\"><strong>Cancel<\/strong><\/span>.<\/td>\n<\/tr>\n<tr>\n<td><code>02<\/code><\/td>\n<td>3DS Requestor cancelled Authentication.<\/td>\n<\/tr>\n<tr>\n<td><code>03<\/code><\/td>\n<td>Transaction abandoned.<\/td>\n<\/tr>\n<tr>\n<td><code>04<\/code><\/td>\n<td>Transaction timed out at ACS \u2014 other timeouts.<\/td>\n<\/tr>\n<tr>\n<td><code>05<\/code><\/td>\n<td>Transaction timed out at ACS \u2014 first CReq not received by ACS.<\/td>\n<\/tr>\n<tr>\n<td><code>06<\/code><\/td>\n<td>Transaction error.<\/td>\n<\/tr>\n<tr>\n<td><code>07<\/code><\/td>\n<td>Unknown.<\/td>\n<\/tr>\n<tr>\n<td><code>08<\/code><\/td>\n<td>Transaction timed out at SDK.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h3>MPI data combinations<\/h3>\n<p>When you are <a href=\"\/pt\/online-payments\/3d-secure\/authorize-mpidata\/\">using authentication data from a third party to authorize payments with Adyen<\/a>, you send multiple values you receive to Adyen. You must make sure that the combination of the values you send are aligned with what Adyen expects.<\/p>\n<p>The possible combinations differ for each authentication flow. Cartes Bancaires does not use the ECI value, but it may be returned in some cases.<\/p>\n<table>\n<thead>\n<tr>\n<th>Authentication flow<\/th>\n<th><code>directoryResponse<\/code><\/th>\n<th><code>authenticationResponse<\/code><\/th>\n<th><code>eci<\/code><\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td>Challenge flow<\/td>\n<td><span translate=\"no\"><strong>C<\/strong><\/span><\/td>\n<td><span translate=\"no\"><strong>Y<\/strong><\/span><\/td>\n<td>Visa, Amex, JCB, CUB:  <span translate=\"no\"><strong>05<\/strong><\/span> <br> Mastercard, BCMC: <span translate=\"no\"><strong>02<\/strong><\/span> <br> Cartes Bancaires: optional<\/td>\n<\/tr>\n<tr>\n<td>Frictionless flow<\/td>\n<td><span translate=\"no\"><strong>Y<\/strong><\/span><\/td>\n<td><\/td>\n<td>Visa, Amex, JCB, CUB:  <span translate=\"no\"><strong>05<\/strong><\/span> <br> Mastercard, BCMC: <span translate=\"no\"><strong>02<\/strong><\/span> <br> Cartes Bancaires: optional<\/td>\n<\/tr>\n<tr>\n<td>Attempt<\/td>\n<td><span translate=\"no\"><strong>A<\/strong><\/span><\/td>\n<td><\/td>\n<td>Visa, Amex, JCB, CUB:  <span translate=\"no\"><strong>06<\/strong><\/span> <br> Mastercard, BCMC: <span translate=\"no\"><strong>02<\/strong><\/span> <br> Cartes Bancaires: optional<\/td>\n<\/tr>\n<tr>\n<td>3D Secure 2 exemption<\/td>\n<td><span translate=\"no\"><strong>I<\/strong><\/span> (all schemes) or <span translate=\"no\"><strong>Y<\/strong><\/span> (Cartes Bancaires<br> with <code>threeDSVersion<\/code>: <strong>2.1.0<\/strong>)<\/td>\n<td><\/td>\n<td>Visa, Amex, JCB, CUB:  <span translate=\"no\"><strong>07<\/strong><\/span> <br> Mastercard, BCMC: <span translate=\"no\"><strong>02<\/strong><\/span> <br> Cartes Bancaires: optional<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h3 id=\"adyen-emvco-map-mpidata\">Mapping Adyen parameters to EMVCo fields<\/h3>\n<p>The Adyen <code>mpiData<\/code> parameters map to the <a href=\"https:\/\/www.emvco.com\/emv-technologies\/3-d-secure\/\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">EMVCo specifications<\/a> as follows.<\/p>\n<table>\n<thead>\n<tr>\n<th style=\"text-align: left;\">Adyen parameter<\/th>\n<th style=\"text-align: left;\">EMVCo parameter<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td style=\"text-align: left;\"><code>authenticationValue<\/code><\/td>\n<td style=\"text-align: left;\"><code>authenticationValue<\/code><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>dsTransID<\/code><\/td>\n<td style=\"text-align: left;\"><code>dsTransID<\/code><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>eci<\/code><\/td>\n<td style=\"text-align: left;\"><code>eci<\/code><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>threeDSVersion<\/code><\/td>\n<td style=\"text-align: left;\"><code>messageVersion<\/code><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>threeDSServerTransID<\/code><\/td>\n<td style=\"text-align: left;\"><code>threeDSServerTransID<\/code><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>authenticationResponse<\/code><\/td>\n<td style=\"text-align: left;\"><code>transStatus<\/code> in <code>RReq<\/code><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>directoryResponse<\/code><\/td>\n<td style=\"text-align: left;\"><code>transStatus<\/code> in <code>ARes<\/code><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>challengeCancel<\/code><\/td>\n<td style=\"text-align: left;\"><code>challengeCancel<\/code><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h2 id=\"paymentmethod\">paymentMethod<\/h2>\n<p>The  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Checkout\/latest\/post\/payments#request-paymentMethod\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">paymentMethod<\/a> object, and its sub-fields below, are required for 3D Secure 2 transactions. If you are <a href=\"\/pt\/development-resources\/pci-dss-compliance-guide\">fully PCI compliant<\/a> you can <a href=\"\/pt\/payment-methods\/cards\/raw-card-data\/#make-a-payment\">pass the parameters for raw card<\/a> data instead.<\/p>\n<table>\n<thead>\n<tr>\n<th>Field<\/th>\n<th>Type<\/th>\n<th style=\"text-align: center;\">Required<\/th>\n<th>Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td><code>type<\/code><\/td>\n<td>String<\/td>\n<td style=\"text-align: center;\"><span class=\"hint--bottom\" data-hint=\"Required\" markdown=\"1\"><img style=\"width: 25px;\" alt=\"Required\" src=\"\/user\/pages\/reuse\/image-library\/01.icons\/required\/required.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/span><\/td>\n<td>Set to <strong>scheme<\/strong>.<\/td>\n<\/tr>\n<tr>\n<td><code>encryptedCardNumber<\/code><\/td>\n<td>String<\/td>\n<td style=\"text-align: center;\"><span class=\"hint--bottom\" data-hint=\"Required\" markdown=\"1\"><img style=\"width: 25px;\" alt=\"Required\" src=\"\/user\/pages\/reuse\/image-library\/01.icons\/required\/required.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/span><\/td>\n<td>The encrypted card number.<\/td>\n<\/tr>\n<tr>\n<td><code>encryptedExpiryMonth<\/code><\/td>\n<td>String<\/td>\n<td style=\"text-align: center;\"><span class=\"hint--bottom\" data-hint=\"Required\" markdown=\"1\"><img style=\"width: 25px;\" alt=\"Required\" src=\"\/user\/pages\/reuse\/image-library\/01.icons\/required\/required.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/span><\/td>\n<td>The encrypted card expiry month.<\/td>\n<\/tr>\n<tr>\n<td><code>encryptedExpiryYear<\/code><\/td>\n<td>String<\/td>\n<td style=\"text-align: center;\"><span class=\"hint--bottom\" data-hint=\"Required\" markdown=\"1\"><img style=\"width: 25px;\" alt=\"Required\" src=\"\/user\/pages\/reuse\/image-library\/01.icons\/required\/required.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/span><\/td>\n<td>The encrypted card expiry year.<\/td>\n<\/tr>\n<tr>\n<td><code>encryptedSecurityCode<\/code><\/td>\n<td>String<\/td>\n<td style=\"text-align: center;\"><span class=\"hint--bottom\" data-hint=\"Required\" markdown=\"1\"><img style=\"width: 25px;\" alt=\"Required\" src=\"\/user\/pages\/reuse\/image-library\/01.icons\/required\/required.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/span><\/td>\n<td>The encrypted card verification code.<\/td>\n<\/tr>\n<tr>\n<td><code>brand<\/code><\/td>\n<td>String<\/td>\n<td style=\"text-align: center;\"><span class=\"hint--bottom\" data-hint=\"Conditionally required\" markdown=\"1\"><img style=\"width: 25px;\" alt=\"Conditionally required\" src=\"\/user\/pages\/reuse\/image-library\/01.icons\/conditionally-required\/conditionally-required.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/span><\/td>\n<td><strong>Use case<\/strong>: required for Cartes Bancaires transactions. <br> The secondary brand of the card.<\/td>\n<\/tr>\n<tr>\n<td><code>holderName<\/code><\/td>\n<td>String<\/td>\n<td style=\"text-align: center;\"><span class=\"hint--bottom\" data-hint=\"Conditionally required\" markdown=\"1\"><img style=\"width: 25px;\" alt=\"Conditionally required\" src=\"\/user\/pages\/reuse\/image-library\/01.icons\/conditionally-required\/conditionally-required.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/span><\/td>\n<td><strong>Use case<\/strong>: required for Visa and JCB transactions. <br> The name of the cardholder. We recommend to include this field whenever available for higher authentication rates.<\/td>\n<\/tr>\n<tr>\n<td><code>threeDS2SdkVersion<\/code><\/td>\n<td>String<\/td>\n<td style=\"text-align: center;\"><span class=\"hint--bottom\" data-hint=\"Conditionally required\" markdown=\"1\"><img style=\"width: 25px;\" alt=\"Conditionally required\" src=\"\/user\/pages\/reuse\/image-library\/01.icons\/conditionally-required\/conditionally-required.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/span><\/td>\n<td><strong>Use case<\/strong>: required for native mobile integrations. <br> The 3D Secure 2 mobile SDK version. See our <a href=\"\/pt\/online-payments\/3d-secure\/native-3ds2\">integration guides<\/a> to learn how you can get the SDK version.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h2 id=\"threeds2requestdata\">threeDS2RequestData<\/h2>\n<p>The  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Checkout\/latest\/post\/payments#request-threeDS2RequestData\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">threeDS2RequestData<\/a> object contains additional request fields that are required for certain types of 3D Secure 2 integrations.<\/p>\n<table>\n<thead>\n<tr>\n<th>Field<\/th>\n<th>Type<\/th>\n<th>Required<\/th>\n<th>Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td><code>acquirerBIN<\/code><\/td>\n<td>String<\/td>\n<td><img alt=\"\" src=\"\/user\/pages\/reuse\/3ds2-reuse-pages\/reference-3ds2requestdata\/conditionally-required.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/td>\n<td><strong>Use case<\/strong>: required if you enrolled for 3D Secure 2 through a different acquirer or PSP and are performing the <a href=\"\/pt\/online-payments\/3d-secure\/standalone-authentication\">authentication-only<\/a> flow. <br> The acquiring BIN enrolled for 3D Secure 2. This string should match the value that you will use in the authorization.<\/td>\n<\/tr>\n<tr>\n<td><code>acquirerMerchantID<\/code><\/td>\n<td>String<\/td>\n<td><img alt=\"\" src=\"\/user\/pages\/reuse\/3ds2-reuse-pages\/reference-3ds2requestdata\/conditionally-required.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/td>\n<td><strong>Use case<\/strong>: required if you enrolled for 3D Secure 2 through a different acquirer or PSP and are performing the <a href=\"\/pt\/online-payments\/3d-secure\/standalone-authentication\">authentication-only<\/a> flow. <br> The authorisation merchant ID enrolled for 3D Secure 2. This string should match the value that you will use in the authorization.<\/td>\n<\/tr>\n<tr>\n<td><code>addrMatch<\/code><\/td>\n<td>String<\/td>\n<td><\/td>\n<td>Indicates if the shipping address and billing address of the shopper match. Possible values: <ul><li markdown=\"1\"><span translate=\"no\"><strong>Y<\/strong><\/span>: the addresses match.<\/li><li markdown=\"1\"><span translate=\"no\"><strong>N<\/strong><\/span>: the addresses do not match.<\/li><\/ul><\/td>\n<\/tr>\n<tr>\n<td><code>challengeIndicator<\/code>  <div data-component-wrapper=\"tag\">\n    <tag :variant=&quot;warning&quot;>\n        Deprecated in Checkout API v68\n    <\/tag>\n<\/div>\n<\/td>\n<td>String<\/td>\n<td><img alt=\"\" src=\"\/user\/pages\/reuse\/3ds2-reuse-pages\/reference-3ds2requestdata\/conditionally-required.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/td>\n<td><strong>Use case<\/strong>: required to manually request exemptions to the challenge through the API request, or for Cartes Bancaires transactions. <br>  The preference for receiving a challenge from the issuer. Possible values:<ul><li markdown=\"1\"><span translate=\"no\"><strong>noPreference<\/strong><\/span><\/li><li markdown=\"1\"><span translate=\"no\"><strong>requestNoChallenge<\/strong><\/span><\/li><li markdown=\"1\"><span translate=\"no\"><strong>requestChallenge<\/strong><\/span><\/li><li markdown=\"1\"><span translate=\"no\"><strong>requestChallengeAsMandate<\/strong><\/span><\/li><\/ul>   <br> On Checkout API v68 or later, use <code>threeDSRequestorChallengeInd<\/code> instead.<\/td>\n<\/tr>\n<tr>\n<td><code>deviceRenderOptions.sdkInterface<\/code><\/td>\n<td>String<\/td>\n<td><\/td>\n<td>Only for app-based integrations. The supported SDK interface types. Defaults to <span translate=\"no\"><strong>native<\/strong><\/span>. Possible values:<ul><li markdown=\"1\"><span translate=\"no\"><strong>native<\/strong><\/span><\/li><li markdown=\"1\"><span translate=\"no\"><strong>html<\/strong><\/span><\/li><li markdown=\"1\"><span translate=\"no\"><strong>both<\/strong><\/span><\/li><\/ul><\/td>\n<\/tr>\n<tr>\n<td><code>deviceRenderOptions.sdkUiType<\/code><\/td>\n<td>Array<\/td>\n<td><\/td>\n<td>Only for app-based integrations. The string array of UI types supported for displaying specific challenges. Defaults to all values. Possible values:<ul><li markdown=\"1\"><span translate=\"no\"><strong>text<\/strong><\/span><\/li><li markdown=\"1\"><span translate=\"no\"><strong>singleSelect<\/strong><\/span><\/li><li markdown=\"1\"><span translate=\"no\"><strong>multiSelect<\/strong><\/span><\/li><li markdown=\"1\"><span translate=\"no\"><strong>outOfBand<\/strong><\/span><\/li><li markdown=\"1\"><span translate=\"no\"><strong>otherHtml<\/strong><\/span><\/li><\/ul><\/td>\n<\/tr>\n<tr>\n<td><code>mcc<\/code><\/td>\n<td>String<\/td>\n<td><img alt=\"\" src=\"\/user\/pages\/reuse\/3ds2-reuse-pages\/reference-3ds2requestdata\/conditionally-required.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/td>\n<td><strong>Use case<\/strong>: required if you enrolled for 3D Secure 2 through a different acquirer or PSP and are performing the <a href=\"\/pt\/online-payments\/3d-secure\/standalone-authentication\">authentication-only<\/a> flow. <br> The four-digit code with which the <code>acquirerMerchantID<\/code> is registered at the scheme.<\/td>\n<\/tr>\n<tr>\n<td><code>merchantName<\/code><\/td>\n<td>String<\/td>\n<td><img alt=\"\" src=\"\/user\/pages\/reuse\/3ds2-reuse-pages\/reference-3ds2requestdata\/conditionally-required.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/td>\n<td><strong>Use case<\/strong>: required if you enrolled for 3D Secure 2 through a different acquirer or PSP and are performing the <a href=\"\/pt\/online-payments\/3d-secure\/standalone-authentication\">authentication-only<\/a> flow, or if you are enrolled with Adyen, and want to override the merchant name configured on your account.  <br>The merchant name that the issuer presents to the shopper if they get a challenge.  We recommend to use the same value that you will use in the authorization. <br> <strong>Format<\/strong>: <ul><li markdown=\"1\">Maximum length: 40 characters<\/li><\/ul><\/td>\n<\/tr>\n<tr>\n<td><code>messageVersion<\/code><\/td>\n<td>String<\/td>\n<td><\/td>\n<td>The 3D Secure 2 protocol version.<\/td>\n<\/tr>\n<tr>\n<td><code>notificationURL<\/code><\/td>\n<td>String<\/td>\n<td><img alt=\"\" src=\"\/user\/pages\/reuse\/3ds2-reuse-pages\/reference-3ds2requestdata\/conditionally-required.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/td>\n<td><strong>Use case<\/strong>: required for <code>deviceChannel<\/code> <span translate=\"no\"><strong>browser<\/strong><\/span> or if you built your own implementation with <code>channel<\/code> <span translate=\"no\"><strong>Web<\/strong><\/span>. <br> The URL where the Challenge Response value will be sent.<\/td>\n<\/tr>\n<tr>\n<td><code>sdkAppID<\/code><\/td>\n<td>String<\/td>\n<td><img alt=\"\" src=\"\/user\/pages\/reuse\/3ds2-reuse-pages\/reference-3ds2requestdata\/conditionally-required.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/td>\n<td><strong>Use case<\/strong>: required for <code>deviceChannel<\/code> <span translate=\"no\"><strong>app<\/strong><\/span>. <br> The <code>sdkAppID<\/code> value as received from the 3D Secure 2 SDK.<\/td>\n<\/tr>\n<tr>\n<td><code>sdkEncData<\/code><\/td>\n<td>String<\/td>\n<td><img alt=\"\" src=\"\/user\/pages\/reuse\/3ds2-reuse-pages\/reference-3ds2requestdata\/conditionally-required.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/td>\n<td><strong>Use case<\/strong>: required for <code>deviceChannel<\/code> <span translate=\"no\"><strong>app<\/strong><\/span>. <br> The <code>sdkEncData<\/code> value as received from the 3D Secure 2 SDK.<\/td>\n<\/tr>\n<tr>\n<td><code>sdkEphemPubKey<\/code><\/td>\n<td>Object<\/td>\n<td><img alt=\"\" src=\"\/user\/pages\/reuse\/3ds2-reuse-pages\/reference-3ds2requestdata\/conditionally-required.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/td>\n<td><strong>Use case<\/strong>: required for <code>deviceChannel<\/code> <span translate=\"no\"><strong>app<\/strong><\/span>. <br> The <code>sdkEphemPubKey<\/code> value as received from the 3D Secure 2 SDK. This object includes the <code>crv<\/code>, <code>kty<\/code>, <code>x<\/code>, and <code>y<\/code>.<\/td>\n<\/tr>\n<tr>\n<td><code>sdkMaxTimeout<\/code><\/td>\n<td>Integer<\/td>\n<td><\/td>\n<td>Only for app-based integrations. The maximum amount of time in minutes for the 3D Secure 2 authentication process. Defaults to <strong>60<\/strong> minutes.<\/td>\n<\/tr>\n<tr>\n<td><code>sdkReferenceNumber<\/code><\/td>\n<td>String<\/td>\n<td><img alt=\"\" src=\"\/user\/pages\/reuse\/3ds2-reuse-pages\/reference-3ds2requestdata\/conditionally-required.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/td>\n<td><strong>Use case<\/strong>: required for app-based integrations. <br> The <code>sdkReferenceNumber<\/code> value as received from the 3D Secure 2 SDK.<\/td>\n<\/tr>\n<tr>\n<td><code>sdkTransID<\/code><\/td>\n<td>String<\/td>\n<td><img alt=\"\" src=\"\/user\/pages\/reuse\/3ds2-reuse-pages\/reference-3ds2requestdata\/conditionally-required.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/td>\n<td><strong>Use case<\/strong>: required for app-based integrations. <br> The <code>sdkTransID<\/code> value as received from the 3D Secure 2 SDK.<\/td>\n<\/tr>\n<tr>\n<td><code>threeDSCompInd<\/code><\/td>\n<td>String<\/td>\n<td><\/td>\n<td>The completion indicator for the <code>threeDSMethodUrl<\/code> fingerprinting.<\/td>\n<\/tr>\n<tr>\n<td><code>threeDSRequestorChallengeInd<\/code><\/td>\n<td>String<\/td>\n<td><img alt=\"\" src=\"\/user\/pages\/reuse\/3ds2-reuse-pages\/reference-3ds2requestdata\/conditionally-required.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/td>\n<td><strong>Use case<\/strong>: required if you want to manually request exemptions to the challenge through the API request, or for Cartes Bancaires transactions. <br> Indicates whether a challenge is requested for this transaction. Possible values: <ul><li markdown=\"1\"><span translate=\"no\"><strong>01<\/strong><\/span>: no preference<\/li><li markdown=\"1\"><span translate=\"no\"><strong>02<\/strong><\/span>: no challenge requested<\/li>  <li markdown=\"1\"><span translate=\"no\"><strong>03<\/strong><\/span>: challenge requested by the 3D Secure requestor<\/li> <li markdown=\"1\"><span translate=\"no\"><strong>04<\/strong><\/span>: challenge requested due to a mandate<\/li> <li markdown=\"1\"><span translate=\"no\"><strong>05<\/strong><\/span>: no challenge requested due to a performed risk analysis.<\/li> <li markdown=\"1\"><span translate=\"no\"><strong>06<\/strong><\/span>: <a href=\"\/pt\/online-payments\/3d-secure\/data-only\/\">Data-only<\/a> flow.<\/li><\/ul><\/td>\n<\/tr>\n<tr>\n<td><code>threeDSRequestorID<\/code><\/td>\n<td>String<\/td>\n<td><img alt=\"\" src=\"\/user\/pages\/reuse\/3ds2-reuse-pages\/reference-3ds2requestdata\/conditionally-required.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/td>\n<td><strong>Use case<\/strong>: required for Visa payments if you enrolled for 3D Secure 2 through a different acquirer or PSP and are performing the <a href=\"\/pt\/online-payments\/3d-secure\/standalone-authentication\">authentication-only<\/a> flow. <br> The unique requestor ID assigned by the Directory Server when you enrol for 3D Secure 2.<\/td>\n<\/tr>\n<tr>\n<td><code>threeDSRequestorName<\/code><\/td>\n<td>String<\/td>\n<td><img alt=\"\" src=\"\/user\/pages\/reuse\/3ds2-reuse-pages\/reference-3ds2requestdata\/conditionally-required.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/td>\n<td><strong>Use case<\/strong>: required for Visa payments if you enrolled for 3D Secure 2 through a different acquirer or PSP and are performing the <a href=\"\/pt\/online-payments\/3d-secure\/standalone-authentication\">authentication-only<\/a> flow. <br> The unique requestor name assigned by the Directory Server when you enrol for 3D Secure 2.<\/td>\n<\/tr>\n<tr>\n<td><code>threeDSRequestorURL<\/code><\/td>\n<td>String<\/td>\n<td><\/td>\n<td>The URL of the (customer service) website that will be shown to the shopper in case of technical errors during the 3D Secure 2 process.<\/td>\n<\/tr>\n<tr>\n<td><code>transactionType<\/code><\/td>\n<td>String<\/td>\n<td><img alt=\"\" src=\"\/user\/pages\/reuse\/3ds2-reuse-pages\/reference-3ds2requestdata\/optional.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/td>\n<td>The type of transaction being authenticated. Highly recommended for Brazil. Possible values:<ul><li markdown=\"1\"><span translate=\"no\"><strong>goodsOrServicePurchase<\/strong><\/span><\/li><li markdown=\"1\"><span translate=\"no\"><strong>checkAcceptance<\/strong><\/span><\/li><li markdown=\"1\"><span translate=\"no\"><strong>accountFunding<\/strong><\/span><\/li><li markdown=\"1\"><span translate=\"no\"><strong>quasiCashTransaction<\/strong><\/span><\/li><li markdown=\"1\"><span translate=\"no\"><strong>prepaidActivationAndLoad<\/strong><\/span><\/li><\/ul> Supported from <strong>v50<\/strong> and later of Checkout API.<\/td>\n<\/tr>\n<tr>\n<td><code>homePhone<\/code>,<br> <code>workPhone<\/code> or<br> <code>mobilePhone<\/code><\/td>\n<td>String<\/td>\n<td><img alt=\"\" src=\"\/user\/pages\/reuse\/3ds2-reuse-pages\/reference-3ds2requestdata\/conditionally-required.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/td>\n<td><strong>Use case<\/strong>: required for Visa and JCB payments if you did not include the <a href=\"#3d-secure-2-additional-data-objects\"><code>shopperEmail<\/code> parameter<\/a>, and did not provide the phone number in  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Checkout\/latest\/post\/payments#request-telephoneNumber\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">telephoneNumber<\/a>. <br>  A phone number for the shopper. <strong>Format<\/strong>: The phone number must include a country code (1-3 digits), followed by the number (4-15 digits). <br>  <strong>Example<\/strong>: <span translate=\"no\"><strong>+4912345678901<\/strong><\/span> <div class=\"sc-notice note\"><div> If the value you provide does not follow the guidelines, we drop the value and do not submit it for authentication. <\/div><\/div><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h2 id=\"payload-structure\">Challenge flow objects<\/h2>\n<p>When the 3D Secure 2 authentication has to go through the fingerprint or challenge flows, you initialize the flows using the following objects. The Component returns the <code>fingerprint<\/code> or the <code>challengeResult<\/code> that you need to pass when you submit the authentication result.<\/p>\n<table>\n<thead>\n<tr>\n<th>Field<\/th>\n<th>Type<\/th>\n<th>Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td><code>threeds2.fingerprintToken<\/code><\/td>\n<td>Base64url encoded string<\/td>\n<td>Required to initialize the device fingerprinting process. This contains the following parameters: <ul><li markdown=\"1\"><code>threeDSMethodNotificationURL<\/code><\/li><li markdown=\"1\"><code>threeDSMethodUrl<\/code><\/li><li markdown=\"1\"><code>threeDSServerTransID<\/code><\/li><\/ul><\/td>\n<\/tr>\n<tr>\n<td><code>threeds2.challengeToken<\/code><\/td>\n<td>Base64url encoded string<\/td>\n<td>Required to initialize the challenge flow. This contains the following parameters: <ul><li markdown=\"1\"><code>acsReferenceNumber<\/code><\/li><li markdown=\"1\"><code>acsTransID<\/code><\/li><li markdown=\"1\"><code>acsURL<\/code><\/li><li markdown=\"1\"><code>messageVersion<\/code><\/li><li markdown=\"1\"><code>threeDSNotificationURL<\/code><\/li><li markdown=\"1\"><code>threeDSServerTransID<\/code><\/li><\/ul><\/td>\n<\/tr>\n<tr>\n<td> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Checkout\/latest\/post\/payments\/details#request-details-threeds2-fingerprint\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">threeds2.fingerprint<\/a><\/td>\n<td>Base64 encoded string<\/td>\n<td>Returned by the Component after the challenge flow. This contains the following parameters:<ul><li markdown=\"1\"><code>threeDSCompInd<\/code><\/li><\/ul> Pass this in the  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Checkout\/latest\/post\/payments\/details\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">\/payments\/details<\/a> request.<\/td>\n<\/tr>\n<tr>\n<td> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Checkout\/latest\/post\/payments\/details#request-details-threeds2-challengeResult\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">threeds2.challengeResult<\/a><\/td>\n<td>Base64 encoded string<\/td>\n<td>Returned by the Component after the challenge flow. This contains the following parameters: <ul><li markdown=\"1\"><code>transStatus<\/code><\/li><\/ul>  Pass this in the  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Checkout\/latest\/post\/payments\/details\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">\/payments\/details<\/a> request.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>","url":"https:\/\/docs.adyen.com\/pt\/online-payments\/3d-secure\/api-reference","articleFields":{"description":"Learn about parameters that you can use in your 3D Secure 2 request.","feedback_component":true,"id":"47486123","type":"page","_expandable":{"operations":""},"status":"current","last_edit_on":"12-07-2023 14:00","filters_component":false,"page_id":"346b1513-5c8f-4625-9a50-70fc219238e2","decision_tree":"[]"},"algolia":{"url":"https:\/\/docs.adyen.com\/pt\/online-payments\/3d-secure\/api-reference","title":"3D Secure 2 API reference","content":"For 3D Secure 2, you include additional parameters in your payment requests that provide additional information to authenticate your shoppers. You include these parameters when you make a request to one of the following endpoints:\n\n\n \/payments\n\n\n \/payments\/details\n\n\n \/sessions\n\n\nThis page describes payload structures and objects for  Checkout API v41 or later. If you are using a classic integration, see\u00a03D Secure 2 classic integration.\nParameter types\nThere are various parameters you can include in your requests for 3D Secure 2 authentication. The tables on this page specify the parameters that are required, conditionally required, recommended, and optional to include in your requests.\n\n\n\nIcon\nType\nDescription\n\n\n\n\n\nRequired\nParameters that are required to complete 3D Secure 2 authentication.\n\n\n\nConditionally required\nParameters that are required for particular setups, or issuers and card schemes.\n\n\n\nRecommended\nParameters that are not required to send in your requests, but including them may increase the authentication performance.\n\n\n\nOptional\nParameters that map to a field in the EMVCo Authentication Response (Areq), but are optional to include in your requests.\n\n\n\n3D Secure 2 objects\nIn addition to the regular fields you provide in your payment requests, we recommend that you provide all available information to increase the likelihood of achieving a frictionless flow and a higher authorisation rate.\nSome of these objects are mandatory for some issuers and card schemes, and not providing them in your payment request can result in a failed authentication. Some fields have sub-fields where you can, or need to, provide more information.\n\n\n\nObject\nRequired\nDescription\n\n\n\n\n accountInfo\n\nShopper account information for 3D Secure 2. See the reference to learn its sub-fields.\n\n\n authenticationData\n\nUse case: required for certain 3D Secure 2 setups.  The data for the 3D secure 2 authentication. See the reference to learn its sub-fields.\n\n\n billingAddress\n\nThe address where to send the invoice. We recommend to include it in your requests when available to improve authentication performance See the reference to learn its required sub-fields.\n\n\n browserInfo\n\nThe shopper's browser information.  See the reference to learn its sub-fields and the requirements depending on your integration type.\n\n\n channel\n\nThe platform where a payment transaction takes place. Possible values: WebiOSAndroid\n\n\n deliveryAddress\n\nThe address where the purchased goods must be delivered. Include this in your request whenever available. See the reference to learn about its required sub-fields.\n\n\n installments\n\nIf you want to split the payment into installments, include this object to specify the installment settings. See the reference to learn about its required sub-fields.\n\n\n merchantRiskIndicator\n\nAdditional risk fields for 3D Secure 2. Include this in your request whenever available. See the reference to learn about its sub-fields.\n\n\n mpiData\n\nUse case: required if you are making a request to authorize a payment using third-party authentication data from another 3D Secure 2 provider.  This is the authentication data produced by a merchant plug-in (MPI). See the reference to learn its required sub-fields.\n\n\n origin\n\nUse case: required for browser-based (channel: Web) transactions.  The origin URL of the page where you are rendering the Drop-in\/Component. When this field is not set, or set incorrectly, the 3D Secure 2 action can not be handled correctly.  Format: Maximum characters: 80Do not include subdirectories and a trailing slash. Example: If you are rendering on https:\/\/your-company.example.com\/checkout\/payment, set to https:\/\/your-company.example.com.\n\n\n paymentMethod\n\nThe type and required details for a card payment method. See the reference to learn about its required sub-fields.\n\n\n telephoneNumber\n\nUse case: required for Visa and JCB transactions if you did not include the shopperEmail field. The shopper's phone number. To be more specific, you can use the mobilePhone, homePhone, and workPhone fields in the threeDS2RequestData object.  Format: The phone number must include a plus sign (+) and a country code (1-3 digits), followed by the number (4-15 digits).   Example: +4912345678901  If the value you provide does not follow the guidelines, we drop the value and do not submit it for authentication. \n\n\n returnUrl\n\nThe URL where the shopper is redirected back to after completing authentication to support cases where the payment is routed to the 3D Secure 2 redirect flow. See our integration guides to learn how to set this URL depending on your platform.\n\n\n scaExemption\n\nUse case: required if you want to request exemptions through the API request, or when making a Cartes Bancaires transaction. We do not recommend to use this field, because it overrides our exemption logic.  The exemption type that you want to request for the particular transaction.  Possible values:lowValuesecureCorporate trustedBeneficiarytransactionRiskAnalysis\n\n\n shopperEmail\n\nUse case: required for Visa and JCB transactions; if you don't include this, you have to send the phone number in  telephoneNumber. We strongly recommend to include the email address for all transactions.  The cardholder's email address.\n\n\n shopperIP\n\nUse case: required for Visa and JCB transactions for all web and mobile integrations. You must include shopperIP for native mobile integrations to support cases where the transaction is routed to the redirect flow.  We recommend to include this field for all transactions, because it is used in a number of risk checks.    The IP address of the shopper.\n\n\n socialSecurityNumber\n\nThe shopper's CPF or CNPJ number. We strongly recommend that you include this for shoppers in Brazil. Supported from v50 and later of our API.\n\n\n threeDS2RequestData\n\nUse case: required for certain 3D Secure 2 setups. See the reference to learn about its required sub-fields depending on integration type.\n\n\n\naccountInfo\nThe  accountInfo object is not required, but we recommend to include it in your requests to increase the chances of achieving the frictionless flow.\n\n\n\nField\nType\nRequired\nDescription\n\n\n\n\naccountAgeIndicator\nString\n\nIndicator for the length of time since this shopper account was created. Possible values: notApplicablethisTransactionlessThan30Daysfrom30To60DaysmoreThan60Days\n\n\naccountChangeDate\nString\n\nDate when the shopper's account was last changed. Format: ISO 8601 YYYY-MM-DDThh:mm:ssTZD Example: 2017-07-17T13:42:40+01:00\n\n\naccountChangeIndicator\nString\n\nIndicator for when the shopper's account was last changed. Possible values: thisTransactionlessThan30Daysfrom30To60DaysmoreThan60Days\n\n\naccountCreationDate\nString\n\nDate when the shopper's account was created. Format: ISO 8601 YYYY-MM-DDThh:mm:ssTZD Example: 2017-07-17T13:42:40+01:00\n\n\naccountType\nString\n\nThe type of the shopper's account. For example, for a multi-account card product. Possible values: notApplicablecreditdebit\n\n\naddCardAttemptsDay\nInteger\n\nNumber of attempts the shopper made to add a card to their account in the last day. Maximum value: 999\n\n\npasswordChangeDate\nString\n\nDate when the shopper last changed their password. Format: ISO 8601 YYYY-MM-DDThh:mm:ssTZD Example: 2017-07-17T13:42:40+01:00\n\n\npasswordChangeIndicator\nString\n\nIndicator for when the shopper's account password was last changed. Possible values: thisTransactionlessThan30Daysfrom30To60DaysmoreThan60Days\n\n\npurchasesLast6Months\nInteger\n\nNumber of purchases in the last 6 months. Maximum value: 9999\n\n\npastTransactionsDay\nInteger\n\nNumber of transactions from this shopper in the past 24 hours. Maximum value: 999\n\n\npastTransactionsYear\nInteger\n\nNumber of transactions from this shopper in the past year. Maximum value: 999\n\n\npaymentAccountAge\nString\n\nDate this payment method was added to the shopper's account. Format: ISO 8601 YYYY-MM-DDThh:mm:ssTZD Example: 2017-07-17T13:42:40+01:00\n\n\npaymentAccountIndicator\nString\n\nIndicator for the length of time since this payment method was added to the shopper's account. Possible values: notApplicablethisTransactionlessThan30Daysfrom30To60DaysmoreThan60Days\n\n\ndeliveryAddressUsageDate\nString\n\nDate when the selected delivery address was first used with the 3DS Requestor. Format: ISO 8601 YYYY-MM-DDThh:mm:ssTZD Example: 2017-07-17T13:42:40+01:00\n\n\ndeliveryAddressUsageIndicator\nString\n\nIndicator for when this delivery address was first used with the 3DS Requestor. Possible values: thisTransactionlessThan30Daysfrom30To60DaysmoreThan60Days\n\n\nsuspiciousActivity\nBoolean\n\nWhether suspicious activity was recorded on this account.\n\n\nhomePhone  \n    \n        Deprecated in Checkout API v68\n    \n\n\nString\n\nUse \n  threeDSRequestData.homePhone\n instead. Shopper's home phone number, including the country code.\n\n\nmobilePhone \n    \n        Deprecated in Checkout API v68\n    \n\n\nString\n\nUse \n  threeDSRequestData.mobilePhone\n instead.  Shopper's mobile phone number, including the country code.\n\n\nworkPhone      \n    \n        Deprecated in Checkout API v68\n    \n\n\nString\n\nUse \n  threeDSRequestData.workPhone\n instead.  Shopper's work phone number, including the country code.\n\n\n\nMapping Adyen parameters to EMVCo fields\nThe Adyen accountInfo parameters map to the EMVCo specifications as follows.\n\n\n\nAdyen parameter\nEMVCo parameter\n\n\n\n\naccountAgeIndicator\nchAccAgeInd\n\n\naccountChangeDate\nchAccDate\n\n\naccountChangeIndicator\nchAccChangeInd\n\n\naccountCreationDate\nchAccDate\n\n\npasswordChangeDate\nchAccPwChange\n\n\npasswordChangeIndicator\nchAccPwChangeInd\n\n\npurchasesLast6Months\nnbPurchaseAccount\n\n\naddCardAttemptsDay\nprovisionAttemptsDay\n\n\npastTransactionsDay\ntxnActivityDay\n\n\npastTransactionsYear\ntxnActivityYear\n\n\npaymentAccAge\npaymentAccountAge\n\n\npaymentAccountIndicator\npaymentAccInd\n\n\ndeliveryAddressUsageDate\nshipAddressUsage\n\n\ndeliveryAddressUsageIndicator\nshipAddressUsageInd\n\n\n\nauthenticationData\nThe  authenticationData object contains sub-fields that are required to include for certain 3D Secure 2 authentication scenarios.\n\n\n\nField\nType\nRequired\nDescription\n\n\n\n\nauthenticationOnly\nBoolean\n\nUse case: required to trigger standalone authentication.  When set to true, you only perform the 3D Secure 2 authentication, and will not proceed to the payment authorization. The default value is false.\n\n\nattemptAuthentication\nString\n\nIndicates whether to attempt 3D Secure 2 authentication for a transaction. We do not recommend to use this field. This overrides your Dynamic 3D Secure settings. Possible values: always: attempt 3D Secure 2.never: do not attempt 3D Secure 2. If regulations require authentication, the transaction gets declined.\n\n\nthreeDSRequestData.challengeWindowSize\nString\n\nThe size of the challenge window displayed to the shopper in the challenge flow. Possible values: 01: ['250px', '400px']02: ['390px', '400px']03: ['500px', '600px']04: ['600px', '400px']05: ['100%', '100%']\n\n\nthreeDSRequestData.dataOnly  \n    \n        Available on Checkout API v69\n    \n\n\nString\n\nUse case: required to trigger the data-only flow.  When set to true, forces the 3D Secure 2 data-only flow for all transactions where it is possible.  If you are using Checkout API v68 or earlier, use the additionalData.threeDSDataOnly field instead.\n\n\nthreeDSRequestData.nativeThreeDS\nString\n\nUse case: required to trigger the native flow when using the  \/payments endpoint, or to trigger the redirect flow when using the  \/sessions endpoint.  Indicates if native 3D Secure 2 should be used when available. Adyen can still select to fallback to the redirect flow to optimize authorization rates and improve the shopper's experience. Possible values: preferred: use native 3D Secure 2 when available.disabled: only use the redirect 3D Secure 2 flow.\n\n\nthreeDSRequestData.threeDSVersion\nString\n\nThe version of 3D Secure 2 to use. Possible values: 2.1.02.2.0\n\n\n\nbillingAddress\nThe  billingAddress object is not required, but we recommend to include it in your requests when available to improve authentication performance. This object includes some required sub-fields.\nWhen using our Drop-in\/Components, the billing address is returned in an event. For example, on web integrations, this is the state.data.billingAddress object from the onSubmit event.\n\n\n\nField\nType\nRequired\nDescription\n\n\n\n\ncity\nString\n\nThe name of the city.\n\n\ncountry\nString\n\nThe country code. Format: the two-letter ISO-3166-1 alpha-2 country code. Exception: QZ (Kosovo).\n\n\nhouseNumberOrName\nString\n\nThe number or name of the house.\n\n\npostalCode\nString\n\nThe postal code consisting of a maximum of five digits for an address in the US, or a maximum of ten characters for an address in all other countries\/regions.\n\n\nstateOrProvince\nString\n\nUse case: required for addresses in the US and Canada.  The state or province code of the billing address as defined in ISO 3166-2.  Example: CA in US, or ON in Canada.\n\n\nstreet\nString\n\nThe name of the street.\n\n\n\nbrowserInfo\nFor web integrations  ( channel: Web): the full object, except javaScriptEnabled, is required.\nFor mobile integrations ( channel: iOS\/Android): the object is not required but recommended to support cases where the payment is routed to 3D Secure 2 redirect.\n\n\n\nField\nType\nRequired\nDescription\n\n\n\n\nacceptHeader\nString\n\nThe accept header value of the shopper's browser.\n\n\ncolorDepth\nInt\n\nUse case: web integrations.  The color depth of the shopper's browser in bits per pixel. Use the browser's screen.colorDepth property to obtain the value. Accepted values: 1, 4, 8, 15, 16, 24, 32, or 48 bit.\n\n\njavaEnabled\nBoolean\n\nUse case: web integrations.  Boolean value indicating if the shopper's browser is able to execute Java.\n\n\njavaScriptEnabled\nBoolean\n\nBoolean value indicating if the shopper's browser is able to execute JavaScript. If not present, the default value is true.\n\n\nlanguage\nString\n\nUse case: web integrations.  The name of the browser language used by the shopper. This is the navigator.language value of the shopper's browser as defined in IETF BCP 47.  Examples: nl-NL, fr-FR, en-US.\n\n\nscreenHeight\nInt\n\nUse case: web integrations.  The pixel height of the shopper's screen.\n\n\nscreenWidth\nInt\n\nUse case: web integrations.   The pixel width of the shopper's screen.\n\n\ntimeZoneOffset\nString\n\nUse case: web integrations.  Time difference between UTC time and the shopper's browser local time, in minutes.  Example: -120\n\n\nuserAgent\nString\n\nThe user agent value of the shopper's browser.\n\n\n\ndeliveryAddress\nInclude the  deliveryAddress object in your request if you want to submit the shopper's delivery address. If you include this object in your request, provide the required fields.\n\n\n\nField\nType\nRequired\nDescription\n\n\n\n\ncity\nString\n\nThe name of the city.\n\n\ncountry\nString\n\nThe country code. Format: the two-letter ISO-3166-1 alpha-2 country code. Exception: QZ (Kosovo).\n\n\nhouseNumberOrName\nString\n\nThe number or name of the house.\n\n\npostalCode\nString\n\nThe postal code consisting of a maximum of five digits for an address in the US, or a maximum of ten characters for an address in all other countries\/regions.\n\n\nstateOrProvince\nString\n\nUse case: required for addresses in the US and Canada.  The state or province code of the billing address as defined in ISO 3166-2.  Example: CA in US, or ON in Canada.\n\n\nstreet\nString\n\nThe name of the street.\n\n\n\ninstallments\nInclude the  installments object in your request when you want to split the payment into installments. If you include this object in your request, some sub-fields are required.\n\n\n\nField\nType\nRequired\nDescription\n\n\n\n\nvalue\nInteger\n\nThe number of installments. For Mexico, the value can be 0, for other countries, the value must be greater than zero. See installment options in supported countries\/regions for possible values. Usually, the acquirer sets the maximum allowed number of installments. For example, it may not be possible to split a payment in more than 24 installments.\n\n\nextra\nInteger\n\nThe bonus percentage, refund percentage, or if the transaction is completed with a Buy Now Pay Later payment method for transactions processed in Mexico.\n\n\nplan\nString\n\nUse case: required for installments in Japan, and Mexico. The installment plan. Possible values: regularrevolvingbonus The default value is regular.\n\n\n\nmerchantRiskIndicator\nThe  merchantRiskIndicator object is not required, but we recommend to include it in your requests to increase the chances of achieving the frictionless flow.\n\n\n\nField\nType\nRequired\nDescription\n\n\n\n\naddressMatch\nBoolean\n\nWhether the chosen delivery address is identical to the billing address.\n\n\ndeliveryEmail \n    \n        Deprecated in Checkout API v68\n    \n\n\nString\n\nUse deliveryEmailAddress instead. The delivery email address (for digital goods).\n\n\ndeliveryEmailAddress\nString\n\nThe delivery email address (for digital goods).\n\n\ndeliveryTimeframe\nString\n\nThe estimated delivery time for the shopper to receive the goods. Possible values:electronicDeliverysameDayShippingovernightShippingtwoOrMoreDaysShipping\n\n\ngiftCardAmount\nInteger\n\nFor prepaid or gift card purchase, the purchase amount total of prepaid or gift card(s).\n\n\ngiftCardCurr\nInteger\n\nFor prepaid or gift card purchase, ISO 4217 three-digit currency code of the gift card, other than those listed in Table A.5 of the EMVCo 3D Secure Protocol and Core Functions Specification.\n\n\ngiftCardCount\nString\n\nFor prepaid or gift card purchase, total count of individual prepaid or gift cards\/codes purchased.\n\n\npreOrderDate\nString\n\nFor pre-order purchases, the expected date this product will be available to the shopper.Format: ISO 8601 YYYY-MM-DDThh:mm:ssTZDExample: 2017-07-17T13:42:40+01:00\n\n\npreOrderPurchase\nBoolean\n\nWhether this transaction is for pre-ordering a product.\n\n\npreOrderPurchaseInd\nString\n\nIndicates if this transaction is for placing an order for merchandise with a future availability or release date.\n\n\nreorderItems\nBoolean\n\nWhether the shopper has already purchased the same items in the past.\n\n\nreorderItemsInd\nBoolean\n\nIndicates if the he cardholder is reordering previously purchased merchandise.\n\n\ndeliveryAddressIndicator\nString\n\nIndicator regarding the delivery address. Possible values:shipToBillingAddressshipToVerifiedAddressshipToNewAddressshipToStoredigitalGoodsgoodsNotShippedother\n\n\nshipIndicator\nString\n\nIndicates the shipping method for the purchase.\n\n\n\nMapping Adyen parameters to EMVCo fields\nThe Adyen merchantRiskIndicator parameters map to the EMVCo specifications as follows.\n\n\n\nAdyen parameter\nEMVCo parameter\n\n\n\n\ndeliveryEmail\ndeliveryEmailAddress\n\n\ndeliveryTimeframe\ndeliveryTimeframe\n\n\ngiftCardAmount\ngiftCardAmount\n\n\ngiftCardCount\ngiftCardCount\n\n\npreOrderDate\npreOrderDate\n\n\npreOrderPurchase\npreOrderPurchaseInd\n\n\nreorderItems\nreorderItemsInd\n\n\n\nmpiData\nThe  mpiData object is required in your authorization requests with Adyen if you use authentication data from a third-party to authorize payments. Get the values from the authentication data produced by a 3D Secure 2 provider. When you make the request to Adyen, include all the fields you receive from the third-party authentication provider.\n\n\n\nField\nType\nRequired\nDescription\n\n\n\n\nauthenticationResponse\nString\n\nThe \n  transStatus\n from the last CRes (Challenge Response) message or in the RReq (Results Request) sent after the shopper completes the challenge. If the transaction was frictionless there is no RReq, so omit this parameter.\n\n\ncavv\nString\n\nThe cardholder authentication value (base64 encoded, 20 bytes in a decoded form). This is the authenticationValue returned in the Authentication Response (ARes) for the frictionless flow, or the RReq for the challenge flow.\n\n\nchallengeCancel\nString\n\nIndicator informing the Access Control Server (ACS) and the Directory Server (DS) that the authentication has been cancelled. See possible values.\n\n\ndirectoryResponse\nString\n\nThe result of the initial authentication response. This is the transStatus from the ARes.\n\n\ndsTransID\nString\n\nThe unique transaction identifier assigned by the Directory Server to identify a single transaction.\n\n\neci\nString\n\nThe electronic commerce indicator (ECI). This is a scheme specific indicator of the authentication result.\n\n\nriskScore\nString\n\nUse case: required for Cartes Bancaires transactions.  Risk score calculated by Directory Server (DS).\n\n\nthreeDSVersion\nString\n\nThe version of 3D Secure 2 used. Possible values: 2.1.02.2.0\n\n\ntransStatusReason\nString\n\nProvides information on why the transStatus field has the specified value. See possible values.\n\n\ntokenAuthenticationVerificationValue\nString\n\nThe network token authentication verification value (TAVV). This is the network token cryptogram.\n\n\n\ntransStatus and transStatusReason values\nYou receive the transStatus value in the response of your payment request. This field indicates whether a transaction was authenticated, or whether additional verification is required.\n\n\n\ntransStatus value\nDescription\n\n\n\n\nY\nAuthentication \/ account verification successful.\n\n\nI\nAuthentication \/ exemption granted by Issuer.\n\n\nN\nNot Authenticated \/ account not verified. Transaction denied.\n\n\nU\nAuthentication \/ account verification could not be performed.\n\n\nA\nAuthentication \/ verification was attempted but could not be verified.\n\n\nC\nChallenge Required. Additional authentication is required using a challenge.\n\n\nR\nAuthentication \/ account verification rejected by the Issuer.\n\n\n\nThis field is called 3DS challenged in your Customer Area. The transStatusReason field informs you why the transStatus field has the specified value.\n\n\n\ntransStatusReason value\nScheme\nDescription\n\n\n\n\n01\nAll\nCard authentication failed.\n\n\n02\nAll\nUnknown device.\n\n\n03\nAll\nUnsupported device.\n\n\n04\nAll\nExceeds authentication frequency limit.\n\n\n05\nAll\nExpired card.\n\n\n06\nAll\nInvalid card number.\n\n\n07\nAll\nInvalid transaction.\n\n\n08\nAll\nNo card record.\n\n\n09\nAll\nSecurity failure.\n\n\n10\nAll\nStolen card.\n\n\n11\nAll\nSuspected fraud.\n\n\n12\nAll\nTransaction not permitted for cardholder.\n\n\n13\nAll\nCardholder not enrolled in service.\n\n\n14\nAll\nTransaction timed out at ACS.\n\n\n15\nAll\nLow confidence.\n\n\n16\nAll\nMedium confidence.\n\n\n17\nAll\nHigh confidence.\n\n\n18\nAll\nVery high confidence.\n\n\n19\nAll\nExceeds ACS maximum challenges.\n\n\n20\nAll\nNon-payment transaction not supported.\n\n\n21\nAll\n3RI transaction not supported.\n\n\n22\nAll\nACS technical issue.\n\n\n23\nAll\nDecoupled Authentication required by ACS but not requested by 3DS Requestor.\n\n\n24\nAll\n3DS Requestor decoupled max expiry time exceeded.\n\n\n25\nAll\nDecoupled Authentication was provided insufficient time to authenticate cardholder. ACS will not make attempt.\n\n\n26\nAll\nAuthentication attempted but not performed by the cardholder.\n\n\n80\nVisa\nError connecting to ACS.\n\n\n80\nMastercard\nReturned on all Data Only authentications.\n\n\n80\nAmerican Express\nSafekey is not available for this type of card.\n\n\n81\nVisa\nACS timed out.\n\n\n81\nMastercard\nChallenge exemption accepted.\n\n\n82\nVisa\nInvalid response from ACS.\n\n\n82\nMastercard\nChallenge Mandate requested but could not be performed.\n\n\n83\nMastercard, Visa\nSystem Error response from ACS.\n\n\n84\nMastercard, Visa\nInternal error while generating CAVV.\n\n\n85\nVisa\nVMID not eligible for requested program.\n\n\n86\nVisa\nProtocol version not supported by ACS\n\n\n87\nVisa\nTransaction is excluded from Attempts Processing (includes non- reloadable pre-paid cards and non-payments (NPA)).\n\n\n88\nVisa\nRequested program not supported by ACS.\n\n\n\nchallengeCancel values\n\n\n\nValue\nDescription\n\n\n\n\n00\nData element is absent or value has been sent back with the key challengeCancel.\n\n\n01\nCardholder selected Cancel.\n\n\n02\n3DS Requestor cancelled Authentication.\n\n\n03\nTransaction abandoned.\n\n\n04\nTransaction timed out at ACS \u2014 other timeouts.\n\n\n05\nTransaction timed out at ACS \u2014 first CReq not received by ACS.\n\n\n06\nTransaction error.\n\n\n07\nUnknown.\n\n\n08\nTransaction timed out at SDK.\n\n\n\nMPI data combinations\nWhen you are using authentication data from a third party to authorize payments with Adyen, you send multiple values you receive to Adyen. You must make sure that the combination of the values you send are aligned with what Adyen expects.\nThe possible combinations differ for each authentication flow. Cartes Bancaires does not use the ECI value, but it may be returned in some cases.\n\n\n\nAuthentication flow\ndirectoryResponse\nauthenticationResponse\neci\n\n\n\n\nChallenge flow\nC\nY\nVisa, Amex, JCB, CUB:  05  Mastercard, BCMC: 02  Cartes Bancaires: optional\n\n\nFrictionless flow\nY\n\nVisa, Amex, JCB, CUB:  05  Mastercard, BCMC: 02  Cartes Bancaires: optional\n\n\nAttempt\nA\n\nVisa, Amex, JCB, CUB:  06  Mastercard, BCMC: 02  Cartes Bancaires: optional\n\n\n3D Secure 2 exemption\nI (all schemes) or Y (Cartes Bancaires with threeDSVersion: 2.1.0)\n\nVisa, Amex, JCB, CUB:  07  Mastercard, BCMC: 02  Cartes Bancaires: optional\n\n\n\nMapping Adyen parameters to EMVCo fields\nThe Adyen mpiData parameters map to the EMVCo specifications as follows.\n\n\n\nAdyen parameter\nEMVCo parameter\n\n\n\n\nauthenticationValue\nauthenticationValue\n\n\ndsTransID\ndsTransID\n\n\neci\neci\n\n\nthreeDSVersion\nmessageVersion\n\n\nthreeDSServerTransID\nthreeDSServerTransID\n\n\nauthenticationResponse\ntransStatus in RReq\n\n\ndirectoryResponse\ntransStatus in ARes\n\n\nchallengeCancel\nchallengeCancel\n\n\n\npaymentMethod\nThe  paymentMethod object, and its sub-fields below, are required for 3D Secure 2 transactions. If you are fully PCI compliant you can pass the parameters for raw card data instead.\n\n\n\nField\nType\nRequired\nDescription\n\n\n\n\ntype\nString\n\nSet to scheme.\n\n\nencryptedCardNumber\nString\n\nThe encrypted card number.\n\n\nencryptedExpiryMonth\nString\n\nThe encrypted card expiry month.\n\n\nencryptedExpiryYear\nString\n\nThe encrypted card expiry year.\n\n\nencryptedSecurityCode\nString\n\nThe encrypted card verification code.\n\n\nbrand\nString\n\nUse case: required for Cartes Bancaires transactions.  The secondary brand of the card.\n\n\nholderName\nString\n\nUse case: required for Visa and JCB transactions.  The name of the cardholder. We recommend to include this field whenever available for higher authentication rates.\n\n\nthreeDS2SdkVersion\nString\n\nUse case: required for native mobile integrations.  The 3D Secure 2 mobile SDK version. See our integration guides to learn how you can get the SDK version.\n\n\n\nthreeDS2RequestData\nThe  threeDS2RequestData object contains additional request fields that are required for certain types of 3D Secure 2 integrations.\n\n\n\nField\nType\nRequired\nDescription\n\n\n\n\nacquirerBIN\nString\n\nUse case: required if you enrolled for 3D Secure 2 through a different acquirer or PSP and are performing the authentication-only flow.  The acquiring BIN enrolled for 3D Secure 2. This string should match the value that you will use in the authorization.\n\n\nacquirerMerchantID\nString\n\nUse case: required if you enrolled for 3D Secure 2 through a different acquirer or PSP and are performing the authentication-only flow.  The authorisation merchant ID enrolled for 3D Secure 2. This string should match the value that you will use in the authorization.\n\n\naddrMatch\nString\n\nIndicates if the shipping address and billing address of the shopper match. Possible values: Y: the addresses match.N: the addresses do not match.\n\n\nchallengeIndicator  \n    \n        Deprecated in Checkout API v68\n    \n\n\nString\n\nUse case: required to manually request exemptions to the challenge through the API request, or for Cartes Bancaires transactions.   The preference for receiving a challenge from the issuer. Possible values:noPreferencerequestNoChallengerequestChallengerequestChallengeAsMandate    On Checkout API v68 or later, use threeDSRequestorChallengeInd instead.\n\n\ndeviceRenderOptions.sdkInterface\nString\n\nOnly for app-based integrations. The supported SDK interface types. Defaults to native. Possible values:nativehtmlboth\n\n\ndeviceRenderOptions.sdkUiType\nArray\n\nOnly for app-based integrations. The string array of UI types supported for displaying specific challenges. Defaults to all values. Possible values:textsingleSelectmultiSelectoutOfBandotherHtml\n\n\nmcc\nString\n\nUse case: required if you enrolled for 3D Secure 2 through a different acquirer or PSP and are performing the authentication-only flow.  The four-digit code with which the acquirerMerchantID is registered at the scheme.\n\n\nmerchantName\nString\n\nUse case: required if you enrolled for 3D Secure 2 through a different acquirer or PSP and are performing the authentication-only flow, or if you are enrolled with Adyen, and want to override the merchant name configured on your account.  The merchant name that the issuer presents to the shopper if they get a challenge.  We recommend to use the same value that you will use in the authorization.  Format: Maximum length: 40 characters\n\n\nmessageVersion\nString\n\nThe 3D Secure 2 protocol version.\n\n\nnotificationURL\nString\n\nUse case: required for deviceChannel browser or if you built your own implementation with channel Web.  The URL where the Challenge Response value will be sent.\n\n\nsdkAppID\nString\n\nUse case: required for deviceChannel app.  The sdkAppID value as received from the 3D Secure 2 SDK.\n\n\nsdkEncData\nString\n\nUse case: required for deviceChannel app.  The sdkEncData value as received from the 3D Secure 2 SDK.\n\n\nsdkEphemPubKey\nObject\n\nUse case: required for deviceChannel app.  The sdkEphemPubKey value as received from the 3D Secure 2 SDK. This object includes the crv, kty, x, and y.\n\n\nsdkMaxTimeout\nInteger\n\nOnly for app-based integrations. The maximum amount of time in minutes for the 3D Secure 2 authentication process. Defaults to 60 minutes.\n\n\nsdkReferenceNumber\nString\n\nUse case: required for app-based integrations.  The sdkReferenceNumber value as received from the 3D Secure 2 SDK.\n\n\nsdkTransID\nString\n\nUse case: required for app-based integrations.  The sdkTransID value as received from the 3D Secure 2 SDK.\n\n\nthreeDSCompInd\nString\n\nThe completion indicator for the threeDSMethodUrl fingerprinting.\n\n\nthreeDSRequestorChallengeInd\nString\n\nUse case: required if you want to manually request exemptions to the challenge through the API request, or for Cartes Bancaires transactions.  Indicates whether a challenge is requested for this transaction. Possible values: 01: no preference02: no challenge requested  03: challenge requested by the 3D Secure requestor 04: challenge requested due to a mandate 05: no challenge requested due to a performed risk analysis. 06: Data-only flow.\n\n\nthreeDSRequestorID\nString\n\nUse case: required for Visa payments if you enrolled for 3D Secure 2 through a different acquirer or PSP and are performing the authentication-only flow.  The unique requestor ID assigned by the Directory Server when you enrol for 3D Secure 2.\n\n\nthreeDSRequestorName\nString\n\nUse case: required for Visa payments if you enrolled for 3D Secure 2 through a different acquirer or PSP and are performing the authentication-only flow.  The unique requestor name assigned by the Directory Server when you enrol for 3D Secure 2.\n\n\nthreeDSRequestorURL\nString\n\nThe URL of the (customer service) website that will be shown to the shopper in case of technical errors during the 3D Secure 2 process.\n\n\ntransactionType\nString\n\nThe type of transaction being authenticated. Highly recommended for Brazil. Possible values:goodsOrServicePurchasecheckAcceptanceaccountFundingquasiCashTransactionprepaidActivationAndLoad Supported from v50 and later of Checkout API.\n\n\nhomePhone, workPhone or mobilePhone\nString\n\nUse case: required for Visa and JCB payments if you did not include the shopperEmail parameter, and did not provide the phone number in  telephoneNumber.   A phone number for the shopper. Format: The phone number must include a country code (1-3 digits), followed by the number (4-15 digits).   Example: +4912345678901  If the value you provide does not follow the guidelines, we drop the value and do not submit it for authentication. \n\n\n\nChallenge flow objects\nWhen the 3D Secure 2 authentication has to go through the fingerprint or challenge flows, you initialize the flows using the following objects. The Component returns the fingerprint or the challengeResult that you need to pass when you submit the authentication result.\n\n\n\nField\nType\nDescription\n\n\n\n\nthreeds2.fingerprintToken\nBase64url encoded string\nRequired to initialize the device fingerprinting process. This contains the following parameters: threeDSMethodNotificationURLthreeDSMethodUrlthreeDSServerTransID\n\n\nthreeds2.challengeToken\nBase64url encoded string\nRequired to initialize the challenge flow. This contains the following parameters: acsReferenceNumberacsTransIDacsURLmessageVersionthreeDSNotificationURLthreeDSServerTransID\n\n\n threeds2.fingerprint\nBase64 encoded string\nReturned by the Component after the challenge flow. This contains the following parameters:threeDSCompInd Pass this in the  \/payments\/details request.\n\n\n threeds2.challengeResult\nBase64 encoded string\nReturned by the Component after the challenge flow. This contains the following parameters: transStatus  Pass this in the  \/payments\/details request.\n\n\n","type":"page","locale":"pt","boost":17,"hierarchy":{"lvl0":"Home","lvl1":"Online payments","lvl2":"3D Secure 2 authentication","lvl3":"3D Secure 2 API reference"},"hierarchy_url":{"lvl0":"https:\/\/docs.adyen.com\/pt","lvl1":"https:\/\/docs.adyen.com\/pt\/online-payments","lvl2":"https:\/\/docs.adyen.com\/pt\/online-payments\/3d-secure","lvl3":"\/pt\/online-payments\/3d-secure\/api-reference"},"levels":4,"category":"Online Payments","category_color":"green","tags":["Secure","reference"]}}