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.

TypePayments by Online Bank Transfer


Further information can be found 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


VR-ePayment Gateway interface

Definitions

Data formats

Format

Description

a

alphabetical

as

alphabetical with special characters

n

numeric

an

alphanumeric

ans

alphanumeric with special characters

ns

numeric with special characters

bool

boolean expression (true or false)

3

fixed length with 3 digits/characters

..3

variable length with maximum 3 digits/characters

enum

enumeration of allowed values

dttm

ISODateTime (YYYY-MM-DDThh:mm:ss)


Abbreviations

Abbreviation

Description

Comment

CND

condition


M

mandatory

If a parameter is mandatory, then it must be present

O

optional

If a parameter is optional, then it can be present, but it is not required

C

conditional

If a parameter is conditional, then there is a conditional rule which specifies whether it is mandatory or optional


Notice: Please note that the names of parameters can be returned in upper or lower case.


Calling the iDEAL interface

To process a payment with online transfer with iDEAL, call up the following URL:


Notice: For security reasons, VR-ePayment Gateway rejects all payment requests with formatting errors. Therefore, please use the correct data type for each parameter.

The following table describes the encrypted payment request parameters:

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

KeyFormatCNDDescriptionBeschreibung

MerchantID

ans..30

M

MerchantID, assigned by VR-Payment. Additionally this parameter has to be passed in plain language too.

HändlerID, die von  vergeben wird. Dieser Parameter ist zusätzlich auch unverschlüsselt zu übergeben.

Key

Format

CND

Description

Beschreibung

TransIDan..35M

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.

KeyFormatCNDDescriptionBeschreibung
Amount

n..10

M

Amount in the smallest currency unit (e.g. EUR Cent). Please contact the VR-ePayment Support, if you want to capture amounts <100 (smallest currency unit).

Betrag in der kleinsten Währungseinheit (z.B. EUR Cent). Bitte wenden Sie sich an den , wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten.

KeyFormatCNDDescriptionBeschreibung
Currency

a3

M

Currency, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table

Währung, drei Zeichen DIN / ISO 4217, z.B. EUR, USD, GBP. Hier eine Übersicht: A1 Währungstabelle

KeyFormatCNDDescriptionBeschreibung

MAC

an64

M
Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here:
Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier:

Key

Format

CND

Description

Beschreibung

OrderDesc

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 VR-ePayment Backoffice.

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.

KeyFormatCNDDescriptionBeschreibung
UserData

ans..1024

O

If specified at request, VR-ePayment Gateway forwards the parameter with the payment result to the shop.

Wenn beim Aufruf angegeben, übergibt das  die Parameter mit dem Zahlungsergebnis an den Shop.

KeyFormatCNDDescriptionBeschreibung
URLSuccess

ans..256

M

Complete URL which calls up VR-ePayment Gateway if payment has been successful. The URL may be called up only via port 443. This URL may not contain parameters: In order to exchange values between VR-ePayment Gateway and shop, please use the parameter UserData.

(info) Common notes:

  • We recommend to use parameter "response=encrypt" to get an encrypted response by VR-ePayment Gateway
  • However, fraudster may just copy the encrypted DATA-element which are sent to URLFailure and send the DATA to URLSuccess. Therefore ensure to check the "code"-value which indicates success/failure of the action. Only a result of "code=00000000" should be considered successful.

Vollständige URL, die das  aufruft, wenn die Zahlung erfolgreich war. Die URL darf nur über Port 443 aufgerufen werden. Diese URL darf keine Parameter enthalten: Um Parameter durchzureichen nutzen Sie stattdessen den Parameter UserData.

(info) Allgemeine Hinweise:

  • Wir empfehlen, den Parameter "response=encrypt" zu verwenden, um eine verschlüsselte Antwort von zu erhalten
  • Betrüger könnten das verschlüsselte DATA-Element kopieren, welches an URLFailure gesendet wurde, und betrügerisch dasselbe DATA an URLSuccess senden. Überprüfen Sie daher unbedingt den "code"-Wert des DATA-Elements. Nur eine Antwort mit "code=00000000" sollte als erfolgreich angesehen werden.

KeyFormatCNDDescriptionBeschreibung
URLFailure

ans..256

M

Complete URL which calls up VR-ePayment Gateway if payment has been unsuccessful. The URL may be called up only via port 443. This URL may not contain parameters: In order to exchange values between VR-ePayment Gateway and shop, please use the parameter UserData.

(info) Common notes:

  • We recommend to use parameter "response=encrypt" to get an encrypted response by VR-ePayment Gateway
  • However, fraudster may just copy the encrypted DATA-element which are sent to URLFailure and send the DATA to URLSuccess/URLNotify. Therefore ensure to check the "code"-value which indicates success/failure of the action. Only a result of "code=00000000" should be considered successful.

Vollständige URL, die das aufruft, wenn die Zahlung gescheitert ist. Die URL darf nur über Port 443 aufgerufen werden. Diese URL darf keine Parameter enthalten: Um Parameter durchzureichen nutzen Sie stattdessen den Parameter UserData.

(info) Allgemeine Hinweise:

  • Wir empfehlen, den Parameter "response=encrypt" zu verwenden, um eine verschlüsselte Antwort von zu erhalten
  • Betrüger könnten das verschlüsselte DATA-Element kopieren, welches an URLFailure gesendet wurde, und betrügerisch dasselbe DATA an URLSuccess/URLNotify senden. Überprüfen Sie daher unbedingt den "code"-Wert des DATA-Elements. Nur eine Antwort mit "code=00000000" sollte als erfolgreich angesehen werden.

KeyFormatCNDDescriptionBeschreibung
Response

a7

O

Status response sent by VR-ePayment Gateway to URLSuccess and URLFailure, should be encrypted. For this purpose, transmit Response=encrypt parameter.

Die Status-Rückmeldung, die das  an URLSuccess und URLFailure sendet, sollte verschlüsselt werden. Dazu übergeben Sie den Parameter Response=encrypt.

KeyFormatCNDDescriptionBeschreibung
URLNotify

ans..256

M

Complete URL which VR-ePayment Gateway calls up in order to notify the shop about the payment result. The URL may be called up only via port 443. It may not contain parameters: Use the UserData parameter instead.

(info) Common notes:

  • We recommend to use parameter "response=encrypt" to get an encrypted response by VR-ePayment Gateway
  • However, fraudster may just copy the encrypted DATA-element which are sent to URLFailure and send the DATA to URLSuccess/URLNotify. Therefore ensure to check the "code"-value which indicates success/failure of the action. Only a result of "code=00000000" should be considered successful.

Vollständige URL, die das  aufruft, um den Shop zu benachrichtigen. Die URL darf nur über Port 443 aufgerufen werden. Sie darf keine Parameter enthalten: Nutzen Sie stattdessen den Parameter UserData.

(info) Allgemeine Hinweise:

  • Wir empfehlen, den Parameter "response=encrypt" zu verwenden, um eine verschlüsselte Antwort von zu erhalten
  • Betrüger könnten das verschlüsselte DATA-Element kopieren, welches an URLFailure gesendet wurde, und betrügerisch dasselbe DATA an URLSuccess/URLNotify senden. Überprüfen Sie daher unbedingt den "code"-Wert des DATA-Elements. Nur eine Antwort mit "code=00000000" sollte als erfolgreich angesehen werden.

KeyFormatCNDDescriptionBeschreibung
ReqId

ans..32

O

To avoid double payments or actions (e.g. by ETM), enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction or action is submitted again with the same ReqID, VR-ePayment Gateway will not carry out the payment or new action, but will just return the status of the original transaction or action.

Please note that the VR-ePayment Gateway must have a finalized transaction status for the first initial action (authentication/authorisation). This does not apply to 3-D Secure authentications that are terminated by a timeout. The 3-D Secure Timeout status does not count as a completed status in which the ReqID functionality on VR-ePayment Gateway does not take effect. Submissions with identical ReqID for an open status will be processed regularly.

Notice: Please note that a ReqID is only valid for 12 month, then it gets deleted at the VR-ePayment Gateway.

