iDEAL

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

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

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

MerchantID

BasicAuth.Username

ans..30

M

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

TransID

"transactionId": "..."

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 EMS, this ID is transferred to the central iDEAL system as 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

"referenceNumber": "..."

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), EMS or via Rabobank, please contact our Merchant Service (Computop Helpdesk) and we will activate the transfer for you.

Amount

"amount": { "value": ...}

n..10

M

Amount in the smallest currency unit (e.g. EUR Cent).

Currency

"amount": { "currency": "..."}

a3

M

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

MAC

–––

an64

M

Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here:

• HMAC Authentication (Request)

• HMAC Authentication (Notify)

OrderDesc

"order": {"description": "..."}

ans..768

O

Description of purchased goods, unit prices etc.

Please note: The following characters are not allowed: ä,ö,ü,ß

Please note: The first 27 characters appear on the customer-account statement. You can view the full data in Computop Analytics.

UserData

"metadata[userData]": "..."

ans..1024

O

If specified at request, Paygate forwards the parameter with the payment result to the shop.

URLSuccess

"urls": {"success": "..."}

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.

Common notes:

• We recommend to use parameter "response=encrypt" to get an encrypted response by Paygate

• 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.

URLFailure

"urls": {"failure": "..."}

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.

Common notes:

• We recommend to use parameter "response=encrypt" to get an encrypted response by Paygate

• 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 Paygate to URLSuccess and URLFailure, should be encrypted. For this purpose, transmit Response=encrypt parameter.

URLNotify

"urls": {"notify": "..."}

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 UserDataparameter instead.

Common notes:

• Before follow-up actions (capture / credit / reversal) are carried out on an existing transaction, the first Notify must have been answered by the shop.

• 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.

ReqId

"requestId": "..."

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.

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.

IssuerID

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

ans..11

OC

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

For Ideal 2.0 this is optional parameter, as the issuer selection will be moved to iDeal hub payment page.

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

Plain

"metadata[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.

Custom

"metadata": "..."

ans..1024Format

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.

Please find a sample here: Custom

REST

Format

CND

Description

"paymentId": "..."

an32

M

May be "00000000000000000000000000000000" if not yet set by Computop Paygate

"_Links.self.type": "..."

an..20

M

"application/json"

"_Links.redirect.href": "..."

an..1024

M

Merchant needs to redirect consumer to this URL to complete payment

"_Links.redirect.type": "..."

an..20

M

"text/html"

mid

ans..30

M

MerchantID, assigned by Computop

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.

XID

an32

M

ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate

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 EMS, this ID is transferred to the central iDEAL system as 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

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

an8

M

Error code according to Paygate Response Codes (A4 Error codes)

RefNr

ans..

OC

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), EMS or via Rabobank, please contact our Merchant Service (Computop Helpdesk) and we will activate the transfer for you.

UserData

ans..1024

O

If specified at request, Paygate 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)

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

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.

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.

Please find a sample here: Custom

MerchantID

ans..30

M

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

MerchantID

ans..30

M

MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language 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 characters)

MerchantID

BasicAuth.Username

ans..30

M

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

PayID

"paymentId": "..."

an32

M

ID assigned by Paygate for the payment to be credited

TransID

"transactionId": "..."

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

"amount": { "value": ...}

n..10

M

Amount in the smallest currency unit (e.g. EUR Cent).

Currency

"amount": { "currency": "..."}

a3

M

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

OrderDesc

"order": {"description": "..."}

ans..768

OC

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

ReqId

"requestId": "..."

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.

mid

"merchantId": "..."

ans..30

M

MerchantID, assigned by Computop

PayID

"paymentId": "..."

an32

M

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

XID

"xId": "..."

an32

M

ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate

TransID

"transactionId": "..."

an..35

M

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

Status

"status": "OK"

"status": "FAILED"

a..50

M

OK (URLSuccess) or FAILED (URLFailure)

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!

Code

"code": ...

an8

M

Error code according to Paygate Response Codes (A4 Error codes)

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)

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, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table

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 EMS, this ID is transferred to the central iDEAL system as 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..

OC

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), EMS or via Rabobank, please contact our Merchant Service (Computop Helpdesk) and we will activate the transfer for you.

PayID

an32

M

ID assigned by Paygate for this transaction

Action

a..20

M

The parameter Action defines the type of transaction: Credit

PayID

an32

M

ID assigned by Paygate for this transaction

Status

a..50

M

OK (URLSuccess) or FAILED (URLFailure)

Code

an8

M

Error code according to Paygate Response Codes (A4 Error codes)