Card Drop-in integration

There is no required cards specific integration for Drop-in.

There is no required cards specific integration for Drop-in.

If your integration uses iOS Drop-in v5.0.0 or later, you can optionally include the following when you configure the Drop-in:

If your integration uses iOS Drop-in v4.10.3 or earlier, you can optionally include the following when you configure the Drop-in:

When you make a /sessions 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.

curl https://checkout-test.adyen.com/v69/sessions \
-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
}'

Supported from Checkout API v53 or later.

When you make a /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.

curl https://checkout-test.adyen.com/v69/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.

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

Supported from Drop-in v5.0.0 and later.

Creating a token

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

If you or the shopper chooses to store payment details, your instance of AdyenSession creates a token when the shopper pays.

Making a payment with a token

When the shopper pays, your instance of AdyenSession includes the shopper's stored card details. You can also use tokens to make shopper-not-present payments for subscriptions or contracts.

This is the default for Drop-in v4.10.0 and earlier.

Create a token

When a shopper chooses to pay with card, Drop-in renders a switch for saving the card details for future payments.

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

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

• storePaymentMethod: The data.storePaymentMethod from your your client app.
• shopperReference: Your unique identifier for the shopper.

If you don't want to show the switch for saving card details, set showsStorePaymentMethodField to false when creating an instance of Drop-in.

let configuration = DropInComponent.Configuration(apiContext: apiContext)
configuration.card.showsStorePaymentMethodField = false

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.

Make a payment with a token

When the shopper proceeds to pay, Drop-in invokes the didSubmit method which contains data.paymentMethod.

1. Pass the data.paymentMethod to your server.

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

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

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"
 }'

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.

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

If you want to accept credit card installments, initialize installment options and installment configuration:

1. Create installment options

To specify the numbers of monthly installments that the shopper can choose from, initialize InstallmentOptions with either:

• monthValues: an array of unsigned integers for the number of installments offered. Must not be empty and must include integers greater than 1. For example, if you offer three, six, or nine installments, include [3, 6, 9].
• maxInstallmentMonth: an unsigned integer for the maximum number of installments offered. The result is the option from 2 to the number you specify. The integer must be greater than 1. For example, if you include 4, the shopper can choose 1, 2, 3, or 4 installments.

To specify if you offer revolving installments:

• includesRevolving: set to true to offer revolving installments. Default is false.

let installmentOptions = InstallmentOptions.init(monthValues: [3, 6, 9], includesRevolving: false)

let installmentOptions = InstallmentOptions.init(maxInstallmentMonth: 5, includesRevolving: true)

2. Create installment configuration

Create the installment configuration by initializing InstallmentConfiguration with one or both of the following:

• Default options: apply to all card types. Create an installment configuration, providing the default options.

let installmentConfiguration = InstallmentConfiguration.init(defaultOptions: installmentOptions)
installmentOptions: installmentConfiguration

• Card-based options: offered based on card types. Create an installment configuration, providing the card-based options:

//Specify CardType. For example, for Visa, use [visa: installmentOptions].
let installmentConfiguration.init(cardBasedOptions: [CardType: installmentOptions])
installmentOptions: installmentConfiguration