Card Component v4.x.x integration

This page explains how to add cards to your existing Android 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.

Requirements

Get your client key

1. Log in to your Customer Area.
2. Go to Developers > API credentials, and select the credential username for your integration, for example ws@Company.[YourCompanyAccount].
3. Under Client settings > Authentication select the Client key tab.
4. Select Generate client key.
5. Select the copy icon and store your client key securely in your system.
6. Under Add allowed origins, enter your domains and select Add.
7. Select Save changes.

Show the available cards in your payment form

To show the Card Component in your payment form, you need to:

1. Specify in your /paymentMethods request a combination of countryCode and amount.currency. This is used to determine which cards are available to the shopper.

2. Deserialize the /paymentMethods response, and get the object with type: scheme.
   For showing stored cards, get the object with type: storedPaymentMethods.

3. 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 are 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:

Make a payment

When the shopper proceeds to pay, the Component returns the paymentComponentState.data.paymentMethod.

1. Pass the paymentComponentState.data to your server.

2. 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:

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 do not 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

When the shopper proceeds to pay, the Component returns the paymentComponentState.data.paymentMethod.

1. Pass the paymentComponentState.data.paymentMethod to your server.

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

   • paymentMethod: The paymentComponentState.data.paymentMethod from your client app.
   • shopperReference: The unique shopper identifier that you specified when creating the token.
   • shopperInteraction: ContAuth.
   • recurringProcessingModel: CardOnFile.

The /payments response contains:

• resultCode: Use this to inform the shopper about the payment status.

You can also use tokens to make shopper-not-present payments for subscriptions or contracts. For more information, refer to Making a payment for a subscription or contract.

Test and go live

If your client-side integration isn't ready, you can test API requests with encrypted card details by adding a test_ prefix to the test card details.

Before making live card payments:

1. Test your integration using our test card numbers. You can check the status of test payments in your Customer Area > Transactions > Payments.

2. Add the cards that you want to accept in your live Customer Area.

3. Configure the Component using the client key from your live Customer Area.

4. Before you can start accepting card payments in the live environment, you need to assess your PCI DSS compliance and submit the required Self-Assessment Questionnaire A document. For more information, refer to PCI DSS compliance guide.

See also