availability

This is a preview of the adoption guide for our upcoming 3D Secure 2.0 integration. Our SDKs are still under development and the implementation is subject to change.

We encourage you to begin testing now, but do not release your 3D Secure 2.0 integration in production at this time.

Start here

  • 3D Secure 2.0 (3DS 2.0) is the next iteration of the 3DS authentication protocol.
  • It satisfies the Strong Customer Authentication (SCA) requirements going into effect in 2019 for European merchants transacting with European customers.
  • We are currently updating the latest major versions of our client SDKs to support 3DS 2.0. Beta versions of our JavaScript v3 and iOS v4 SDKs are available now; an Android beta is coming soon.
  • This Adoption guide focuses on how our 3DS 2.0 implementation will differ from our original 3DS integration.

If you are based in Europe and already use 3DS

  1. Use this Adoption guide to update your existing 3DS integration to 2.0.
    • Although SCA requirements will not be enforced for merchants until September 14, 2019, we recommend integrating 3DS 2.0 by April 14, 2019, to meet card brand guidelines.
  2. If you integrate 3DS 2.0 using beta versions of our SDKs, be ready to update to a stable version once available and account for any breaking changes introduced.
    • In the meantime, if you have any feedback on our beta SDKs, please let us know!

If you are based in Europe and do not use 3DS yet

  1. Read our 3DS support article to get familiar with 3DS in general.
    • A conceptual understanding of 3DS will be helpful as you complete a 2.0 integration.
  2. Use both our original 3DS integration guide and this Adoption guide to add 3DS 2.0 to your Braintree integration.
    • Much of the original 3DS guide is still relevant for 3DS 2.0, except for the key differences covered on this page.
    • Although SCA requirements will not be enforced for merchants until September 14, 2019, we recommend integrating 3DS 2.0 by April 14, 2019, to meet card brand guidelines.
  3. If you integrate 3DS 2.0 using beta versions of our SDKs, be ready to update to a stable version once available and account for any breaking changes introduced.
    • In the meantime, if you have any feedback on our beta SDKs, please let us know!

If you are based outside Europe

While generally not required, you can most likely use 3DS 2.0, too! Right now we’re focused on helping European merchants integrate, but the same general steps will apply to any merchant who wants to use 3DS 2.0.

See the overall 3DS compatibility details in our support article, and contact us if you have questions about using 3DS outside of Europe.

About 3DS 2.0

This new version of 3DS is designed to primarily do two things:

First and foremost, the protocol allows more data elements to be passed to issuing banks, which in turn allows them to perform a much more effective risk assessment of a given authentication. As a result, issuing banks will be able to allow more authentications to proceed without challenging the cardholder.

Second, the authentication challenges themselves are designed to be more effective and secure, especially for mobile devices, resulting in fewer authentication challenges and less friction during checkout workflows. You can find a lot more details and context in our blog post about 3DS 2.0.

Getting ready for 3DS 2.0

To minimize the need for issuing banks to present authentication challenges to customers, update your integration to collect as many of these customer data fields as possible. These new fields are not strictly required, but without them, you and your customers won't get the most out of 3DS 2.0.

Field Name Description
billingGivenName Customer's first name.
billingSurname Customer's last name.
streetAddress Customer's billing street address.
extendedAddress Customer's billing extended address when available (e.g. Apt. #3).
locality Customer's billing city.
region Customer's billing state.
postalCode Customer's billing postal code.
countryCodeAlpha2 Customer's ISO 3166-1 alpha-2 country code for their billing address.
billingPhoneNumber Customer's billing phone number.
email Customer's email.

Enabling 3DS 2.0

In addition to collecting the customer data elements above, you'll need to update your Braintree client-side integration.

Update your SDK version

If you're using <script> tags to load files, be sure to at least include:

HTML
Copy
Copied
<!-- Load the client component. -->
<script src="https://js.braintreegateway.com/web/3.43.0-beta.4/js/client.min.js"></script>

