Search

Are you looking for test card numbers?

Would you like to contact support?

Payment-method icon

iDEAL for API only

Add iDEAL to an existing API-only integration.

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 are different for test and live payments.

    Test payments

    Bank name Issuer
    Test Issuer 1121
    Test Issuer 2 1151
    Test Issuer 3 1152
    Test Issuer 4 1153
    Test Issuer 5 1154
    Test Issuer 6 1155
    Test Issuer 7 1156
    Test Issuer 8 1157
    Test Issuer 9 1158
    Test Issuer 10 1159
    Test Issuer Refused 1160
    Test Issuer Pending 1161
    Test Issuer Cancelled 1162

    Live payments

    Bank name Issuer
    ABN AMRO 0031
    ASN Bank 0761
    bunq 0802
    Handelsbanken 0804
    ING Bank 0721
    Knab 0801
    Moneyou 0803
    Rabobank 0021
    Regiobank 0771
    SNS Bank 0751
    Triodos Bank 0511
    Van Lanschot Bankiers 0161

We provide logos for iDEAL and the issuing banks, which you can use on your payment form. For more information, refer to Downloading logos for details.

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

In your /paymentMethods request, specify:

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.

curl https://checkout-test.adyen.com/v50/payments \
-H "x-API-key: YOUR_X-API-KEY" \
-H "content-type: application/json" \
-d '{
  "merchantAccount":"YOUR_MERCHANT_ACCOUNT",
  "reference":"YOUR_ORDER_NUMBER",
  "amount":{
    "currency":"EUR",
    "value":1000
  },
  "paymentMethod":{
    "type":"ideal",
    "issuer":"0721"
  },
  "returnUrl":"https://your-company.com/checkout?shopperOrder=12xy.."
}'
# Set your X-API-KEY with the API key from the Customer Area.
adyen = Adyen::Client.new
adyen.api_key = "YOUR_X-API-KEY"
 
response = adyen.checkout.payments({
  :amount => {
    :currency => "EUR",
    :value => 1000
  },
  :reference => "YOUR_ORDER_NUMBER",
  :paymentMethod => {
    :type => "ideal",
    :issuer => "0721"
  },
  :returnUrl => "https://your-company.com/checkout?shopperOrder=12xy..",
  :merchantAccount => "YOUR_MERCHANT_ACCOUNT"
})
// Set YOUR_X-API-KEY with the API key from the Customer Area.
// Change to Environment.LIVE and add the Live URL prefix when you're ready to accept live payments.
    Client client = new Client("YOUR_X-API-KEY", Environment.TEST);
    Checkout checkout = new Checkout(client);

    PaymentsRequest paymentsRequest = new PaymentsRequest();

    String merchantAccount = "YOUR_MERCHANT_ACCOUNT";
    paymentsRequest.setMerchantAccount(merchantAccount);

    Amount amount = new Amount();
    amount.setCurrency("EUR");
    amount.setValue(15000L);
    paymentsRequest.setAmount(amount);

    DefaultPaymentMethodDetails paymentMethodDetails = new DefaultPaymentMethodDetails();
    paymentMethodDetails.setIdealIssuer("0721");
    paymentMethodDetails.setType("ideal");
    paymentsRequest.setPaymentMethod(paymentMethodDetails);

    paymentsRequest.setReference("YOUR_ORDER_NUMBER");
    paymentsRequest.setReturnUrl("https://your-company.com/checkout?shopperOrder=12xy..");

    PaymentsResponse paymentsResponse = checkout.payments(paymentsRequest);
// Set your X-API-KEY with the API key from the Customer Area.
$client = new \Adyen\Client();
$client->setXApiKey("YOUR_X-API-KEY");
$service = new \Adyen\Service\Checkout($client);

