About iDEAL

General information about iDEAL

Like giropay in Germany, Dutch banks established the iDEAL money transfer standard. Approximately 50% of all e-commerce payments in the Netherlands are processed with iDEAL. Offering iDEAL is a vital success factor for e-commerce business wanting to sell in the Netherlands. The customer is using the familiar and trusted online banking of its own credit institution, just the same as with online banking.

With online banking, the data disclosed in the online transfer is encrypted with SSL (Secure Sockets Layer) to prevent manipulation.

Logo

Info

Bank transfers with iDEAL are a guarantee of success in the Netherlands: About 100.000 webshops and organizations offers iDEAL with approximately 50% of all e-commerce payments being processed with iDEAL. Monthly there are about 13 million transactions.

Type

Payments by Online Bank Transfer

Further information can be found on iDEAL-website in Dutch and English (www.ideal.nl).

Specific requirement iDEAL Mobile: Redirect to Issuer (no in-app browser)

The Merchant needs to provide the redirect to the Issuer from the browser window or Merchant app where the Consumer selected the Issuing bank. If it is not possible to keep the Consumer in the same browser window then this should be communicated to the Consumer (e.g. ‘You will now be redirected to the app or mobile website of your bank’).

In case of a payment initiated in the Merchant app, it is not allowed to present the Issuer approval screens in a webview component within the Merchant’s own app (in-app browser). The complete payment flow, up to the redirect back to the Merchant’s app, must take place in an app that is trusted by the Consumer, either the Consumer’s chosen browser or the Issuer’s mobile app. Thus, for execution the issuerAuthentionURL must be offered to the operating system at all times. During the payment flow it must not be possible for the Consumer to initiate another payment through the Merchant’s original app.

Relevant details about the redirect from the Merchant to the Issuer’s mobile channel:

The Issuer decides which Consumers to redirect to which channel. For example some Issuers may treat users of tablet devices the same as mobile users while others will treat them like PC users;

The Merchant should not intervene with the redirect. There is only one issuerAuthenticationURL for the Merchant to use in all transactions, not a separate URL for mobile iDEAL transactions. The issuerAuthenticationURL should be executed by the operating system at all times;

If the Issuing bank has integrated iDEAL mobile in its mobile banking app, the Consumer is offered the option, on a ‘landing page’, to open the app or pay via the (mobile) web page. On this ‘landing page’ the Consumer might be offered the option to download the latest version of the mobile banking app, if it is not yet installed on the Consumer’s device.

Process flow chart

iDEAL process flow

interface

Calling the iDEAL interface

To process a payment with online transfer with iDEAL, please use the following URL:

ideal.aspx

Key

REST

Format

CND

Description

Beschreibung

TransID

"transactionId": "..."

an..35

M

TransactionID provided by you which should be unique for each payment.

If you do not transfer the RefNr parameter separately, the TransID value in the direction of iDEAL becomes the purchaseID and this is subject to the following limitation: Only the characters a-zA-Z0-9, are allowed, no special characters, format an..35.

Ihre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss.

Sollten sie separat keine RefNr übergeben, wird der Wert TransID in Richtung iDEAL zur purchaseID und diese unterliegt der nachfolgenden Limitierung: Nur die Zeichen a-zA-Z0-9, sind erlaubt, keine Sonderzeichen, Format an..35.

RefNr

"referenceNumber": "..."

ans..

O

Unique reference number. In case of using the EMS interface the length is limited to 15 chars.

In case of PPRO: Only characters a-zA-Z0-9,-_ are allowed, format ans..40.

In case of direct integration via a Dutch bank (will be passed on to iDEAL as purchaseID): Only the characters a-zA-Z0-9, are allowed, no special characters, format an..35.

Eindeutige Referenznummer. Bei Verwendung der EMS-Schnittstelle ist die Übergabe auf 15 Stellen limitiert.

Bei PPRO: Nur die Zeichen a-zA-Z0-9,-_ sind erlaubt, Format ans..40.

Bei Direktintegration über eine niederländische Hausbank (wird als purchaseID an iDEAL weitergegeben): Nur die Zeichen a-zA-Z0-9, sind erlaubt, keine Sonderzeichen, Format an..35.

Key	REST	Format	CND	Description	Beschreibung
OrderDesc	"order": {"description": "..."}	ans..768	O	Description of purchased goods, unit prices etc. Please note: The first 27 characters appear on the customer-account statement. You can view the full data in .	Beschreibung der gekauften Waren, Einzelpreise etc. Bitte beachten Sie: Die ersten 27 Zeichen erscheinen auf dem Kontoauszug des Kunden. In können Sie die kompletten Daten einsehen.

