Achtung:
Bevor Sie die AKDB EPayment in ihren Formular-Prozessen einbinden, stellen Sie bitte sicher, dass die konfigurative Anbindung des Dienstes durch den Xima® Formcycle-Administrator erfolgt ist!

Das AKDB EPayment Plugin ermöglicht es über die von der AKDB bereitgestellte Payment-Schnittstelle Bezahlvorgänge in einen Formularprozesse einzubauen.

Der nachfolgende Artikel beschreibt beispielhaft die von einen Formular-Ersteller auszuführenden Schritte, um einen Bezahlvorgang in einem Formular einzubauen.
Auf die notwendigen Schritte, um den Service technisch in Xima® Formcycle einzubinden wird an dieser Stelle nicht eingegangen.


Prinzipiell sind immer folgende Schritte für eine Einbindung auszuführen:

  1. Formular mit "bestellbaren" Artikeln und notwendigen Dateneingaben versehen
  2. Statusverarbeitung konfigurieren mit Aktionen zum Starten einer Bezahl-Transaktion und zum Kontrollieren des Status der Transaktion
  3. Anzeige des Ergebnisses der Bezahl-Transaktion

1. Formular für den Bezahlvorgang designen

Durch die Installation des Plugins im FORMCYCLE-System sind im Designer 2 zusätzliche Elemente, sowie 4 Vorlagen vorhanden, welche den Nutzer bei der notwendigen Konfiguration für das EPayment unterstützen sollen.

Artikel definieren durch das Formular-Element: EPayment Artikel:

Konfigurationsmöglichkeiten am Formular-Element EPayment Artikel

Über das Formular-Element EPayment Artikel werden die für eine Bestell-Transaktion notwendigen Artikel definiert.
Das Formular-Element dient dabei zum Einen für eine visuelle Darstellung des Artikels (mit Bild, Preisangabe, Eingabemöglichkeit für Bestellmenge) innerhalb eines Formulars, als auch als Vorlage
für die notwendige serverseitige Konfiguration des Artikels innerhalb des Aktions-Plugins AKDB:EPayment initialisieren

Grundeigenschaften:

Angehackt, Versteckt
Durch das initiale Auswählen dieser zwei Optionen wird es möglich einen Bestellartikel vor dem Nutzer zu verbergen und direkt bei Absenden eines Formulars in den Warenkorb zu legen.
Dies kann immer dann der Fall sein, wenn dem Benutzer selbst keine Entscheidung für die Auswahl eines Bestellartikels ermöglicht werden soll, zum Beispiel bei der Erhebung einer Gebühr.

EPayment Bestellartikel Einstellungen:

Artikelbeschreibung
Nähere Beschreibung eines Artikels
Artikel-Preis
Der Preis für einen Artikel. Der an dieser Stelle konfigurierte Wert dient zum Einen für die Anzeige innerhalb des Formulars, als auch für eine Vorbelegung der Bestellinformationen bei der serverseitigen Konfiguration des EPayments.
Artikelnummer
Eine eindeutige Nummer für den einzelnen Artikel innerhalb des Formulars. Dient bei der Ausführung eines Bestell-Prozesses zur eindeutigen Identifizierung des jeweiligen Artikels.
Bei Durchführung eines Bestellvorgangs werden nur die Artikelnummer sowie die jeweilige Anzahl von einem Bestellartikel zum Server übertragen.
Damit ein Artikel innerhalb einer Bestellung übermittelt wird, muss die "Bestellen"-Option angehakt sein.

Vorlagen zur Ermittlung von Bestellinformationen:

Vorlagen zur Datenerhebung für das EPayment

Durch das Plugin werden verschiedene Designer-Vorlagen bereitgestellt, mit denen es ermöglicht wird die nachfolgend aufgeführten Daten vom Benutzer zu ermitteln:

  • Persönliche Daten: Anrede, Name, Vorname, E-Mail etc.
  • Rechnungsadresse
  • Lieferadresse
  • Bankverbindung
Die Vorlagen "Persönliche Daten" und "Rechnungsadresse" können im Zusammenspiel mit dem Bürgerkonto-Login der AKDB verwendet werden. Sie werden nach einem erfolgreichen Login automatisch vorbelegt.

Bestellprozess starten mittels Formular-Element EPayment Bestellen Button:

Konfigurationsmöglichkeiten am Formular-Element EPayment Bestellen Button

Über das Formular-Element EPayment Bestellen Button kann das Formular durch den Nutzer abgesendet und damit der Bezahlvorgang gestartet werden.
Bei Nutzung dieses speziellen Absende-Buttons werden zum Absende-Zeitpunkt alle ausgewählten Artikeln ermittelt und deren Artikelnummer sowie Bestellmenge zum Server übertragen.

EPayment Einstellungen:

Schaltflächentext
Beschriftung des Absenden-Buttons
Eingaben pruefen vor Absenden
Wenn ausgewählt, wird das Formular vor dem Absenden validiert, sonst erfolgt keine Prüfung.

2. Statusverarbeitung für EPayment konfigurieren

Um eine Bezahl-Transaktion in einen Formularprozess einzubauen werden die folgenden Aktions-Plugins zur Verfügung gestellt:

Ein Statusverarbeitung für einen einfachen Fall kann folgendermaßen konfiguriert sein:

Statusverarbeitung mit Anbindung EPayment

Kurze Ablaufbeschreibung zur dargestellten Statusverarbeitung:

1. Nach dem Absenden des Bestellformulars wird in den Status Eingegangen gewechselt und dort das Aktions-Plugin AKDB:EPayment initialisieren ausgeführt. Dieses ermittelt die für den Bestellvorgang notwendigen Daten aus dem Formular und startet mit diesen eine Bezahl-Transaktion auf Seiten der AKDB. Wenn dies erfolgreich war, wird der Benutzer zum ePay-BL Portal der AKDB, unter vorheriger Angabe eines Rücksprung-Ziels (Realisiert über Festlegung eines Ziel-Status), weitergeleitet.

2. Nach Abschluss des Bezahlvorgangs im ePay-BL Portal wird der Benutzer wieder zum Xima® Formcycle-Formular zurückgeleitet. Dies erfolgt unter Benutzung des angegebenen Rücksprung-Ziels.
Aus einer im Vorfeld festgelegten Konfiguration im AKDB:EPayment initialisieren Aktions-Plugin wird der Ziel-Status nach Rückkehr aus dem ePay-BL Portal ermittelt. Im vorliegenden Beispiel wird deshalb in den Status Zahlung pruefen gewechselt.

3. Die Statusverarbeitung Zahlung pruefen wird ausgeführt und dort das Aktions-Plugin AKDB:EPayment verifizieren durchlaufen. Unter Zuhilfenahme dieses Plugins wird der aktuelle Status der Bezahlung am EPayment-System geprüft und in der weiteren Statusverarbeitung (per Platzhalter) zur Verfügung gestellt.

4. Im Falle einer positiven Verifizierung des Bezahlvorgangs wird unter Zuhilfenahme der Aktion Statusänderung in den Status Bezahlt gewechselt. Innerhalb von diesem Status ist eine Weiterleitungs-Aktion zum aktuellen Formular konfiguriert, sodass dieses dem Benutzer wieder angezeigt wird. Innerhalb dieses Formulares kann dann ein Text-Element konfiguriert werden, welches nur im Status Bezahlt angezeigt wird und dem Benutzer eine positive Rückmeldung zum Ausgang seines Bezahlvorgangs anzeigt.

Hinweis: Anstatt einer Rückleitung ins Formular kann im Status Bezahlt auch eine individuelle Abschluss-Seite konfiguriert sein. Dann würde diese dem Nutzer angezeigt werden.

5. Im Falle einer negativen Verifizierung des Bezahlvorgangs (z.B.: der Nutzer hat den Bezahlvorgang im ePay-BL Portal abgebrochen; während des Bezahlvorgangs ist ein Fehler aufgetreten) wird unter Zuhilfenahme der Aktion Statusänderung in den Status Bezahlung offen gewechselt. Es erfolgt wieder eine Weiterleitung ins aktuelle Formular, wo ein Text-Element konfiguriert ist, welches nur im Status Bezahlung offen angezeigt wird und dem Benutzer eine Rückmeldung zu seiner noch ausstehenden Bezahlung anzeigt.

 

Konfigurationsmöglichkeiten des Aktions-Plugins AKDB:EPayment initialisieren