<!-- Load the Hosted Fields component.. -->
<script src="https://js.braintreegateway.com/web/3.43.0-beta.4/js/hosted-fields.min.js"></script>

<!-- Load the 3D Secure component. -->
<script src="https://js.braintreegateway.com/web/3.43.0-beta.4/js/three-d-secure.min.js"></script>

Configure 3DS version

Specify version: 2 in your options object when calling threeDSecure.create(). This allows your transactions to route through the 3DS 2.0 protocol whenever possible, and automatically fall back to 3DS 1.x as needed.

Callbacks Promises
Copy
Copied
var threeDSecure;

braintree.client.create({
  // Use the generated client token to instantiate the Braintree client.
  authorization: 'CLIENT_TOKEN_FROM_SERVER'
}, function (clientErr, clientInstance) {
  if (clientErr) {
    // Handle error in client creation
    return;
  }

  braintree.threeDSecure.create({
    version: 2, // Will use 3DS 2 whenever possible
    client: clientInstance
  }, function (threeDSecureErr, threeDSecureInstance) {
    if (threeDSecureErr) {
      // Handle error in 3D Secure component creation
      return;
    }

    threeDSecure = threeDSecureInstance;
  });
});

Pass new parameters on verification calls

To reduce the need for issuing banks to challenge cardholders to authenticate with 3DS 2.0, you'll need to pass some new parameters when calling verifyCard():

  • tokenizedCard: The full tokenized payload returned by the Braintree SDK. This object contains the payment method nonce representing the card and tokenized card details.
  • additionalInformation: Additional customer data elements to pass to the issuing bank; see code snippet below for details. For best results, provide as many of these elements as possible. This may require updating your UI to collect more information.
  • onLookupComplete: Required callback that will be invoked before the challenge flow. Accepts two parameters:
    • data: 3DS data lookup response object; see code snippet below for details.
    • next: Callback function to execute after consuming the 3DS data response.
Callbacks Promises
Copy
Copied
threeDSecure.verifyCard({
  amount: '500.00',
  tokenizedCard: TOKENIZED_CARD_PAYLOAD,
  additionalInformation: {
    billingGivenName: 'Jill',
    billingSurname: 'Doe',
    billingPhoneNumber: '8101234567',
    billingAddress: {
      streetAddress: '555 Smith St.',
      extendedAddress: '#5', // When available
      locality: 'Oakland',
      region: 'CA',
      postalCode: '12345',
      countryCodeAlpha2: 'US'
    },
    email: 'test@example.com'
  },
  /**
  * @function onLookupComplete
  * Newly required in `verifyCard` options object, will be called after receiving ThreeDSecure
  * response, before completing the flow.
  * @param {object} data - ThreeDSecure data to consume before continuing
  * @param {string} data.paymentMethod.nonce - payment nonce
  * @param {object} data.threeDSecureInfo
  * @param {boolean} data.threeDSecureInfo.liabilityShifted
  * @param {boolean} data.threeDSecureInfo.liabilityShiftPossible
  * @param {function} next - callback to continue flow
  * */
  onLookupComplete: function (data, next) {
    // use `data` here, then call `next()`
    next();
  }
}, function (err, response) {
  // Handle response
});

Testing in sandbox

The table below includes test cards for scenarios where the cardholder is given a challenge by their issuing bank (Challenge) or where the card issuer determines a challenge is not needed (No Challenge).

important

Use the card numbers below to test 3DS 2.0 on your client side in sandbox. Any other test cards will result in 3DS verification results that are not in the 2.0 format.

For expiration year values for all test cards in the table below, use the current year +3. The expiration month should always be 01. For example, if the current year is 2019, a valid test value for the expiration date would be 01/2022.

Status and Scenario Card brand specific test values
"Successful No-Challenge Authentication"
Cardholder enrolled, authentication successful, and signature verification successful.
Visa
  • 4000000000001000
  • 01/20**
Mastercard
  • 5200000000001005
  • 01/20**
Amex
  • 340000000001007
  • 01/20**
