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
Paygate interface
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) Abbreviation Description CND condition M mandatory O optional C conditional Notice: Please note that the names of parameters can be returned in upper or lower case.Definitions
Data formats
Abbreviations
Comment If a parameter is mandatory, then it must be present If a parameter is optional, then it can be present, but it is not required If a parameter is conditional, then there is a conditional rule which specifies whether it is mandatory or optional
Calling the iDEAL interface
To process a payment with online transfer with iDEAL, please use the following URL:
https://www.computop-paygate.com/ideal.aspx |
Notice: For security reasons, Computop Paygate 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:
| Key | Format | CND | Description |
|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too. |
Key | Format | CND | Description |
|---|---|---|---|
| TransID | an..35 | M | Merchants own transaction ID, which must be unique for each payment. In the case of iDEAL integration via a Dutch house bank (direct integration) or Rabobank, this ID is transferred to the central iDEAL system as the purchaseID. In the case of direct integration via a Dutch house bank: Only the characters a-zA-Z0-9 are permitted, no special characters, format an..35. For iDEAL via Rabobank: Only the characters a-zA-Z0-9, are allowed, no special characters, format an..24 |
RefNr | ans.. | O | Unique reference number which is transmitted to the downstream systems in the following cases. For PPRO: Only the characters a-zA-Z0-9,-_ are permitted, format ans..40. For EMS: The transfer of the RefNr value is limited to 15 characters. If you as a merchant would like the RefNr to be transferred downstream in the case of integrations via Dutch house bank (direct integration) or via Rabobank, please contact our Merchant Service (Computop Helpdesk) and we will activate the transfer for you. For iDEAL via Rabobank: format an..24 |
| Key | Format | CND | Description |
|---|---|---|---|
| Amount | n..10 | M | Amount in the smallest currency unit (e.g. EUR Cent) |
| Key | Format | CND | Description |
|---|---|---|---|
| Currency | a3 | M | Currency, three letters DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table |
| Key | Format | CND | Description |
|---|---|---|---|
an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here: |
Key | Format | CND | Description |
|---|---|---|---|
OrderDesc | ans..768 | O | Description of purchased goods, unit prices etc. Please note: The following characters are not allowed ä,ö,ü,ß The first 27 characters appear on the customer-account statement. You can view the full data in Computop Analytics. |
| Key | Format | CND | Description |
|---|---|---|---|
| UserData | ans..1024 | O | If specified at request, Paygate forwards the parameter with the payment result to the shop. |
| Key | Format | CND | Description |
|---|---|---|---|
| URLSuccess | ans..256 | M | Complete URL which calls up Paygate 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 Paygate and shop, please use the parameter UserData.
|
| Key | Format | CND | Description |
|---|---|---|---|
| URLFailure | ans..256 | M | Complete URL which calls up Paygate 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 Paygate and shop, please use the parameter UserData.
|
| Key | Format | CND | Description |
|---|---|---|---|
| Response | a7 | O | Status response sent by Paygate to URLSuccess and URLFailure, should be encrypted. For this purpose, transmit Response=encrypt parameter. |
| Key | Format | CND | Description |
|---|---|---|---|
| URLNotify | ans..256 | M | Complete URL which Paygate 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.
|
| Key | Format | CND | Description |
|---|---|---|---|
| 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, Computop Paygate 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 Computop Paygate 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 Paygate 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 Paygate. |
Key | Format | CND | Description | ||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
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.
| ||||||||||||||||||||||||||||||||
IssuerID | ans..11 | OC | Not with PPRO: BIC for the selected bank | ||||||||||||||||||||||||||||||||
| Language | a2 | O | Only with PPRO: 2-letter language code (e.g.. de) that should be preferred when presenting payment pages to the consumer |
| Key | Format | CND | Description |
|---|---|---|---|
| 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 Computop Paygate and therefore protected against manipulation. |
| Key | Format | CND | Description |
|---|---|---|---|
| Custom | ans..1024 | O | "Custom"-parameter is added to the request data before encryption and is part of encrypted "Data" in Computop Paygate request. By this they are protected against manipulation by a consumer. The Custom-value is added to the Computop Paygate 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. |
The following table gives the result parameters which Computop Paygate 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:
pls. be prepared to receive additional parameters at any time and do not check the order of parameters the key (e.g. mid, RefNr) should not be checked case-sentive
| Key | Format | CND | Description |
|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop |
| Key | Format | CND | Description |
|---|---|---|---|
| PayID | an32 | M | ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request. |
| Key | Format | CND | Description |
|---|---|---|---|
| XID | an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate |
Key | Format | CND | Description |
|---|---|---|---|
| TransID | an..35 | M | Merchants own transaction ID, which must be unique for each payment. In the case of iDEAL integration via a Dutch house bank (direct integration) or Rabobank, this ID is transferred to the central iDEAL system as the purchaseID. In the case of direct integration via a Dutch house bank: Only the characters a-zA-Z0-9 are permitted, no special characters, format an..35. For iDEAL via Rabobank: Only the characters a-zA-Z0-9, are allowed, no special characters, format an..35 |
| Status | a..50 | M | OK (URLSuccess) or FAILED (URLFailure). Please note that in the case of an iDEAL payment with an NL house bank (direct integration) as well as via EMS, there may be an initial open status. If, in the case of an iDEAL payment, we receive feedback from the customer/browser from the downstream systems, we also expect the payment status directly. If this is not received within 15 seconds, the customer/browser is forwarded to the “URLSuccess” with an open status. Paygate then waits for the final status from iDEAL and, once received, this is transmitted to the store system via a separate “URLNotify” call. Open status message on the “URLSuccess”: Code=01150705&Status=OPEN&Description=not yet known |
| Key | Format | CND | Description |
|---|---|---|---|
| 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! |
| Key | Format | CND | Description |
|---|---|---|---|
| Code | an8 | M | Error code according to Paygate Response Codes (A4 Error codes) |
| Key | Format | CND | Description |
|---|---|---|---|
| UserData | ans..1024 | O | If specified at request, Paygate forwards the parameter with the payment result to the shop. |
| Key | Format | CND | Description |
|---|---|---|---|
an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here: |
Key | Format | CND | Description | |
|---|---|---|---|---|
AccBank | ans..20 | MC | Identification of the financial institution of the account holder (with PPRO only if Status=OK). Please note as part of iDeal 2.0, the AccBank will be sent with BIC value. Bank name will not be sent. | |
AccOwner | a3..50 | MC | Name of the account holder (with PPRO only if Status=OK) | |
IBAN | ans..34 | MC | IBAN of the account holder (with PPRO only if Status=OK) | |
BIC | ans..11 | MC | BIC of the account holder (with PPRO only if Status=OK) | |
PaymentPurpose | ans..26 | C | Only with PPRO: Purpose of payment | |
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. | |
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 Computop Helpdesk. | |
TransactionID | an..20 | O | Only with PPRO: Unique transaction number from PPRO | |
| Key | Format | CND | Description |
|---|---|---|---|
| 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 Computop Paygate and therefore protected against manipulation. |
| Key | Format | CND | Description |
|---|---|---|---|
| Custom | ans..1024 | O | "Custom"-parameter is added to the request data before encryption and is part of encrypted "Data" in Computop Paygate request. By this they are protected against manipulation by a consumer. The Custom-value is added to the Computop Paygate 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. |
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.
Credit with reference
Credits (refunds) are possible via a Server-to-Server connection. Computop Paygate permits only credits for iDEAL that reference on a captured transaction previously made via Computop Paygate. 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:
https://www.computop-paygate.com/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 Computop Paygate.
Notice: For security reasons, Computop Paygate 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:
| Key | Format | CND | Description |
|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too. |
| Key | Format | CND | Description |
|---|---|---|---|
| PayID | an32 | M | ID assigned by Paygate for the payment to be credited |
Key | Format | CND | Description |
|---|---|---|---|
| TransID | an..35 | M | TransactionID provided by you which should be unique for each payment. |
| Key | Format | CND | Description |
|---|---|---|---|
an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here: |
| Key | Format | CND | Description |
|---|---|---|---|
| Amount | n..10 | M | Amount in the smallest currency unit (e.g. EUR Cent) |
| Key | Format | CND | Description |
|---|---|---|---|
| Currency | a3 | M | Currency, three letters DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table |
Key | Format | CND | Description |
|---|---|---|---|
OrderDesc | ans..768 | OC | Description of refunded goods, unit prices, merchant’s comment etc. |
| Key | Format | CND | Description |
|---|---|---|---|
| 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, Computop Paygate 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 Computop Paygate 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 Paygate 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 Paygate. |
The following table describes the result parameters with which the Computop Paygate responds to your system pls. be prepared to receive additional parameters at any time and do not check the order of parameters the key (e.g. mid, RefNr) should not be checked case-sentive
| Key | Format | CND | Description |
|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop |
| Key | Format | CND | Description |
|---|---|---|---|
| PayID | an32 | M | ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request. |
| Key | Format | CND | Description |
|---|---|---|---|
| XID | an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate |
Key | Format | CND | Description |
|---|---|---|---|
| TransID | an..35 | M | TransactionID provided by you which should be unique for each payment. |
| Key | Format | CND | Description |
|---|---|---|---|
| Status | a..50 | M | OK (URLSuccess) or FAILED (URLFailure) |
| Key | Format | CND | Description |
|---|---|---|---|
| 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! |
| Key | Format | CND | Description |
|---|---|---|---|
| Code | an8 | M | Error code according to Paygate Response Codes (A4 Error codes) |
Batch processing via the interface
Basic information about using Batch files and about their structure 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:
Action | Version | Description |
|---|---|---|
Credit | 1.0 / 2.0 | Standard version without return of parameter Code |
1.x / 2.x | with RefNr (valid for all versions other than 1.0) |
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) in the batch file:
Key | Format | CND | Description |
|---|---|---|---|
Type | a..11 | M | HEAD for Header, FOOT for Footer, IDEAL for iDEAL |
Action | a..20 | M | The parameter Action defines the type of transaction: Credit |
| Key | Format | CND | Description |
|---|---|---|---|
| Amount | n..10 | M | Amount in the smallest currency unit (e.g. EUR Cent) |
| Key | Format | CND | Description |
|---|---|---|---|
| Currency | a3 | M | Currency, three letters DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table |
Key | Format | CND | Description |
|---|---|---|---|
| TransID | an..35 | M | Merchants own transaction ID, which must be unique for each payment. In the case of iDEAL integration via a Dutch house bank (direct integration) or Rabobank, this ID is transferred to the central iDEAL system as the purchaseID. In the case of direct integration via a Dutch house bank: Only the characters a-zA-Z0-9 are permitted, no special characters, format an..35. For iDEAL via Rabobank: Only the characters a-zA-Z0-9, are allowed, no special characters, format an..35 |
RefNr | ans.. | O | Unique reference number which is transmitted to the downstream systems in the following cases. For PPRO: Only the characters a-zA-Z0-9,-_ are permitted, format ans..40. For EMS: The transfer of the RefNr value is limited to 15 characters. If you as a merchant would like the RefNr to be transferred downstream in the case of integrations via Dutch house bank (direct integration) or via Rabobank, please contact our Merchant Service (Computop Helpdesk) and we will activate the transfer for you. |
| Key | Format | CND | Description |
|---|---|---|---|
| PayID | an32 | M | ID assigned by Paygate for this transaction |
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 before):
Key | Format | CND | Description |
|---|---|---|---|
Action | a..20 | M | The parameter Action defines the type of transaction: Credit |
| Key | Format | CND | Description |
|---|---|---|---|
| PayID | an32 | M | ID assigned by Paygate for this transaction |
| Key | Format | CND | Description |
|---|---|---|---|
| Status | a..50 | M | OK (URLSuccess) or FAILED (URLFailure) |
| Key | Format | CND | Description |
|---|---|---|---|
| Code | an8 | M | Error code according to Paygate Response Codes (A4 Error codes) |