Native 3DS2 Drop-in integration

Add native 3D Secure 2 authentication to your existing Drop-in integration.

Our Android Drop-in renders the available cards in your payment form, and securely collects any sensitive card information, so it doesn't touch your server. Drop-in also handles the 3D Secure 2 device fingerprinting and challenge flows, including the data exchange between your front end and the issuer's Access Control Server (ACS).

When adding 3D Secure 2 authentication to your integration, you also need to:

Configure Drop-in to collect the card holder name.
Provide additional parameters when making a payment request.
Submit authentication results if you receive an action object in response to your /payments or /payments/details request.
Check the payment result if the payment was routed to the 3D Secure 1 flow.

This page describes the integration steps for v3.0.0 or later of Android Drop-in. If you are using an earlier version, refer to an earlier version of this integration guide.

Before you begin

This page explains how to add cards with native 3D Secure 2 authentication to your existing Android Drop-in integration. The Android Drop-in integration works the same way for all payment methods. If you haven't done this integration yet, refer to our Drop-in integration guide.

Before you begin your integration:

Contact our Support Team to make sure that 3D Secure is triggered in your app.
Make sure that you have set up your back end implementation, and added Drop-in to your payment form.
Add the cards that you want to accept in your test Customer Area.

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.

Show the available cards in your payment form

For information about the supported countries and currencies for each card, refer to Payment methods.

To show cards in your payment form:

Specify in your /paymentMethods request a combination of countryCode and amount.currency. Drop-in uses this information to show the available cards to your shopper.
When creating an instance of Drop-in, create a configuration object:

a. Set holderNameRequire to true. This will show the input field for the card holder name.
b. Pass your Client Encryption Public Key.

To get your public key:
1. Sign in to your Customer Area using your company-level account.
2. Navigate to Account > API Credentials.
3. Click on your web service user (ws@Company.[YourCompanyAccount]) in the users list.
  This opens the Edit Web Service User page.
4. In the Client-Side Encryption panel, copy the Client Encryption Public Key.
```
val cardConfiguration = CardConfiguration.Builder(context, "<publicKey>")
     .setHolderNameRequire (true)
        .build()

val dropInConfiguration = DropInConfiguration.Builder(this@MainActivity, YourDropInService::class.java)
       .setEnvironment(Environment.TEST)
       // When you're ready to accept live payments, change the value to one of our live environments.
       .addCardConfiguration(cardConfiguration)
       .build()
```

Make a payment

When the shopper proceeds to pay, Drop-in returns the paymentComponentData.paymentMethod.

Pass the paymentComponentData to your server.

From your server, make a /payments request, specifying:

Parameter name	Required	Description
`paymentMethod`		The `paymentComponentData.paymentMethod` object from your client app.
`additionalData.allow3DS2`		Set to `true`.
`channel`		Set to Android.
`returnUrl`		In case of a 3D Secure 1 flow, this is the URL where the shopper will be redirected back to after completing 3D Secure 1 authentication. Get this URL from Drop-in in the `RedirectComponent.getReturnUrl(context)`. This URL can have a maximum of 1024 characters.
`billingAddress`		The cardholder's billing address.
`shopperEmail`		The cardholder's email address.

To increase the likelihood of achieving a frictionless flow and higher authorisation rates, we recommend that you send additional parameters.

For channel Android, we recommend including these additional parameters: billingAddress and shopperEmail.

https://docs.adyen.com/online-payments/3d-secure/native-3ds2/android-drop-in#payments-android

curl https://checkout-test.adyen.com/v66/payments \
-H "X-API-key: [Your API Key here]" \
-H "Content-Type: application/json" \
-d '{
   "amount":{
      "currency":"EUR",
      "value":1000
   },
   "reference":"YOUR_ORDER_NUMBER",
   "shopperReference":"YOUR_UNIQUE_SHOPPER_ID",
   "{hint:paymentComponentData.paymentMethod from app}paymentMethod{/hint}":{
      "type":"scheme",
      "encryptedCardNumber":"adyenjs_0_1_18$k7s65M5V0KdPxTErhBIPoMPI8HlC..",
      "encryptedExpiryMonth":"adyenjs_0_1_18$p2OZxW2XmwAA8C1Avxm3G9UB6e4..",
      "encryptedExpiryYear":"adyenjs_0_1_18$CkCOLYZsdqpxGjrALWHj3QoGHqe+..",
      "encryptedSecurityCode":"adyenjs_0_1_24$XUyMJyHebrra/TpSda9fha978+..",
      "holderName":"S. Hopper"
   },
   "additionalData":{
      "allow3DS2":true
   },
   "{hint:state.data.billingAddress from onSubmit}billingAddress{/hint}": {
       "street": "Infinite Loop",
       "houseNumberOrName": "1",
       "postalCode": "1011DJ",
       "city": "Amsterdam",
       "country": "NL"
  },
   "shopperEmail":"s.hopper@example.com"
   "channel":"Android",
   "returnUrl":"adyencheckout://your.package.name",
   "merchantAccount":"YOUR_MERCHANT_ACCOUNT"
}'