Key

REST

Format

CND

Description

Beschreibung

BIC

"payment": {"ideal": { "account": { "code": "..." }}}

ans..11

O

Bank Identifier Code

For iDEAL via PPRO: In case this optional parameter is provided with any of the values below the redirection page to select the desired bank is bypassed.

Bank name	BIC
Rabobank	RABONL2U
ABN AMRO	ABNANL2A
Van Lanschot Baniers	FVLBNL22
Triodos Bank	TRIONL2U
ING Bank	INGBNL2A
SNS Bank	SNSBNL2A
ASN	ASNBNL21
RegioBank	RBRBNL21
Knab	KNABNL2H
Bunq	BUNQNL2A
Handelsbanken	HANDNL2A
Revolut	REVOLT21
Yoursafe bank	BITSNL2A
N26 bank	NTSBDEB1
Nationale Nederlanden bank	NNBANL2G

Bank Identifier Code

Bei iDEAL via PPRO: Falls dieser optionale Parameter mit einem der nachstehenden Werte übermittelt wird, wird die Weiterleitungsseite zur Auswahl der gewünschten Bank übersprungen.

Bankname	BIC
Rabobank	RABONL2U
ABN AMRO	ABNANL2A
Van Lanschot Baniers	FVLBNL22
Triodos Bank	TRIONL2U
ING Bank	INGBNL2A
SNS Bank	SNSBNL2A
ASN	ASNBNL21
RegioBank	RBRBNL21
Knab	KNABNL2H
Bunq	BUNQNL2A
Handelsbanken	HANDNL2A
Revolut	REVOLT21
Yoursafe bank	BITSNL2A
N26 bank	NTSBDEB1
Nationale Nederlanden bank	NNBANL2G

IssuerID

"payment": {"ideal": { "issuerId": "..." }}

ans..11

MC

Not with PPRO: BIC for the selected bank (see querying the stored iDEAL banks)

Nicht bei PPRO: BIC der ausgewählten Bank (siehe Abfrage der hinterlegten iDEAL-Banken)

Language

"language": "..."

a2

O

Only with PPRO: 2-letter language code (e.g.. de) that should be preferred when presenting payment pages to the consumer

Nur bei PPRO: 2-stelliger Sprachcode (z.B. de), der für die Zahlungsseiten für den Kunden bevorzugt werden soll

Parameters for online transfers with iDEAL

Key

Format

CND

Description

Beschreibung

TransID

an..35

M

TransactionID provided by you which should be unique for each payment.

If you do not transfer the RefNr parameter separately, the TransID value in the direction of iDEAL becomes the purchaseID and this is subject to the following limitation: Only the characters a-zA-Z0-9, are allowed, no special characters, format an..35.

Ihre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss.

Sollten sie separat keine RefNr übergeben, wird der Wert TransID in Richtung iDEAL zur purchaseID und diese unterliegt der nachfolgenden Limitierung: Nur die Zeichen a-zA-Z0-9, sind erlaubt, keine Sonderzeichen, Format an..35.

Status

a..50

M

OK (URLSuccess) or FAILED (URLFailure).

Only for direct integration with NL merchant Bank and also EMS flow there is also a Status OPEN (URLSuccess) possible. If provides Status=OPEN and Description=result uncertain | Code=01150705 the payment is still open and about 15 minutes later the final status is reported and must be processed additionally.

OK (URLSuccess) oder FAILED (URLFailure)

Nur für die direkte Integration mit der NL Merchant Bank und auch EMS Flow ist auch ein Status OPEN (URLSuccess) möglich. Falls das Status=OPEN und Description=result uncertain | Code=01150705 meldet, ist die Zahlung noch offen und etwa 15 Minuten später wird der finale Status gemeldet und muss zusätzlich verarbeitet werden.

Key

Format

CND

Description

Beschreibung

RefNr

ans..

OC

Unique reference number. In case of using the EMS interface the length is limited to 15 chars.

In case of PPRO: Only characters a-zA-Z0-9,-_ are allowed, format ans..40.

In case of direct integration via a Dutch bank (will be passed on to iDEAL as purchaseID): Only the characters a-zA-Z0-9, are allowed, no special characters, format an..35.

