Wiki-Quellcode von AKDB EPayment-Plugin

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

Navigation

Copyright 2000-2025