This shows you the differences between two versions of the page.
Both sides previous revision Previous revision | Next revision Both sides next revision | ||
en:girocheckout:giropay:functions [2013/11/06 02:38] michaelheumann |
en:girocheckout:giropay:functions [2013/11/06 03:00] michaelheumann |
||
---|---|---|---|
Line 29: | Line 29: | ||
== Parameters == | == Parameters == | ||
- | ^Name | + | ^Name |
|rc | |rc | ||
|msg |Yes | |msg |Yes | ||
|bankcode | |bankcode | ||
|bic |Optional | |bic |Optional | ||
- | |bankname | + | |bankname |
+ | |payment | ||
+ | |verifyAge | ||
+ | |||
+ | == Example in case of success == | ||
+ | {{page> | ||
+ | |||
+ | == Example in case of error == | ||
+ | {{page> | ||
+ | |||
+ | ===== Initialization of the giropay payment ===== | ||
+ | |||
+ | You send the transaction data and receive a link (redirect URL) as a reply. Afterwards, you send your customer a redirection to that URL. This may be done through an HTTP redirect header, an HTML page with a corresponding meta tag or Javascript. The actual payment processing takes place as the customer logs into his online banking platform and confirms the prefilled transfer form there by entering a TAN. | ||
+ | The notification of your application about the payment outcome is done via a GET request sent by GiroCheckout to the URL specified in the urlNotify parameter. | ||
+ | |||
+ | === Request === | ||
+ | **URL:** https:// | ||
+ | **To be provided by:** GiroSolution AG \\ | ||
+ | **To be called by:** Merchant | ||
+ | |||
+ | == Parameters == | ||
+ | ^Name | ||
+ | |merchantId | ||
+ | |projectId | ||
+ | |merchantTxId | ||
+ | |amount | ||
+ | |currency | ||
+ | |purpose | ||
+ | |bankcode | ||
+ | |bankaccount | ||
+ | |bic |Optional |String(11) | ||
+ | |iban | ||
+ | |info[1..5]Label|Optional |String(30) | ||
+ | |info[1..5]Text |Optional |String(80) | ||
+ | |urlRedirect | ||
+ | |urlNotify | ||
+ | |hash | ||
+ | |||
+ | == The info parameters == | ||
+ | Using the info parameters, you may display additional information on the giropay transfer pages. A maximum of 5 elements is possible. Each information is comprised of a label and the information itself. | ||
+ | |||
+ | == Example == | ||
+ | {{page> | ||
+ | |||
+ | === Reply === | ||
+ | Die Antwort ist ein JSON Objekt. Wenn **rc = 0** zurückgeliefert wird, sind die Parameter reference und redirect gesetzt. Leiten Sie den Kunde bitte an die redirect URL weiter. | ||
+ | == Parameter == | ||
+ | ^Name | ||
+ | |rc | ||
+ | |msg |Ja | ||
+ | |reference | ||
+ | |redirect | ||
+ | |||
+ | == Beispiel im Erfolgsfall == | ||
+ | {{page> | ||
+ | |||
+ | == Beispiel im Fehlerfall == | ||
+ | {{page> | ||
+ | |||
+ | ===== Benachrichtigung über den Ausgang der Zahlung ===== | ||
+ | Nach Beendigung der giropay Zahlung/ | ||
+ | |||
+ | === Anfrage === | ||
+ | **URL:** notifyUrl aus dem Transaktionsstart \\ | ||
+ | **Bereitzustellen von:** Händler \\ | ||
+ | **Aufzurufen von:** GiroSolution AG | ||
+ | |||
+ | == GET Parameter == | ||
+ | ^Name | ||
+ | |gcReference | ||
+ | |gcMerchantTxId | ||
+ | |gcBackendTxId | ||
+ | |gcAmount | ||
+ | |gcCurrency | ||
+ | |gcResultPayment | ||
+ | |gcResultAVS | ||
+ | |gcHash | ||
+ | |||
+ | === Antwort === | ||
+ | Als Antwort auf den GET-Request wird einer der folgendes HTTP Statuscodes erwartet. | ||
+ | |||
+ | ^HTTP Statuscode | ||
+ | |200 (OK) |Die Benachrichtigung wurde korrekt verarbeitet. | | ||
+ | |400 (Bad Request) | ||
+ | |Alle anderen | ||
+ | ===== Rückleitung des Kunden zum Shop ===== | ||
+ | Nach Beendigung der giropay Zahlung kann der Kunde über einen Link zurück zum Shop kommen. Diese Rückleitung erfolgt nicht automatisch. | ||
+ | |||
+ | === Anfrage === | ||
+ | **URL:** redirectUrl aus dem Transaktionsstart \\ | ||
+ | **Bereitzustellen von:** Händler \\ | ||
+ | **Aufzurufen von:** GiroSolution AG | ||
+ | |||
+ | == GET Parameter == | ||
+ | ^Name | ||
+ | |gcReference | ||
+ | |gcMerchantTxId | ||
+ | |gcBackendTxId | ||
+ | |gcAmount | ||
+ | |gcCurrency | ||
+ | |gcResultPayment | ||
+ | |gcResultAVS | ||
+ | |gcHash |