# Set your X-API-KEY with the API key from the Customer Area.
adyen = Adyen::Client.new
adyen.env = :test
adyen.api_key = "YOUR_X-API-KEY"

response = adyen.checkout.payments({
  :amount => {
    :currency => "EUR",
    :value => 1000
  },
  :reference => "YOUR_ORDER_NUMBER",
  :shopperReference => "YOUR_UNIQUE_SHOPPER_ID",
  :paymentMethod => {    # Data object from paymentComponentData from the client app, parsed from JSON to a Hash.
    :type => "scheme",
    :encryptedCardNumber => "adyenjs_0_1_18$k7s65M5V0KdPxTErhBIPoMPI8HlC..",
    :encryptedExpiryMonth => "adyenjs_0_1_18$p2OZxW2XmwAA8C1Avxm3G9UB6e4..",
    :encryptedExpiryYear => "adyenjs_0_1_18$CkCOLYZsdqpxGjrALWHj3QoGHqe+..",
    :encryptedSecurityCode => "adyenjs_0_1_24$XUyMJyHebrra/TpSda9fha978+..",
    :holderName => "S. Hopper"
},
  :additionalData => {
    :allow3DS2 => true
  },
  :billingAddress => {
    :city => "Amsterdam",
    :country => "NL",
    :houseNumberOrName => "1",
    :postalCode => "1011DJ",
    :street => "Infinite Loop"
  },
  :shopperEmail => "s.hopper@example.com",
  :channel => "Android",
  :returnUrl => "my-app://",
  :merchantAccount => "YOUR_MERCHANT_ACCOUNT"
})

# Check if further action is needed.
if response.body.has_key(:action)
   # Pass the action object to your front end
   # response.body[:action]
else
   # No further action needed, pass the resultCode object to your front end
   # response.body[:resultCode]

Client client = new Client("YOUR_API_KEY", Environment.TEST);

  Checkout checkout = new Checkout(client);

  PaymentsRequest paymentsRequest = new PaymentsRequest();

  paymentsRequest.setMerchantAccount("YOUR_MERCHANT_ACCOUNT");
  paymentsRequest.setReference("YOUR_ORDER_REFERENCE");

  DefaultPaymentMethodDetails paymentMethodDetails = new DefaultPaymentMethodDetails();
  paymentMethodDetails.setType("scheme");
  paymentMethodDetails.setEncryptedCardNumber("adyenjs_0_1_18$k7s65M5V0KdPxTErhBIPoMPI8HlC..");
  paymentMethodDetails.setEncryptedExpiryMonth("adyenjs_0_1_18$p2OZxW2XmwAA8C1Avxm3G9UB6e4..");
  paymentMethodDetails.setEncryptedExpiryYear("adyenjs_0_1_18$CkCOLYZsdqpxGjrALWHj3QoGHqe+..");
  paymentMethodDetails.setEncryptedSecurityCode("adyenjs_0_1_24$XUyMJyHebrra/TpSda9fha978+..");
  paymentMethodDetails.setHolderName("S. Hopper");

  paymentsRequest.setPaymentMethod(paymentMethodDetails);

  Amount amount = new Amount();
  amount.setCurrency("EUR");
  amount.setValue(1000L);

  paymentsRequest.setAmount(amount);

  Map<String, String> additionalData = new HashMap<>();
  additionalData.put("allow3DS2", "true");

  paymentsRequest.setAdditionalData(additionalData);

  Address billingAddress = new Address();
  billingAddress.setCity("Amsterdam");
  billingAddress.setCountry("NL");
  billingAddress.setHouseNumberOrName("1");
  billingAddress.setPostalCode("1011DJ");
  billingAddress.setStreet("Infinite Loop");

  paymentsRequest.setBillingAddress(billingAddress);

  paymentsRequest.setShopperEmail("s.hopper@example.com");

  paymentsRequest.setReturnUrl("adyencheckout://your.package.name");

  PaymentsResponse paymentsResponse = checkout.payments(paymentsRequest);

// Set your X-API-KEY with the API key from the Customer Area.
$client = new \Adyen\Client();
$client->setXApiKey("YOUR_X-API-KEY");
$service = new \Adyen\Service\Checkout($client);