Um Doppelzahlungen (z.B. durch ETM) zu vermeiden, übergeben Sie einen alphanumerischen Wert, der Ihre Transaktion oder Aktion identifiziert und nur einmal vergeben werden darf. Falls die Transaktion oder Aktion mit derselben ReqID erneut eingereicht wird, führt das keine Zahlung oder weitere Aktion aus, sondern gibt nur den Status der ursprünglichen Transaktion oder Aktion zurück.

Bitte beachten Sie, dass das für die erste initiale Aktion (Authentifizierung/Autorisierung) einen abgeschlossenen Transaktionsstatus haben muss. Dies gilt nicht für 3-D Secure Authentifizierungen, die durch einem Timeout beendet werden. Der Status 3-D Secure Timeout gilt nicht als abgeschlossener Status, bei dem ReqID-Funktionalität am nicht greift. Einreichungen mit identischer ReqID auf einen offenen Status werden regulär verarbeitet.

Hinweis: Bitte beachten Sie, dass eine ReqID nur 12 Monate gültig ist, danach wird sie vom gelöscht.

Key

Format

CND

Description

Beschreibung

BIC

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 nameBIC
RabobankRABONL2U
ABN AMROABNANL2A
Van Lanschot BaniersFVLBNL22
Triodos BankTRIONL2U
ING BankINGBNL2A
SNS BankSNSBNL2A
ASNASNBNL21
RegioBankRBRBNL21
KnabKNABNL2H
BunqBUNQNL2A
HandelsbankeHANDNL2A
RevolutREVOLT21

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.

BanknameBIC
RabobankRABONL2U
ABN AMROABNANL2A
Van Lanschot BaniersFVLBNL22
Triodos BankTRIONL2U
ING BankINGBNL2A
SNS BankSNSBNL2A
ASNASNBNL21
RegioBankRBRBNL21
KnabKNABNL2H
BunqBUNQNL2A
HandelsbankeHANDNL2A
RevolutREVOLT21

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)
Languagea2OOnly with PPRO: 2-letter language code (e.g.. de) that should be preferred when presenting payment pages to the consumerNur bei PPRO: 2-stelliger Sprachcode (z.B. de), der für die Zahlungsseiten für den Kunden bevorzugt werden soll

KeyFormatCNDDescriptionBeschreibung
Plain

ans..50

O

A single value to be set by the merchant to return some information unencrypted in response/notify, e.g. the MID. 

"Plain"-parameter is part of encrypted "Data" in VR-ePayment Gateway and therefore protected against manipulation. 

Ein einzelner Wert, der von Ihnen gesetzt werden kann, um Informationen wieder unverschlüsselt in der Antwort bzw. im Notify zurückzugeben, z.B. die MID.

Da der "Plain"-Parameter Teil des verschlüsselten "Data" im  ist, ist dieser vor Manipulationen geschützt. 

KeyFormatCND

Description

Beschreibung
Custom

ans..1024

O

"Custom"-parameter is added to the request data before encryption and is part of encrypted "Data" in VR-ePayment Gateway request. By this they are protected against manipulation by a consumer. 

The Custom-value is added to the VR-ePayment Gateway response in plain text and the "|" is replaced by a "&". By this you can put a single value into Custom-parameter and get multiple key-value-pairs back in response for your own purpose. 

Please find a samples here: Custom

Der "Custom"-Parameter wird vor der Verschlüsselung an den Aufruf angehängt und ist Teil des verschlüsselten "Data" im  Aufruf. Dadurch ist der Wert gegen Manipulation geschützt. 

Der Custom-Wert wird dann in Klartext an die -Antwort angehängt und dabei wird "|" durch "&" ersetzt. Dadurch können Sie einen Custom-Wert übergeben und bekommen mehrere Key-Value-Paare zu Ihrer eigenen Verwendung in der Antwort zurück.

Hier finden Sie ein Beispiel: Custom

Parameters for online transfers with iDEAL


The following table gives the result parameters which VR-ePayment Gateway transmits to URLSuccess or URLFailure and URLNotify. If you have specified the Response=encrypt parameter, the following parameters are sent Blowfish encrypted to your system:

(info) pls. be prepared to receive additional parameters at any time and do not check the order of parameters

