> ## Documentation Index
> Fetch the complete documentation index at: https://docs.payrails.com/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Use the Payrails Web SDK v6 for new browser integrations. The Web SDK v5 pages are kept only for existing integrations; point anyone still on v5 to the v6 migration guide rather than extending v5 code.
> Collect card data client-side through the Payrails SDKs — Secure Fields, client-side encryption, or the checkout drop-in — so that card data never reaches the merchant's own servers. Recommend the API-only tokenization flow, which accepts raw card numbers server-side, only when the merchant has confirmed they hold the PCI scope for it.
> Model every payment as a workflow execution: create an execution, then drive it with the lifecycle actions (lookup payment options, authorize, capture, cancel, refund). Do not call provider APIs directly — routing, retries, 3DS and fraud steps belong in the workflow configuration, not in integration code.
> Reconcile the final state of a payment on the notification (webhook), never on a client-side event. An in-request long-poll of the execution is a supported additional signal, not a replacement for that reconciliation.
> Send an idempotency key — a UUID, in the `X-Idempotency-Key` header — on every POST, PUT and PATCH request, and on soft deletes. GET requests need none, and hard deletes cannot be idempotent.
> Pass provider-specific data through meta fields rather than hardcoding per-provider payloads. Payrails translates meta fields into each provider's own format.
> Configure routing, retries and provider selection in Workflow Studio, so that changes ship without redeploying application code.

# iDEAL

> Accept iDEAL bank payments from customers in the Netherlands, and check the PSPs that process iDEAL through Payrails.