$params = [
  "amount" => [
    "currency" => "EUR",
    "value" => 1000
  ],
  "reference" => "YOUR_ORDER_NUMBER",
  "paymentMethod" => [
    "type" => "scheme",
    "encryptedCardNumber" => "adyenjs_0_1_18$k7s65M5V0KdPxTErhBIPoMPI8HlC..",
    "encryptedExpiryMonth" => "adyenjs_0_1_18$p2OZxW2XmwAA8C1Avxm3G9UB6e4..",
    "encryptedExpiryYear" => "adyenjs_0_1_18$CkCOLYZsdqpxGjrALWHj3QoGHqe+..",
    "encryptedSecurityCode" => "adyenjs_0_1_24$XUyMJyHebrra/TpSda9fha978+..",
    "holderName" => "S. Hopper"
  ],
  "additionalData" => [
     "allow3DS2" => true
  ],
  "billingAddress" => [
     "city" => "Amsterdam",
     "country" => "NL",
     "houseNumberOrName" => "1",
     "postalCode" => "1011DJ",
     "street" => "Infinite Loop"
  ],
  "shopperEmail" => "s.hopper@example.com",
  "channel" => "Android",
  "returnUrl" => "adyencheckout://your.package.name",
  "merchantAccount" => "YOUR_MERCHANT_ACCOUNT"
];

$result = $service->payments($params);