(info) the key (e.g. MerchantId, RefNr) should not be checked case-sentive

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

KeyFormatCNDDescriptionBeschreibung

mid

ans..30

M

MerchantID, assigned by VR-Payment

HändlerID, die von vergeben wird

KeyFormatCNDDescriptionBeschreibung
PayID

an32

M

ID assigned by VR-ePayment Gateway for the payment, e.g. for referencing in batch files as well as for capture or credit request.

Vom vergebene ID für die Zahlung; z.B. zur Referenzierung in Batch-Dateien sowie im Capture- oder Credit-Request.

KeyFormatCNDDescriptionBeschreibung
XID

an32

M

ID for all single transactions (authorisation, capture, credit note) for one payment assigned by VR-ePayment Gateway

Vom  vergebene ID für alle einzelnen Transaktionen (Autorisierung, Buchung, Gutschrift), die für eine Zahlung durchgeführt werden

Key

Format

CND

Description

Beschreibung

TransIDan..35M

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.

KeyFormatCNDDescriptionBeschreibung
Status

a..50

M

OK (URLSuccess) or FAILED (URLFailure)

OK (URLSuccess) oder FAILED (URLFailure)

KeyFormatCNDDescriptionBeschreibung
Description

ans..1024

M
Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!
Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description, sondern Code für die Auswertung des Transaktionsstatus!

KeyFormatCNDDescriptionBeschreibung
Code

n8

M

Error code according to VR-ePayment Gateway Response Codes (A4 Error codes)

Fehlercode gemäß  Antwort-Codes (A4 Fehlercodes)

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.

KeyFormatCNDDescriptionBeschreibung
UserData

ans..1024

O

If specified at request, VR-ePayment Gateway forwards the parameter with the payment result to the shop.

Wenn beim Aufruf angegeben, übergibt das  die Parameter mit dem Zahlungsergebnis an den Shop.

KeyFormatCNDDescriptionBeschreibung

MAC

an64

M
Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here:
Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier:

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

a..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 VR-ePayment Support.

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

KeyFormatCNDDescriptionBeschreibung
Plain

ans..50

O

A single value to be set by the merchant to return some information unencrypted in response/notify, e.g. the MID. 

"Plain"-parameter is part of encrypted "Data" in VR-ePayment Gateway and therefore protected against manipulation. 

Ein einzelner Wert, der von Ihnen gesetzt werden kann, um Informationen wieder unverschlüsselt in der Antwort bzw. im Notify zurückzugeben, z.B. die MID.

Da der "Plain"-Parameter Teil des verschlüsselten "Data" im  ist, ist dieser vor Manipulationen geschützt. 

KeyFormatCND

Description

Beschreibung
Custom

ans..1024

O

"Custom"-parameter is added to the request data before encryption and is part of encrypted "Data" in VR-ePayment Gateway request. By this they are protected against manipulation by a consumer. 

The Custom-value is added to the VR-ePayment Gateway response in plain text and the "|" is replaced by a "&". By this you can put a single value into Custom-parameter and get multiple key-value-pairs back in response for your own purpose. 

Please find a samples here: Custom

Der "Custom"-Parameter wird vor der Verschlüsselung an den Aufruf angehängt und ist Teil des verschlüsselten "Data" im  Aufruf. Dadurch ist der Wert gegen Manipulation geschützt. 

Der Custom-Wert wird dann in Klartext an die -Antwort angehängt und dabei wird "|" durch "&" ersetzt. Dadurch können Sie einen Custom-Wert übergeben und bekommen mehrere Key-Value-Paare zu Ihrer eigenen Verwendung in der Antwort zurück.

Hier finden Sie ein Beispiel: Custom

Return parameters for URLSuccess, URLFailure and URLNotify with iDEAL


Querying the stored iDEAL banks

VR-ePayment Gateway 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 call up the following URL:


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 VR-ePayment Gateway requests:

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

KeyFormatCNDDescriptionBeschreibung

MerchantID

ans..30

M

MerchantID, assigned by VR-Payment. Additionally this parameter has to be passed in plain language too.

HändlerID, die von  vergeben wird. Dieser Parameter ist zusätzlich auch unverschlüsselt zu übergeben.

