Differences

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

--- en:girocheckout:ideal:start [2022/10/17 21:03]
michaelheumann
+++ en:girocheckout:ideal:start [2023/03/24 20:46]
michaelheumann
@@ Line 120: / Line 120: @@
 |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      |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. |
+|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 145: / Line 145: @@
 == example in case of error ==
 {{page>codesamples:ideal#transactionstart.response.false&noheader&nofooter}}
 ==== notification about the payment result ====
@@ Line 194: / Line 193: @@
 |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/ideal/senderinfo \\
+**Provided by:** GiroCheckout \\
+**Called by:** Merchant
+== POST Parameters ==
+^Name           ^Mandatory  ^Type      ^Description   ^
+|merchantId     |Yes       |Integer   |merchant ID of a iDEAL project |
+|projectId      |Yes       |Integer   |project ID of a iDEAL 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:ideal#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:ideal#senderinfo.response.true&noheader&nofooter}}
+== Example in case of error ==
+{{page>codesamples:ideal#senderinfo.response.false&noheader&nofooter}}

Girocheckout API

User Tools

Site Tools

Differences

Page Tools