====== giropay Rechnung API ======
===== Funktionen =====
==== Rechnungsdaten hinterlegen ====
Die übergebenen Zahldaten werden gespeichert und eine Referenznummer reneriert. Anhand dieser Referenznummer kann der Kunde später die Zahlung starten. Hierzu gibt es verschiedene Wege.

=== Anfrage ===
**URL:** https://payment.girosolution.de/girocheckout/api/v2/girocode/createpayment \\
**Bereitzustellen von:** GiroCheckout \\
**Aufzurufen von:** Händler

== POST-Parameter ==
^Name           ^Pflicht  ^Type        ^Beschreibung   ^
|merchantId     |Ja       |Integer     |Händler-ID eines giropay Rechnung Projekts |
|projectId      |Ja       |Integer     |Projekt-ID eines giropay Rechnung Projekts |
|merchantTxId   |Ja       |String(255) |eindeutige Transaktions-ID des Händlers  |
|amount         |Ja       |Integer     |Bei Dezimalwährungen den Betrag in der kleinsten Währungseinheit angeben, z.B. Cent |
|currency       |Ja       |String(3)   |Währung der Transaktion \\ EUR = Euro |
|purposetext    |Ja       |String(27)  |Verwendungszweck für die Zahlung |
|multiple       |Ja       |Integer     |Definiert, ob die Bezahlung mehrfach durchgeführt werden kann. \\ 0 = Einmalzahlung \\ 1 = Mehrfachzahlung |
|validtil       |Nein     |Integer     |Gültigkeitsdatum der Zahlung im Format YYYYMMDD |
|urlRedirect    |Nein     |String      |URL, an die der Kunde nach der Zahlung geschickt werden soll. |
|urlNotify      |Nein     |String      |URL, an die der Zahlungsausgang gemeldet werden soll. |
|format         |Ja       |String(20)  |Format der GiroCode Grafik in der Antwort. \\ **link-qr**: QR-Code mit Link zur giropay Zahlung \\ **none**: Keine Grafik |
|resolution |Nein |Integer     |Auflösung in Pixel (z.B. 250), wenn der GiroCode als Grafik angefordert wurde |
|hash           |Ja       |String(32)|HMAC MD5 hash über alle Werte des Aufrufs (siehe [[girocheckout:general:start#hash_generieren|hash generieren]])|

=== Antwort ===
Die Antwort besteht aus einem JSON Objekt. Das Feld rc liefert einen Fehlercode zurück. Wird rc = 0 zurückgeliefert, wurden die Daten gespeichert und eine Referenznummer erstellt.

== Parameter ==
^Name           ^Pflicht  ^Type      ^Beschreibung   ^
|rc             |Ja       |Integer   |[[girocheckout:errorcodes|Fehlernummer]] |
|msg            |Ja       |String    |zusätzliche Informationen im Fehlerfall |
|girocodereference|Optional |String(10)|eindeutige Referenznummer |
|image          |Optional |String    |Base64 kodiertes PNG Bild, wenn über Parameter **format** angefordert |
|url            |Optional |String    |URL zur Zahlung (giropay Rechnung)|
^HEADER Parameter^^^^
|hash           |Ja       |String    |HMAC MD5 hash über alle Werte der Rückmeldung. Siehe [[girocheckout:general:start#uebermittlung_von_daten_ueber_einen_schnittstellenaufruf_an_den_haendler|hash der Rückantwort]] |

===== Integration für den Endkunde =====
==== giropay-Bezahlbutton (präferierte Lösung) ====
In eine PDF oder HTML Rechnung wird eine der folgenden Grafiken eingebunden und mit dem von der Schnittstelle zurückgelieferten Link versehen.

{{:girocheckout:giropay_invoice:giropay_rechnung_bezahlbutton.zip|Download giropay Bezahlbutton Grafiken als png und eps}}

**Beispiel:**\\
{{:girocheckout:giropay_invoice:button_jetzt_online_uberwisen_250x60px.jpg.jpeg?nolink|}}