Card Component v4.x.x integration

Add card payments to your existing Components integration.

Our Card Component 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 Components integration. The Android Components integration works the same way for all payment methods. If you haven't done this integration yet, refer to our Components integration guide.

Before starting your integration:

Make sure that you have set up your back end implementation for making API requests.
Add the cards that you want to accept in your test Customer Area.
Get your client key: 1. Log in to your Customer Area.
Go to Developers > API credentials, and select the credential username for your integration, for example ws@Company.[YourCompanyAccount].
Under Client settings > Authentication select the Client key tab.
Select Generate client key.
Select the copy icon and store your client key securely in your system.
Under Add allowed origins, enter your domains and select Add.
Select Save changes.

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 the Card Component in your payment form, you need to:

Specify in your /paymentMethods request a combination of countryCode and amount.currency. This is used to determine which cards are available to the shopper.
Deserialize the /paymentMethods response, and get the object with type: scheme.
For showing stored cards, get the object with type: storedPaymentMethods.

Add the Card Component:

a. Import the Card Component to your build.gradle file.

  implementation "com.adyen.checkout:card:<latest-version>"

For the latest version, refer to our GitHub.

b. Create a cardConfiguration object, and pass your client key. You can also include optional configuration, for example to make the cardholder name required.

 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()

c. Initialize the Card Component. Pass the object from the /paymentMethods response and the cardConfiguration object.

   val cardComponent = CardComponent.PROVIDER.get(this@YourActivity, paymentMethod, cardConfiguration)

d. Add the Card Component view to your layout.

   <com.adyen.checkout.Card.CardView
          android:id="@+id/cardView"
          android:layout_width="wrap_content"
          android:layout_height="wrap_content"/>

e. Attach the Component to the view to start getting your shopper's payment details.

   cardView.attach(cardComponent, this@YourActivity)

f. When shoppers enter their payment details, you start receiving updates. If isValid is true and the shopper proceeds to pay, pass the paymentComponentState.data to your server and make a payment request.

 cardComponent.observe(this) { paymentComponentState ->
    if (paymentComponentState?.isValid == true) {
       // When the shopper proceeds to pay, pass the `paymentComponentState.data` to your server to send a /payments request
       sendPayment(paymentComponentState.data)
    }
 }

Optional configuration

When you create the CardConfiguration object, you can optionally add configuration parameters.

Address field 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, the Component returns the paymentComponentState.data.paymentMethod.

Pass the paymentComponentState.data to your server.
From your server, make a /payments request, specifying:
- paymentMethod: The paymentComponentState.data.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, the Card Component renders a switch for saving the card details for future payments. If a shopper selects this option, the paymentComponentState from the Component will include data.storePaymentMethod. Pass this to your server.

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

storePaymentMethod: The paymentComponentState.data.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 the cardConfiguration object:

     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