The most successful and most frequently used payment method in the Netherlands. iDEAL covers all major Dutch banks and nearly all Dutch online consumers are comfortable paying and familiar with it. Learn more about iDEAL.

Consumer bank selection

In the iDEAL payment flow, the consumer selects their online bank and is then redirected to their bank's online environment to approve the payment.

iDEAL supports the provisioning of the consumer's preferred bank. The conditions for providing the bankCode (BIC), and thereby bypassing the iDEAL payment page are:

• Merchants who have access to the consumer's preferred bank are permitted to provide the BIC. This preferred bank could be known, for instance, if it is stored in the user's account.
• Merchants that store the consumer's preferred bank must provide an option to pay with a different bank. This alternative payment option can only be accessed through the iDEAL payment page.
• Merchants that store a preferred bank must be able to support all (new) iDEAL issuers as a preferred bank.

Make an iDEAL payment

iDEAL payments follow our standardized REDIRECT payment flow. However, we recommend including all relevant settings for any authentication methods you support.

To make an iDEAL payment, you'll need to provide the following data at minimum when calling our /v1/payment-charges API:

Request

POST /v1/payment-charges

{
  "paymentMethod": "IDEAL",
  "amount": {
    "value": 1000,
    "currency": "EUR"
  },
  "consumer": {
    "name": "John Smith",
    "country": "NL"
  },
  "instrument": {
    "type": "BANK_ACCOUNT",
    "details": {
      "bankCode": "TESTNL2A" //optional
    }
  },
  "authenticationSettings": [
    {
      "type": "REDIRECT",
      "settings": {
        "returnUrl": "https://www.webshop.com/order-results-page"
      }
    }
  ]
}

Response

You'll receive our standard payment charge response (see potential responses in the API Reference)

{
  "id": "charge_X0O78tadFHrZCbGhkycPk",
  "status": "AUTHENTICATION_PENDING",
  
  // ...
  
  "authenticationMethods": [
    {
      "type": "REDIRECT",
      "details": {
        "requestUrl": "https://redirection-target.ppro.com",
        "requestMethod": "GET"
      }
    }
  ]
}

Pick the desired authentication method

REDIRECT

1. Redirect your consumer to the returned $.authenticationMethods[?(@.type == "REDIRECT")].details.requestUrl.
   For example, with the value of https://redirection-target.ppro.com/ using the returned $.authenticationMethods[?(@.type == "REDIRECT")].details.requestMethod HTTP method.
2. The consumer will finalize the payment process on the redirected page.

Handling the payment result

REDIRECT

1. Once the consumer has confirmed the payment, they are redirected to the returnUrl provided in the initial payment charge creation request.
2. After the consumer is redirected back to your site, check the payment status by making a GET /v1/payment-charges/{paymentChargeId}. Use the Status that you received to display the payment outcome to the consumer.
3. Webhooks are also sent to inform you of the payment outcome. If the shopper closes the browser and doesn't return to your website, you can rely on webhooks to receive the payment result.

Payment instrument

An instrument of type BANK_ACCOUNT will be created for iDEAL payments where the consumers bank account details will be returned.

Request

GET /v1/payment-instruments/{instrument-id}

Response

{
  "id": "instr_2mNvmRvn1YtinziAyY1Og",
  "details": {
    "holderName": "The dude",
    "iban": "NL18ABNA0484869868",
    "swiftCode": "ABNANL2A",
    "bankCode": "ABNANL2A"
  },
  "type": "BANK_ACCOUNT"
}

Account on file

To streamline future iDEAL transactions, include the instrumentId in your requests. This allows for bypassing of the bank selection step and route the payment directly using the associated bankCode.