iDEAL for API-only

Accept iDEAL payments using our APIs, and build your own payment form to have full control over the look and feel of your checkout page.

Before you begin

This page assumes you have already:

• Built a API-only integration.
• Added iDEAL in your Customer Area.

Build your payment form for iDEAL

To show iDEAL in your payment form, you need to:

1. Include iDEAL in the list of available payment methods.
   You don't need to collect any information from the shopper in your payment form.

2. In your /paymentMethods request, specify:

   • countryCode: NL
   • amount.currency: EUR
   • amount.value: The value of the payment.

3. Make a /payments request after the shopper clicks the pay button.

Make a payment

In your /payments request, specify:

• paymentMethod.type: ideal
• returnUrl: The URL where the shopper will be redirected back to after they complete the payment. This URL can have a maximum of 1024 characters.

In the /payments response, note the action object. This contains the information needed to redirect the shopper.

Handle the redirect

1. To complete the payment, redirect the shopper to the action.url returned in the /payments response.

   When using the HTTP GET method:
   For security reasons, when displaying the redirect in the app, we recommend that you use SFSafariViewController for iOS or Chrome Custom Tabs for Android, instead of WebView objects. Also refer to the security best practices for WebView.

2. After the shopper is redirected back to your website, check the payment result by making a POST /payments/details request, specifying:

   • details: object that contains the URL-decoded redirectResult returned when the shopper was redirected back to your site.

3. In the response note the following:

   • resultCode: use this to present the result to your shopper.
   • pspReference: our unique identifier for the transaction.

Present the payment result

Use the  resultCode that you received in the /payments/details response to present the payment result to your shopper.

The resultCode values you can receive for iDEAL are:

resultCode	Description	Action to take
Authorised	The payment was successful.	Inform the shopper that the payment has been successful. You will receive the funds in 2-3 days.
Cancelled	The shopper cancelled the payment while on their bank's website.	Ask the shopper whether they want to continue with the order, or ask them to select a different payment method. Optionally, you can configure an OFFER_CLOSED webhook for cancellations.
Error	There was an error when the payment was being processed.	Inform the shopper that there was an error processing their payment. The response contains a refusalReason, indicating the cause of the error.
Pending or Received	The shopper has completed the payment but the final result is not yet known. It may take minutes or hours for the iDEAL payments network to confirm this.	Inform the shopper that you've received their order, and are waiting for the payment to be completed. You will receive the final result of the payment in an AUTHORISATION webhook. If the transaction is not authorised within 30 minutes, the offer will close. Optionally, you can configure an OFFER_CLOSED webhook for expired offers.
Refused	The payment was refused by the shopper's bank.	Ask the shopper to try the payment again using a different payment method.

If the shopper closed the browser and failed to return to your website, wait for webhooks to know the outcome of the payment:

eventCode	success field	Description	Action to take
AUTHORISATION	false	The transaction failed.	Cancel the order and inform the shopper that the payment failed.
AUTHORISATION	true	The shopper successfully completed the payment.	Inform the shopper that the payment has been successful and proceed with the order.

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.

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.

Store the shopper's preferred bank

iDEAL allows you to store the shopper's preferred bank. With stored bank details, the shopper is redirected from your checkout page to their bank without having to select it.

To store the shopper's preferred bank:

1. Configure your webhook to include bank account details:
   1. Navigate to your CA > Developers > Webhooks.
   2. Next to your webhook, click the three-dot menu and select Edit webhook.
   3. Under Additional settings > Bank, click the Include Bank Account Details checkbox.
   4. At the bottom of the page, click Save configuration.
2. When you receive the webhook with the Authorised iDEAL, store the Bank Identifier Code (BIC) field as the shopper's preferred bank.

Create a payment with the shopper's stored preferred bank

1. Present the stored bank to the shopper on your Checkout page.

2. In your /payments request, include paymentMethod.issuer, where the issuer value is the BIC of the stored bank.

3. Handle the redirect.

4. Present the payment result.

BICs for iDEAL partner banks

Bank name	BIC
ABN AMRO	ABNANL2A
ASN Bank	ASNBNL21
bunq	BUNQNL2A
ING Bank	INGBNL2A
Knab	KNABNL2H
N26	NTSBDEB1
Nationale-Nederlanden	NNBANL2G
Rabobank	RABONL2U
Regiobank	RBRBNL21
Revolut	REVOLT21
SNS Bank	SNSBNL2A
Triodos Bank	TRIONL2U
Van Lanschot Kempen	FVLBNL22
Yoursafe	BITSNL2A

Test and go live

While using your iDEAL 2.0 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	Cancelled
   Cancellation before login	Cancelled
   Expiration	Pending or Received
   Failure	Refused

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

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

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

See also