Parameters for requesting the stored iDEAL banks


Please transfer the Merchant-ID both in the unencrypted as well as the encrypted string.

The following table describes the result parameters, which VR-ePayment Gateway sends in response:

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

KeyFormatCNDDescriptionBeschreibung

MerchantID

ans..30

M

MerchantID, assigned by VR-Payment. Additionally this parameter has to be passed in plain language too.

HändlerID, die von  vergeben wird. Dieser Parameter ist zusätzlich auch unverschlüsselt zu übergeben.

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. VR-ePayment Gateway permits only credits for iDEAL that reference on a captured transaction previously made via VR-ePayment Gateway. 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:


Notice: Please note that credits (refunds) for iDEAL can be processed only when using the processing partners EMS or EVO Payments. With a direct connection to the respective Dutch bank there are no credits possible via VR-ePayment Gateway.

Notice: For security reasons, VR-ePayment Gateway rejects all payment requests with formatting errors. Therefore, please use the correct data type for each parameter.

The following table describes the encrypted payment request parameters:

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

KeyFormatCNDDescriptionBeschreibung

MerchantID

ans..30

M

MerchantID, assigned by VR-Payment. Additionally this parameter has to be passed in plain language too.

HändlerID, die von  vergeben wird. Dieser Parameter ist zusätzlich auch unverschlüsselt zu übergeben.

KeyFormatCNDDescriptionBeschreibung
PayID

an32

M

ID assigned by VR-ePayment Gateway for the payment to be credited

Vom vergebene ID für die gutzuschreibende Zahlung

Key

Format

CND

Description

Beschreibung

TransIDan..35M

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.

KeyFormatCNDDescriptionBeschreibung

MAC

an64

M
Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here:
Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier:

KeyFormatCNDDescriptionBeschreibung
Amount

n..10

M

Amount in the smallest currency unit (e.g. EUR Cent). Please contact the VR-ePayment Support, if you want to capture amounts <100 (smallest currency unit).

Betrag in der kleinsten Währungseinheit (z.B. EUR Cent). Bitte wenden Sie sich an den , wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten.

KeyFormatCNDDescriptionBeschreibung
Currency

a3

M

Currency, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table

Währung, drei Zeichen DIN / ISO 4217, z.B. EUR, USD, GBP. Hier eine Übersicht: A1 Währungstabelle

Key

Format

CND

Description

Beschreibung

OrderDesc

ans..768

OC

Description of refunded goods, unit prices, merchant’s comment etc.

Beschreibung der gutgeschriebenen Artikel, Einzelpreise, Händlerkommentar etc.

KeyFormatCNDDescriptionBeschreibung
ReqId

ans..32

O

To avoid double payments or actions (e.g. by ETM), enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction or action is submitted again with the same ReqID, VR-ePayment Gateway will not carry out the payment or new action, but will just return the status of the original transaction or action.

Please note that the VR-ePayment Gateway must have a finalized transaction status for the first initial action (authentication/authorisation). This does not apply to 3-D Secure authentications that are terminated by a timeout. The 3-D Secure Timeout status does not count as a completed status in which the ReqID functionality on VR-ePayment Gateway does not take effect. Submissions with identical ReqID for an open status will be processed regularly.

Notice: Please note that a ReqID is only valid for 12 month, then it gets deleted at the VR-ePayment Gateway.

Um Doppelzahlungen (z.B. durch ETM) zu vermeiden, übergeben Sie einen alphanumerischen Wert, der Ihre Transaktion oder Aktion identifiziert und nur einmal vergeben werden darf. Falls die Transaktion oder Aktion mit derselben ReqID erneut eingereicht wird, führt das keine Zahlung oder weitere Aktion aus, sondern gibt nur den Status der ursprünglichen Transaktion oder Aktion zurück.

Bitte beachten Sie, dass das für die erste initiale Aktion (Authentifizierung/Autorisierung) einen abgeschlossenen Transaktionsstatus haben muss. Dies gilt nicht für 3-D Secure Authentifizierungen, die durch einem Timeout beendet werden. Der Status 3-D Secure Timeout gilt nicht als abgeschlossener Status, bei dem ReqID-Funktionalität am nicht greift. Einreichungen mit identischer ReqID auf einen offenen Status werden regulär verarbeitet.

