Girocheckout API

User Tools

Site Tools

Trace:
en:girocheckout:giropay:functions

Differences

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

Link to this comparison view

Both sides previous revision Previous revision
Next revision 		Previous revision
Next revision Both sides next revision
en:girocheckout:giropay:functions [2013/10/31 17:27]
thorstenmarx gelöscht 		en:girocheckout:giropay:functions [2013/11/06 02:38]
michaelheumann
Line 1: Line 1:
-====== Funktionen ======+{{indexmenu_n>3}} 
 +====== giropay API Functions ======
  
-===== Bankleitzahlprüfung ===== +===== Check bank status ===== 
-Mit dieser Funktion prüfen Sie, ob eine Bank am giropay-Verfahren teilnimmt und Zahlungen abgewickelt werden können. Bitte nutzen Sie vor jeder giropay Transaktion diese Funktion, um sicherzustellen, dass die Bank des Kunden giropay unterstützt und verfügbar ist. +You can use this function to check if a bank supports the giropay payment method and allows payments and/or age verification. Please use this function prior to **every** transaction to make sure that the customer's bank supports the corresponding giropay transaction and is available.
-=== Anfrage === +
-**URL:** https://payment.girosolution.de/giroconnect/v2/giropay/bankstatus +
-^Name           ^Pflicht  ^Type      ^Beschreibung   ^ +
-|merchantId     |Ja       |Integer   |Händler-ID eines giropay Projekts | +
-|projectId      |Ja       |Integer   |Projekt-ID eines giropay Projekts | +
-|txKind         |Optional |Integer   |giropay-Transaktionsart, die durchgefüht werden soll\\ 0 = giropay Zahlung (default)| +
-|bankcode       |Ja*      |String(8) |Bankleizahl der Kundenbank, die geprüft werden soll | +
-|bic            |Ja*      |String(11)|BIC der Kundenbank, die geprüft werden soll | +
-|hash           |Ja       |String(32)|HMAC MD5 hash über alle Werte des Aufrufs | +
-* Bankleitzahl **oder** BIC ist anzugeben. +
-== Example == +
-{{page>codesamples:giropay#bankstatus.Anfrage&noheader&nofooter}}+
  
-=== Response === +=== Request === 
-== Example == +**URL:** https://payment.girosolution.de/girocheckout/api/v2/giropay/bankstatus \\ 
-{{page>codesamples:giropay#bankstatus.Antwort&noheader&nofooter}}+**To be provided by:** GiroSolution AG \\ 
 +**To be called by:** Merchant
  
-===== Initialisierung der giropay Zahlung =====+== Parameters == 
 +^Name           ^Mandatory ^Type      ^Description   ^ 
 +|merchantId     |Yes       |Integer   |Merchant ID of a giropay project | 
 +|projectId      |Yes       |Integer   |Project ID of a giropay project | 
 +|bankcode       |Optional  |String(8) |Bank code (Bankleitzahl) of the customer's bank to be checked | 
 +|bic            |Optional  |String(11)|BIC of the customer's bank to be checked | 
 +|hash           |Yes       |String(32)|HMAC MD5 hash on all the values of the function call. See  [[girocheckout:general:start#hash_generieren|generate hash]]|
  
-Sie übermitteln die Transaktionsdaten und erhalten einen Link (Redirect-URL) als Antwort. Anschließend senden Sie Ihrem Kunden eine Weiterleitung zur Redirect-URL. Dies kann durch einen HTTP-Redirect-Header, eine HTML-Seite mit entsprechendem Meta-Tag oder Javascript erfolgen. Die eigentliche Zahlungsabwicklung erfolgt dann, indem der Kunde sich beim Onlinebanking seiner Bank anmeldet und dort die vorausgefüllte Überweisung durch eine TAN bestätigt. +<WRAP center round info 60%> 
-Die Benachrichtigung Ihrer Anwendung über den Ausgang der Zahlung erfolgt, indem GiroConnect Ihrer Anwendung einen GET-Request schickt.+For this check, either the bank code (Bankleitzahl) or the BIC of the customer's bank must be specified. If both are present, they must refer to the same bank. 
 +</WRAP>
  
-=== Anfrage === +== Example == 
- +{{page>codesamples:giropay#bankstatus.request&noheader&nofooter}}
-^Name           ^Pflicht  ^Type     ^Beschreibung   ^ +
-|merchantId     |Ja       |bla      |bla            | +
-|projectId      |Ja       |bla      |bla            | +
-|transactionId  |Ja       |bla      |bla            | +
-|amount         |Ja       |bla      |bla            | +
-|currency       |Optional |String(3)     |bla            | +
-|purpose         |bla            |bla      |bla            | +
-|bankcode         |bla            |bla      |bla            | +
-|bankaccount         |bla            |bla      |bla            | +
-|bic         |bla            |bla      |bla            | +
-|iban         |bla            |bla      |bla            | +
-|projectId         |bla            |bla      |bla            | +
-|urlRedirect         |bla            |bla      |bla            | +
-|urlNotify         |bla            |bla      |bla            | +
-|hash         |bla            |bla      |bla            | +
- +
-=== Antwort === +
- +
-JSON +
- +
-===== Benachrichtigung über den Ausgang der Zahlung =====+
  
-===== Rückleitung des Kunden zum Shop =====+=== Reply === 
 +The reply is a JSON object. If **rc = 0** is returned, a giropay transaction may be carried through with this bank. Please note the parameters //payment// and //verifyAge//. Additionally, the bank code and the bank name are returned.
  
 +== Parameters ==
 +^Name           ^Mandatory ^Type      ^Beschreibung   ^
 +|rc             |Yes       |Integer   |[[girocheckout:errorcodes|Error code]] |
 +|msg            |Yes       |String    |Additional information in case of error |
 +|bankcode       |Optional  |Integer   |Bank code (Bankleitzahl)|
 +|bic            |Optional  |String    |BIC, if available |
 +|bankname       |Optional  |String    |Bank name %7
en/girocheckout/giropay/functions.txt · Last modified: 2021/04/12 14:33

Page Tools