If you are using Android Drop-in v5.0.0 or later:
This payment method requires no additional configuration.
Follow the Drop-in integration guide.
iDEAL is moving to a more centralized infrastructure to process payments.
Adyen merchants currently using iDEAL have a deadline of 01 April 2025 to complete the following:
- Remove the list of banks from their checkout pages.
- Redirect shoppers to the central iDEAL payment page.
Our Android Drop-in renders iDEAL in your payment form, and redirects the shopper to their selected bank's website or app to complete the payment.
Requirements
| Requirement | Description |
|---|---|
| Integration type | Make sure that you have an existing Advanced flow Android Drop-in integration. |
| Setup steps | Before you begin, add iDEAL in your Customer Area. |
Show iDEAL in your payment form
Drop-in uses the countryCode and the amount.currency from your /paymentMethods request to show the available payment methods to your shopper.
To show iDEAL in your payment form, you need to specify in your /paymentMethods request:
- countryCode: NL
- amount.currency: EUR
- amount.value: The value of the payment.
Make a payment
When the shopper proceeds to pay, Drop-in returns the paymentComponentData.paymentMethod.
- Pass the
paymentComponentData.paymentMethodto your server. - From your server, make a /payments request, specifying:
paymentMethod: ThepaymentComponentData.paymentMethodfrom your client app.returnURL: URL to where the shopper should be redirected back to after they complete the payment. This URL can have a maximum of 1024 characters. Get this URL from the Component in theRedirectComponent.getReturnUrl(context).
In the /payments response, note the action object. This contains the information needed to redirect the shopper.
If your integration is set up correctly, the action object is passed from your server to the client.
Check the payment result
Drop-in redirects the shopper to complete the payment. When the shopper returns back to your app, Drop-in provides the actionComponentData object.
From your server, make a POST /payments/details request providing:
details: TheactionComponentData.detailsobject from Drop-in.
You receive a response containing:
resultCode: Use this to present the payment 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 have 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 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:
- 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,
recurringProcessingModelis a required parameter when creating or using a token.
When the payment is settled, you receive a RECURRING_CONTRACT webhook containing:
eventCode: RECURRING_CONTRACToriginalReference: ThepspReferenceof 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.
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
pspReferencefrom 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,
recurringProcessingModelis 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: ReceivedpspReference: a unique identifier for this transaction.
You can track whether the payment was successful using webhooks.
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:
- Click Select your bank to navigate to a list of issuers.
- Select the TESTNL2A issuer.
-
Select the test simulation you want to run according to the following table:
Test simulation resultCodeproducedSuccess 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.
iDEAL is moving to a new infrastructure to process payments. If you already have a test account with Adyen, a new iDEAL payment method has been configured in your Customer Area. To use the new iDEAL payment method for testing, you must disable the old iDEAL payment method and enable the new iDEAL payment method. If your merchant account does not have the new payment method, reach out to our Support Team. Live accounts are not affected by this change.