"Failed No-Challenge Authentication"
Cardholder enrolled, authentication unsuccessful. Merchants should prompt customers for another form of payment.
Visa
  • 4000000000001018
  • 01/20**
Mastercard
  • 5200000000001013
  • 01/20**
Amex
  • 340000000001015
  • 01/20**
"Attempt No-Challenge Authentication"
The provided card brand authenticated this 3D Secure transaction without password confirmation from the customer.
Visa
  • 4000000000001026
  • 01/20**
Mastercard
  • 5200000000001021
  • 01/20**
Amex
  • 340000000001023
  • 01/20**
"Unavailable No-Challenge Authentication from the Issuer"
Authentication unavailable for this transaction.
Visa
  • 4000000000001034
  • 01/20**
Mastercard
  • 5200000000001039
  • 01/20**
Amex
  • 340000000001031
  • 01/20**
"Rejected No-Challenge Authentication by the Issuer"
Authentication unsuccessful. Merchants should prompt customers for another form of payment.
Visa
  • 4000000000001042
  • 01/20**
Mastercard
  • 5200000000001047
  • 01/20**
Amex
  • 340000000001049
  • 01/20**
"Authentication Not Available on Lookup"
Authentication unavailable for this transaction.
Visa
  • 4000000000001059
  • 01/20**
Mastercard
  • 5200000000001054
  • 01/20**
Amex
  • 340000000001056
  • 01/20**
"Error on Lookup"
An error occurred while attempting to lookup enrollment.
Visa
  • 4000000000001067
  • 01/20**
Mastercard
  • 5200000000001062
  • 01/20**
Amex
  • 340000000001064
  • 01/20**
"Timeout on Lookup"
Attempting to lookup enrollment resulted in a timeout.
Visa
  • 4000000000001075
  • 01/20**
Mastercard
  • 5200000000001070
  • 01/20**
Amex
  • 340000000001072
  • 01/20**
"Bypassed Authentication"
Bypass used to simulate a scenario where merchant has elected to bypass the consumer authentication flow via CardinalCommerce Rules Engine configuration.
Visa
  • 4000000000001083
  • 01/20**
Mastercard
  • 5200000000001088
  • 01/20**
Amex
  • 340000000001080
  • 01/20**
"Successful Challenge Authentication"
Cardholder enrolled, authentication successful, and signature verification successful.
Visa
  • 4000000000001091
  • 01/20**
Mastercard
  • 5200000000001096
  • 01/20**
Amex
  • 340000000001098
  • 01/20**
"Failed Challenge Authentication"
Cardholder enrolled, authentication unsuccessful. Merchants should prompt customers for another form of payment.
Visa
  • 4000000000001109
  • 01/20**
Mastercard
  • 5200000000001104
  • 01/20**
Amex
  • 340000000001106
  • 01/20**
"Challenge Authentication is Unavailable"
Authentication unavailable for this transaction.
Visa
  • 4000000000001117
  • 01/20**
Mastercard
  • 5200000000001112
  • 01/20**
Amex
  • 340000000001114
  • 01/20**
"Error on Authentication"
An error occurred while attempting to authenticate. Alternatively, merchants can ask customers for an alternative form of payment.
Visa
  • 4000000000001125
  • 01/20**
Mastercard
  • 5200000000001120
  • 01/20**
Amex
  • 340000000001122
  • 01/20**

Common questions

Can merchants customize the presentation of the bank challenge?

No. The presentation will be controlled by the issuing bank. This means that unlike prior versions, you will not need to provide the iframe or utilize the addFrame and removeFrame callbacks.

Will vaulted credit cards be supported?

Yes, the guide will be updated with additional directions for vaulted credit cards.

What happens if some of the additional parameters are not present?

The bank will decide if a challenge is necessary. Sending all additional parameters will result in the best chance for a frictionless experience.

Can I use 3DS 2.0 with recurring billing?

We're working on a way to make 3DS 2.0 compatible with subscriptions and will update this guide once we have more details to share.

Still have questions?

If you can’t find an answer, contact us