$params = array(
  "amount" => array(
    "currency" => "EUR",
    "value" => 1000
  ),
  "reference" => "YOUR_ORDER_NUMBER",
  "paymentMethod" => array(
    "type" => "ideal",
    "issuer" => "0721"
  ),
  "returnUrl" => "https://your-company.com/checkout?shopperOrder=12xy..",
  "merchantAccount" => "YOUR_MERCHANT_ACCOUNT"
);
$result = $service->payments($params);
#Set your X-API-KEY with the API key from the Customer Area.
adyen = Adyen.Adyen()
adyen.client.xapikey = 'YOUR_X-API-KEY'

result = adyen.checkout.payments({
   'amount': {
      'value': 1000,
      'currency': 'EUR'
   },
   'reference': 'YOUR_ORDER_NUMBER',
   'paymentMethod': {
      'type': 'ideal',
      'issuer': '0721'
   },
   'returnUrl': 'https://your-company.com/checkout?shopperOrder=12xy..',
   'merchantAccount': 'YOUR_MERCHANT_ACCOUNT'
})
// Set your X-API-KEY with the API key from the Customer Area.
var client = new Client ("YOUR_X-API-KEY", Environment.Test);
var checkout = new Checkout(client);

var amount = new Model.Checkout.Amount("EUR", 1000);
var details = new Model.Checkout.DefaultPaymentMethodDetails{
  Type = "ideal",
  Issuer = "0721
};
var paymentsRequest = new Model.Checkout.PaymentRequest
{
  Reference = "YOUR_ORDER_NUMBER",
  Amount = amount,
  ReturnUrl = @"https://your-company.com/checkout?shopperOrder=12xy..",
  MerchantAccount = "YOUR_MERCHANT_ACCOUNT",
  PaymentMethod = details
};

var paymentResponse = checkout.Payments(paymentsRequest);
// Set your X-API-KEY with the API key from the Customer Area.
const {Client, Config, CheckoutAPI} = require('@adyen/api-library');
const config = new Config();
// Set your X-API-KEY with the API key from the Customer Area.
config.apiKey = '[API_KEY]';
config.merchantAccount = '[YOUR_MERCHANT_ACCOUNT]';
const client = new Client({ config });
client.setEnvironment("TEST");
const checkout = new CheckoutAPI(client);
checkout.payments({
    amount: { currency: "EUR", value: 1000 },
    paymentMethod: {
        type: 'ideal',
        issuer: '0721'
    },
    reference: "YOUR_ORDER_NUMBER",
    merchantAccount: config.merchantAccount,
    returnUrl: "https://your-company.com/checkout?shopperOrder=12xy.."
}).then(res => res);

The /payments response contains:

  • resultCode: RedirectShopper
  • details: Array that contains the key parameter name and the corresponding data type that you should expect when the shopper is redirected to your returnURL. You need to submit this value in your /payments/details request when handling the redirect.
  • action: Object containing information about the redirect.
  • action.paymentData: Value that you need to submit in your /payments/details request when handling the redirect.
  • action.url: Link to where you should redirect your shopper.
  • action.method: GET or POST. The HTTP request method that you should use. After the shopper completes the payment, they will be redirected back to your returnURL using the same method.
    The redirect method depends on your payment method configuration and the length of the data included in the request, so make sure that your integration can handle both HTTP GET and HTTP POST methods.

{
   "resultCode":"RedirectShopper",
   "action":{
      "method":"GET",
      "paymentData":"Ab02b4c0!BQABAgCSZT7t...",
      "paymentMethodType":"ideal",
      "type":"redirect",
      "url":"https://test.adyen.com/hpp/redirectIdeal.shtml?brandCode=ideal.."
   },
   "details":[
      {
         "key":"payload",
         "type":"text"
      }
   ],
   ...
}

Handle the redirect

To complete an iDEAL payment, you need to redirect the shopper to the issuer's website. After the shopper is redirected back to your website or app, make a /payments/details request to check the payment result.

