Import 3D Secure results

Process payments when 3D Secure runs outside of Stripe.

Importing 3DS results is an advanced payment flow that allows you to incorporate your external 3DS authentication into your Stripe payment by importing the authentication result. You need to import 3DS results if you:

Are in the travel industry and receive card numbers and cryptograms from a travel aggregator, such as Expedia or Sabre
Use a third-party provider to perform 3DS

In these situations, you can pass the card details and cryptogram directly to the Payment Intents API instead of using Stripe Elements to collect payment details and run 3DS.

Importing 3DS results is available in the following countries:

Australia

Canada

Hong Kong

Mexico

New Zealand

Singapore

Switzerland

United Kingdom

United States

Beta All other countries in which Stripe supports card payments.

Importing 3DS results isn’t available in the following countries:

India

Malaysia

Thailand

Warning

In all the following code samples, the parameters set in the three_d_secure object must identically match the values returned by your 3DS provider.

Process a payment with card details

If you handle card details on your server:

Create and confirm a PaymentIntent with the card details and 3DS details in one API call.
When creating the PaymentIntent, set confirm to true.
Set error_on_requires_action to true when you confirm the PaymentIntent to prevent Stripe from performing a 3DS request during a soft decline.

Process a payment with a PaymentMethod

If you tokenize card details with the Payment Methods API:

Create and confirm a PaymentIntent with the PaymentMethod ID and 3DS details in one API call.
When creating the PaymentIntent, set confirm to true.
Set error_on_requires_action to true when you confirm the PaymentIntent to prevent Stripe from performing a 3DS request during a soft decline.

Caution

If you intend to process a payment with a PaymentMethod shortly after tokenizing the card details, use raw card data instead.

Set up future payments

The 3DS protocol supports two message categories:

Payment Authentication: used for authenticating cardholders during transactions.
Non-Payment Authentication: used for identity verification and account confirmation.

If you want to onboard customers for future payments, include the non-payment authentication cryptogram and either the card details or PaymentMethod ID when creating and confirming a SetupIntent.

Import 3DS exempted outcomes

If you obtain a 3DS result outside of Stripe that contains a ‘low-risk’ SCA exemption, you can flag the exemption-based nature of the 3DS result to Stripe by using the exemption_indicator parameter.

If Stripe’s real-time transaction risk analysis determines that it’s appropriate, Stripe requests the low-risk exemption from the issuer and communicates this action to you by returning exemption_indicator_applied in to the authorization request response.

To see whether Stripe requested the low-risk exemption, expand the latest_charge and inspect the three_d_secure attribute.

{
    "id": "pi_3aTnU0Aif3fLhNTb0le1BSXI",
    "object": "payment_intent",
    // ...
    "latest_charge": {
        "id": "ch_3aTnU1AifffLhNTb0tUoEZcd",
        "object": "charge",
        // ...
        "payment_method_details": {
            "card": {

Importing Cartes Bancaires outcomes

To use 3DS import for transactions that process on the Cartes Bancaires network, you need to explicitly pass the authenticated network in your request using the network parameter.

To import Cartes Bancaires cryptograms, you also need additional data from your external 3DS server. The table below specifies the details of these additional required and recommended fields. These recommendations apply when you import 3DS outcomes using both PaymentIntents and SetupIntents.

Field	Description	Optionality
electronic_commerce_indicator	The Electronic Commerce Indicator (ECI) is returned by your 3DS provider and indicates what degree of authentication was performed.	Optional. Include this if it’s available.
cb_avalgo	The cryptogram calculation algorithm used by the card Issuer’s ACS to calculate the Authentication cryptogram. Also known as cavvAlgorithm. ARes/RReq messageExtension: `CB-AVALGO`	Required.
cb_exemption	The exemption indicator returned from Cartes Bancaires in the ARes. This is a 3 byte bitmap (lowest significant byte first and most significant bit first) that has been Base64 encoded. String (4 characters). ARes message extension: `CB-EXEMPTION`	Optional. Include this if it’s available.
cb_score	The risk score returned from Cartes Bancaires in the ARes. Numeric value 0-99. ARes/RReq message extension: `CB-SCORE`	Optional. Include this if it’s available.
ares_trans_status	The `transStatus` returned from the card Issuer’s ACS in the ARes.	Optional. Include this if it’s available.
requestor_challenge_indicator	The challenge indicator (`threeDSRequestorChallengeInd`) which was requested in the AReq sent to the card Issuer’s ACS. A string containing 2 digits from 01-99.	Optional. Include this if it’s available.

Provide as many of these additional fields as possible to increase the chances of a successful authorization.

Exemptions with Cartes Bancaires

If you have been granted an SCA exemption over 3DS, you must submit either the cb_exemption parameter, the exemption_indicator parameter, or both. If either of these parameters indicates that the exemption is low risk due to acquirer transaction risk analysis, Stripe reassesses the transaction, as described in Import 3DS exempted outcomes.

If you have access to cb_exemption, pass that value and don’t populate exemption_indicator. Stripe infers the appropriate exemption indicator based on cb_exemption.
If you pass both the cb_exemption parameter and exemption_indicator parameter, make sure that they both correctly indicate the exempted status.
If there’s a mismatch where exemption_indicator=none and the bitmap in cb_exemption indicates that the applied exemption is a low risk exemption, Stripe rejects the request.

Testing

You can validate your integration in a sandbox using either the authentication required test card: 4000 0027 6000 3184 or pm_card_authenticationRequired.

The simulation accepts any correctly-formatted 3DS result. For example:

Version: 2.1.0
Electronic Commerce Indicator: 02
Cryptogram: M6+990I6FLD8Y6rZz9d5QbfrMNY=
Transaction ID: 5f5d08f2-8c36-4f72-99d1-57b4fb70b7d5

Or:

Version: 2.2.0
Electronic Commerce Indicator: 05
Cryptogram: 4BQwsg4yuKt0S1LI1nDZTcO9vUM=
Transaction ID: f879ea1c-aa2c-4441-806d-e30406466d79

Exemptions granted through 3DS

In a testing environment, all cards that include exemption_indicator return exemption_indicator_applied as true. To test a PaymentIntent creation that doesn’t pass the internal TRA check, and that returns false, use card number 4000 0000 0001 6123 and set exemption_indicator=low_risk.

Cartes Bancaires

You can use the following co-badged cards to test importing Cartes Bancaires outcomes:

Brand	CVC	Date
Cartes Bancaires / Visa	Any 3 digits	Any future date
Cartes Bancaires / Mastercard	Any 3 digits	Any future date
Cartes Bancaires / Visa	Any 3 digits	Any future date

You can use any valid cb_exemption value in your tests. For example:

AAAA - No exemption granted
BAAA - Low risk exemption granted

Like the standard exemptions flow, when the value of cb_exemption corresponds to low risk, only the test card 4000 0000 0001 6123 returns false for exemption_indicator_applied.

Raw PAN usage

Stripe requires users to validate that cardholder data is handled securely and in compliance with the Payment Card Industry Data Security Standard (PCI DSS) before granting access to raw card data APIs.

For businesses that require this functionality, Stripe imposes strict requirements, including:

Validation of PCI DSS compliance
Submission to the Stripe review process
Agreement to maintain additional controls on top of Stripe’s default security settings

See Enabling access to raw card data APIs support article for enablement details.

Note

For accounts with custom pricing, if you specify Stripe as your acquirer in the 3D Secure request, Stripe passes network costs applicable to 3DS through, per your agreement with Stripe.