iDEAL via Checkout.com

Accept iDEAL payments from customers in the Netherlands with Checkout.com 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 Checkout.com:

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

Request fields for Checkout.com

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
`meta.order.description`	Required	Sent as the payment description. Checkout.com requires it for iDEAL in production.
`meta.customer.email`	Optional	Sent to Checkout.com as the customer email.
`meta.customer.name`, `meta.customer.lastName`	Optional	Sent to Checkout.com as the customer name.

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"
      }
    }
  ],
  "meta": {
    "customer": {
      "email": "sanne.devries@example.com",
      "name": "Sanne",
      "lastName": "de Vries"
    },
    "order": {
      "description": "Order 1234"
    }
  },
  "returnInfo": {
    "success": "https://example.com/success",
    "error": "https://example.com/error"
  }
}

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 Checkout.com handles iDEAL

Checkout.com needs no payment token for iDEAL. Payrails creates the iDEAL source at Checkout.com from the authorize request.
Payrails sets the bank page language to Dutch (nl).
Payrails doesn’t send the billing address to Checkout.com for iDEAL.

Merchant regions

Merchants based in these regions can accept iDEAL through Checkout.com:

European Economic Area
United Kingdom

Getting Started

Payment Orchestration

Token Vault

Analytics & Reporting

Fraud Management

Chargebacks

Monitoring

Resources

Use Cases

Supported workflows

Before you begin

Request fields for Checkout.com

Authorize an iDEAL payment

How Checkout.com handles iDEAL

Merchant regions

​Supported workflows

​Before you begin

​Request fields for Checkout.com

​Authorize an iDEAL payment

​How Checkout.com handles iDEAL

​Merchant regions

Supported workflows

Before you begin

Request fields for Checkout.com

Authorize an iDEAL payment

How Checkout.com handles iDEAL

Merchant regions