Accept payments with iDEAL, the go-to online banking method in the Netherlands, with widespread support from major Dutch banks.

When customers use iDEAL, they select their issuing bank and complete payments on the bank’s platform. It is highly secure, with immediate payment notification.

How to use iDEAL

The journey unfolds as follows:

1. On the merchant’s website, the customer selects iDEAL as their payment method.
2. They are redirected to a page where they are presented with a list from which they can select their preferred bank.
3. The customer chooses a bank from the list, and they are redirected to their online bank.
4. The customer confirms the payment and is redirected back to the merchant’s website.
5. The merchant receives the payment confirmation.
6. The merchant can ship the order/deliver the goods to the customer.

How it works

Here is an overview of the crucial steps required to integrate the iDEAL payment method.

Step 1: Create the Order

Step 2: Get the Payment Link

Step 3: Get the Payment Status

Step 1: Create the Order

Make sure to initiate the order request with iDEAL (“IDEL”) as the chosen payment method (transaction.paymentMethod) and configure the customer’s language preference in customerInfo.customerLanguage.

Step 2: Get the Payment Link

Follow the instructions below to obtain the payment link, to redirect the customer to a secure payment page for authentication and payment authorization.

Please be aware that the request below requires an Authorization Header containing the transactionSignature obtained on the previous step.

Endpoints:

Ensure that you include these essential elements as specified:

Header parameters:

Request parameters:

Here’s a model of how to get the payment link:

{
 "userAcceptanceIndicator": true,
 "gatewayId": "bcmc",
 "info": {
 "deviceInfo": {
 "browserAcceptHeader": "application/json, text/plain, */*",
 "browserJavaEnabled": "false",
 "browserLanguage": "en",
 "browserColorDepth": "24",
 "browserScreenHeight": "1080",
 "browserScreenWidth": "1920","browserTZ": "-60",
 "browserUserAgent": "Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/106.0.0.0 Safari/537.36",
 "geoLocalization": "Lat: 38.7350528 | Long: -9.2143616",
 "systemFamily": "Windows",
 "systemVersion": "Windows",
 "deviceID": "498bfd4c3a3645b38667a7037b616c18",
 "applicationName": "Chrome",
 "applicationVersion": "106"
 },
 "customerInfo": [
 {
 "key": "customerName",
 "value": "Test Name"
 },
 {
 "key": "customerEmail",
 "value": email@provider.com
 }
 ],
 "accountInfo": {
 "holderName": "Test Name",
 "customerCountry": "BE"
 }
 },
 "merchant": {
 "merchantURL": https://egadget2.azurewebsites.net/#/returns?id={{transactionId}}
 }
}

After successfully completing the operation, a ‘pending’ paymentStatus is received.

The user is then redirected to a payment confirmation environment before being seamlessly returned to the merchant’s URL.

Step 3: Get the Payment Status

You can perform a “Get Status” operation to check the status at any time.

The Authorization HTTP header is set to the Bearer token as it was used in the initial Checkout.

GET {transactionID}/status

Request URL:

https://stargate-cer.qly.site1.sibs.pt/api/v1/payments/{transactionID}/status

Request Headers:

Authorization: ‘Bearer <AuthToken>’
X-IBM-Client-Id: ‘<ClientId>’
Content-Type: application/json

A successful technical response comprises of an HTTP-200 status and a returnStatus.statusCode=”000″.

Here are some examples of the possible result codes: