Einleitung
Diese Aktion ermöglicht es, basierend auf der ausgewählten Zahlungsart in einem Angebot oder einer Bestellung eine externe Zahlungsabwicklung anzufragen und das Ergebnis der Anfrage zu verarbeiten. Während der Verarbeitung kann der Benutzer nicht in Elements arbeiten. Vielmehr muss er auf das Ergebnis der Aktion warten.
Der Benutzer wählt die Elements-Zahlungsart „Kreditkarte“ aus. Bei der Übergabe an das ERP-System wird in einem neuen Browser-Tab die Kreditkartenabwicklung aufgerufen. Diese muss der Benutzer durchlaufen. Sobald er dies erfolgreich gemacht hat, wird die Bestellung im ERP-System angelegt und die Transaktionsnummer wird in einem Feld in der Bestellung hinterlegt.
Wähle bitte den Aktionstyp „Bezahlung“ aus.
Auslöser
In der Karte „Ausführung bei“ kannst du festlegen, wann die Aktion ausgelöst wird.
Wenn du „vor Übergabe an das ERP“ aktivierst, wird die Aktion immer ausgeführt, wenn der Benutzer eine in der Aktion hinterlegte Entität an das ERP-System übergeben möchte (TriggeredBy = „beforeCommit„). Dann wird auch das Kennzeichen für die automatische Ausführung übergeben.
Die Aktion kann in diesen Entitäten ausgelöst werden:
- Angebot (offer): Die Aktion wird ausgelöst, wenn der Benutzer auf „Angebot verbindlich bestätigen“ klickt.
- Bestellung (order): Die Aktion wird ausgelöst, wenn der Benutzer auf „Bestellung verbindlich bestätigen“ klickt.
Die Aktion wird nur ausgeführt, wenn eine Bestellung oder ein Angebot neu in Elements angelegt wird. Zudem wird sie ausschließlich für konfigurierte Elements-Zahlarten (s. Administration / Zuordnungen / Bezahlung) ausgeführt.
Die Aktion wird in zwei Schritten durchlaufen. Dabei werden jeweils Daten übergeben und Rückmeldungen verarbeitet.
Zahlungsprozess – Initialisierung
In einem ersten Schritt wird der Bezahlvorgang eingeleitet.
Eingabeparameter
Neben den allgemeinen werden zusätzlich diese Daten übergeben:
| Key | Datentyp | Value |
|---|---|---|
| WebhookUrl | string | für diesen Prozess frisch generierte Rücksprung-URL für Zahlungsanbieter |
| ExternalEntityReference | string | die Elements Referenznummer des Belegs |
| PaymentProcessStatus | string | der Status des Prozesses (new | inProcess | finished | canceled | failed) |
| CurrencyCode | string | die Währung |
| GrossAmount | decimal | der Gesamtbetrag der Entität |
Es werden keine Positionsdaten übergeben.
Ausgabeparameter
Neben einem Sperrkennzeichen zum Abbruch des Prozesses, wird ein Token für den Folgeaufruf sowie eine URL zum Aufruf der Seite des Zahlungsanbieters für die Abwicklung der Bezahlung erwartet.
| Key | Datentyp | Value |
|---|---|---|
| PreventsCommit | bool | das Kennzeichen, ob die Übergabe an das ERP abgebrochen werden soll |
| PaymentProcessToken | string | der Token für Folgeaufruf (falls vorhanden) |
| PaymentProcessProviderUrl | string | die URL zum Aufruf der Seite des Zahlungsanbieters für die Abwicklung der Bezahlung |
Zahlungsprozess – Abschluss
Im zweiten Schritt wird der Bezahlvorgang abgeschlossen. Der Schritt wird durch einen Webhook-Aufruf ausgelöst.
Eingabeparameter
Neben den allgemeinen werden zusätzlich diese Daten übergeben:
| Key | Datentyp | Value |
|---|---|---|
| PaymentProcessToken | string | der Token aus Initialaufruf (falls vorhanden) |
| PaymentProcessStatus | string | der Status des Prozesses (new | inProcess | finished | canceled | failed) |
| PaymentProcessWebhookResult_HttpHeader | Dictionary<string,string> | HttpHeader des Webhook-Aufrufs |
| PaymentProcessWebhookResult_HttpQuery | Dictionary<string,string> | HttpQuery-Parameter des Webhook-Aufrufs |
| HttpBody | string | der serialisierte Body des Webhook-Aufrufs |
Ausgabeparameter
Es werden die allgemeinen Rückmeldungen erwartet.
Die Rückgabe von Dateien wird nicht unterstützt.
| Key | Datentyp | Value |
|---|---|---|
| PreventsCommit | bool | das Kennzeichen, ob die Übergabe an das ERP abgebrochen werden soll |
| ExternalPaymentReference | string | die Externe Zahlungsreferenz / TransactionID des Zahlungsanbieters (falls vorhanden) |
Der Benutzer hat die Zahlungsart „Rechnung“ ausgewählt. Es muss keine externe Abwicklung durchlaufen werden.
Neben den allgemeinen Rückmeldungen kannst du die externe Zahlungsreferenz übergeben. Diese kann dann weiterverarbeitet werden, damit zum Beispiel die Buchhaltung neben der Elements Referenznummer die Referenznummer des Zahlungsanbieters einsehen kann.
Alternativ kannst du auch ein Sperrkennzeichen mitgeben. Sobald die Aktion feststellt, dass die Bestellung oder das Angebot nicht weiterverarbeitet werden kann, kann ein Sperrkennzeichen mitgeschickt werden. Dann ist es dem Benutzer nicht mehr möglich, die Bestellung oder das Angebot im ERP-System zu speichern.
Der Benutzer hat die Zahlungsart „Kreditkarte“ ausgewählt und die Abwicklung durchlaufen. Dabei ist es zu einem Problem gekommen. Die Bestellung kann somit auch nicht an das ERP-System übergeben werden. Es wird eine Fehlermeldung eingeblendet.
Schicke bei einer Sperrung bitte auch immer eine Fehlermeldung mit, damit der Benutzer auch reagieren und die Bestellung oder das Angebot anpassen kann.