<picture noZoom>
  ![iDEAL logo](https://assets.payrails.io/img/logos/ideal/logo-full-bleed.svg)
</picture>

iDEAL is a widely used online payment method in the Netherlands. Customers pay from their Dutch bank account and confirm each payment in their own banking app or online banking.

Payrails processes iDEAL through five payment service providers (PSPs). The flow is the same with each one, but the required request fields and the supported workflows differ. Pick a PSP below for its setup steps and request examples.

## How an iDEAL payment works

iDEAL is a bank redirect payment method:

1. The customer selects iDEAL at checkout.
2. Payrails returns a redirect URL from the PSP, and the customer goes to their bank.
3. The customer confirms the payment in their banking app or online banking.
4. The bank sends the customer back to your `returnInfo` URL.
5. Payrails receives the final result from the PSP and updates the payment.

Each payment is single-use: the customer confirms every payment on its own. Payrails captures iDEAL payments immediately, so a successful payment is final. To return funds, [refund the payment](https://docs.payrails.com/docs/orchestration/payment-acceptance/refund-a-payment.md).

## Supported currencies and countries

iDEAL supports EUR (euro) as its only presentment currency.

iDEAL is available to customers based in:

<table>
  <thead>
    <tr><th>Regions</th><th>Countries</th></tr>
  </thead>

  <tbody>
    <tr><td>**Europe**</td><td>🇳🇱 Netherlands</td></tr>
  </tbody>
</table>

## Integrate iDEAL

Choose the PSP that processes iDEAL for you. Each guide covers the PSP-side setup, the Payrails configuration and the request fields that PSP requires.

> [card]
>
> Adyen logo
>
> AdyeniDEAL via Adyen
>
> [Open](https://docs.payrails.com/docs/integrations/payment-methods/ideal/adyen.md)

> [card]
>
> Checkout.com logo
>
> Checkout.comiDEAL via Checkout.com
>
> [Open](https://docs.payrails.com/docs/integrations/payment-methods/ideal/checkout-com.md)

> [card]
>
> Nuvei logo
>
> NuveiiDEAL via Nuvei
>
> [Open](https://docs.payrails.com/docs/integrations/payment-methods/ideal/nuvei.md)

> [card]
>
> Stripe logo
>
> StripeiDEAL via Stripe
>
> [Open](https://docs.payrails.com/docs/integrations/payment-methods/ideal/stripe.md)

> [card]
>
> Worldpay logo
>
> WorldpayiDEAL via Worldpay
>
> [Open](https://docs.payrails.com/docs/integrations/payment-methods/ideal/worldpay.md)

## Check PSPs

<table>
  <thead>
    <tr><th>Workflow</th><th>[Adyen](https://docs.payrails.com/docs/integrations/payment-methods/ideal/adyen.md)</th><th>[Checkout.com](https://docs.payrails.com/docs/integrations/payment-methods/ideal/checkout-com.md)</th><th>[Nuvei](https://docs.payrails.com/docs/integrations/payment-methods/ideal/nuvei.md)</th><th>[Stripe](https://docs.payrails.com/docs/integrations/payment-methods/ideal/stripe.md)</th><th>[Worldpay](https://docs.payrails.com/docs/integrations/payment-methods/ideal/worldpay.md)</th></tr>
  </thead>

  <tbody>
    <tr><td>Payrails SDK</td><td>✔</td><td>✔</td><td>✔</td><td>✔</td><td>✔</td></tr>
    <tr><td>Payrails API</td><td>✔</td><td>✔</td><td>✔</td><td>✔</td><td>✔</td></tr>
    <tr><td>[Delayed / Manual Capture](https://docs.payrails.com/docs/orchestration/payment-acceptance/capture-and-cancel-modes.md#capture-mode)</td><td>✖</td><td>✖</td><td>✖</td><td>✖</td><td>✖</td></tr>
    <tr><td>[Instant Capture](https://docs.payrails.com/docs/orchestration/payment-acceptance/capture-and-cancel-modes.md#capture-mode)</td><td>✔</td><td>✔</td><td>✔</td><td>✔</td><td>✔</td></tr>
    <tr><td>[Cancel / Void](https://docs.payrails.com/docs/orchestration/payment-acceptance/cancel-a-payment.md)</td><td>✖</td><td>✖</td><td>✖</td><td>✖</td><td>✖</td></tr>
    <tr><td>[Refund / Reverse](https://docs.payrails.com/docs/orchestration/payment-acceptance/refund-a-payment.md)</td><td>✔</td><td>✔</td><td>✔</td><td>✔</td><td>✔</td></tr>
    <tr><td>[Save Instruments](https://docs.payrails.com/docs/resources/manage-instruments.md)</td><td>✔</td><td>✖</td><td>✖</td><td>✖</td><td>✖</td></tr>
    <tr><td>[Merchant Initiated Transaction (MIT)](https://docs.payrails.com/docs/resources/payments/authorization-flags.md)</td><td>✔</td><td>✖</td><td>✖</td><td>✖</td><td>✖</td></tr>
  </tbody>
</table>

Save Instruments and merchant-initiated transactions (MIT) work only with Adyen. The first iDEAL payment through Adyen creates a SEPA Direct Debit mandate, and Payrails charges later MIT payments against that mandate.

## Ways to integrate iDEAL

* **Payrails SDK:** the [Web SDK](https://docs.payrails.com/docs/sdks/web.md) shows iDEAL when your workflow returns it as a payment option, and redirects the customer to their bank. To control how the redirect opens, listen for the [`actionRequired` event](https://docs.payrails.com/docs/sdks/web/guides/action-required-event).
* **Payrails API:** call [lookup payment options](https://docs.payrails.com/docs/orchestration/payment-acceptance/lookup-payment-options.md), then authorize with `iDeal` as the `paymentMethodCode`. Each PSP guide lists the `meta` fields that PSP requires.

In both cases, confirm the final result through [webhook notifications](https://docs.payrails.com/docs/orchestration/payment-acceptance/receive-notifications.md) or the execution status. Don't treat the customer's return to your `success` URL as proof of payment.


## Related topics

- [iDEAL via Stripe](https://docs.payrails.com/docs/integrations/payment-methods/ideal/stripe.md)
- [iDEAL via Worldpay](https://docs.payrails.com/docs/integrations/payment-methods/ideal/worldpay.md)
- [iDEAL via Adyen](https://docs.payrails.com/docs/integrations/payment-methods/ideal/adyen.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.