Cards Drop-in integration

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

When using Drop-in to accept card payments, you can:

• Collect your shopper's billing address. Send the billing address in the payment request if you want to use the Address Verification Service (AVS) to help reduce fraudulent payments.
• Tokenize your shopper's card details for future payments and show their stored card when they return.
• Present credit and debit card forms separately. By default, credit and debit cards are shown in one form. However, in some scenarios you may want to present each one in a separate payment form.
• Show installment payment options. If you offer credit card installments, you can choose options to show to your shopper.

Before you begin

This page explains how to add card payments to your existing Web Drop-in integration. The Web 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 starting your integration:

1. Make sure that you have set up your back end implementation, and added Drop-in to your payments form.
2. Add the cards that you want to accept in your test Customer Area.

Show the available cards in your payment form

Drop-in uses the combination of countryCode and amount.currency from your /paymentMethods request to show the available cards to your shopper.

Optional Drop-in configuration

When creating an instance of Drop-in, you can optionally specify:

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

   const dropin = checkout
       .create('dropin', {
           paymentMethodsConfiguration: {
               card: { // Example optional configuration for cards
                   hasHolderName: true,
                   holderNameRequired: true,
                   enableStoreDetails: true,
                   billingAddressRequired: true, // Set to true to show the billing address input fields.
                   name: 'Credit or debit card',
                   onBrand: handleOnBrand // Your function for handling onBrand event,
                   data : {
                       holderName: 'S. Hopper'
                   }
               },
               ...
           }
       })
       .mount('#dropin');

Show installment payment options

If you are offering credit card installments, you can configure Drop-in to show options for credit card installment payments by adding installmentOptions and showInstallmentAmounts in the card configuration. In the UI, shoppers can choose the type and the number of installments.

    {
     ...
     paymentMethodsConfiguration: {
        card: {
          installmentOptions: { // Example optional installment configuration for cards
            visa: {
                // Shows 1, 2, and 3 as the numbers of monthly installments shoppers can choose.
                values: [1, 2, 3],
                // Shows regular and revolving as plans shoppers can choose.
                plans: [ 'regular', 'revolving' ]
            },
            mc: {
                 ...
            }
          },
          // Shows payment amount per installment.
          showInstallmentAmounts: false
        }
     ...
      }
    }

Make a payment

When the shopper selects to pay, Drop-in calls the onSubmit 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 onSubmit event.
   • billingAddress: Optional The state.data.billingAddress from the onSubmit event. Applicable if you configured Drop-in to collect the shopper's billing address and if you want to use AVS.

curl https://checkout-test.adyen.com/v67/payments \
-H "X-API-key: [Your API Key here]" \
-H "Content-Type: application/json" \
-d '{
  "amount": {
    "currency": "USD",
    "value": 1000
  },
  "reference": "YOUR_ORDER_NUMBER",
  "{hint:state.data.paymentMethod from onSubmit}paymentMethod{/hint}": {
    "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...",
    "holderName": "S. Hopper"
  },
  "{hint:state.data.billingAddress from onSubmit}billingAddress{/hint}": {
       "street": "Infinite Loop",
       "houseNumberOrName": "1",
       "postalCode": "95014",
       "city": "Cupertino",
       "stateOrProvince": "CA",
       "country": "US"
  },
  "returnUrl": "https://your-company.com/checkout?shopperOrder=12xy..",
  "merchantAccount": "YOUR_MERCHANT_ACCOUNT"
}'

# Set your X-API-KEY with the API key from the Customer Area.
adyen = Adyen::Client.new
adyen.api_key = "YOUR_X-API-KEY"
 