Eindeutige Referenznummer. Bei Verwendung der EMS-Schnittstelle ist die Übergabe auf 15 Stellen limitiert.

Bei PPRO: Nur die Zeichen a-zA-Z0-9,-_ sind erlaubt, Format ans..40.

Bei Direktintegration über eine niederländische Hausbank (wird als purchaseID an iDEAL weitergegeben): Nur die Zeichen a-zA-Z0-9, sind erlaubt, keine Sonderzeichen, Format an..35.

Key	Format	CND	Description	Beschreibung
AccBank	ans..20	MC	Identification of the financial institution of the account holder (with PPRO only if Status=OK)	Identifikation des Finanzinstituts des Kontoinhabers (bei PPRO nur wenn Status=OK)
AccOwner	a3..50	MC	Name of the account holder (with PPRO only if Status=OK)	Name des Kontoinhabers (bei PPRO nur wenn Status=OK)
IBAN	ans..34	MC	IBAN of the account holder (with PPRO only if Status=OK)	IBAN des Kontoinhabers (bei PPRO nur wenn Status=OK)
BIC	ans..11	MC	BIC of the account holder (with PPRO only if Status=OK)	BIC des Kontoinhabers (bei PPRO nur wenn Status=OK)
PaymentPurpose	ans..26	C	Only with PPRO: Purpose of payment	Nur bei PPRO: Zahlungszweck
PaymentGuarantee	a.12	C	Only with PPRO: NONE= no payment guarantee, VALIDATED= customer account valid, but no payment guarantee, FULL= payment guarantee Notice: This parameter is only returned if the Status=OK.	Nur bei PPRO: NONE= keine Zahlungsgarantie, VALIDATED= Kundenkonto valide, aber keine Zahlungsgarantie, FULL= Zahlungsgarantie Hinweis: Dieser Parameter wird nur zurückgegeben, falls der Status=OK ist.
ErrorText	ans..128	C	Only with PPRO: Detailed PPRO error message. Notice: Is returned only if Status=FAILED. Use is possible only in agreement with .	Nur bei PPRO: detaillierte PPRO Fehlermeldung. Hinweis: Wird nur bei Status=FAILED zurückgegeben. Nutzung nur in Abstimmung mit dem möglich.
TransactionID	an..20	O	Only with PPRO: Unique transaction number from PPRO	Nur bei PPRO: Eindeutige Transaktionsnummer bei PPRO

Return parameters for URLSuccess, URLFailure and URLNotify with iDEAL

Notice: Please note that for IDEAL transactions which are processed via PPRO, in rare cases there may be delayed notifications up to 5 days after the payment has been completed. This changes the payment status. Therefore we ask you to take this into account so that your store is able to process such notifications.

Querying the stored iDEAL banks

offers merchants the possibility to query which banks are stored for the merchant before the actual payment process. Since the configured bank list rarely changes, this does not need to be queried for each bank transfer. For this verification please use the following URL:

idealIssuerList.aspx

The following table describes the encrypted payment request parameters: Please note that the Merchant-ID plus Len and Data must be transferred every time as with all requests:

Parameters for requesting the stored iDEAL banks

Please transfer the MerchantID both in the unencrypted as well as the encrypted string.

The following table describes the result parameters, which sends in response:

Key

Format

CND

Description

Beschreibung

IdealIssuerList

ans..

M

The IdealIssuerList contains all banks stored for the merchant at the time of the query in the format IssuerID,Name,Country|…

IssuerID = BIC of the bank

Name = name of the bank

Country = Name of the country for the bank (max. 128 charachters)

Die IdealIssuerList enthält sämtliche Banken, die zum Zeitpunkt der Abfrage beim Händler hinterlegt sind, im Format IssuerID,Name,Land|…

IssuerID = BIC der Bank

Name = Name der Bank

Land = Name des Landes zur Bank (max. 128 Zeichen)

Result parameters for requesting the stored iDEAL banks

Credit with reference

Credits (refunds) are possible via a Server-to-Server connection. permits only credits for iDEAL that reference on a captured transaction previously made via . The amount of the Credit is limited to the amount of the previous capture.

Please note that in case of EMS only one refund request can be processed. Submitting multiple refunds is not allowed.

To carry out a credit for iDEAL, please use the following URL:

credit.aspx

Notice: Please note that credits (refunds) for iDEAL can be processed only when using the processing partners EMS, PPRO, Rabobank Omnikassa and additionally with EVO Payments Debtor Management. With a direct connection to the respective Dutch bank there are no credits possible via .

