Payment-method icon

Cards Drop-in integration

Add cards to an existing Drop-in integration.

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

This page is for v5.0.0, released in October 2023. If you're using an earlier version, use the guide for earlier versions instead.

Before you begin

Choose which server-side flow your integration uses:

API reference

When you make the /sessions request, no additional fields are required for cards.

Drop-in Configuration

When you configure Drop-in, no specific configuration for cards is required.

Optional configuration

You can include the following functions in the configuration object:

Configuration function Description Parameter
setAddressConfiguration Options for address fields. An AddressConfiguration object.
setHideCvc If the security code (CVC/CVV) field is hidden. hideCvc: Boolean
Default: false.
setHideCvcStoredCard If the security code (CVC/CVV) field is hidden for stored cards. hideCvcStoredCard: Boolean
Default: false.
setHolderNameRequired If the cardholder name is required. holderNameRequired: Boolean
Default: false.
setInstallmentConfiguration Options for installment payments. An InstallmentConfiguration object.
setKcpAuthAvailability Options for the security field for Korean cards. A KCPAuthVisibility object.
Enum values:
- HIDE
- SHOW
setShopperReference Your unique shopper reference. This is passed back to you in the PaymentComponentData when the payment flow finishes. shopperReference: String
setSocialSecurityNumberVisibility For Brazil card payments, if the CPF/CNPJ social security number field is shown. A SocialSecurityNumberVisibility object.
Enum values:
- HIDE
- SHOW
setSupportedCardTypes The card brands or types supported for the payment. While the shopper enters their card number, supported brands or types are shown on the payment form. An array of supportCardBrands or supportCardTypes.
Default: PaymentMethod.brands, if it exists. Otherwise, DEFAULT_SUPPORTED_CARDS_LIST.

For example, to add configuration to set the Postal Code field to be optional for Mastercard and JCB:

Address fields

In the AddressConfiguration object, you can configure the following classes:

  • FullAddress: all of the address fields on the payment form. You can include the following:

    Parameter Description Default value
    addressFieldPolicy 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 data type String to specify which brands input is optional for.
    Required
    defaultCountryCode The default country code that is selected when the payment form initializes. String value, for example, NL. null
    supportedCountryCodes The supported country codes. A list of String values.
  • PostalCode: the Postal Code field on the payment form. You can inclue the following:

    Parameter Description Default value
    addressFieldPolicy 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 data type String to specify which brands input is optional for.
    Required

After adding configuration to Drop-in, create the checkout session.

Showing debit and credit cards separately

Drop-in can show separate payment forms for debit cards and credit cards. Here are example use cases for this feature:

  • In Brazil, Mexico, and Finland, many shoppers use combo cards that can make both debit or credit transactions. Separate forms for Debit Card and Credit Card lets the shopper choose the type of transaction.
  • To accept card payments in Sweden, local legislation requires you to show the debit card payment options before the credit card ones.

When you make a /sessions request from your server, include:

The following example shows how to do this for a shopper in the Netherlands, making a EUR 47.00 payment.

Combo cards

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

Sweden

To comply with local legislation, set countryCode to SE in your request. Drop-in shows the payment form for Debit Card before the one for Credit Card.

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-badged cards

Co-badged cards are rendered by Drop-in according to the co-badged card regulations for the applicable regions. This means that Drop-in renders all supported brands, and allows the cardholder to choose their preferred brand.

Stored card payments

Adyen's tokenization service allows you to securely store shopper's payment details for future payments. You first need to create a token.

Storing the shopper's payment details

Include the storedPaymentMethodMode parameter in your /sessions request. Possible values:

Value Description
disabled (default) Don't store payment details.
askForConsent If shopperReference is included in the request, show a checkbox in the payment form that the shopper can select to store their payment details.
enabled If shopperReference is included in the request, store the shopper's payment details without asking them.

If you or the shopper chooses to store payment details, Adyen creates a token for the shopper's payment details when the shopper pays.

Making a payment with stored payment details

When the shopper pays, Drop-in uses the token for the shopper's payment details. You can also use tokens to make shopper-not-present payments for subscriptions or contracts.

Accepting installment payments

If you want to accept credit card installments, include in the /sessions request, include the installmentOptions object which includes the following fields:

Field Required Description
values -white_check_mark- An array of the number of installments that the shopper can choose.
preselectedValue The preselected number of installments in the payment form.
plans An array that shows the types of installment plans that the shopper can choose.
Possible values: regular and revolving.
If not included, the default is regular.

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.

See also