response = adyen.checkout.payments({
  :amount => {
    :currency => "USD",
    :value => 1000
  },
  :reference => "YOUR_ORDER_NUMBER",
  :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...",
    :holderName => "S. Hopper"
  },
  :billingAddress => {
    :city => "Cupertino",
    :country => "US",
    :houseNumberOrName => "1",
    :postalCode => "95014",
    :stateOrProvince => "CA",
    :street => "Infinite Loop"
  },
  :returnUrl => "https://your-company.com/checkout?shopperOrder=12xy..",
  :merchantAccount => "YOUR_MERCHANT_ACCOUNT"
})

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("USD");
    amount.setValue(1000L);

    paymentsRequest.setAmount(amount);

    Address billingAddress = new Address();
    billingAddress.setCity("Cupertino");
    billingAddress.setCountry("US");
    billingAddress.setHouseNumberOrName("1");
    billingAddress.setPostalCode("95014");
    billingAddress.setStreet("Infinite Loop");

    paymentsRequest.setBillingAddress(billingAddress);

    paymentsRequest.setReturnUrl("https://your-company.com/checkout?shopperOrder=12xy..");

    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 = array(
  "amount" => array(
    "currency" => "USD",
    "value" => 1000
  ),
  "reference" => "YOUR_ORDER_NUMBER",
  "paymentMethod" => array(
    "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...",
    "holderName" => "S. Hopper"
  ),
  "billingAddress" => [
    "city" => "Cupertino",
    "country" => "US",
    "houseNumberOrName" => "1",
    "stateOrProvince" => "CA",
    "postalCode" => "95014",
    "street" => "Infinite Loop"
  ],
  "returnUrl" => "https://your-company.com/...",
  "merchantAccount" => "YOUR_MERCHANT_ACCOUNT"
);
$result = $service->payments($params);

# 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": "USD",
    "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"
  },
  "billingAddress": {
    "street": "Infinite Loop",
    "houseNumberOrName": "1",
    "postalCode": "95014",
    "city": "Cupertino",
    "stateOrProvince": "CA",
    "country": "US"
  },
  "returnUrl": "https://your-company.com/checkout?shopperOrder=12xy..",
  "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: "USD", Value: 1000),
    Reference = "YOUR_ORDER_NUMBER",
    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"
    },
    BillingAddress = new Model.Checkout.Address
    {
        City = "Cupertino",
        Country = "US",
        HouseNumberOrName = "1",
        StateOrProvince = "CA",
        PostalCode = "95014",
        Street = "Infinite Loop"
    },
    ReturnUrl = "https://your-company.com/checkout?shopperOrder=12xy..",
    MerchantAccount = "YOUR_MERCHANT_ACCOUNT"
};

var paymentResponse = checkout.Payments(paymentsRequest);

// 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 = '[YOUR_MERCHANT_ACCOUNT]';
const client = new Client({ config });
client.setEnvironment("TEST");
const checkout = new CheckoutAPI(client);
checkout.payments({
    amount: { currency: "USD", value: 1000 },
    paymentMethod: {
        type: 'scheme',
        encryptedSecurityCode: "adyenjs_0_1_18$MT6ppy0FAMVMLH...",
        encryptedExpiryMonth: "adyenjs_0_1_18$MT6ppy0FAMVMLH...",
        encryptedExpiryYear: "adyenjs_0_1_18$MT6ppy0FAMVMLH...",
        holderName: "S. Hopper",
        encryptedCardNumber: "adyenjs_0_1_18$MT6ppy0FAMVMLH..."
    },
    billingAddress: {
        city: "Cupertino",
        country: "CA",
        houseNumberOrName: "1",
        postalCode: "95014",
        stateOrProvince: "CA",
        street: "Infinite Loop"
    },
    reference: "YOUR_ORDER_NUMBER",
    merchantAccount: config.merchantAccount,
    returnUrl: "https://your-company.com/..."
}).then(res => res);

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 > API URLs > Additional data settings.

{
  "additionalData": {
    "cardSummary": "1111"
  },
  "pspReference": "851572424333194G",
  "resultCode": "Authorised",
  "merchantReference": "YOUR_ORDER_NUMBER"
}

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

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

Card brand recognition

When the shopper is entering their card details, Drop-in tries to recognize the card brand. When successful, Drop-in 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 Drop-in according to the European regulatory guidelines (EU IFR Regulation 2015/751 article 8). This means that Drop-in renders all supported brands, and allows the cardholder to choose their preferred brand. This functionality is supported in version 3.18.2 and later.

