Payment-method icon

iDEAL Drop-in integration

Add iDEAL to an existing Drop-in integration.

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

Before you begin

This page assumes you have already:

API reference

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

Drop-in configuration

Optional configuration

You can add the following optional configuration:

Parameter name Description Default
showImage Set to false to remove the bank logos from the iDEAL form. true
issuer Set to an iDEAL issuer ID to preselect a specific bank. No bank is preselected.
highlightedIssuers Set to the iDEAL issuer IDs for banks you want to show on top of the dropdown menu. Added in v5.1.0 All issuers are shown in the dropdown.
placeholder The string you want to show as the dropdown menu text. Custom translation configuration overrides this value. Select your bank

If you want to add optional configuration, include this in a configuration object. The following example shows how to configure Drop-in to remove the bank logos, and preselect ABN AMRO:

const idealConfiguration = {
  showImage: false, // Optional. Set to **false** to remove the bank logos from the iDEAL form.
  issuer: "0031" // Optional. Set this to an **id** of an iDEAL issuer to preselect it.

Include the idealConfiguration object when creating a configuration object for Drop-in:

List of issuer IDs

The available banks for iDEAL are different in the test and live environment:

Bank name Issuer ID
Test Issuer 1121
Test Issuer 2 1151
Test Issuer 3 1152
Test Issuer 4 1153
Test Issuer 5 1154
Test Issuer 6 1155
Test Issuer 7 1156
Test Issuer 8 1157
Test Issuer 9 1158
Test Issuer 10 1159
Test Issuer Refused 1160
Test Issuer Pending 1161
Test Issuer Cancelled 1162

Recurring payments

We support recurring transactions 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.

Create a token

We strongly recommend that you request explicit permission from the shopper if you intend to make recurring SEPA payments. Being transparent about the payment schedule and the charged amount reduces the risk of chargebacks.

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

As of 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:

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

    Make sure that your server is able to receive RECURRING_CONTRACT as part of your standard webhooks. You can enable the RECURRING_CONTRACT event code in the webhook settings page.

Make a payment with a token

For each recurring payment for this shopper, make a SEPA payment with a  /payments call, and additionally include:

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

For more information about the shopperInteraction and recurringProcessingModel fields, refer to Recurring transaction types.

If the payment was successfully received the response will contain a Received resultCode and a pspReference, which is our unique identifier for this transaction. You can track whether the payment was successful using webhooks.

Test and go live

We provide different test issuers for testing iDEAL payments, including testing for payments with Cancelled, Pending, or Refused result codes. Select the corresponding test issuer name, for example, Test Issuer Cancelled to simulate a cancelled payment scenario.

We recommend that you test each scenario before you go live.

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

Before you can accept live iDEAL payments, you need to submit a request for iDEAL in your live Customer Area.

See also