Differences

This shows you the differences between two versions of the page.

--- en:girocheckout:eps:start [2019/09/03 18:04]
michaelheumann
+++ en:girocheckout:eps:start [2023/03/24 20:45]
michaelheumann
@@ Line 1: / Line 1: @@
 ====== eps ======
-Information about eps can be found under [[https://www.girosolution.de/girocheckout/fuer-haendler/|https://www.girosolution.de/girocheckout/fuer-haendler/]].
 **eps can only process EURO payments.**
@@ Line 21: / Line 20: @@
 buyer -> shop:
-shop -> girocheckout:
-girocheckout -> shop:
 shop -> girocheckout:
 girocheckout -> eps:
@@ Line 28: / Line 25: @@
 girocheckout -> shop:
 shop -> buyer:
-buyer -> bank:
+buyer -> eps:
+eps -> bank:
 bank -> buyer:
 buyer -> bank:
@@ Line 45: / Line 43: @@
   - buyer/ customer chooses eps and enters his bank's BIC
-  - merchant checks the bankstatus ([[en:girocheckout:eps:start#check_bankstatus|check bankstatus]])
-  - merchant receives a reply, if bank supports eps
   - merchant initialises eps ([[en:girocheckout:eps:start#initialise_eps_payment|initialise eps payment]])
   - GiroCheckout initialises request at eps
@@ Line 52: / Line 48: @@
   - merchant gets response about initialisation (if an issue occurs the transaction is finished)
   - merchant sends redirect URL to buyer/ customer
-  - the buyer's/ customer's browser redirects to buyer's/ customer's online banking account
+  - the buyer's/ customer's browser redirects to eps where the bank is selected (optional, only if bank is not already stored in browser)
+  - eps redirects to the customer's online banking
   - bank shows login page
   - buyer/ customer authorises eps payment
@@ Line 66: / Line 63: @@
 ===== API functions =====
-==== overview =====
+==== Overview =====
 As shown in the workflow there are different API calls during an eps transaction.
@@ Line 114: / Line 111: @@
 ==== eps issuer bank request ====
+**This call should not be used anymore. All eps transactions now use an external bank selection form!**
 Returns a list which contains all supported eps issuer banks. The buyer has to choose his one.
@@ Line 155: / Line 154: @@
 |merchantId     |yes              |Integer     |merchant ID of an eps project |
 |projectId      |yes              |integer     |project ID of an eps project |
-|merchantTxId   |yes              |String(255) |unique transaction id of the merchant |
+|merchantTxId   |yes              |String(255) |unique transaction id of the merchant. Allowed characters: any letters (incl. language-specific special characters such as German Umlauts), 0-9, symbols & = + , : ; . _ ! ? # /  |
 |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|
@@ Line 162: / Line 161: @@
 |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 |
+|kassenzeichen  |optional         |String (255) |Optional field that allows passing an additional reference/identifier for the transaction. This value is displayed inside GiroCockpit as part of the transaction details (and soon export) and a search for it is also supported there. Characters must comply with the UTF-8 character set. |
 |hash           |yes              |String      |HMAC MD5 hash (see [[en:girocheckout:general:start#hash_generation|hash generation]]) |
@@ Line 188: / Line 188: @@
 == example in case of error ==
 {{page>codesamples:eps#transactionstart.response.false&noheader&nofooter}}
 ==== notification about the payment result ====
@@ Line 239: / Line 238: @@
 |gcResultPayment  |yes       |Integer     | [[en:girocheckout:resultcodes#zahlungsausgang|payment result codes]]|
 |gcHash           |yes       |String      | HMAC MD5 hash (see [[en:girocheckout:general:start#hash_generation|hash generation]]) |
+===== 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.  This information may be used for a refund to the original payer.
+=== API call ===
+**URL:** https://payment.girosolution.de/girocheckout/api/v2/eps/senderinfo \\
+**Provided by:** GiroCheckout \\
+**Called by:** Merchant
+== POST Parameters ==
+^Name           ^Mandatory  ^Type      ^Description   ^
+|merchantId     |Yes       |Integer   |merchant ID of a eps project |
+|projectId      |Yes       |Integer   |project ID of a eps project  |
+|reference      |Yes       |String(36)|GiroCheckout transaction ID |
+|hash           |Yes       |String(32)|HMAC MD5 hash of the full JSON string. (see [[en:girocheckout:general:start#api_call_reply_to_the_merchant|api call reply]])|
+== Example ==
+{{page>codesamples:eps#senderinfo.request&noheader&nofooter}}
+=== 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           ^Mandatory  ^Type      ^Description   ^
+|rc             |yes       |Integer   |[[en:girocheckout:errorcodes|response code]] |
+|msg            |yes       |String    |additional information about the response code in case of error|
+|accountholder  |Optional |String    |Account holder of the sender account|
+|iban           |Optional |String    |IBAN of the sender account |
+|bic            |Optional |String    |BIC of the sender account |
+^HEADER parameter^^^^
+|hash           |yes       |String    |HMAC MD5 hash of the full JSON string. (see [[en:girocheckout:general:start#api_call_reply_to_the_merchant|api call reply]]) |
+== Example in case of success ==
+{{page>codesamples:eps#senderinfo.response.true&noheader&nofooter}}
+== Example in case of error ==
+{{page>codesamples:eps#senderinfo.response.false&noheader&nofooter}}

Girocheckout API

User Tools

Site Tools

Differences

Page Tools