// Check if further action is needed
if (array_key_exists("action", $result){
   // Pass the action object to your client app.
   // $result["action"]
}
else {
   // No further action needed, pass the resultCode to your client app.
   // $result['resultCode']
}

# Set your X-API-KEY with the API key from the Customer Area.
adyen = Adyen.Adyen()
adyen.client.xapikey = 'YOUR_X-API-KEY'

result = adyen.checkout.payments({
  "amount": {
    "currency": "EUR",
    "value": 1000
  },
  "reference":"YOUR_ORDER_NUMBER",
  "paymentMethod": {
    "type": "scheme",
    "encryptedCardNumber": "adyenjs_0_1_18$k7s65M5V0KdPxTErhBIPoMPI8HlC..",
    "encryptedExpiryMonth": "adyenjs_0_1_18$p2OZxW2XmwAA8C1Avxm3G9UB6e4..",
    "encryptedExpiryYear": "adyenjs_0_1_18$CkCOLYZsdqpxGjrALWHj3QoGHqe+..",
    "encryptedSecurityCode": "adyenjs_0_1_24$XUyMJyHebrra/TpSda9fha978+..",
    "holderName": "S. Hopper"
  },
  "additionalData": {
    "allow3DS2": "true"
  },
  "billingAddress": {
    "street": "Infinite Loop",
    "houseNumberOrName": "1",
    "postalCode": "1011DJ",
    "city": "Amsterdam",
    "country": "NL"
  },
  "shopperEmail": "s.hopper@example.com",
  "channel": "Android",
  "returnUrl": "adyencheckout://your.package.name",
  "merchantAccount": "YOUR_MERCHANT_ACCOUNT"
})

// Set your X-API-KEY with the API key from the Customer Area.
var client = new Client ("YOUR-X-API-KEY", Environment.Test);
var checkout = new Checkout(client);
var paymentRequest = new Adyen.Model.Checkout.PaymentRequest
{
    Amount = new Model.Checkout.Amount(Currency: "EUR", Value: 1000),
    Reference = "YOUR_ORDER_REFERENCE",
    PaymentMethod = new DefaultPaymentMethodDetails
    {
        EncryptedCardNumber = "adyenjs_0_1_18$k7s65M5V0KdPxTErhBIPoMPI8HlC..",
        EncryptedExpiryMonth = "adyenjs_0_1_18$p2OZxW2XmwAA8C1Avxm3G9UB6e4..",
        EncryptedExpiryYear = "adyenjs_0_1_18$CkCOLYZsdqpxGjrALWHj3QoGHqe+..",
        EncryptedSecurityCode = "adyenjs_0_1_24$XUyMJyHebrra/TpSda9fha978+..",
        HolderName = "S. Hopper",
        Type = "scheme"
    },
    AdditionalData = new Dictionary<string, string> { { "allow3DS2", "true" } },
    BillingAddress = new Model.Checkout.Address
    {
        City = "Amsterdam",
        Country = "NL",
        HouseNumberOrName = "1",
        PostalCode = "1011DJ",
        Street = "Infinite Loop"
    },
    ShopperEmail = "s.hopper@example.com",
    ReturnUrl = "adyencheckout://your.package.name",
    MerchantAccount = "YOUR_MERCHANT_ACCOUNT"
};

// Set your X-API-KEY with the API key from the Customer Area.
const {Client, Config, CheckoutAPI} = require('@adyen/api-library');
const config = new Config();
// Set your X-API-KEY with the API key from the Customer Area.
config.apiKey = '[API_KEY]';
config.merchantAccount = '[MERCHANT_ACCOUNT]';
const client = new Client({ config });
client.setEnvironment("TEST");
const checkout = new CheckoutAPI(client);
checkout.payments({
  amount:{
    currency: "EUR",
    value: 1000
  },
  reference: "YOUR_ORDER_NUMBER",
  paymentMethod: {
    type: "scheme",
    encryptedCardNumber: "adyenjs_0_1_18$k7s65M5V0KdPxTErhBIPoMPI8HlC..",
    encryptedExpiryMonth: "adyenjs_0_1_18$p2OZxW2XmwAA8C1Avxm3G9UB6e4..",
    encryptedExpiryYear: "adyenjs_0_1_18$CkCOLYZsdqpxGjrALWHj3QoGHqe+..",
    encryptedSecurityCode: "adyenjs_0_1_24$XUyMJyHebrra/TpSda9fha978+..",
    holderName: "S. Hopper"
  },
  additionalData : {
     allow3DS2:true
  },
  billingAddress: {
    city: "Amsterdam",
    country: "NL",
    houseNumberOrName: "1",
    postalCode: "1011DJ",
    street: "Infinite Loop"
  },
  shopperEmail: "s.hopper@example.com",
  channel: "Android",
  returnUrl: "adyencheckout://your.package.name",
  merchantAccount: "YOUR_MERCHANT_ACCOUNT"
}).then(res => res);

Your next steps depend on whether the /payments response contains an action object, and on the action.type:

If you receive an action object, store the action.paymentData on your server - you'll need this when making a /payments/details request later.

`action.type`	Description	Next steps
No `action` object	The transaction was either exempted or out-of-scope for 3D Secure 2 authentication.	1. Return `CallResult` with `ResultType` FINISHED, and the `resultCode` from the `/payments` response. 2. Use the `resultCode` to present the payment result to your shopper.
threeDS2Fingerprint	The payment qualifies for 3D Secure 2, and will go through either the frictionless or the challenge flow.	1. Return `CallResult` with `ResultType` ACTION and the `action` object. 2. Proceed to the next section to Submit authentication results.
redirect	The payment is routed to the 3D Secure 1 flow, based on issuer performance.	1. Return `CallResult` with `ResultType` ACTION and the `action` object. 2. Check the payment result.

The following example shows a /payments response with action.type: threeDS2Fingerprint

https://docs.adyen.com/online-payments/3d-secure/native-3ds2/android-drop-in#-payments-response

/payments response

{
  "resultCode":"IdentifyShopper",
  "action":{
    "{hint: Store this on your server.}paymentData{/hint}":"Ab02b4c0!BQABAgCuZFJrQOjSsl\/zt+...",
    "paymentMethodType":"scheme",
    "token":"eyJ0aHJlZURTTWV0aG9kTm90aWZpY...",
    "type":"threeDS2Fingerprint"
  },
  "authentication":{
    "threeds2.fingerprintToken":"eyJ0aHJlZURTTWV0aG9kTm90aWZpY..."
  },
  ...
}

Submit authentication results

If the CallResult.ResultType is ACTION, Drop-in performs the makeDetailsCall method, and then provides the actionComponentData.

Pass the actionComponentData.details to your server.
From your server, make a /payments/details request, specifying:
- paymentData: The paymentData from the response to your last API request (either to the /payments, or the /payments/details endpoint.)
- details: The actionComponentData.details from Drop-in.

{
        "{hint:value that you stored on your server}paymentData{/hint}":"Ab02b4c0!BQABAgCuZFJrQOjSsl\/zt+...",
        "{hint:actionComponentData.details from app}details{/hint}":{
           "threeds2.fingerprint": "eyJ0aHJlZURTQ29tcEluZCI6ICJZIn0="
        }
}

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

If you receive an action object, store the action.paymentData on your server - you'll need this when making a /payments/details request later.

`action.type`	Description	Next steps
No `action` object	The 3D Secure 2 authentication process has been completed.	1. Return `CallResult` with `ResultType` FINISHED and the `resultCode` from the `/payments/details` response. 2. Use the `resultCode` to present the payment result to your shopper.
threeDS2Challenge	The payment needs to go through a 3D Secure challenge flow.	1. Return `CallResult` with `ResultType` ACTION and the `action` object. 2. Perform the step of submitting authentication results again.

Present the payment result

Use the resultCode from the /payments or /payments/details response to present the payment result to your shopper. You will also receive the outcome of the payment asynchronously in a notification webhook.

For card payments, you can receive the following resultCode values:

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 whether 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 `refusalReason` field.	Inform the shopper that there was an error processing their payment.
Refused	The payment was refused. For more information, check the `refusalReason` field.	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 2 authentication scenarios.

Are you looking for test card numbers?

Would you like to contact support?