GiroSolution: ePayment-Plugin
Plugin-Download (erfordert Anmeldung)
Das kostenpflichtige GiroSolution ePayment Plugin ermöglicht es, über die von GiroSolution bereitgestellte PayPage, einen Bezahlvorgang innerhalb eines Formularprozesses einzubauen.
Aktions-Plugin GiroSolution: Paypage: Initialisierung
Mit der Einbindung des Aktions-Plugin GiroSolution: Paypage: Initialisierung ist es möglich ein Bezahl-Transaktion innerhalb der Xima® Formcycle Statusverarbeitung auszuführen. Nachfolgend werden die dafür notwendigen Konfigurations-Parameter näher beschrieben.
Transaktionsdaten
- Automatisch zur Paypage witerleiten
- Diese Einstellung ist standardmäßig aktiviert. Dadurch wird nach dem Initialisieren der Bezahl-Transaktion automatisch auf die Payment-Page von GiroSolution weitergeleitet. Wenn dies nicht gewünscht ist, kann durch Deaktivierung dieser Einstellung eine Weiterleitung unterbunden werden.
- Betrag
- Hier ist der zu bezahlende Betrag in der kleinsten Währungseinheit (z.B.: Cent, Penny) anzugeben. Es werden Platzhalter unterstützt.
- Verwendungszweck
- Verwendungszweck der Transaktion, welcher später auf der Kartenabrechnung bzw. dem Kontoauszug erscheint. Es werden Platzhalter unterstützt. Maximal sind 20 (SEPA-konforme) Zeichen erlaubt:
- a b c d e f g h i j k l m n o p q r s t u v w x y z
- A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
- Zahlen von 0 – 9
- Sonderzeichen: ' : ? , - ( + . ) / |
- Beschreibung für Bezahlung
- Definiert die Beschreibung zum Zahlbetrag, welcher auf der Bezahlseite von GiroSolution angezeigt wird. Es werden Platzhalter unterstützt. Maximal sind 60 Zeichen zulässig. Unterstützt werden Buchstaben aller Sprachen, also beispielsweise auch Umlaute und spanische Sonderzeichen usw., Satzzeichen, Ziffern und Symbole, die sich auf Währungen beziehen (also $ und € etc.).
Zielstatus
In diesem Bereich können Status festgelegt werden, in welchen der Vorgang versetzt wird, wenn Xima® Formcycle eine Rückmeldung von GiroSolution erhält:
- Zielstatus für Payment Server Rückmeldung
- Hier kann ein Status definiert werden, in dem gewechselt wird, wenn die Transaktions-Benachrichtigung bei einer Server-To-Server-Verbindung zurückgemeldet wird. In der jeweiligen Status-Verarbeitung stehen dann die unter Notification-Parameter aufgeführten Parameter zur Verfügung.
- Zielstatus für erfolgreiche Zahlung
- Hier kann ein Status festgelegt werden, in welchen gewechselt wird, wenn der Kunde die Zahlung erfolgreich abgeschlossen hat. In der jeweiligen Status-Verarbeitung stehen dann die unter Notification-Parameter aufgeführten Parameter zur Verfügung.
- Zielstatus für abgebrochenen Zahlvorgang
- Hier kann ein Status festgelegt werden, in welchen gewechselt wird, wenn der Kunde innerhalb der GiroSolution Bezahlseite auf "Zurück" klickt und damit den Bezahlvorgang abbricht.
- Zielstatus für erfolglose Zahlung
- Hier kann ein Status festgelegt werden, in welchen gewechselt wird, wenn der Bezahlvorgang erfolglos beendet wurde.
Nach dem Durchlaufen der jeweiligen Statusverarbeitung erfolgt standardmäßig eine Weiterleitung ins Formular.
Wenn in der Statusverarbeitung eine Aktion vom Typ "Abschlussseite (Template)" definiert ist, erfolgt die Weiterleitung zu dieser Abschluss-Seite anstatt ins Formular.
Übersteuerung globaler Einstellungen
In diesem Bereich können die unter Globale Einstellungen für Anbindung einer Paypage getroffenen Einstellungen übersteuert werden.
- Händler-ID
- Händler-ID aus einem GiroSolution Payment Page Projekt.
- Projekt-ID
- Projekt-ID aus einem GiroSolution Payment Page Projekt.
- Projekt-Passwort
- Projekt-Passwort aus einem GiroSolution Payment Page Projekt.
- Währung
- Währung mit der alle Payment Page Transaktionen ablaufen. Angabe muss im ISO 4217 Format erfolgen.
- Sprache
- Sprache auf der Payment Page, mögliche Werte:
- de: Anzeige in deutscher Sprache
- en: Anzeige in englischer Sprache
- Anbietername
- Name des Anbieters auf der Bezahlseite. Wenn nichts festgelegt ist, wird der im GiroSolution GiroCockpit festgelegte Wert verwendet.
- Test-Modus?
- Legt fest, in welchem Modus die Zahlarten auf den Payment Page anzuzeigen sind. Wenn aktiviert ist der Test-Betrieb aktiv, sonst der Live-Betrieb.
Allgemeine Rückgabeparameter
In diesem Bereich werden die vom Plugin als Ergebnis zurückgelieferten Parameter aufgeführt. Für die einzelnen Parameter kann ein Alias vergeben werden. In weiteren Aktionen kann auf den entsprechenden Rückgabeparameter per Platzhalter-Syntax zugegriffen werden. Der Platzhalter wird dabei nach dem folgenden Muster gebildet:
[%$<Plugin-Name>.RESULT[0].<Name oder vergebener Alias der Rückgabeparameters>%]
- ResultCode
- Enthält einen Zahlenwert, welcher den Abarbeitungs- bzw. Fehlerstatus des Plugins widergibt.
- ResultMessage
- Enthält eine Klartextmeldung, welche den zurückgelieferten ResultCode näher erläutert.
- ResultMerchantTxID
- Enthält die erzeugte Transaktions-ID enthält. Dieser Rückgabewert ist nur vorhanden, wenn auf Seiten von GiroSolution eine Transaktion erfolgreich erzeugt werden konnte.
- ResultPaypageUrl
- Enthält die Redirect-URL zur Payment-Page von GiroSolution. Dieser Rückgabewert ist nur vorhanden, wenn auf Seiten von GiroSolution eine Transaktion erfolgreich erzeugt werden konnte.
- ResultPaypageReferenceID
- Enthält die Referenznummer für die Payment Page. Dieser Rückgabewert ist nur vorhanden, wenn auf Seiten von GiroSolution eine Transaktion erfolgreich erzeugt werden konnte.
Notification-Parameter
Die nachfolgende Tabelle listet die garantierten bzw. optionalen Parameter auf, welche von der GiroSolution-Schnittstelle zurück übermittelt werden und damit den Status der Bezahl-Transaktion kennzeichnen.
Die Parameter stehen in den konfigurierten Zielstatus für Payment Page Rückmeldungen zur Verfügung und können über die Platzhalternotation [%<Parametername>%] angesprochen werden.
Parametername | Optional | Bedeutung |
---|---|---|
gcAccountHolder | ja | Kontoinhaber bei Lastschriftverfahren |
gcAmount | nein | Rechnungsbetrag, bei Dezimalwährungen den Betrag in der kleinsten Währungseinheit angeben, z.B. Cent, Penny |
gcBackendTxId | nein | Zahlungsabwickler Transaktions-ID |
gcCardExpDate | ja | Gültigkeitsdatum der Kreditkarte im Format Monat/Jahr, wenn Kreditkartenzahlung |
gcCardnumber | ja | Maskierte Kreditkartennummer |
gcCurrency | nein | Die in der Transaktion verwendete Währung |
gcHash | nein | HMAC MD5 Hash über alle Werte des Aufrufs |
gcIban | ja | IBAN bei Lastschrift |
gcMerchantTxId | nein | Verkäufer Transaktions-ID |
gcPaymethod | nein | ID der Zahlungsart der Transaktion, mögliche Werte:
|
gcPkn | ja | Pseudokartennummer |
gcProjectId | nein | GiroCheckout Projekt-ID, über die die Transaktion abgewickelt wurde. |
gcReference | nein | GiroCheckout Transaktions-ID |
gcResultPayment | nein | Ergebniscodes der Zahlung, mögliche Werte:
|
gcType | nein | Transaktionsart, mögliche Werte:
|
Globale Plugin-Einstellungen
Konfiguration der Plugin-Bundle Properties
Über die nachfolgend beschriebenen Einstellungen wird das Plugin an die durch GiroSolution zur Verfügung gestellte Schnittstelle angeschlossen.
Globale Einstellungen für Anbindung einer Paypage
- payment.paypage.merchant.id (Pflicht)
- Händler-ID aus einem GiroSolution Payment Page Projekt.
- payment.paypage.project.id (Pflicht)
- Projekt-ID aus einem GiroSolution Payment Page Projekt.
- payment.paypage.project.pwd (Pflicht)
- Projekt-Passwort aus einem GiroSolution Payment Page Projekt.
- payment.paypage.testmode (Pflicht)
- Legt fest, in welchem Modus die Zahlarten auf den Payment Page anzuzeigen sind, mögliche Werte:
- true: Anzeige im Test-Betrieb
- false: Anzeige im Live-Betrieb
- payment.paypage.currency (Pflicht)
- Währung mit der alle Payment Page Transaktionen ablaufen. Angabe muss im ISO 4217 Format erfolgen.
- payment.paypage.locale (Pflicht)
- Sprache auf der Payment Page, mögliche Werte:
- de: Anzeige in deutscher Sprache
- en: Anzeige in englischer Sprache
- payment.paypage.organization
- Name des Anbieters der Payment Page. Wenn nichts festgelegt ist, wird der im GiroSolution GiroCockpit festgelegte Wert verwendet.
- payment.paypage.proxy.host
- Hostname eines Proxy-Servers, wenn die Kommunikation zwischen GiroSolution und Xima® Formcycle über einen Proxy-Server erfolgen soll
- payment.paypage.proxy.port
- Angabe eines Proxy-Server Ports, wenn die Kommunikation zwischen GiroSolution und Xima® Formcycle über einen Proxy-Server erfolgen soll.