This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next 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:21] 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 === | ||
+ | The reply is a JSON object. If **rc = 0** is returned, the parameters reference and redirect are set. Please redirect the customer to the redirect URL. | ||
+ | |||
+ | == Parameters == | ||
+ | ^Name | ||
+ | |rc | ||
+ | |msg |Yes | ||
+ | |reference | ||
+ | |redirect | ||
+ | |||
+ | == Example in case of success == | ||
+ | {{page> | ||
+ | |||
+ | == Example in case of error == | ||
+ | {{page> | ||
+ | |||
+ | ===== Notification about the payment outcome ===== | ||
+ | After completion of the giropay payment or age verification, | ||
+ | |||
+ | === Request === | ||
+ | **URL:** notifyUrl aus dem Transaktionsstart \\ | ||
+ | **To be provided by:** Merchant \\ | ||
+ | **To be called by:** GiroSolution AG | ||
+ | |||
+ | == GET Parameters == | ||
+ | ^Name | ||
+ | |gcReference | ||
+ | |gcMerchantTxId | ||
+ | |gcBackendTxId | ||
+ | |gcAmount | ||
+ | |gcCurrency | ||
+ | |gcResultPayment | ||
+ | |gcResultAVS | ||
+ | |gcHash | ||
+ | |||
+ | === 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) | ||
+ | |All others | ||
+ | |||
+ | ===== Returning of the customer to the shop ===== | ||
+ | After completing the giropay payment, the customer may return to the shop through a link. This return is not done automatically. | ||
+ | |||
+ | === Request === | ||
+ | **URL:** redirectUrl from the transaction beginning \\ | ||
+ | **To be provided by:** Merchant \\ | ||
+ | **To be called by:** GiroSolution AG | ||
+ | |||
+ | == GET Parameters == | ||
+ | ^Name | ||
+ | |gcReference | ||
+ | |gcMerchantTxId | ||
+ | |gcBackendTxId | ||
+ | |gcAmount | ||
+ | |gcCurrency | ||
+ | |gcResultPayment | ||
+ | |gcResultAVS | ||
+ | |gcHash |