Cards Drop-in v4.x.x integration

Add card payments to your existing Android Drop-in integration.

Our Android Drop-in renders the available cards in your payment form, and securely collects sensitive card information, so it doesn't touch your server.

Before you begin

This page explains how to add cards 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:

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.

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 payment methods to your shopper.

Optional configuration

When creating an instance of Drop-in, you can optionally include a CardConfiguration object to add configuration parameters for cards in your payment form.

The following example shows how to configure Drop-in to make the cardholder name required:

// Optional. Add this if you need any custom configuration for the component.
val cardConfiguration = CardConfiguration.Builder(context, "YOUR_CLIENT_KEY")
    // Makes the cardholder name required
    .setHolderNameRequired(true)
    // When you're ready to accept live payments, change the value to one of our live environments.
    .setEnvironment(Environment.TEST)
    .build()

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

Address fields configuration

Configure the postal code field in AddressConfiguration.PostalCode.

Include the following parameter:

Parameter	Description	Default value
`addressFieldPolicy`	Set if shoppers are required to fill in the fields. Possible values: - Required - Optional - OptionalForCardTypes: include the `brand` parameter, which is a list of values of type `String` to specify which brands input is optional for.	Required

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:
- paymentMethod: The paymentComponentData.paymentMethod from your client app.

The /payments response contains:

pspReference: Our unique identifier for the transaction.
resultCode: Use this to present the payment result to your shopper.
merchantReference: The reference from the /payments request.
additionalData: Additional information about the transaction.
To specify the fields that you want to receive in additionalData, log in to your Customer Area, and go to Developers > Additional data.

Present the payment result

Use the resultCode from the /payments response to present the payment result to your shopper. You will also receive the outcome of the payment asynchronously in a 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.

Additional resultCode values are possible in case of the 3D Secure authentication flow. For more information, refer to Result codes.

Recurring payments

Adyen's tokenization service allows you to securely store shopper's card details for recurring payments. To make recurring payments, you first need to create a shopper token, and then use the token to make future payments for the shopper.

Create a token

When a shopper chooses to pay with card, Drop-in renders a switch for saving the card details for future payments. If the shopper selects this option, the actionComponentData from Drop-in will include a paymentComponentData.storePaymentMethod. Pass this to your server.

To create a token, include in your /payments request:

storePaymentMethod: The paymentComponentData.storePaymentMethod from your client app.
shopperReference: Your unique identifier for the shopper.

If you don't want to show the switch for saving card details, set showStoredPaymentMethods to false when creating an instance of Drop-in.

     val cardConfiguration = CardConfiguration.Builder(context, "YOUR_CLIENT_KEY")
          // hides the switch for saving card details
          .setShowStorePaymentField(false)
          .build()

Show a stored card in your payment form

To show a stored card in your payment form, additionally pass in your /paymentMethods request:

shopperReference: The unique shopper identifier that you specified when creating the token.

Make a payment with a token