Wiki-Quellcode von AKDB EPayment-Plugin

Zeige letzte Bearbeiter
1 {{content/}}
2
3 Das AKDB EPayment Plugin ermöglicht es über die von der AKDB bereitgestellte Payment-Schnittstelle Bezahlvorgänge in einen Formularprozesse einzubauen.
4
5 Der nachfolgende Artikel beschreibt beispielhaft die von einen Formular-Ersteller auszuführenden Schritte, um einen Bezahlvorgang in einem Formular einzubauen.
6 Auf die notwendigen Schritte, um den Service technisch in {{formcycle/}} einzubinden wird an dieser Stelle nicht eingegangen.
7
8 Prinzipiell sind immer folgende Schritte für eine Einbindung auszuführen:
9
10 1. Formular mit "bestellbaren" Artikeln und notwendigen Dateneingaben versehen
11 1. Statusverarbeitung konfigurieren mit Aktionen zum Starten einer Bezahl-Transaktion und zum Kontrollieren des Status der Transaktion
12 1. Anzeige des Ergebnisses der Bezahl-Transaktion
13
14 == 1. Formular für den Bezahlvorgang designen ==
15
16 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.
17
18 === Artikel definieren durch das Formular-Element: //EPayment Artikel//: ===
19
20 {{figure image="hilfe_epay_artikel_form.png"}}
21 Konfigurationsmöglichkeiten am Formular-Element //EPayment Artikel//
22 {{/figure}}
23
24 Über das Formular-Element //EPayment Artikel// werden die für eine Bestell-Transaktion notwendigen Artikel definiert.
25 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
26 für die notwendige serverseitige Konfiguration des Artikels innerhalb des Aktions-Plugins ~*~*AKDB:EPayment initialisieren~*~*.
27
28 __Grundeigenschaften:__
29
30 ; Angehackt, Versteckt
31 : 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.
32 : 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.
33
34 __EPayment Bestellartikel Einstellungen:__
35
36 ; Artikelbeschreibung
37 : Nähere Beschreibung eines Artikels
38 ; Artikel-Preis
39 : 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>>doc:||anchor="config_artikel"]] des EPayments.
40 ; Artikelnummer
41 : 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.
42
43 {{info}}
44 Bei Durchführung eines Bestellvorgangs werden nur die Artikelnummer sowie die jeweilige Anzahl von einem Bestellartikel zum Server übertragen.
45 Damit ein Artikel innerhalb einer Bestellung übermittelt wird, muss die "Bestellen"-Option angehakt sein.
46 {{/info}}
47
48 === Vorlagen zur Ermittlung von Bestellinformationen: ===
49
50 {{figure image="hilfe_epay_vorlagen_form.png"}}
51 Vorlagen zur Datenerhebung für das EPayment
52 {{/figure}}
53
54 Durch das Plugin werden verschiedene Designer-Vorlagen bereitgestellt, mit denen es ermöglicht wird die nachfolgend aufgeführten Daten vom Benutzer zu ermitteln:
55
56 * **Persönliche Daten**: Anrede, Name, Vorname, E-Mail etc.
57 * **Rechnungsadresse**
58 * **Lieferadresse**
59 * **Bankverbindung**
60
61 {{info}}
62 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.
63 {{/info}}
64
65 === Bestellprozess starten mittels Formular-Element //EPayment Bestellen Button//: ===
66
67 {{figure image="hilfe_epay_button_form.png"}}
68 Konfigurationsmöglichkeiten am Formular-Element //EPayment Bestellen Button//
69 {{/figure}}
70
71 Über das Formular-Element //EPayment Bestellen Button// kann das Formular durch den Nutzer abgesendet und damit der Bezahlvorgang gestartet werden.
72 Bei Nutzung dieses speziellen Absende-Buttons werden zum Absende-Zeitpunkt alle ausgewählten Artikeln ermittelt und deren Artikelnummer sowie Bestellmenge zum Server übertragen.
73
74 __EPayment Einstellungen:__
75
76 ; Schaltflächentext
77 : Beschriftung des Absenden-Buttons
78 ; Eingaben pruefen vor Absenden
79 : Wenn ausgewählt, wird das Formular vor dem Absenden validiert, sonst erfolgt keine Prüfung.
80
81 == 2. Statusverarbeitung für EPayment konfigurieren ==
82
83 Um eine Bezahl-Transaktion in einen Formularprozess einzubauen werden die folgenden Aktions-Plugins zur Verfügung gestellt:
84
85 * **AKDB:EPayment initialisieren**: Dieses erzeugt eine neue Bezahl-Transaktion auf Seiten der AKDB und leitet den Benutzer auf dessen Portalseite weiter.
86 * **AKDB:EPayment verifizieren**: Prüft den aktuellen Status einer Bezahl-Transaktion
87
88 Ein Statusverarbeitung für einen einfachen Fall kann folgendermaßen konfiguriert sein:
89
90 (% style="background-color:transparent; border:none" %)
91 |(% style="border-style:none; width:180px" %)[[image:hilfe_statusverabeitung.png||alt="Statusverarbeitung mit Anbindung EPayment"]]|(% style="border-style:none; width:700px" %)(((
92 __Kurze Ablaufbeschreibung zur dargestellten Statusverarbeitung:__
93
94 ~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, weitergeleitet.
95
96 2. Nach Abschluss des Bezahlvorgangs auf im ePay-BL Portal wird der Benutzer wieder zu FORMCYCLE-Formular zurückgeleitet. Dies erfolgt unter Benutzung des angegebenen Rücksprung-Ziels.
97 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.
98
99 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.
100
101 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 durch eine **Weiterleitungs**-Aktion eine Weiterleitung ins aktuelle Formular konfiguriert, sodass dieses dem Benutzer wieder angezeigt wird. Innerhalb dieses Formulares kann dann ein Formular-Element konfiguriert werden, welches nur im Status //Bezahlt// angezeigt wird und dem Benutzer eine positive Rückmeldung zum Ausgang seinen Bezahlvorgangs anzeigt.
102
103 __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.
104
105 5. Im Falle einer negativen Verifizierung des Bezahlvorgangs (z.B.: Nutzer hat Bezahlvorgang im ePay-BL Portal abgebrochen, Es kam zu Fehlern während des Bezahlvorgangs) wird unter Zuhilfenahme der Aktion Statusänderung in den Status Bezahlung offen gewechselt. Es erfolgt wieder eine Weiterleitung ins aktuelle Formular, wo eine Formular-Element konfiguriert ist, welches nur im Status //Bezahlung offen// angezeigt wird und dem Benutzer eine Rückmeldung zu  seiner noch ausstehenden Bezahlung anzeigt.
106
107
108 )))
109
110 === Konfigurationsmöglichkeiten des Aktions-Plugins //AKDB:EPayment initialisieren// ===
111
112 Dieses 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.
113
114 {{info}}
115 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 und es muss nur noch der Ziel-Status für eine erfolgreiche / nicht erfolgreiche Transaktion festgelegt werden.
116 Es empfiehlt sich deshalb die in diesem Artikel beschriebene Konfigurations-Reihenfolge einzuhalten.
117 {{/info}}
118
119 Die Konfigurationsoberfläche des Aktions-Plugins ist in einzelne Bereiche unterteilt die nachfolgend kurz beschrieben werden.
120
121 {{panel title="Konfiguration AKDB EPayment-Mandant" fullwidth="true" initial="hidden" triggerable="true"}}
122
123 {{figure image="plugin_init_config_akdb_mandant.png"}}
124 Konfiguration AKDB EPayment-Mandant
125 {{/figure}}
126
127 In diesem Bereich werden die für den Formular-Prozess zu verwendenden Einstellungen ePay-BL Mandanten hinterlegt. Diese sind notwendig, um später die Transaktion auf Seiten von ePay-BL
128 der richtigen Behörde (=Mandantnummer), Bewirtschafter und Haushaltsstelle zuzuordnen. Die Daten in diesem Bereich sind meistens bereits mit globalen Einstellungen vorbefüllt,
129 sofern diese durch einen Plugin-Administrator korrekt hinterlegt wurden.
130
131 Die einzelnen Parameter können per Platzhalter oder fest definiert hinterlegt werden. Weiterhin kann über den Button [[image:icon_update.png]] //EPayment Webservice Erreichbarkeit prüfen// die Erreichbarkeit des EPayment Webservice geprüft werden.
132
133 ; Mandant-Nummer (Pflichtfeld)
134 : AKDB-Mandantennummer des aufrufenden eShops (FORMCYCLE) (Wird durch ePay-BL-System vorgegeben)
135 ; Bewirtschafter-Nummer (Pflichtfeld)
136 : Bewirtschafternummer (Wird durch ePay-BL-System vorgegeben)
137 ; Haushaltsstelle (Pflichtfeld)
138 : Nummer der Haushaltsstelle, welcher die Buchung zugeordnet werden soll. (Wird durch ePay-BL-System vorgegeben)
139 ; Objektnummer (Pflichtfeld)
140 : Dient der internen Verbuchung im EPayment-System. (Wird durch ePay-BL-System vorgegeben)
141 ; Kennzeichen-Mahnverfahren (Pflichtfeld)
142 : Einstellung für das Kennzeichen in einem Mahnverfahren. (Mögliche Werte werden durch ePay-BL-System vorgegeben)
143 ; Fälligkeitszeitraum (Pflichtfeld)
144 : Einstellung für die Berechnung des Fälligkeitszeitraumes der Zahlung (Dauer in Tagen).
145 ; Währung
146 : Währung in welcher der Betrag ausgewiesen wird. Ist nichts definiert wird als Wert **EUR** angenommen.
147
148 {{/panel}}
149
150 {{panel title="Konfiguration für die PayPage" fullwidth="true" initial="hidden" triggerable="true"}}
151
152 {{figure image="plugin_init_config_paypage.png"}}
153 Konfiguration für die PayPage
154 {{/figure}}
155
156 ; URL zur PayPage (Pflichtfeld)
157 : URL zur PayPage des EPayment-Systems. Die hier hinterlegte URL wird durch das ePay-BL-System vorgegeben und beinhaltete den Verweis auf die PayPage im ePay-BL-System.
158 ; Automatische Weiterleitung zur PayPage verhindern
159 : Bei aktivierter Einstellung kann eine automatische Weiterleitung zur PayPage unterbunden werden.
160 ; Status, in welchen nach erfolgreicher Transaktion gewechselt wird (Pflichtfeld)
161 : Hier muss ein Status festgelegt werden, in welchen gewechselt wird, wenn der Bezahlvorgang auf Seiten des ePay-BL-Systems erfolgreich durchlaufen wurde.
162 ; Status, in welchen nach fehlerhafter oder abgebrochener Transaktion gewechselt wird (Pflichtfeld)
163 : Hier muss ein Status festgelegt werden, in welchen gewechselt wird, wenn der Bezahlvorgang auf Seiten des ePay-BL-Systems abgebrochen wurde.
164 ; PayPage Buchungstext
165 : Dieser Buchungstext wird dem Benutzer auf der PayPage angezeigt.
166 ; Fälligkeitsdatum
167 : Der konfigurierte Wert muss sich in ein gültiges Datum umwandeln lassen. Wenn an dieser Stelle ein Wert hinterlegt ist, wird dieser als Fälligkeitszeitpunkt für die Zahlung übermittelt und
168 die Einstellung für den **Fälligkeitszeitraum** wird nicht beachtet.
169
170 {{/panel}}
171
172 {{panel title="Kundenstammdaten" fullwidth="true" initial="hidden" triggerable="true"}}
173
174 {{figure image="plugin_init_config_kundenstammdaten.png"}}
175 Konfiguration für die Kundenstammdaten
176 {{/figure}}
177
178 In diesem Bereich werden die Daten des Benutzers, für den die Bezahl-Transaktion erzeugt werden soll, hinterlegt.
179 Die einzelnen Parameter können per Platzhalter oder fest definiert hinterlegt werden.
180
181 {{info}}
182 Über den Link [[image:icon_update.png]] //Formular-Elemente für Kundenstammdaten ermitteln// können die Felder bei Nutzung der EPayment-Vorlage //Persönliche Daten// vorbelegt werden.
183 {{/info}}
184
185 ; Anrede
186 ; Titel
187 ; Vorname
188 ; Nachname (Pflichtfeld)
189 ; Geburtsdatum
190 : Geburtsdatum muss in der Form **dd.MM.yyyy** übermittelt werden.
191 ; E-Mail
192 : Wird für die Zustellung von Emails an den Kunden in Abhängigkeit von der ePay-BL-Mandantkonfiguration benötigt.
193 ; Telefon (privat)
194 ; Telefon (dienstlich)
195 ; Mobiltelefon
196
197 {{/panel}}
198
199 {{id name="config_artikel"/}}
200
201 {{panel title="Bestellinformationen" fullwidth="true" initial="hidden" triggerable="true"}}
202 {{figure image="plugin_init_config_artikel.png"}}
203 Konfiguration der Bestellinformationen
204 {{/figure}}
205
206 In diesem Bereich werden die bestellbaren Artikel definiert.
207 Weiterhin wird im Feld //Übermittelte Bestellung//, per Platzhalter, der Wert festgelegt, welcher zum Ausführungszeitpunkt die JSON-Struktur mit den im Formular bestellten Artikeln enthält.
208
209
210 {{info}}
211 Wenn das Formular über die Elemente **EPayment-Artikel** und **EPayment Bestellen Button** verfügt kann über den jeweiligen Button [[image:icon_update.png]] eine Vorbefüllung der vorhandenen Pflichtfelder durchgeführt werden.
212 {{/info}}
213
214 In der Tabelle //Bestellartikel-Definitionen// erfolgt die Definition der einzelnen Bestell-Artikel. Die hier konfigurierten Angaben sind maßgeblich für eine Übermittlung an den ePay-BL-Service.
215 Jeder Artikel muss über folgende Parameter verfügen:
216 ; Artikelnummer (Pflichtfeld)
217 : Eine Nummer die den einzelnen Artikel innerhalb einer Bestellung eindeutig identifizierbar macht.
218 ; Beschreibung (Pflichtfeld)
219 : Der Buchungstext darf nur folgende Zeichen enthalten: //A-Za-z0-9,.:/+& -*$%ÄÖÜäöüß// und ist in seiner Länge auf maximal 21 Zeichen begrenzt.
220 ; Betrag (Pflichtfeld)
221 : Komma separierte Zahl, die den Preis eines Artikels definiert.
222 ; Belegnummer
223 : Die Belegnummer ist optional und dient der weiterführenden Verarbeitung auf Seiten von ePay-BL.
224
225
226 {{info}}
227 __Hinweis:__ Um zur Laufzeit den Gesamtpreis einer Zahlungsanweisung zu errechnen, wird immer der Artikel-Preis aus der //Bestellartikel-Definitionen//-Tabelle entnommen.
228 Einzig Artikelnummer und Bestellmenge werden aus den vom Browser übermittelten Daten zur Erstellung der Bezahl-Transaktion herangezogen.
229 {{/info}}
230
231
232 {{/panel}}
233
234 {{panel title="Konfiguration Rechnungsadresse (optional)" fullwidth="true" initial="hidden" triggerable="true"}}
235
236 {{figure image="plugin_init_config_rechadr.png"}}
237 Konfiguration der Rechnungsadresse
238 {{/figure}}
239
240 Die in diesem Bereich konfigurierbaren Werte sind grundlegend optional. Das heißt, die Daten zur Rechnungsadresse müssen nicht an den EPayment-Service übergeben werden.
241 Bei Festlegung einer Konfiguration innerhalb dieses Bereichs werden aber einige Felder "bedingt verpflichtend".
242
243 {{info}}
244 Über den Link [[image:icon_update.png]] //Formular-Elemente für Rechnungsadresse ermitteln// können die Felder bei Nutzung der EPayment-Vorlage //Rechnungsadresse// vorbelegt werden.
245 {{/info}}
246
247
248 ; Strasse (bedingt verpflichtend)
249 : Wahlweise ist Strasse und Hausnummer **oder** Postfach bei Nutzung von Rechnungsadressdaten ein Pflichtfeld.
250 ; Hausnummer (bedingt verpflichtend)
251 : Wahlweise ist Strasse und Hausnummer **oder** Postfach bei Nutzung von Rechnungsadressdaten ein Pflichtfeld.
252 ; Postfach (bedingt verpflichtend)
253 : Wahlweise ist Postfach **oder** Strasse und Hausnummer bei Nutzung von Rechnungsadressdaten ein Pflichtfeld.
254 ; Ort (bedingt verpflichtend)
255 ; PLZ (bedingt verpflichtend)
256 : Postleitzahl
257 ; Land (bedingt verpflichtend)
258 : Wenn gesetzt, muss die Angabe gemäß ISO 3166-1 erfolgen (zwei Großbuchstaben, z.B.: DE)
259
260 {{/panel}}
261
262 {{panel title="Konfiguration Lieferadresse (optional)" fullwidth="true" initial="hidden" triggerable="true"}}
263
264 {{figure image="plugin_init_config_lieferadr.png"}}
265 Konfiguration der Lieferadressdaten
266 {{/figure}}
267
268 In diesem Bereich konfigurierten Werte sind grundlegend optional. Das heißt, die Daten zur Lieferadresse müssen nicht an den EPayment-Service übergeben werden.
269 Dies ist zum Beispiel dann der Fall, wenn es sich bei dem zu bezahlenden Objekt um ein immaterielles Gut handelt.
270 Bei Festlegung einer Konfiguration innerhalb dieses Bereichs werden aber einige Felder "bedingt verpflichtend".
271
272 {{info}}
273 Über den Link [[image:icon_update.png]] //Formular-Elemente für Lieferadresse ermitteln// können die Felder bei Nutzung der EPayment-Vorlage //Lieferadresse// vorbelegt werden.
274 {{/info}}
275
276
277 ; Anrede
278 ; Vorname
279 ; Nachname
280 ; Strasse (bedingt verpflichtend)
281 : Wahlweise ist Strasse und Hausnummer **oder** Postfach bei Nutzung von Lieferadressdaten ein Pflichtfeld.
282 ; Hausnummer (bedingt verpflichtend)
283 : Wahlweise ist Strasse und Hausnummer **oder** Postfach bei Nutzung von Lieferadressdaten ein Pflichtfeld.
284 ; Postfach (bedingt verpflichtend)
285 : Wahlweise ist Postfach **oder** Strasse und Hausnummer bei Nutzung von Lieferadressdaten ein Pflichtfeld.
286 ; Ort (bedingt verpflichtend)
287 ; PLZ (bedingt verpflichtend)
288 : Postleitzahl
289 ; Land (bedingt verpflichtend)
290 : Wenn gesetzt, muss die Angabe gemäß ISO 3166-1 erfolgen (zwei Großbuchstaben, z.B.: DE)
291
292 {{/panel}}
293
294 {{panel title="Konfiguration für die Bankverbindung (optional)" fullwidth="true" initial="hidden" triggerable="true"}}
295
296 {{figure image="plugin_init_config_bank.png"}}
297 Konfiguration für die Bankverbindung
298 {{/figure}}
299
300 In diesem Bereich konfigurierten Werte sind grundlegend optional. Das heißt, die Daten zur Bankverbindung müssen nicht an den EPayment-Service übergeben werden.
301 Bei Festlegung einer Konfiguration innerhalb dieses Bereichs werden aber einige Felder "bedingt verpflichtend".
302
303 {{info}}
304 Über den Link [[image:icon_update.png]] //Formular-Elemente für Bankverbindung ermitteln// können die Felder bei Nutzung der EPayment-Vorlage //Bankverbindung// vorbelegt werden.
305 {{/info}}
306
307
308 ; Kontoinhaber
309 : Falls der Inhaber des Kontos vom Namen des Kunden abweicht, muss dieser hier übertragen werden. Falls das Feld leer ist, wird bei den Zahlungsüberstellungen der Nachname des Kunden verwendet.
310 ; Kontonummer (bedingtes Pflichtfeld)
311 : Kontonummer vom Zahlungspflichtigen. Wenn Kontodaten konfiguriert werden, ist dies ein Pflichtfeld.
312 ; IBAN
313 : **I**nternational **B**ank **A**ccount **N**umber des Kontos
314 ; BIC
315 : **B**ank **I**dentification **C**ode des Kontos
316 ; BLZ (bedingtes Pflichtfeld)
317 : Bankleitzahl vom Konto des Zahlungspflichtigen. Wenn Kontodaten konfiguriert werden, ist dies ein Pflichtfeld.
318
319 {{/panel}}
320
321 {{panel title="Allgemeine Rückgabeparameter" fullwidth="true" initial="hidden" triggerable="true"}}
322
323 {{figure image="plugin_init_config_result.png"}}
324 Konfiguration der Plugin Rückgabedaten (Platzhalter)
325 {{/figure}}
326
327 In diesem Bereich werden die vom Plugin als Ergebnis der Bezahl-Transaktion zurückgelieferten Parameter aufgeführt.
328 Für die einzelnen Parameter kann ein Alias vergeben werden.
329 In weiteren Aktionen kann auf den entsprechenden Rückgabeparameter per Platzhalter-Syntax zugegriffen werden.
330 Der Platzhalter wird dabei nach dem folgenden Muster gebildet:
331
332
333 {{code language="java"}}
334 [%$<Plugin-Name>.RESULT[0].<Name oder vergebener Alias der Rückgabeparameters>%]
335 {{/code}}
336
337
338
339 ; Kassenzeichen
340 : Das für die Transaktion, auf Seiten von ePay-BL erzeugte, notwendige Kassenzeichen.
341 ; EShopKundenNr
342 : Die für die Transaktion automatisch erzeugte EShopKundenNr. (Dient der internen Verarbeitung.)
343 ; Gesamtbetrag
344 : Der errechnete Gesamtbetrag der Bezahl-Transaktion. (Ergibt sich aus der Summe aller bestellten Artikel X deren Bestellmenge.)
345
346
347 {{info}}
348 Über den [[image:icon_copy.png]] Button kann der aus dem Namen oder Alias erzeugte Platzhalter einfach in die Zwischenablage kopiert
349 und an anderer Stelle, z.B.: im Text einer E-Mail-Aktion, eingefügt werden.
350 {{/info}}
351
352 {{/panel}}
353
354 === Konfigurationsmöglichkeiten des Aktions-Plugins //AKDB:EPayment verifizieren// ===
355
356 {{figure image="plugin_verify.png"}}
357 Konfiguration des Plugins //AKDB:EPayment verifizieren//
358 {{/figure}}
359
360 Dieses 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.
361 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.
362
363
364
365 {{panel title="Allgemeine Rückgabeparameter" fullwidth="true" initial="hidden" triggerable="true"}}
366
367
368 In diesem Bereich werden die vom Plugin als Ergebnis der Status-Prüfung am ePay-BL-Service zurückgelieferten Parameter aufgeführt.
369 Für die einzelnen Parameter kann ein Alias vergeben werden.
370 In weiteren Aktionen kann auf den entsprechenden Rückgabeparameter per Platzhalter-Syntax zugegriffen werden.
371 Der Platzhalter wird dabei nach dem folgenden Muster gebildet:
372
373
374 {{code language="java"}}
375 [%$<Plugin-Name>.RESULT[0].<Name oder vergebener Alias der Rückgabeparameters>%]
376 {{/code}}
377
378
379
380 ; PayPageStatus
381 : Enthält den vom ePay-BL-Service zurückgelieferten Statuscode. Die nachfolgende Tabelle gibt einen Überblick über die möglichen Statuscode und deren Bedeutung:
382 |=Statuscode|=Bedeutung
383 |INAKTIV | Die Bezahlung über die PayPage ist erfolgreich durchgeführt worden
384 |AKTIV | Die Bezahlung über die PayPage ist noch nicht erfolgt.
385 |MANDANT_NICHT_GEFUNDEN | Der Mandant wurde im ePayment-System nicht gefunden.
386 |MANDANT_INAKTIV | Der Mandant ist im ePayment-System derzeit als inaktiv gekennzeichnet.
387 |VERBINDUNG_OHNE_HTTPS | Die Verbindung zum Webservice erfolgte nicht über HTTPS mit Client-Zertifikaten.
388 |VERBINDUNG_ZERTIFIKAT_FEHLER | Das für die Verbindung verwendete Client-Zertifikat darf nicht für den gewählten Mandanten verwendet werden.
389 |KASSENZEICHEN_NICHT_VORHANDEN | Das gewählte Kassenzeichen ist nicht vorhanden.
390 |KASSENZEICHEN_NICHT_GEFUNDEN | Das gewählte Kassenzeichen konnte nicht gefunden werden.
391 |INTERNER_EPAYMENT_FEHLER | Interner nicht dokumentierter Fehler im ePayment-System.
392 |UNDEFINIERT | Ein im System nicht bekannter Status
393 ; WebserviceErgebnisText
394 : Enthält den vom ePay-BL Service zurückgelieferten Erläuterungstext zum übermittelten Status.
395
396 {{info}}
397 Über den [[image:icon_copy.png]] Button kann der aus dem Namen oder Alias erzeugte Platzhalter einfach in die Zwischenablage kopiert
398 und an anderer Stelle, z.B.: als Wert innerhalb einer Bedingung, eingefügt werden.
399 {{/info}}
400
401
402 {{/panel}}
403
404 == 3. Ergebnisanzeige ==
405
406 {{figure image="hilfe_statusverabeitung_bedingung.png"}}
407 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.
408 {{/figure}}
409
410 Für die Anzeige des Ergebnisses bzw. dem Status einer Bezahl-Transaktion bestehen mehrere Möglichkeiten.
411 Man kann dem Nutzer dieses in einer extra dafür hinterlegten Abschluss-Seite oder durch die Wiederanzeige das Formulars anzeigen.
412 Ein Beispiel für die Ergebnisanzeige innerhalb des Formular ist unter //Punkt 2// aufgeführt.
413
414 In den meisten Fällen ist es gewünscht, dass je nach Status der Bezahl-Transaktion unterscheidliche Rückmeldungstexte angezeigt oder
415 zusätzliche Aktionen ausgeführt, werden.
416
417 Erreichen kann man dies über eine entsprechende Bedingung am Status oder der jeweiligen Aktion.
418
419
420 == Weiterführende Informationen ==
421
422 === Aktions-Plugin //AKDB:EPayment PayPageURL bereitstellen// ===
423
424 Durch dieses Plugin kann die aktuell gültige URL zur Bezahl-Transaktion ins ePay-BL-Portal aus dem Formular-Vorgang ermittet werden. 
425 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 Plugins **AKDB:EPayment initialisieren** konfiguriert sein.

Navigation

Copyright 2000-2025