iDEAL Component

This page explains how to add iDEAL to your existing Web Components integration.

Requirements

Select the server-side flow that your integration uses:

API reference

You do not need to send additional fields for iDEAL. 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.

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:

Copy code
 <div id="ideal-container"></div>

Step 2: Create an instance of the Component

v6.0.0 or later

Create an instance of the Component, passing:

• Your instance of AdyenCheckout.

Copy code
const ideal = new Redirect(checkout, { type: 'ideal' }).mount('#ideal-container');

Copy code
const idealComponent = checkout.create('ideal').mount('#ideal-container');

Optional configuration

With iDEAL 2.0, optional configurations are no longer available for Components.

Recurring payments

Adyen supports recurring payments for iDEAL through SEPA Direct Debit. To make recurring payments, you need to:

1. Create a shopper token.
2. Use the token to make future payments for the shopper.

1. Create a token

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

• amount: The transaction must have a minimum value of EUR 0.01.
• storePaymentMethod: true
• shopperReference: your unique identifier for the shopper (minimum length three characters). Do not include personally identifiable information (PII), such as name or email address.
• recurringProcessingModel: Subscription or UnscheduledCardOnFile

  From Checkout v70, recurringProcessingModel is a required parameter when creating or using a token.

When the payment is settled, you receive a RECURRING_CONTRACT webhook containing:

• eventCode: RECURRING_CONTRACT
• originalReference: The pspReference of the initial payment.
• pspReference: This is the token that you need to make recurring payments for this shopper.

2. Make a payment with a token

For each recurring payment for this shopper, make a SEPA payment to the /payments endpoint, specifying:

• paymentMethod.type: sepadirectdebit
• paymentMethod.storedPaymentMethodId: The pspReference from the RECURRING_CONTRACT webhook. You can also get this value using the /listRecurringDetails endpoint.
• shopperReference: The shopper ID you provided when you created the shopper token.
• shopperInteraction: ContAuth.

• recurringProcessingModel: Subscription or UnscheduledCardOnFile.

  From Checkout v70, recurringProcessingModel is a required parameter when creating or using a token.

For more information about the shopperInteraction and recurringProcessingModel fields, refer to Tokenization.

curl https://checkout-test.adyen.com/checkout/v68/payments \
-H 'x-api-key: ADYEN_API_KEY' \
-H 'content-type: application/json' \
-d '{
   "amount":{
      "value":1000,
      "currency":"EUR"
   },
   "paymentMethod":{
      "type":"sepadirectdebit",
      "storedPaymentMethodId":"7219687191761347"
   },
   "reference":"YOUR_ORDER_NUMBER",
   "merchantAccount":"YOUR_MERCHANT_ACCOUNT",
   "shopperReference":"YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j",
   "shopperInteraction":"ContAuth",
   "recurringProcessingModel": "Subscription"
}'

If the payment was successfully received, the response contains:

• resultCode: Received
• pspReference: a unique identifier for this transaction.

You can track whether the payment was successful using webhooks.

BICs for iDEAL partner banks

Test and go live

Request iDEAL for the live environment

Before you can accept live payments, you need to add iDEAL in your live Customer Area.

Live Penny Testing

1. Get a live bank account from one of the iDEAL issuers.
2. Create an iDEAL payment on live and redirect to the iDEAL Payment Page.
3. Scan the QR code on the iDEAL Payment Page or Click Select your bank to navigate to a list of issuers.
4. Authorise the payment.
5. Check the status of test payments in your live Customer Area > Transactions > Payments.

Testing on the Test environment

In case the iDEAL test environment is up and running, it may be possible to test using your test account. You are always redirected to a test payment page where you can simulate different iDEAL result codes.

On the payment page:

1. Click Select your bank to navigate to a list of issuers.
2. Select the TESTNL2A issuer.

3. Select the test simulation you want to run according to the following table:

   Test simulation	resultCode produced
   Success	Authorised
   Cancellation	Canceled
   Cancellation before login	Canceled
   Expiration	Pending or Received
   Failure	Refused

When possible, we recommend that you test each scenario before you go live, otherwise you should perform a Live Penny Test to verify your integration.

Check the status of test payments in your Customer Area > Transactions > Payments.

See also