Dieses Aktions-Plugin ist für das Erzeugen einer Bezahl-Transaktion im ePay-BL Portal zuständig. Hier werden im Vorfeld die Daten, welche im Zusammenhang mit der Transaktion stehen (bestellte Artikel, Preisbestimmung, persönliche Daten des Käufers, Rechnungsadresse etc.), festgelegt. Weiterhin erfolgt die Festlegung in welchen Status, nach Rückkehr aus dem ePay-BL Portal, gewechselt werden soll.

Wenn vor der Konfiguration des Plugins bereits mindestens ein EPayment-Artikel, der EPayment Bestellen Button sowie die Vorlage für die persönlichen Daten im Formular hinterlegt wurden, werden bei einer Neueinrichtung der AKDB:EPayment initialisieren Plugin-Aktion die notwendigen Pflicht-Konfigurationen bereits mit den ermittelten Daten aus dem Formular vorbelegt. Es muss anschließend nur noch der Ziel-Status für eine erfolgreiche / nicht erfolgreiche Transaktion festgelegt werden.

Es empfiehlt sich deshalb die in diesem Artikel beschriebene Konfigurations-Reihenfolge einzuhalten.

Es ist aber auch möglich das Formular im Nachhinein anzupassen und anschließend die Daten innerhalb des Aktions-Plugins zu aktualisieren.

Die Konfigurationsoberfläche des Aktions-Plugins ist in einzelne Bereiche unterteilt die nachfolgend kurz beschrieben werden.

Konfiguration AKDB EPayment-Mandant

Konfiguration für die PayPage

Kundenstammdaten

Bestellinformationen

Konfiguration Rechnungsadresse (optional)

Konfiguration Lieferadresse (optional)

Konfiguration für die Bankverbindung (optional)

Allgemeine Rückgabeparameter

Konfigurationsmöglichkeiten des Aktions-Plugins AKDB:EPayment verifizieren

Konfiguration des Plugins AKDB:EPayment verifizieren

Dieses Aktions-Plugin ist zum Auswerten des Status einer Bezahl-Transaktion zuständig. Im Standardfall muss innerhalb des Plugins keine weitere Konfiguration erfolgen, da alle notwendigen Parameter, für eine Prüfanfrage am ePay-BL-Service, intern hinterlegt sind.
Es besteht aber auch die Möglichkeit die AKDB-Mandantennummer und das Kassenzeichen durch eine Konfiguration zu übersteuern. Dies kann immer dann der Fall sein, wenn die Prüfung in einem anderem Formularvorgang erfolgen soll, in dem nicht die eigentliche Bezahl-Transaktion erzeugt wurde. 

Allgemeine Rückgabeparameter

3. Ergebnisanzeige

Beispiel für die Konfiguration einer Bedingung, welche den aktuelle Status einer Bezahl-Transaktion beinhaltet. Die Bedingung im vorliegenden Beispiel wird positiv durchlaufen, wenn der Nutzer zuvor bezahlt hat.

Für die Anzeige des Ergebnisses bzw. dem Status einer Bezahl-Transaktion bestehen mehrere Möglichkeiten.
Man kann dem Nutzer dieses in einer extra dafür hinterlegten Abschluss-Seite oder durch die Wiederanzeige das Formulars anzeigen.
Ein Beispiel für die Ergebnisanzeige innerhalb des Formular ist unter dem Punkt Statusverarbeitung für EPayment konfigurieren aufgeführt.

In den meisten Fällen ist es gewünscht, dass je nach Status der Bezahl-Transaktion unterscheidliche Rückmeldungstexte angezeigt oder zusätzliche Aktionen ausgeführt werden.

Erreichen kann man dies über eine entsprechende Bedingung an der jeweiligen Aktion.

Weiterführende Informationen

Aktions-Plugin AKDB:EPayment PayPageURL bereitstellen

Durch dieses Aktions-Plugin kann die aktuell gültige URL zur Bezahl-Transaktion ins ePay-BL-Portal aus dem Formular-Vorgang ermittet werden. 
Dadurch besteht die Möglichkeit eine noch nicht abgeschlossene Bezahl-Transaktion nochmals zur Anzeige zu bringen und die Zahlung durchzuführen. Dieses Aktions-Plugin muss dabei im zeitlichen Ablauf nach dem Plugin AKDB:EPayment initialisieren konfiguriert sein. 

Tags:
Erstellt von awa am 12.03.2020, 09:24
Copyright 2000-2025