Present debit and credit cards separately

In some scenarios, you may want to present your shoppers with separate payment forms for debit cards and credit cards. Some examples include:

• In Brazil, many shoppers use Combo cards, allowing for both debit and credit transactions. Having a separate form for Debit Card and Credit Card gives your shoppers a clear indication of whether they are making a debit or credit transaction.
• If you accept payments in Sweden, you need to present debit cards before credit cards in order to comply with local legislation.

For more details, see the corresponding sections about Brazil and Sweden.

Required versions

To present debit and credit cards separately in your Web Drop-in integration, you need to use:

• Checkout API v53 or later.
• Web Components 3.9.5 or later.

Show the available debit and credit cards

1. When you make a POST /paymentMethods request from your server, include:
   • splitCardFundingSources: Set to true.
   The following example shows how you would do this for a shopper in the Netherlands, making a 47.00 EUR payment.
   https://docs.adyen.com/payment-methods/cards/ios-drop-in#-paymentmethods-request

   /paymentMethods request

   curl https://checkout-test.adyen.com/v67/paymentMethods \
   -H "x-API-key: YOUR_X-API-KEY" \
   -H "content-type: application/json" \
   -d '{
     "merchantAccount": "YOUR_MERCHANT_ACCOUNT",
     "countryCode": "NL",
     "amount": {
       "currency": "EUR",
       "value": 4700
     },
     "splitCardFundingSources": true
   }'

   The response includes the list of available payment methods, with debit and credit cards split into separate objects.
   https://docs.adyen.com/payment-methods/cards/ios-drop-in#response

   Response

   {
      ...
      "paymentMethods": [
          {
              "brands": [
                  "mc",
                  "visa",
                  "amex"
              ],
              ...
              "fundingSource": "credit",
              "name": "Credit Card",
              "type": "scheme"
          },
          {
              "brands": [
                  "mc",
                  "visa",
                  "amex"
              ],
              "fundingSource": "debit",
              "name": "Debit Card",
              "type": "scheme"
          }
      ]
   }

If your integration is set up correctly, the full /paymentMethods response is passed to the AdyenCheckout instance in your front end. Drop-in then automatically renders separate payment forms for Credit card and Debit card.

When the shopper selects the Pay button from any of the payment forms, Drop-in works the same way as when cards are presented in one form — it calls the onSubmit event which contains a state.data. You can then use the state.data to make a payment.

Brazil

For debit transactions, we highly recommend using 3D Secure and Automatic Capture due to some issuers' restrictions.

Sweden

If you send a /paymentMethods request with countryCode of SE, Drop-in automatically presents Debit Card before Credit Card, in order to comply with Swedish legislations.

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

To store shopper's card details, set enableStoreDetails to true when creating an instance of Drop-in. This will show a check box to your shopper for saving their card details for future payments.

If the shopper chooses to save their card details when making a payment, the onSubmit method from Drop-in will include state.data.storePaymentMethod. Pass this to your server.

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

• storePaymentMethod: The state.data.storePaymentMethod from your front end.
• shopperReference: Your unique identifier for the shopper.

Show a stored card in your payment form

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

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

If you don't want to show previously stored payment methods in the Drop-in payment method list, set showStoredPaymentMethods to false when creating an instance of Drop-in.

Make a payment with a token

When the shopper selects to pay, Drop-in calls the onSubmit 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 onSubmit event.
   • shopperReference: The unique shopper identifier that you specified when creating the token.
   • shopperInteraction: ContAuth.
   • recurringProcessingModel: CardOnFile.
   https://docs.adyen.com/payment-methods/cards/ios-drop-in#payment-request-with-a-token

   Payment request with a token

   curl https://checkout-test.adyen.com/v67/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"
   }'

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

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.
   If you want to test API calls but your client-side integration is not yet ready, add a test_ prefix to the test card credentials. Refer to test with encrypted card details.
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