Card Component

On this page, you can find additional configuration for adding cards to your Components integration.

Before you begin

This page assumes you've already:

• Built a Components integration.
• Added cards in your Customer Area.

API reference

You don't need to send additional fields for cards. To see optional fields that you can send for all payment methods, choose the endpoint you integrated:

• /sessions: This is the default with Components v5.0.0 or later.
• /payments: If you implemented an additional use case.

You can also send additional fields for specific use cases for example if you want to show debit and credit cards separately or make stored card payments.

Component configuration

Step 1: Create a DOM element

Create a DOM element on your checkout page, placing it where you want the payment method form to be rendered:

 <div id="card-container"></div>

Step 2: Create an instance of the Component

Use the create method of your AdyenCheckout instance, in this case checkout, to create the Component:

const cardComponent = checkout.create('card').mount('#card-container');

Optional configuration

When creating an instance of the Component, you can include a configuration object with the following parameters:

Events

You can also customize your shopper's experience when specific events occur.

Including optional configuration

If you want to add optional configuration, include this in a configuration object. The following example shows how to configure the Component to collect the cardholder name and billing address as required, and customize the icon for Visa:

const cardConfiguration = {
   hasHolderName: true,
   holderNameRequired: true,
   billingAddressRequired: true, // Set to true to show the billing address input fields.
   brandsConfiguration: {
     visa: {                // Customize the icon for Visa
       icon: 'https://...' }
   }
};

Use the create method of your AdyenCheckout instance, in this case checkout, to create an instance of the Component. Add the configuration object if you created one.

const cardComponent = checkout.create('card', cardConfiguration).mount('#card-container');

Card brand recognition

When the shopper is entering their card details, the Component tries to recognize the card brand. When successful, the Component renders the brand icon and the corresponding input field for the card security code (CVC, CVV, or CID).

Co-branded cards

Co-branded cards issued in Europe are rendered by the Component according to the European regulatory guidelines (EU IFR Regulation 2015/751 article 8). This means that the Component renders all supported brands, and allows the cardholder to choose their preferred brand. This functionality is supported in version 3.18.2 and later.

Show debit and credit cards separately

To learn how to present debit and credit cards separately on your payment form, choose the endpoint you're integrating:

 <h1>Debit card</h1>
 <div id="debit-container"></div>

 <h1>Credit card</h1>
 <div id="credit-container"></div>

const debitCards = checkout.paymentMethodsResponse.paymentMethods.find(paymentMethod => paymentMethod.fundingSource === 'debit');

if (debitCards) {
  checkout.create('card', debitCards).mount('#debit-container');
}

const creditCards = checkout.paymentMethodsResponse.paymentMethods.find(paymentMethod => paymentMethod.fundingSource === 'credit');

if (creditCards) {
   checkout.create('card', creditCards).mount('#credit-container');
}

 <h1>Debit card</h1>
 <div id="debit-container"></div>

 <h1>Credit card</h1>
 <div id="credit-container"></div>

const debitCards = paymentMethodsResponse.paymentMethods.find(paymentMethod => paymentMethod.fundingSource === 'debit');

if (debitCards) {
  checkout.create('card', debitCards).mount('#debit-container');
}

const creditCards = paymentMethodsResponse.paymentMethods.find(paymentMethod => paymentMethod.fundingSource === 'credit');

if (creditCards) {
   checkout.create('card', creditCards).mount('#credit-container');
}

Stored card payments

Adyen's tokenization service allows you to securely store shopper's card details for payments. You can configure the Component to:

• Store card details
• Show stored cards
• Make a payment with stored card details

Store card details

Choose the endpoint you integrated:

curl https://checkout-test.adyen.com/v70/sessions \
-H 'X-API-key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
    "merchantAccount":"YOUR_MERCHANT_ACCOUNT",
    "reference":"YOU_REFERENCE",
    "storePaymentMethodMode": "askForConsent",
    "recurringProcessingModel": "CardOnFile",
    "paymentMethod":{
      "type":"scheme",
      "encryptedCardNumber": "adyenjs_0_1_18$MT6ppy0FAMVMLH...",
      "encryptedExpiryMonth": "adyenjs_0_1_18$MT6ppy0FAMVMLH...",
      "encryptedExpiryYear": "adyenjs_0_1_18$MT6ppy0FAMVMLH...",
      "encryptedSecurityCode": "adyenjs_0_1_18$MT6ppy0FAMVMLH..."
    },
    "amount":{
      "currency":"JPY",
      "value": 3000
    }
}'

