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

These instructions explain how to add iDEAL to your existing API-only integration. The API-only integration works the same way for all payment methods. If you haven't done this integration yet, refer to our API-only integration guide.

Before starting your iDEAL integration:

1. Make sure that you have set up your back end implementation.
2. Add iDEAL in your test Customer Area.

Build your payment form for iDEAL

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

1. Show a list of available banks to your shopper.

2. After the shopper selects a bank, pass the corresponding Issuer value to your server. You'll need this to make a payment.

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

You can also get the issuer list from the /paymentMethods response, as explained in the API-only integration guide.

In your /paymentMethods request, specify:

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

The list of issuing banks are included in the object with type: ideal.

Make a payment

In your /payments request, specify:

• paymentMethod.type: ideal
• paymentMethod.issuer: The iDEAL issuer value of the shopper's selected bank.
• 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.

The /payments response contains an action object with 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.

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.

You receive a response containing:

• 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

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

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

• amount: The transaction must have a minimum value of EUR 0.01.
• recurringProcessingModel: Subscription or UnscheduledCardOnFile
• storePaymentMethod: true
• shopperReference: Your unique identifier for the shopper (minimum length three characters).

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.

  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:

• storedPaymentMethodId: The pspReference from the RECURRING_CONTRACT webhook.

  You can also get this value by using the /listRecurringDetails endpoint.

• shopperReference: The shopper ID you provided when created the shopper token.
• shopperInteraction: ContAuth.
• recurringProcessingModel: Subscription or UnscheduledCardOnFile.

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