User Tools

Site Tools


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

giropay/ giropay-ID

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

giropay can only process EURO payments.

Test Data

giropay

field value
bank code 12345679
BIC TESTDETT421
bank account/ login sepatest1
PIN any 5-digit number
TAN any 6-digit number
mobile devices
username chiptansepatest1
PIN 12345
TAN 123456

giropay-ID

field value
bank code 12345679
BIC TESTDETT421
bank account/ login pushtanavstest1
PIN 12345
TAN 123456

giropay+giropay-ID

field value
bank code 12345679
BIC TESTDETT421
bank account/ login sepatest1
PIN 12345
TAN 123456

In order to test a failed age verification, use the logins “pushtanavstest5” or “chiptanavstest5” instead of the one specified above.

transaction result

result code answer description
4000 successful transaction After submission of the form by using the data above you create a successful transaction.
4502 aborted transaction After clicking the button giropay abbrechen und zurück zum Shop you create an unsuccessful transaction.

Workflow

PlantUML Graph

  1. buyer/ customer chooses giropay/ giropay-ID and enters his bank's BIC
  2. merchant checks the bankstatus (check bankstatus)
  3. merchant receives a reply, if bank supports giropay/giropay-ID
  4. merchant initialises giropay/giropay-ID request (initialise giropay payment)
  5. GiroCheckout initialises request at giropay
  6. giropay 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/ customer
  9. the buyer's/ customer's browser redirects to buyer's/ customer's online banking account
  10. bank shows login page
  11. buyer/ customer authorises giropay payment/ giropay-ID
  12. bank processes reqest
  13. bank submits result to giropay
  14. giropay submits result to GiroCheckout
  15. GiroCheckout notifies merchant about the result (payment result notification)
  16. merchant processes result
  17. merchant sends HTTP Statuscode to GiroCheckout
  18. GiroCheckout sends merchants redirect page to giropay
  19. buyer/customer 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 a giropay transaction or giropay-ID verification. A combinaion of giropay and giropay-ID is also possible.

  1. check bankstatus
  2. initialise transaction
  3. payment result notification to merchant
  4. buyer redirection to the merchant (triggered by buyer)

Check bankstatus

This API call checks if a bank supports the giropay payment method or giropay-ID verification. Therefore the BIC of the buyer's account has to be submitted. The response shows if the bank provides giropay or giropay-ID. It is recommended to do this prior to an initial payment, to make sure that the buyer's bank supports giropay.

API call

URL: https://payment.girosolution.de/girocheckout/api/v2/giropay/bankstatus
provided by: GiroCheckout
called by: merchant

POST parameter
parameter mandatory type description
merchantId yes Integer Merchant ID of a giropay, giropay-ID or giropay-ID + giropay project
projectId yes Integer Project ID of a giropay, giropay-ID or giropay-ID + giropay project
bic yes String(11)the buyer's bank account BIC (8 or 11-digits), which schould be checked (determined by Bankstatus Widget)
hash yes String(32)HMAC MD5 hash over all API call params (see hash generation)
Example
curl -d "merchantId=1234567" \
     -d "projectId=1234" \
     -d "bic=TESTDETT421" \
     -d "hash=246d1fa2ed97ecff895de974c560f9ec" \
     https://payment.girosolution.de/girocheckout/api/v2/giropay/bankstatus

Reply

The reply contains an encoded JSON string. An response code is submitted in the field rc. If the response contains rc = 0, the bank supports giropay. Additional information which feature of giropay is supported can be found in the giropay and giropay-ID parameters. There will also be additional information about the bank returned, if they are known.

JSON parameter
name mandatory type description
rc yes Integer error codes
msg yes String additional informationen about the response code
bankcode optional Integer bank code
bic optional String BIC
bankname optional String name of the bank
giropay optional Integer 0 = giropay payment is not supported
1 = giropay payment is supported
giropayid optional Integer 0 = giropay-ID and giropay-ID + giropay payment are not supported
1 = giropay-ID and giropay-ID + giropay payment are supported
HEADER parameter
hash yes String HMAC MD5 hash overall the JSON string. (see api call reply)
Example in case of success

hash : cde71b6b98e8dae709fdc1e17aef885f

{"bankcode":"94059421","bic":"TESTDETT421","bankname":"Testbank","giropay":1,"giropayid":1,"rc":0,"msg":""}
Example in case of error

hash : f1d186103b8c4cb59c54ae7b987a9d4c

{"bankcode":null,"bic":null,"bankname":null,"giropay":null,"giropayid":null,"rc":6001,"msg":"Bank unbekannt"}

giropay issuer bank request

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

URL: https://payment.girosolution.de/girocheckout/api/v2/giropay/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/giropay/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 containing bic as key and name
Example

hash : cf6109481bc2a7bdf82fa3af02a8e763

{"issuer":{"PBNKDEFF100":"Postbank","BELADEBEXXX":"Landesbank Berlin - Berliner Sparkasse", [...]} ,"rc":0,"msg":""}

Initialize giropay payment

The initialization of a giropay can be processed in different ways. This will be distinguished just by the project id.

Towards a successful initialization 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: Merchant

