User Tools

Site Tools


Translations of this page:
en:girocheckout:ideal:start

iDEAL

Information about iDEAL can be found under https://www.girosolution.de/girocheckout/fuer-haendler/.

test data

form value
issuer RABOBANK

transaction result

result code answer description
4000 successful transaction After submission of the form by using the data above there can be created a successful transaction.
unsuccessful transaction not supported

workflow

PlantUML Graph

  1. buyer chooses iDEAL payment method
  2. merchant requests the available banks (bank request)
  3. merchant gets a reply of all issuer banks, that support iDEAL
  4. buyer selects Bank and merchant initialises iDEAL payment (initialise iDEAL payment)
  5. GiroCheckout initialises transaction at iDEAL
  6. iDEAL submits response to GiroCheckout
  7. merchant gets response about initialisation (if an issue occurs the transaction is finished)
  8. merchant sends redirect URL to buyer
  9. the buyer's browser redirects buyer to his online banking account
  10. bank shows login page
  11. buyer authorises payment
  12. bank processes payment
  13. bank submits payment result to iDEAL
  14. iDEAL submits result to GiroCheckout
  15. GiroCheckout notifies merchant about the transaction result (payment result notification)
  16. merchant processes result
  17. merchant sends HTTP Statuscode to GiroCheckout
  18. GiroCheckout sends merchants redirect page to iDEAL
  19. buyer clicks “Zurück zum Shop” and gets redirected to the merchant (buyer redirection)

API functions

overview

As shown in the workflow there are different API calls during an iDEAL transaction.

  1. iDEAL issuer bank request
  2. initialise transaction
  3. payment result notification to merchant
  4. buyer redirection to the merchant (triggered by buyer)

iDEAL issuer bank request

Returns a list which contains all supported iDEAL issuer banks. The buyer has to choose his one.

URL: https://payment.girosolution.de/girocheckout/api/v2/ideal/issuer
provided by: GiroSolution AG
called by: Händler

POST parameter
name mandatory type description
merchantId yes Integer Merchant ID
projectId yes Integer Project ID
hash yes String(32)HMAC MD5 hash (see hash generation)
example
curl -d "merchantId=1234567" \
     -d "projectId=1234" \
     -d "hash=02f123fdb8b2056596abc0e6ebb1a8c3" \
     https://payment.girosolution.de/girocheckout/api/v2/ideal/issuer

reply

The reply contains an encoded JSON string. An response code is submitted in the field rc. If the response contains rc = 0, the request was successful.

JSON parameter
name mandatory type description
rc yes Integer error codes
msg yes String additional informationen about the response code
issuer optional Mixed list of all supported issuer banks
Beispiel

hash : eef32d3cd0f91bf9328825da6b8997ce

{"issuer":{"NLRABO2U152":"Issuer Simulation","INGBNL2A":"Issuer Simulation V3 - ING","RABONL2U":"Issuer Simulation V3 - RABO"},"rc":0,"msg":""}

initialise iDEAL payment

Torwards a successful initialisation you receive a reference number and an redirect link. The redirect link leads to the online banking account of the buyer's bank. He has to be redirected to his bank. This can be achieved by a HTTP-Redirect-Header, HTML page with an corresponding Meta-Tag or JavaScript redirect.

request

URL: https://payment.girosolution.de/girocheckout/api/v2/transaction/start
provided by: GiroCheckout
called by: Händler

POST parameter
name mandatory type description
merchantId yes Integer merchant ID of an iDEAL project
projectId yes integer project ID of an iDEAL project
merchantTxId yes String(255) unique transaction id of the merchant
amount yes Integer if a decimal currency is used, the amount has to be in the smallest unit of value, eg. cent, penny
currency yes String(3) currency
EUR = Euro
purpose yes String(27) purpose
issuer yes String iDEAL Issuer Bank
urlRedirect yes String URL, where the buyer has to be sent after payment
urlNotify yes String URL, where the notification has to be sent after payment
hash yes String HMAC MD5 hash (see hash generation)
example
curl -d "merchantId=1234567" \
     -d "projectId=1234" \
     -d "merchantTxId=1234567890" \
     -d "amount=100" \
     -d "currency=EUR" \
     -d "purpose=Beispieltransaktion" \
     -d "issuer=INGBNL2A" \
     -d "urlRedirect=http://www.my-domain.de/girocheckout/redirect" \
     -d "urlNotify=http://www.my-domain.de/girocheckout/notify" \
     -d "hash=256b7bb16edbc76871c830d0d623c303" \
     https://payment.girosolution.de/girocheckout/api/v2/transaction/start

reply

The reply includes a JSON encoded string. The field rc contains the response code. If it is 0 the transaction was successfully initialised. The response also includes a transaction id and a redirect URL to the online banking account of the buyer's bank.

Parameter
name mandatory type description
rc yes Integer response code
msg yes String additional information about the response code
reference optional String unique GiroCheckout transaction ID
redirect optional String redirect URL to the online banking account
HEADER parameter
hash yes String HMAC MD5 hash overall the JSON string. (see api call reply)
example in case of success

hash : 17790db9c9745b94e1b8db1b22cc7876

{"reference":"c6edadaa-b507-49f1-a548-013675fb5c83","redirect":"http://testnl.paydutch.nl/WeDeal/start.aspx?ID=9c55b84d-3c1f-4c9a-86e1-322318e282cd","rc":"0","msg":""}
example in case of error

hash : 98d9d8b133acf97eb92601fa72d804a0

 {"reference":"f84e606f-817d-439f-ada1-d37e85cb6314","redirect":"","rc":"5100","msg":""}

notification about the payment result

The result of a initialised transaction will be submitted to the prior in the urlNotify parameter specified URL. This notification should be used to update the payment status in the merchant's system. The result of an iDEAL payment is contained in the field gcResultPayment.

Due to the internal iDEAL process, a redirection of the customer to urlRedirect is not done automatically but only after a customer click.

request

URL: notifyUrl of the prior init transaction call
provided by: merchant
called by: GiroCheckout

GET parameter
name mandatory type description
gcReference yes String unique GiroCheckout transaction ID
gcMerchantTxId yes String merchant transaction ID
gcBackendTxId yes String payment processor transaction ID
gcAmount yes Integer if a decimal currency is used, the amount has to be in the smallest unit of value, eg. cent, penny
gcCurrency yes String currency
gcResultPayment yes Integer payment result codes
gcHash yes String HMAC MD5 hash (see hash generation)

reply

As a reply to the GET request, one of the following HTTP status codes is expected.

HTTP status code description
200 (OK) The notification was processed correctly.
400 (Bad Request) The merchant did not process the notification and does not wish to be notified again.
all others The notification is repeated no more than 10 times every 30 minutes until the merchant returns the status code 200 or 400.

redirection of the customer to merchant

After completing the payment, the customer may return to the merchant through a link. This return is not done automatically.

request

URL: redirectUrl of the prior init transaction call
provided by: merchant
called by: GiroCheckout

GET parameter
name mandatory type description
gcReference yes String unique GiroCheckout transaction ID
gcMerchantTxId yes String merchant transaction ID
gcBackendTxId yes String payment processor transaction ID
gcAmount yes Integer if a decimal currency is used, the amount has to be in the smallest unit of value, eg. cent, penny
gcCurrency yes String currency
gcResultPayment yes Integer payment result codes
gcHash yes String HMAC MD5 hash (see hash generation)
en/girocheckout/ideal/start.txt · Last modified: 2015/12/03 18:23 by thorstenmarx

Page Tools