Default icon

Redirect 3DS Components integration

Support cards with 3D Secure authentication through a redirect in your Android app.

You can use the Redirect Component to handle Redirect 3D Secure 2 authentication if you have an API-only integration.

If you have a Components integration that uses the Card Component, the Card Component can handle Redirect 3D Secure 2 authentication without additional integration. You don't need to use the 3D Secure 2 Component in this case.

This guide is for integrations using Redirect Component v5.0.0 with the Advanced flow.
For v4.13.3 or earlier, use the guide for earlier versions.

Before you begin

Build your own UI for collecting card details.

Collect additional parameters in your payment form

For higher authentication rates, we strongly recommend that you collect the shopper's billing address and email address. Send these parameters to your server when making a payment, because they are required by the card schemes.

Import the Redirect Component

When you import the library, import the Redirect Component:

Make a payment

When you make a payment, include the following parameters:

Parameter name Required Description
paymentMethod -white_check_mark- If using the Card Component, pass the object from your client app. If submitting raw card data, refer to Raw card data for the fields that you need to pass.
channel -white_check_mark- Set to Android.
returnUrl -white_check_mark- The URL where the shopper will be redirected back to after completing 3D Secure authentication. Get this URL from the Component in the RedirectComponent.getReturnUrl(context). The return URL can be a maximum of 1024 characters and must not include // (double slash) after the top-level domain.
browserInfo -white_check_mark- Contains the userAgent and acceptHeader fields.
billingAddress Strongly recommended. The cardholder's billing address.
shopperEmail Strongly recommended. The cardholder's email address.

For higher authorization rates, we strongly recommend including the optional parameters.

Your next steps depend on whether the /payments response contains an action object:

Response Description What to do
No action object The transaction was either exempted or out-of-scope for 3D Secure 2 authentication. Continue to get the payment outcome.
action.type: redirect The payment qualifies for 3D Secure. Handle the redirect.

A sample response with action.type: redirect:

Handle the redirect

Pass the action object to the Component to handle the redirect. The shopper is redirected to a separate page to perform 3D Secure 2 authentication and returns to your app after.

Continue to get the payment outcome.

Test and go live

Use our test card numbers to test how your integration handles different 3D Secure authentication scenarios.

See also