Hinweis: Bitte beachten Sie, dass eine ReqID nur 12 Monate gültig ist, danach wird sie vom gelöscht.

Parameters for credits of iDEAL payments

The following table describes the result parameters with which the VR-ePayment Gateway responds to your system

(info) pls. be prepared to receive additional parameters at any time and do not check the order of parameters

(info) the key (e.g. MerchantId, RefNr) should not be checked case-sentive

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

KeyFormatCNDDescriptionBeschreibung

mid

ans..30

M

MerchantID, assigned by VR-Payment

HändlerID, die von vergeben wird

KeyFormatCNDDescriptionBeschreibung
PayID

an32

M

ID assigned by VR-ePayment Gateway for the payment, e.g. for referencing in batch files as well as for capture or credit request.

Vom vergebene ID für die Zahlung; z.B. zur Referenzierung in Batch-Dateien sowie im Capture- oder Credit-Request.

KeyFormatCNDDescriptionBeschreibung
XID

an32

M

ID for all single transactions (authorisation, capture, credit note) for one payment assigned by VR-ePayment Gateway

Vom  vergebene ID für alle einzelnen Transaktionen (Autorisierung, Buchung, Gutschrift), die für eine Zahlung durchgeführt werden

Key

Format

CND

Description

Beschreibung

TransIDan..35M

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.

KeyFormatCNDDescriptionBeschreibung
Status

a..50

M

OK (URLSuccess) or FAILED (URLFailure)

OK (URLSuccess) oder FAILED (URLFailure)

KeyFormatCNDDescriptionBeschreibung
Description

ans..1024

M
Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!
Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description, sondern Code für die Auswertung des Transaktionsstatus!

KeyFormatCNDDescriptionBeschreibung
Code

n8

M

Error code according to VR-ePayment Gateway Response Codes (A4 Error codes)

Fehlercode gemäß  Antwort-Codes (A4 Fehlercodes)

Result parameters for credits of iDEAL payments


Batch processing via the interface

Basic information about using Batch files and about their structure you can be found in the Batch Manager manual. Within batch processing not alle functions are available which are usually available for the online 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:

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

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


The following table describes the individual fields and values used within the data set (record) within the batch file:

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

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)

KeyFormatCNDDescriptionBeschreibung
Amount

n..10

M

Amount in the smallest currency unit (e.g. EUR Cent). Please contact the VR-ePayment Support, if you want to capture amounts <100 (smallest currency unit).

Betrag in der kleinsten Währungseinheit (z.B. EUR Cent). Bitte wenden Sie sich an den , wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten.

KeyFormatCNDDescriptionBeschreibung
Currency

a3

M

Currency, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table

Währung, drei Zeichen DIN / ISO 4217, z.B. EUR, USD, GBP. Hier eine Übersicht: A1 Währungstabelle

Key

Format

CND

Description

Beschreibung

TransIDan..35M

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.

KeyFormatCNDDescriptionBeschreibung
PayID

an32

M

ID assigned by VR-ePayment Gateway for this transaction

Vom vergebene ID für diese Transaktion

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>

The following table describes the response parameters which the Batch Manager saves in the Record area for each transaction (standard parameters not explained here, such as <TransID> or <RefNR> and request parameters are returned unchanged and correspond to the call as specified in):

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

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)

KeyFormatCNDDescriptionBeschreibung
PayID

an32

M

ID assigned by VR-ePayment Gateway for this transaction

Vom vergebene ID für diese Transaktion

KeyFormatCNDDescriptionBeschreibung
Status

a..50

M

OK (URLSuccess) or FAILED (URLFailure)

OK (URLSuccess) oder FAILED (URLFailure)

KeyFormatCNDDescriptionBeschreibung
Code

n8

M

Error code according to VR-ePayment Gateway Response Codes (A4 Error codes)

Fehlercode gemäß  Antwort-Codes (A4 Fehlercodes)

Description of result parameters within the record for Batch files