POST parameter
Name Mandatory Type Description
giropaygiropay-IDgiropay+giropay-ID
merchantId yes yes yes Integer merchant ID of a giropay project
projectId yes yes yes integer project ID of a giropay project
merchantTxId yes yes yes String(255) unique transaction id of the merchant
amount yes yes Integer if a decimal currency is used, the amount has to be in the smallest unit of value, eg. Cent, Penny
currency yes yes String(3) currency
EUR = Euro
purpose yes yes String(27) purpose
bic yes yes yes String(11) BIC (8 or 11-digits), (determined by Bankstatus Widget)
iban optional optional optional String(34) IBAN without whitespaces
info1Labeloptional optional optional String(30) additional information field which is shown on the payment form (label)
info1Text optional optional optional String(80) additional information field which is shown on the payment form (text)
info2Labeloptional optional optional String(30) additional information field which is shown on the payment form (label)
info2Text optional optional optional String(80) additional information field which is shown on the payment form (text)
info3Labeloptional optional optional String(30) additional information field which is shown on the payment form (label)
info3Text optional optional optional String(80) additional information field which is shown on the payment form (text)
info4Labeloptional optional optional String(30) additional information field which is shown on the payment form (label)
info4Text optional optional optional String(80) additional information field which is shown on the payment form (text)
info5Labeloptional optional optional String(30) additional information field which is shown on the payment form (label)
info5Text optional optional optional String(80) additional information field which is shown on the payment form (text)
urlRedirect yes yes yes String URL, where the buyer has to be sent after payment
urlNotify yes yes yes String URL, where the notification has to be sent after payment
hash yes yes yes String HMAC MD5 hash (see hash generation)

Through the info parameter you can display additional information on the payment form of the bank. There are up to info 5 elements possible. One info element consists of one label and one infotext.

Example
curl -d "merchantId=1234567" \
     -d "projectId=1234" \
     -d "merchantTxId=1234567890" \
     -d "amount=100" \
     -d "currency=EUR" \
     -d "purpose=Beispieltransaktion" \
     -d "bic=TESTDETT421" \
     -d "info1Label=Ihre Kundennummer" \
     -d "info1Text=0815" \
     -d "urlRedirect=http://www.ihre-domein.de/girocheckout/redirect" \
     -d "urlNotify=http://www.ihre-domein.de/girocheckout/notify" \
     -d "hash=6048aefae3e7a684ac9d7251220f99f8" \
     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 buyer's 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 : f56b5f91094cd22ace93b76ef250aa62

{"reference":"9ce6c641-4082-4f75-ae54-333309febcc5","redirect":"https://giropay.starfinanz.de/ftg/a/go/07i2j1k00pp0u109biywcswh;jsessionid=B1D575F122ED8D4B4B4EB0F83E85897F","rc":"0","msg":""}
Example in case of error

hash : baf3c9b7217f362c29dd5cf6f098320c

{"reference":null,"redirect":null,"rc":5033,"msg":"Währung ungütig"}

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 a giropay payment is contained in the field gcResultPayment. If a giropay-ID or giropay-ID + giropay transaction was initialised the result of the age verification can be found in the field gcResultAVS.

Due to the internal giropay 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
giropaygiropay-IDgiropay+giropay-ID
gcReference yes yes yes String unique GiroCheckout transaction ID
gcMerchantTxId yes yes yes String merchant transaction ID
gcBackendTxId yes yes yes String payment processor transaction ID
gcAmount yes yes Integer if a decimal currency is used, the amount has to be in the smallest unit of value, eg. cent, penny
gcCurrency yes yes String currency
gcResultPayment yes yes Integer payment result codes
gcResultAVS yes yes Integer age verification result codes
gcObvName optional optional String Optional adjustable field, which includes the name of the person who has to be verified (giropay-ID)
gcHash yes yes 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
giropaygiropay-IDgiropay+giropay-ID
gcReference yes yes yes String unique GiroCheckout transaction ID
gcMerchantTxId yes yes yes String merchant transaction ID
gcBackendTxId yes yes yes String payment processor transaction ID
gcAmount yes yes Integer if a decimal currency is used, the amount has to be in the smallest unit of value, eg. cent, penny
gcCurrency yes yes String currency
gcResultPayment yes yes Integer payment result codes
gcResultAVS yes yes Integer age verification result codes
gcObvName optional optional String Optional adjustable field, which includes the name of the person who has to be verified (giropay-ID)
gcHash yes yes yes String HMAC MD5 hash (see hash generation)

Bank selection widget

The bank selection widget may be used to implement an autocomplete functionality for a BIC or bank number form field.

Demo page

Integration

Native Javascript Widget (pure JS)

This widget was implemented in pure JS and does not require third-party libraries. Thus, no conflicts with other products will occur.

Including the required files:

  • Line 1: Includes stylesheet
  • Lines 2: Includes Widget Script
 1 <link rel="stylesheet" href="https://bankauswahl.giropay.de/widget/v2/style.css" />
 2 <script src="https://bankauswahl.giropay.de/widget/v2/girocheckoutwidget.js"></script>
 

Event “onkeyup” for giropay BIC field:

 1 <input type="text" id="giropay_bic" name="giropay_bic" value="" onkeyup="girocheckout_widget(this, event, 'bic', '0')">

Event “onkeyup” for eps BIC field:

 1 <input type="text" id="eps_bic" name="eps_bic" value="" onkeyup="girocheckout_widget(this, event, 'bic', '3')">

The widget may be configured through several parameters (parameters 3 and 4 of the girocheckout_widget call):

Parameter Type Value Description
return String blz
bic
Defines whether the BIC or the bank code (BLZ) is to be displayed in the field once the bank has been selected. You should usually put 'bic' here.
kind integer 0 = All banks are available for selection
1 = Only banks that support giropay
2 = Only banks that support giropay-ID
Defines which banks are available for selection.

That is all!

en/girocheckout/giropay/start.txt · Last modified: 2016/06/13 16:40 by michaelheumann

Page Tools