Desktop/Mobile Website Browser
Accept iDEAL payments on your website by redirecting shopper to iDEAL payment page. See checkout process below:
- The shopper selects iDEAL as their payment method
- The shopper selects preferred bank or scan a QR code on the checkout page
If
a) The shopper selects a bank from the list, they are redirected to the online banking page to confirm the payment;
b) The shopper scans the QR code, they confirm the payment in the banking app
The shopper is redirected to the payment result page
Step 1. Initialize a Payment Intent
Create a PaymentIntent object with a request_id
, amount
, currency
and a merchant_order_id
from your backend server.
Step 2. Get available banks
iDEAL requires bank_name
when confirming the Payment Intent, you can call this API endpoint /api/v1/pa/config/banks with payment_method_type
, country_code
and lang
to get available bank names based on the payment method selected.
Request:
Response:
Alternatively, you can maintain a list of available banks locally on your server for payment methods that require bank_name
if you do not want to use this API endpoint. However, we highly recommend you get the banks dynamically from this API to avoid any trouble when bank information or availability gets updated.
Supported banks:
bank_name | Display name |
---|---|
rabobank | Rabobank |
abn_amro | ABN AMRO Bank |
van_lanschot_baniers | Van Lanschot Baniers |
triodos | Triodos Bank |
ing | ING Bank |
sns | SNS Bank |
asn | ASN Bank |
regiobank | RegioBank |
knab | Knab |
bunq | Bunq |
handelsbanken | Handelsbanken |
revolut_nl | Revolut |
Step 3. Redirect to iDEAL to complete payment
When a shopper selects to pay with iDEAL on their desktop/mobile browser, call the following API endpoints to get the URL which you can use to redirect the shopper to iDEAL payment page to complete the payment.
- Obtain URL from Airwallex and redirect shopper to iDEAL
Request:
Response: Render the value of url
to redirect shoppers to iDEAL.
- Wait for notification from Airwallex
Airwallex will notify you on the payment result asynchronously via the webhook API. Please refer to webhook documentation to set up your webhook accordingly. Although subscribing to different events is optional, it is recommended to at least subscribe to the payment_intent.succeeded
which indicates that the shopper has successfully paid for the order via iDEAL.
- Query the PaymentIntent status
You may also query the status of a payment anytime via the PaymentIntents API