iDEAL
1.1 General information about iDeal
1.2 Specific requirement iDEAL Mobile: Redirect to Issuer (no in-app browser)
2 1cs Online Payment System interface
2.2 Calling the iDeal interface
1 About iDEAL
1.1 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 | Type |
| 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. | Paymens by Online Bank Transfer |
Further information can be found iDEAL-website in Dutch and English (www.ideal.nl).
1.2 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.
1.3 Process flow chart
iDEAL process flow
2 1cs Online Payment System interface
2.1 Defninitions
2.1.1 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) |
2.1.2 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.
2.2 Calling the iDEAL interface
To process a payment with online transfer with iDEAL, call up the following URL:
https://www.computop-paygate.com/ideal.aspx
Notice: For security reasons, the 1cs Online Payment System 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 |
| MerchantID | ans..30 | M | MerchantID, assigned by First Cash Solution. Additionally, this parameter must be passed in plain language too. |
| 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. |
| 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. Only ASCII characters are allowed. Special characters such as (“umlauts”, …) are not permitted and may have to be replaced by ASCII characters (e.g. ü → ue, é → e, …). |
| Amount | n..10 | M | Amount in the smallest currency unit (e.g. EUR Cent) |
| Currency | a3 | M | Currency, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table EN |
| MAC | an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here: HMAC Authentication (Request) HMAC Authentication (Notify) |
| OrderDesc | ans..768 | M | 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 First Cash Solution Analytics. |
| UserData | ans..1024 | O | If specified at request, the 1cs Online Payment System forwards the parameter with the payment result to the shop |
| URLSuccess | ans..256 | M | Complete URL which calls up the 1cs Online Payment System 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 the 1cs Online Payment System and shop, please use the parameter UserData. General notes: We recommend to use parameter “response=encrypt” to get an encrypted response by 1cs Online Payment system 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. |
| URLFailure | ans..256 | M | Complete URL which calls up the 1cs Online Payment System 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 the 1cs Online Payment System and shop, please use the parameter UserData. General notes: We recommend to use parameter “response=encrypt” to get an encrypted response by 1cs Online Payment system 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. |
| Response | a7 | O | Status response sent by the 1cs Online Payment System to URLSuccess and URLFailure, should be encrypted. For this purpose, transmit Response=encrypt parameter. |
| URLNotify | ans..256 | M | Complete URL which the 1cs Online Payment System 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. General notes: We recommend to use parameter “response=encrypt” to get an encrypted response by 1cs Online Payment system 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. |
| ReqID | ans..32 | O | To avoid double payments, enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction is submitted again with the same ReqID, the 1cs Online Payment System will not carry out the payment, but will just return the status of the original transaction. Please note that the 1cs Onlny Payment System 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 1cs Online Payment System 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. |
| 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 name: BIC Rabobank: RABONL2U ABN AMRO: ABNANL2A Van Landschot 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 |
| IssuerID | ans..11 | MC | Not with PPRO: BIC for the selected bank (see querying the stored iDEAL banks) |
| Language | a2 | O | Only with PPRO: 2-letter language code (e.g.. de) that should be preferred when presenting payment pages to the consumer |
| 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 1cs Online Payment System and therefore protected against manipulation. |
| Custom | ans..1024 | O | “Custom”-parameter is added to the request data before encryption and is part of encrypted “Data” in 1cs Online Payment System request. By this they are protected against manipulation by a consumer. The Custom-value is added to the 1cs Online Payment System 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. |
Parameters for online transfers with iDEAL
The following table gives the result parameters which 1cs Online Payment System 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. MerchantId, RefNr) should not be checked case-sentive>
| Key | Format | CND | Description |
| MID | ans..30 | M | MerchantID, assigned by First Cash Solution |
| PayID | an32 | M | ID assigned by the 1cs Online Payment System for the payment, e.g. for referencing in batch files as well as for capture or credit request. |
| XID | an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by the 1cs Online Payment System. 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. |
| TransID | an..35 | M | TransactionID provided by you which should be unique for each payment |
| 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 1cs Online Payment System 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. |
| 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! |
| Code | n8 | M | Error code according to the 1cs Online Payment System Response Codes Excel file |
| RefNr | ans.. | OC | Merchant’s unique reference number. In case of PPRO: Only characters a-zA-Z0-9,-_ are allowed, format ans..40. Only ASCII characters are allowed. Special characters such as (“umlauts”, …) are not permitted and may have to be replaced by ASCII characters (e.g. ü → ue, é → e, …). |
| UserData | ans..1024 | O | If specified at request, the 1cs Online Payment System forwards the parameter with the payment result to the shop |
| MAC | an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here: HMAC Authentication (Request) HMAC Authentication (Notify) |
| AccBank | ans..20 | MC | Identification of the financial institution of the account holder (with PPRO only if Status=OK) |
| AccOwner | a..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 First Cash Solution support. |
| TransactionID | an..20 | O | Only with PPRO: Unique transaction number from PPRO |
| 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 1cs Online Payment System and therefore protected against manipulation. |
| Custom | ans..1024 | O | “Custom”-parameter is added to the request data before encryption and is part of encrypted “Data” in 1cs Online Payment System request. By this they are protected against manipulation by a consumer. The Custom-value is added to the 1cs Online Payment System 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. |
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.
2.2.1 Querying the stored iDEAL banks
The 1cs Online Payment System 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:
https://www.computop-paygate.com/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 the 1cs Online Payment System requests:
| Key | Format | CND | Description |
| MerchantID | ans..30 | M | MerchantID, assigned by First Cash Solution. Additionally, this parameter must be passed in plain text too. |
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 the 1cs Online Payment System sends in response:
| Key | Format | CND | Description |
| MerchantID | ans..30 | M | MerchantID, assigned by First Cash Solution. Additionally, this parameter must be passed in plain text too. |
| 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) |
Result parameters for requesting the stored iDEAL banks
2.3 Credit with reference
Credits (refunds) are possible via a Server-to-Server connection. the 1cs Online Payment System permits only credits for iDEAL that reference on a captured transaction previously made via the 1cs Online Payment System. 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 or EVO Payments. With a direct connection to the respective Dutch bank there are no credits possible via the 1cs Online Payment System.
Notice: For security reasons, the 1cs Online Payment System 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 |
| MerchantID | ans..30 | M | MerchantID, assigned by First Cash Solution. Additionally, this parameter must be passed in plain language too. |
| PayID | an32 | M | ID assigned by the 1cs Online Payment System for the payment to be credited |
| TransID | an..35 | M | TransactionID provided by you which should be unique for each payment |
| MAC | an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here: HMAC Authentication (Request) HMAC Authentication (Notify) |
| Amount | n..10 | M | Amount in the smallest currency unit (e.g. EUR Cent) |
| Currency | a3 | M | Currency code, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table EN |
| OrderDesc | ans..768 | OC | Description of refunded goods, unit prices, merchant’s comment etc. |
| ReqId | ans..32 | O | To avoid double payments / actions, enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction / action is submitted again with the same ReqID, 1cs OPS will not carry out the payment or new action, but will just return the status of the original transaction / action. Please note that the 1cs OPS must have a finalized transaction status for the first initial action. 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 1cs Online Payment System. |
Parameters for credits of iDEAL payments
The following table gives the result parameters which 1cs Online Payment System 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. MerchantId, RefNr) should not be checked case-sentive>
| Parameter | Format | CND | Description |
| MID | ans..30 | M | MerchantID, assigned by First Cash Solution |
| PayID | an32 | M | ID assigned by the 1cs Online Payment System for the payment, e.g. for referencing in batch files as well as for capture or credit request. |
| XID | an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by the 1cs Online Payment System |
| TransID | an..35 | M | TransactionID provided by you which should be unique for each payment |
| Status | a..50 | M | OK (URLSuccess) or FAILED (URLFailure) |
| 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! |
| Code | n8 | M | Error code according to the 1cs Online Payment System Response Codes Excel file |
Result parameters for credits of iDEAL payments
3 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 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) |
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:
| 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 |
| Amount | n..10 | M | Amount in the smallest currency unit (e.g. EUR Cent) |
| Currency | a3 | M | Currency code, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table EN |
| 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. |
| RefNr | ans.. | O | Unique reference number. In case of using the EMS interface the length is limited to 15 chars. 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. Only ASCII characters are allowed. Special characters such as (“umlauts”, …) are not permitted and may have to be replaced by ASCII characters (e.g. ü → ue, é → e, …). |
| PayID | an32 | M | ID for this transaction given by the 1cs Online Payment System |
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):
| Key | Format | CND | Description |
| Action | a..20 | M | The parameter Action defines the type of transaction: Credit |
| PayID | an32 | M | ID for this transaction given by the 1cs Online Payment System |
| Status | a..50 | M | OK (URLSuccess) or FAILED (URLFailure) |
| Code | n8 | M | Error code according to the 1cs Online Payment System Response Codes Excel file |
Description of result parameters within the record for Batch files
