Use our Redirect Component to redirect the shopper to perform 3D Secure 2 authentication.
When adding card payments with redirect 3D Secure authentication to your integration, you additionally need to:
- Collect the additional parameters in your payment form and configure the card component.
- Provide the required 3D Secure parameters when making a payment request.
- Use the Redirect Component to handle the redirect.
This page describes the integration steps for Android Drop-in v4.0.0 or later.
Before you begin
Before starting your integration:
- Make sure that you have integrated our Card Component, or built your own UI for collecting shopper's card details.
- If you are using 3D Secure for PSD2 compliance, read our comprehensive PSD2 SCA guide.
Collect additional parameters in your payment form
For higher authentication rates, we strongly recommend that you collect the card holder name, the shopper billing address and email address in advance in your payment form. Deliver these parameters to your backend when making a payment as they are required by the card schemes.
Configure the Card Component
val cardConfiguration = CardConfiguration.Builder(context, "YOUR_CLIENT_KEY") .setHolderNameRequired(true) // When you're ready to accept live payments, change the value to one of our live environments. .setEnvironment(Environment.TEST) .build()
Make a payment
From your server, make a /payments request, specifying:
|paymentMethod||If using the Card Component, pass the
|channel||Set to Android.|
|returnUrl||The URL where the shopper will be redirected back to after completing 3D Secure authentication. Get this URL from the Component in the
|billingAddress||The cardholder's billing address.|
|shopperEmail||The cardholder's email address.|
For higher authorisation rates, we recommend that you send additional parameters.
channel Android, we recommend including these additional parameters:
Your next steps depend on whether the /payments response contains an
||The transaction was either exempted or out-of-scope for 3D Secure 2 authentication.||Use the
||The payment qualifies for 3D Secure.||1. Pass the
2. Use the Redirect Component to handle the redirect.
A sample /payments response with
Handle the redirect
Use the Redirect Component to redirect the shopper to complete the 3D Secure authentication. When the shopper returns back to your app, the Redirect Component provides the
From your server, make a POST /payments/details request specifying:
details: This is the
actionComponentData.detailsfrom the Component.
paymentData: Required if using Checkout API version 66 or earlier: the value from the last API response that you stored locally in the client-side app.
You receive a response containing:
resultCode: Use this to present the payment result to your shopper.
pspReference: Our unique identifier for the transaction.
Present the payment result
For card payments, you can receive the following
|resultCode||Description||Action to take|
|Authorised||The payment was successful.||Inform the shopper that the payment has been successful.
If you are using manual capture, you also need to capture the payment.
|Cancelled||The shopper cancelled the payment.||Ask the shopper if they want to continue with the order, or ask them to select a different payment method.|
|Error||There was an error when the payment was being processed. For more information, check the
||Inform the shopper that there was an error processing their payment.|
|Refused||The payment was refused. For more information, check the
||Ask the shopper to try the payment again using a different payment method.|
Test and go live
Use our test card numbers to test how your integration handles different 3D Secure authentication scenarios.