iDEAL via Adyen

Accept iDEAL payments from customers in the Netherlands with Adyen as the payment service provider (PSP). The customer selects iDEAL, confirms the payment with their bank and returns to your site.

Supported workflows

Workflow	Supported
Payrails SDK	✔
Payrails API	✔
Delayed / Manual Capture	✖
Instant Capture	✔
Cancel / Void	✖
Refund / Reverse	✔
Save Instruments	✔
Merchant Initiated Transaction (MIT)	✔

Before you begin

Complete these steps before you send your first iDEAL payment through Adyen:

Set up an Adyen integration in your workspace. Follow the Adyen integration setup guide if you don’t have one yet.
Ask Adyen to enable iDEAL on your Adyen merchant account.
In the Payrails Portal, go to Settings → Integrations, open your Adyen integration, select iDEAL under Payment methods, and save.
Add iDEAL as a payment option in your workflow.

Request fields for Adyen

Send these fields in the authorize request, in addition to the standard authorize fields. Required fields must be present for the payment to succeed. Payrails sends Optional fields to the PSP when you include them.

Field	Status	Description
`amount.currency`	Required	Must be `EUR`. Payrails rejects other currencies.
`holderReference`	Required	Needed to save the instrument. Set on the execution. Sent to Adyen as the shopper reference for the SEPA Direct Debit mandate.
`paymentComposition[].paymentInstrumentData.futureUsage`	Required	Needed to save the instrument. `Subscription` or `UnscheduledCardOnFile`. Adyen rejects `CardOnFile` for iDEAL.
`meta.customer.email`	Optional	Sent to Adyen as the shopper email.
`meta.customer.name`, `meta.customer.lastName`	Optional	Sent to Adyen as the shopper name.
`meta.customer.country.code`	Optional	Sent to Adyen as the country code, for example `NL`.
`meta.order.softDescriptor`	Optional	Shown on the customer’s bank statement.
`meta.order.lines`	Optional	Sent to Adyen as line items.

Authorize an iDEAL payment

Call authorize a payment with iDeal as the paymentMethodCode. The response includes the redirect to the customer’s bank.

Authorize request

{
  "amount": {
    "value": "25.00",
    "currency": "EUR"
  },
  "paymentComposition": [
    {
      "integrationType": "api",
      "paymentMethodCode": "iDeal",
      "amount": {
        "value": "25.00",
        "currency": "EUR"
      },
      "storeInstrument": true,
      "paymentInstrumentData": {
        "futureUsage": "UnscheduledCardOnFile"
      }
    }
  ],
  "meta": {
    "customer": {
      "email": "sanne.devries@example.com",
      "name": "Sanne",
      "lastName": "de Vries",
      "country": {
        "code": "NL"
      }
    },
    "order": {
      "softDescriptor": "Example Store"
    }
  },
  "returnInfo": {
    "success": "https://example.com/success",
    "error": "https://example.com/error"
  }
}

This example saves the instrument. Leave out storeInstrument and paymentInstrumentData for a one-off payment. After the customer confirms the payment, the bank returns them to your success or error URL. Confirm the result through webhook notifications or the execution status before you fulfill the order.

How Adyen handles iDEAL

Adyen captures iDEAL payments automatically. When Adyen confirms the authorization, Payrails also records the capture, so the payment completes in one step.
When the payment succeeds, Payrails stores the customer’s IBAN and account holder name from Adyen on the instrument, if Adyen returns them.
To save the instrument, set storeInstrument to true on the payment composition. Adyen then creates a SEPA Direct Debit mandate, and Payrails charges later merchant-initiated transactions (MIT) against it as SEPA Direct Debit. For an MIT, send the stored PSP token and keep iDeal as the paymentMethodCode.

Getting Started

Payment Orchestration

Token Vault

Analytics & Reporting

Fraud Management

Chargebacks

Monitoring

Resources

Use Cases

Supported workflows

Before you begin

Request fields for Adyen

Authorize an iDEAL payment

How Adyen handles iDEAL

​Supported workflows

​Before you begin

​Request fields for Adyen

​Authorize an iDEAL payment

​How Adyen handles iDEAL

Supported workflows

Before you begin

Request fields for Adyen

Authorize an iDEAL payment

How Adyen handles iDEAL