iDEAL Android Component

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:

• Handle the redirect.

Requirements

Show iDEAL in your payment form

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

1. Specify in your /paymentMethods request:
   • countryCode: NL
   • amount.currency: EUR
   • amount.value: The value of the payment.
2. Deserialize the response from the /paymentMethods call and get the object with type: ideal.
3. Add the iDEAL Component:
   1. Import the iDEAL Component to your build.gradle file.

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

      Check the latest version on GitHub.

   2. Create an idealConfiguration object:

      val idealConfiguration =
         IdealConfiguration.Builder(context, "YOUR_CLIENT_KEY")
         .setEnvironment(Environment.TEST)
         // When you are ready to accept live payments, change the value to one of our live environments.
         .build()

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

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

   4. Add the iDEAL Component view to your layout.

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

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

      idealSpinnerView.attach(idealComponent, this@YourActivity)

   6. 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) { paymentComponentState ->
      if (paymentComponentState?.isValid == true) {
        // When the shopper proceeds to pay, pass the `paymentComponentState.data` to your server to send a /payments request
        sendPayment(paymentComponentState.data)
        }
      }

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. This URL can have a maximum of 1024 characters. Get this URL from the Component in the RedirectComponent.getReturnUrl(context).

     In the /payments response, note the action object. This contains the information needed to redirect the shopper.

1. Pass the action object to your client app. You need this to initialize the Redirect Component.

Handle the redirect

1. Use the Redirect Component to redirect the shopper to the issuing bank's app or website.
2. After the shopper returns to your app, make a POST /payments/details request from your server, providing:
   • details: The actionComponentData.details object from the Redirect Component.

You receive a response containing:

• resultCode: Use this to present the payment result to your shopper.
• pspReference: Our unique identifier for the transaction.

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:

If the shopper closed the browser and failed to return to your website, wait for webhooks to know the outcome of the payment:

Recurring payments

Adyen supports recurring payments 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.

1. Create a token

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

• amount: The transaction must have a minimum value of EUR 0.01.
• storePaymentMethod: true
• shopperReference: your unique identifier for the shopper (minimum length three characters). Do not include personally identifiable information (PII), such as name or email address.
• recurringProcessingModel: Subscription or UnscheduledCardOnFile

  From Checkout v70, recurringProcessingModel is a required parameter when creating or using a token.

When the payment is settled, you receive a RECURRING_CONTRACT webhook 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.

2. Make a payment with a token

For each recurring payment for this shopper, make a SEPA payment to the /payments endpoint, specifying:

• paymentMethod.type: sepadirectdebit
• paymentMethod.storedPaymentMethodId: The pspReference from the RECURRING_CONTRACT webhook. You can also get this value using the /listRecurringDetails endpoint.
• shopperReference: The shopper ID you provided when you created the shopper token.
• shopperInteraction: ContAuth.

• recurringProcessingModel: Subscription or UnscheduledCardOnFile.

  From Checkout v70, recurringProcessingModel is a required parameter when creating or using a token.

For more information about the shopperInteraction and recurringProcessingModel fields, refer to Tokenization.

If the payment was successfully received, the response contains:

• resultCode: Received
• pspReference: a unique identifier for this transaction.

You can track whether the payment was successful using webhooks.

Test and go live

While using your iDeal 2.0 test account, you are always redirected to a test payment page where you can simulate different iDEAL result codes. On the payment page:

1. Click Select your bank to navigate to a list of issuers.
2. Select the TESTNL2A issuer.

3. Select the test simulation you want to run according to the following table:

   Test simulation	resultCode produced
   Success	Authorised
   Cancellation	Cancelled
   Cancellation before login	Cancelled
   Expiration	Pending or Received
   Failure	Refused

We recommend that you test each scenario before you go live.

Check the status of test payments in your Customer Area > Transactions > Payments.

Before you can accept live payments, you need to add iDEAL in your live Customer Area.

See also