Show stored cards

When you make the /sessions request, include shopperReference to show the shopper's stored card details.
By default, the Component shows available stored card payment methods. If you don't want to show them, set showStoredPaymentMethods to false when configuring the Component.

To add available stored cards in your payment form:

1. In your /paymentMethods request, include:

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

The /paymentMethods response includes a storedPaymentMethods array containing the stored payment methods for this shopper.

 {
   ...
   "storedPaymentMethods":[
     {
       "brand":"visa",
       "expiryMonth":"10",
       "expiryYear":"2020",
       "holderName":"John Smith",
       "id":"8415718415172204",
       "lastFour":"1111",
       "name":"VISA",
       "supportedShopperInteractions":[
         "Ecommerce",
         "ContAuth"
       ],
       "type":"scheme"
     },
     {
       "brand":"visa",
       "expiryMonth":"12",
       "expiryYear":"2020",
       "holderName":"John Smith",
       "id":"8315720121476805",
       "lastFour":"0008",
       "name":"VISA",
       "supportedShopperInteractions":[
         "ContAuth",
         "Ecommerce"
       ],
       "type":"scheme"
    }
  ]
 ...
 }

When creating an instance of the AdyenCheckout, pass the full /paymentMethods response to the paymentMethodsResponse object .

2. Add stored cards to your payment form:
   a. Create a DOM element for stored payment methods, placing it where you want the form to be rendered:

   <div id="stored-card"></div>

   b. Get the stored payment methods that you want to display from the checkout.paymentMethodsResponse object, and pass this when creating an instance of the Card Component:

   const storedPaymentMethod = checkout.paymentMethodsResponse.storedPaymentMethods[0];
   const card = checkout.create("card", storedPaymentMethod).mount("#stored-card");

When the shopper selects to pay, the Component calls the onChange event, which contains a state.data. If state.isValid is true, collect the state.data and pass this to your server. You need this to make a payment.

Optional configuration for showing stored cards

You can configure the following for stored cards:

Add the configuration to the configuration object of your AdyenCheckout instance.

const configuration = {
  //...other configuration parameters
  paymentMethodsConfiguration: {
    storedCard: {
      hideCVC: true,
      styles: //your styles for stored cards
    }
  },
};

Make a payment with stored card details

When the shopper selects to pay, the Component calls the onChange event, which contains a state.data.

1. Pass the state.data to your server.
2. From your server, make a /payments request, specifying:
   • paymentMethod: The state.data.paymentMethod from the onChange event.
   • shopperReference: The unique shopper identifier that you specified when creating the token.
   • shopperInteraction: ContAuth.
   • recurringProcessingModel: CardOnFile.
   Payment request with a token

   curl https://checkout-test.adyen.com/v68/payments \
   -H "X-API-key: [Your API Key here]" \
   -H "Content-Type: application/json" \
   -d '{
    "amount":{
      "value":2000,
      "currency":"USD"
    },
    "paymentMethod":{
      "type":"scheme",
      "storedPaymentMethodId":"8415718415172204",
      "encryptedSecurityCode":"adyenjs_0_1_18$MT6ppy0FAMVMLH..."
    },
    "reference":"YOUR_ORDER_NUMBER",
    "merchantAccount":"YOUR_MERCHANT_ACCOUNT",
    "returnUrl":"...",
    "shopperReference":"YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j",
    "shopperInteraction":"ContAuth",
    "recurringProcessingModel":"CardOnFile"
   }'

   https://docs.adyen.com/payment-methods/cards/web-drop-in#payment-request-with-a-token

The /payments response contains:

• resultCode: Use this to present the payment result to your shopper.

{
   "pspReference": "8815329842815468",
   "resultCode": "Authorised"
}

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