Key	REST	Format	CND	Description	Beschreibung
TransID	"transactionId": "..."	an..35	M	TransactionID provided by you which should be unique for each payment.	Ihre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss.

Key	REST	Format	CND	Description	Beschreibung
OrderDesc	"order": {"description": "..."}	ans..768	OC	Description of refunded goods, unit prices, merchant’s comment etc.	Beschreibung der gutgeschriebenen Artikel, Einzelpreise, Händlerkommentar etc.

Parameters for credits of iDEAL payments

Key	REST	Format	CND	Description	Beschreibung
TransID	"transactionId": "..."	an..35	M	TransactionID provided by you which should be unique for each payment.	Ihre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss.

Result parameters for credits of iDEAL payments

Batch processing via the interface

This section describes the parameters which must be transferred within the data set (Record) for executing a iDEAL credit and which information can be found within the response file about the payment status.

Notice: Please note that Batch processing for iDEAL is possible only via EMS, EVO and PPRO connection.

Following table gives an overview of all batch versions that are possible for a specific action an their specialities:

Action	Version	Description	Beschreibung
Credit	1.0 / 2.0	Standard version without return of parameter Code	Standardversion ohne Rückgabe von Parameter Code
	1.x / 2.x	with RefNr (valid for all versions other than 1.0)	mit RefNr (gilt für alle Versionen außer 1.0)

Description of the possible batch versions

The structure for an iDEAL payment within a Batch file to be submitted is the following:

HEAD,<MerchantID>,<Date>,<Version>
IDEAL,Credit,<Amount>,<Currency>,<TransID>(<RefNr>),<PayID>
FOOT,<CountRecords>,<SumAmount>

Example for Master MID function:

HEAD,[Master]MerchantID,Date,2.x
Type,Action,[Slave]MID,Amount,Currency,TransID,Data (depends on Action)
FOOT,CountRecords,SumAmount

Key	Format	CND	Description	Beschreibung
Type	a..11	M	HEAD for Header, FOOT for Footer, IDEAL for iDEAL	HEAD für Header, FOOT für Footer, IDEAL für iDEAL
Action	a..20	M	The parameter Action defines the type of transaction: Credit	Der Action-Parameter definiert die Art der Transaktion: Credit (Gutschrift)

Key

Format

CND

Description

Beschreibung

TransID

an..35

M

TransactionID provided by you which should be unique for each payment.

If you do not transfer the RefNr parameter separately, the TransID value in the direction of iDEAL becomes the purchaseID and this is subject to the following limitation: Only the characters a-zA-Z0-9, are allowed, no special characters, format an..35.

Ihre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss.

Sollten sie separat keine RefNr übergeben, wird der Wert TransID in Richtung iDEAL zur purchaseID und diese unterliegt der nachfolgenden Limitierung: Nur die Zeichen a-zA-Z0-9, sind erlaubt, keine Sonderzeichen, Format an..35.

RefNr

ans..

O

Unique reference number. In case of using the EMS interface the length is limited to 15 chars.

In case of PPRO: Only characters a-zA-Z0-9,-_ are allowed, format ans..40.

In case of direct integration via a Dutch bank (will be passed on to iDEAL as purchaseID): Only the characters a-zA-Z0-9, are allowed, no special characters, format an..35.

Eindeutige Referenznummer. Bei Verwendung der EMS-Schnittstelle ist die Übergabe auf 15 Stellen limitiert.

Bei PPRO: Nur die Zeichen a-zA-Z0-9,-_ sind erlaubt, Format ans..40.

Bei Direktintegration über eine niederländische Hausbank (wird als purchaseID an iDEAL weitergegeben): Nur die Zeichen a-zA-Z0-9, sind erlaubt, keine Sonderzeichen, Format an..35.

Description of fields within the record for Batch files

The record area within the response file for Batch transactions looks the following way:

HEAD,<MerchantID>,<Date>,<Version>
IDEAL,Credit,<Amount>,<Currency>,<TransID>(<RefNr>),<PayID>,<Status>,<Code>
FOOT,<CountRecords>,<SumAmount>

Key	Format	CND	Description	Beschreibung
Action	a..20	M	The parameter Action defines the type of transaction: Credit	Der Action-Parameter definiert die Art der Transaktion: Credit (Gutschrift)

Description of result parameters within the record for Batch files