Search

Are you looking for test card numbers?

Would you like to contact support?

Payment-method icon

iDEAL Android Component

Add iDEAL to an existing Components integration.

Our iDEAL Component renders iDEAL in your payment form and collects your shopper's selected bank.

When making an iDEAL payment, you additionally need to:

Before you begin

This page explains how to add iDEAL to your existing Android Components integration. The Android Components integration works the same way for all payment methods. If you haven't done this integration yet, refer to our Components integration guide.

Before starting your iDEAL integration:

  1. Make sure that you have set up your back end implementation for making API requests.
  2. Add iDEAL in your test Customer Area.

Show iDEAL in your payment form

To show iDEAL Component in your payment form, you need to:

  1. Specify in your /paymentMethods request:
  2. Deserialize the response from the /paymentMethods call and get the object with type: ideal.
  3. Add the iDEAL Component:

    a. Import the iDEAL Component to your build.gradle file.

    implementation "com.adyen.checkout:ideal-ui:<latest-version>"

    Check the latest version on GitHub.

    b. Create an idealConfiguration object:

    val idealConfiguration =
           IdealConfiguration.Builder(this@YourActivity)
           .setEnvironment(Environment.TEST)
           // When you're ready to accept live payments, change the value to one of our live environments.
           .build()

    c. Initialize the iDEAL Component. Pass the payment method object and the idealConfiguration object.

    val idealComponent = IdealComponent.PROVIDER.get(this@YourActivity, paymentMethod, idealConfiguration)

    d. Add the iDEAL Component view to your layout.

    <com.adyen.checkout.ideal.IdealSpinnerView
          android:layout_width="wrap_content"
          android:layout_height="wrap_content"/>

    e. Attach the Component to the view to start getting your shopper's payment details.

    IdealSpinnerView.attach(idealComponent, this@YourActivity)

    f. When shoppers enter their payment details, you start receiving updates. If isValid is true and the shopper proceeds to pay, pass the paymentComponentState.data.paymentMethod to your server and make a payment request.

    idealComponent.observe(this@MainActivity, Observer {
      if (it?.isValid == true) {
          // When the shopper proceeds to pay, pass the `it.data` to your server to send a /payments request
      }
    })

Make a payment

When the shopper proceeds to pay, the Component returns the paymentComponentState.data.paymentMethod.

  1. Pass the paymentComponentState.data.paymentMethod to your server.
  2. From your server, make a /payments request, specifying:

    • paymentMethod.type: The paymentComponentState.data.paymentMethod from your client app.
    • returnURL: URL to where the shopper should be redirected back to after they complete the payment. Get this URL from the Component in the RedirectComponent.getReturnUrl(context).

      curl https://checkout-test.adyen.com/v51/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
        },
        "{hint:paymentComponentState.data.paymentMethod from app}paymentMethod{/hint}":{
          "type":"ideal",
          "issuer":"0721"
        },
        "returnUrl":"adyencheckout://your.package.name"
      }'
      # 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 => "adyencheckout://your.package.name",
        :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.setIssuer("0721");
          paymentMethodDetails.setType("ideal");
          paymentsRequest.setPaymentMethod(paymentMethodDetails);
      
          paymentsRequest.setReference("YOUR_ORDER_NUMBER");
          paymentsRequest.setReturnUrl("adyencheckout://your.package.name");
      
          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" => "adyencheckout://your.package.name",
        "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': 'adyencheckout://your.package.name',
         '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 = @"adyencheckout://your.package.name",
        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: "adyencheckout://your.package.name"
      }).then(res => res);

    The /payments response contains:

    • action: Object containing information about the redirect.

      {
         "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"
            }
         ],
         ...
      }
  3. Pass the action object to your client app. You need this to initialize the Redirect Component.

Handle the redirect

Use the Redirect Component to redirect the shopper to the issuing bank's app or website. After the shopper is redirected back to your app, make a /payments/details call to check the payment result.

For more information and detailed instructions, refer to Using the Redirect Component.

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

We support recurring transactions for iDEAL through SEPA Direct Debit. To make recurring payments, you need to:

  1. Create a shopper token.
  2. Use the token to make future payments for the shopper.

Create a token

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 charged amount reduces the risk of chargebacks.

To create a token, include in your /payments request:

  • storePaymentMethod: true
  • shopperReference: Your unique identifier for the shopper.

When the payment has been settled, you receive a webhook notification containing:

  • eventCode: RECURRING_CONTRACT
  • originalReference: The pspReference of the initial payment.
  • pspReference: This is the token that you need to make recurring payments for this shopper.

Make a payment with a token

To make a payment with the token, include in your /payments request:

  • paymentMethod.storedPaymentMethodId: The pspReference from the RECURRING_CONTRACT.
You can also get this value by using the /listRecurringDetails endpoint.
  • shopperReference: The unique shopper identifier that you specified when creating the token.
  • shopperInteractionContAuth.
  • recurringProcessingModel: Subscription or UnscheduledCardOnFile.

For more information about the shopperInteraction and recurringProcessingModel fields, refer to Recurring transaction types.

curl https://checkout-test.adyen.com/v51/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": "Subscription"
}'
# 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 => "Subscription"
})
// 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("Subscription");

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" => "Subscription",
  "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': 'Subscription'
})
// 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 = "Subscription",
  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: "Subscription"
}).then(res => res);

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