For more information and detailed instructions, refer to Handling redirects.

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 request that they select a different payment method.
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
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 notification.
Refused The payment was refused by the shopper's bank. Ask the shopper to try the payment again using a different payment method.
If a shopper completed the payment but failed to return to your website or app, you will receive the outcome of the payment in an AUTHORISATION notification.

Recurring payments

iDEAL supports recurring transactions through SEPA Direct Debit. When you submit an iDEAL payment, we create a token with the shopper's SEPA details. You can use this token to make recurring payments using SEPA Direct Debit.

  1. Create a shopper token when you make the payment. Use the /listRecurringDetails endpoint to get the recurringDetailReference, or get it from the AUTHORISATION notification.
  2. Make recurring payments specifying:
    • paymentMethod.type: sepadirectdebit
    • recurringProcessingModel: Recurring payment type. Possible values are Subscription, CardOnFile, and UnscheduledCardOnFile.
    • shopperInteraction: Set this to ContAuth.
    • recurringDetailReference
    curl https://checkout-test.adyen.com/v50/payments \
    -H "x-API-key: YOUR_X-API-KEY" \
    -H "content-type: application/json" \
    -d '{
           "amount":{
              "value":1000,
              "currency":"EUR"
           },
           "paymentMethod":{
              "type":"sepadirectdebit",
              "recurringDetailReference":"7219687191761347"
           },
           "reference":"YOUR_ORDER_NUMBER",
           "merchantAccount":"YOUR_MERCHANT_ACCOUNT",
           "shopperReference":"YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j",
           "shopperInteraction":"ContAuth",
           "recurringProcessingModel": "RECURRING_PAYMENT_TYPE"
    }'
    # Set your X-API-KEY with the API key from the Customer Area.
    adyen = Adyen::Client.new
    adyen.api_key = "YOUR_X-API-KEY"
     
    response = adyen.checkout.payments({
      :amount => {
        :currency => "EUR",
        :value => 1000
      },
      :reference => "YOUR_ORDER_NUMBER",
      :paymentMethod => {
        :type => "sepadirectdebit",
        :recurringDetailReference => "7219687191761347"
      },
      :returnUrl => "https://your-company.com/checkout?shopperOrder=12xy..",
      :shopperReference => "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j",
      :merchantAccount => "YOUR_MERCHANT_ACCOUNT",
      :shopperInteraction => "ContAuth",
      :recurringProcessingModel => "RECURRING_PAYMENT_TYPE"
    })
    // Set YOUR_X-API-KEY with the API key from the Customer Area.
    // Change to Environment.LIVE and add the Live URL prefix when you're ready to accept live payments.
    Client client = new Client("YOUR_X-API-KEY", Environment.TEST);
    Checkout checkout = new Checkout(client);
    
    PaymentsRequest paymentsRequest = new PaymentsRequest();
    
    String merchantAccount = "YOUR_MERCHANT_ACCOUNT";
    paymentsRequest.setMerchantAccount(merchantAccount);
    
    Amount amount = new Amount();
    amount.setCurrency("EUR");
    amount.setValue(15000L);
    paymentsRequest.setAmount(amount);
    
    DefaultPaymentMethodDetails paymentMethodDetails = new DefaultPaymentMethodDetails();
    paymentMethodDetails.setRecurringDetailReference("7219687191761347");
    paymentMethodDetails.setType("sepadirectdebit");
    paymentsRequest.setPaymentMethod(paymentMethodDetails);
    
    paymentsRequest.setReference("YOUR_ORDER_NUMBER");
    paymentsRequest.setReturnUrl("https://your-company.com/checkout?shopperOrder=12xy..");
    paymentsRequest.setShopperInteraction("ContAuth");
    paymentsRequest.setRecurringProcessingModel("RECURRING_PAYMENT_TYPE");
    
    PaymentsResponse paymentsResponse = checkout.payments(paymentsRequest);
    // Set your X-API-KEY with the API key from the Customer Area.
    $client = new \Adyen\Client();
    $client->setXApiKey("YOUR_X-API-KEY");
    $service = new \Adyen\Service\Checkout($client);
    
    $params = array(
      "amount" => array(
        "currency" => "EUR",
        "value" => 1000
      ),
      "reference" => "YOUR_ORDER_NUMBER",
      "paymentMethod" => array(
        "type" => "sepadirectdebit",
        "recurringDetailReference" => "7219687191761347"
      ),
      "returnUrl" => "https://your-company.com/checkout?shopperOrder=12xy..",
      "shopperReference" => "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j",
      "recurringProcessingModel" => "RECURRING_PAYMENT_TYPE",
      "shopperInteraction" => "ContAuth",
      "merchantAccount" => "YOUR_MERCHANT_ACCOUNT"
    );
    $result = $service->payments($params);
    #Set your X-API-KEY with the API key from the Customer Area.
    adyen = Adyen.Adyen()
    adyen.client.xapikey = 'YOUR_X-API-KEY'
    
    result = adyen.checkout.payments({
       'amount': {
          'value': 1000,
          'currency': 'EUR'
       },
       'reference': 'YOUR_ORDER_NUMBER',
       'paymentMethod': {
          'type': 'sepadirectdebit',
          'recurringDetailReference': '7219687191761347'
       },
       'returnUrl': 'https://your-company.com/checkout?shopperOrder=12xy..',
       'shopperReference': 'YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j'
       'merchantAccount': 'YOUR_MERCHANT_ACCOUNT',
       'shopperInteraction':'ContAuth',
       'recurringProcessingModel': 'RECURRING_PAYMENT_TYPE'
    })
    // Set your X-API-KEY with the API key from the Customer Area.
    var client = new Client ("YOUR_X-API-KEY", Environment.Test);
    var checkout = new Checkout(client);
    
    var amount = new Model.Checkout.Amount("EUR", 1000);
    var details = new Model.Checkout.DefaultPaymentMethodDetails{
      Type = "sepadirectdebit",
      RecurringDetailReference = "7219687191761347"
    };
    var paymentsRequest = new Model.Checkout.PaymentRequest
    {
      Reference = "YOUR_ORDER_NUMBER",
      Amount = amount,
      ReturnUrl = @"https://your-company.com/checkout?shopperOrder=12xy..",
      MerchantAccount = "YOUR_MERCHANT_ACCOUNT",
      ShopperReference = "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j",
      RecurringProcessingModel = "RECURRING_PAYMENT_TYPE",
      ShopperInteraction = "ContAuth",
      PaymentMethod = details
    };
    
    var paymentResponse = checkout.Payments(paymentsRequest);
    // Set your X-API-KEY with the API key from the Customer Area.
    const {Client, Config, CheckoutAPI} = require('@adyen/api-library');
    const config = new Config();
    // Set your X-API-KEY with the API key from the Customer Area.
    config.apiKey = '[API_KEY]';
    config.merchantAccount = '[YOUR_MERCHANT_ACCOUNT]';
    const client = new Client({ config });
    client.setEnvironment("TEST");
    const checkout = new CheckoutAPI(client);
    checkout.payments({
        amount: { currency: "EUR", value: 1000 },
        paymentMethod: {
            type: 'sepadirectdebit',
            recurringDetailReference: "7219687191761347"
        },
        reference: "YOUR_ORDER_NUMBER",
        merchantAccount: config.merchantAccount,
        shopperReference: "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j",
        returnUrl: "https://your-company.com/checkout?shopperOrder=12xy..",
        shopperInteraction: "ContAuth",
        recurringProcessingModel: "RECURRING_PAYMENT_TYPE"
    }).then(res => res);
We strongly recommend that you request explicit permission from the shopper if you intend to make recurring SEPA payments. Being transparent about the payment schedule and the amount they will be charged will reduce the risk of chargebacks.

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