This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
en:girocheckout:eps:start [2014/07/17 14:04] jeromejung [check bankstatus] |
en:girocheckout:eps:start [2023/05/05 03:29] (current) michaelheumann |
||
---|---|---|---|
Line 1: | Line 1: | ||
====== eps ====== | ====== eps ====== | ||
- | Information about eps can be found under [[https:// | ||
**eps can only process EURO payments.** | **eps can only process EURO payments.** | ||
Line 21: | Line 20: | ||
buyer -> shop: | buyer -> shop: | ||
- | shop -> girocheckout: | ||
- | girocheckout -> shop: | ||
shop -> girocheckout: | shop -> girocheckout: | ||
girocheckout -> eps: | girocheckout -> eps: | ||
Line 28: | Line 25: | ||
girocheckout -> shop: | girocheckout -> shop: | ||
shop -> buyer: | shop -> buyer: | ||
- | buyer -> bank: | + | buyer -> eps: |
+ | eps -> bank: | ||
bank -> buyer: | bank -> buyer: | ||
buyer -> bank: | buyer -> bank: | ||
Line 45: | Line 43: | ||
- buyer/ customer chooses eps and enters his bank's BIC | - buyer/ customer chooses eps and enters his bank's BIC | ||
- | - merchant checks the bankstatus ([[en: | ||
- | - merchant receives a reply, if bank supports eps | ||
- merchant initialises eps ([[en: | - merchant initialises eps ([[en: | ||
- GiroCheckout initialises request at eps | - GiroCheckout initialises request at eps | ||
Line 52: | Line 48: | ||
- merchant gets response about initialisation (if an issue occurs the transaction is finished) | - merchant gets response about initialisation (if an issue occurs the transaction is finished) | ||
- merchant sends redirect URL to buyer/ customer | - merchant sends redirect URL to buyer/ customer | ||
- | - the buyer' | + | - the buyer' |
+ | - eps redirects to the customer' | ||
- bank shows login page | - bank shows login page | ||
- buyer/ customer authorises eps payment | - buyer/ customer authorises eps payment | ||
Line 66: | Line 63: | ||
===== API functions ===== | ===== API functions ===== | ||
- | ==== overview | + | ==== Overview |
As shown in the workflow there are different API calls during an eps transaction. | As shown in the workflow there are different API calls during an eps transaction. | ||
Line 77: | Line 74: | ||
==== check bankstatus ==== | ==== check bankstatus ==== | ||
+ | **This call should not be used anymore. All eps transactions now use an external bank selection form!** | ||
+ | |||
This API call checks, if a bank supports the eps payment method. Therefore the BIC of the buyer' | This API call checks, if a bank supports the eps payment method. Therefore the BIC of the buyer' | ||
Line 88: | Line 87: | ||
|merchantId | |merchantId | ||
|projectId | |projectId | ||
- | |bic |yes | + | |bic |yes |
|hash | |hash | ||
Line 95: | Line 94: | ||
=== reply === | === reply === | ||
- | The reply contains an encoded JSON string. | + | The reply contains an encoded JSON string. |
== JSON parameter == | == JSON parameter == | ||
^name | ^name | ||
- | |rc | + | |rc |
- | |msg |yes | + | |msg |yes |
- | |bic |yes | + | |bic |yes |
- | |bankname | + | |bankname |
- | |eps |yes | + | |eps |yes |
^HEADER parameter^^^^ | ^HEADER parameter^^^^ | ||
- | |hash | + | |hash |
- | == example | + | == example == |
- | {{page> | + | {{page> |
- | == example in case of error == | ||
- | {{page> | ||
+ | ==== eps issuer bank request ==== | ||
+ | **This call should not be used anymore. All eps transactions now use an external bank selection form!** | ||
- | ==== initialise | + | Returns a list which contains all supported eps issuer banks. The buyer has to choose his one. |
+ | |||
+ | **URL:** https:// | ||
+ | **provided by:** GiroSolution AG \\ | ||
+ | **called by:** Händler | ||
+ | |||
+ | == POST parameter | ||
+ | ^name | ||
+ | |merchantId | ||
+ | |projectId | ||
+ | |hash | ||
+ | |||
+ | == example == | ||
+ | {{page> | ||
+ | |||
+ | === 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 | ||
+ | |rc | ||
+ | |msg |yes | ||
+ | |issuer | ||
+ | |||
+ | == Beispiel == | ||
+ | {{page> | ||
+ | |||
+ | ==== Initialize | ||
The initialisation of an eps can be processed in different ways. This will be distinguished just by the project id. | The initialisation of an eps can be processed in different ways. This will be distinguished just by the project id. | ||
Line 128: | Line 154: | ||
|merchantId | |merchantId | ||
|projectId | |projectId | ||
- | |merchantTxId | + | |merchantTxId |
|amount | |amount | ||
|currency | |currency | ||
|purpose | |purpose | ||
- | |bic |yes | + | |bic |**deprecated** |
- | |urlRedirect | + | |urlRedirect |
- | |urlNotify | + | |urlNotify |
- | |hash | + | |kassenzeichen |
+ | |hash | ||
Line 149: | Line 176: | ||
== Parameter == | == Parameter == | ||
^name | ^name | ||
- | |rc | + | |rc |
- | |msg |yes | + | |msg |yes |String(255) |additional information about the response code | |
- | |reference | + | |reference |
- | |redirect | + | |redirect |
^HEADER parameter^^^^ | ^HEADER parameter^^^^ | ||
- | |hash | + | |hash |
== example in case of success == | == example in case of success == | ||
Line 161: | Line 188: | ||
== example in case of error == | == example in case of error == | ||
{{page> | {{page> | ||
- | |||
==== notification about the payment result ==== | ==== notification about the payment result ==== | ||
Line 179: | Line 205: | ||
== GET parameter == | == GET parameter == | ||
^name | ^name | ||
- | |gcReference | + | |gcReference |
- | |gcMerchantTxId | + | |gcMerchantTxId |
- | |gcBackendTxId | + | |gcBackendTxId |
|gcAmount | |gcAmount | ||
- | |gcCurrency | + | |gcCurrency |
|gcResultPayment | |gcResultPayment | ||
- | |gcHash | + | |gcHash |
=== reply === | === reply === | ||
Line 205: | Line 231: | ||
== GET parameter == | == GET parameter == | ||
^name ^ mandatory | ^name ^ mandatory | ||
- | |gcReference | + | |gcReference |
- | |gcMerchantTxId | + | |gcMerchantTxId |
- | |gcBackendTxId | + | |gcBackendTxId |
- | |gcAmount | + | |gcAmount |
- | |gcCurrency | + | |gcCurrency |
- | |gcResultPayment | + | |gcResultPayment |
- | |gcHash | + | |gcHash |
+ | |||
+ | ===== Retrieve sender information ===== | ||
+ | This service allows the retrieval of the information associated to the sender of a completed transaction. As a response to the given reference number, the account holder, IBAN and BIC of the customer are returned. | ||
+ | |||
+ | === API call === | ||
+ | **URL:** https:// | ||
+ | **Provided by:** GiroCheckout \\ | ||
+ | **Called by:** Merchant | ||
+ | |||
+ | == POST Parameters == | ||
+ | ^Name | ||
+ | |merchantId | ||
+ | |projectId | ||
+ | |reference | ||
+ | |hash | ||
+ | |||
+ | == Example == | ||
+ | {{page> | ||
+ | |||
+ | === Response === | ||
+ | The response is a JSON object. The rc field returns an error code. If **rc = 0** is returned, the corresponding fields contain the sender information. | ||
+ | |||
+ | == JSON Parameters == | ||
+ | ^Name | ||
+ | |rc | ||
+ | |msg |yes |String(255) |additional information about the response code in case of error| | ||
+ | |accountholder | ||
+ | |iban | ||
+ | |bic |Optional |String(11) | ||
+ | ^HEADER parameter^^^^ | ||
+ | |hash |yes | ||
+ | |||
+ | == Example in case of success == | ||
+ | {{page> | ||
+ | |||
+ | == Example in case of error == | ||
+ | {{page> | ||