Riverty (JTL-Shop 4)
- 1 Einleitung
- 2 Installation / Update
- 3 Konfiguration
- 3.1 Shop
- 3.1.1 Zahlungsarten
- 3.1.1.1 Profile Tracking
- 3.1.2 Erweiterte Einstellungen zu den Zahlungsarten
- 3.1.3 Versandarten
- 3.1.1 Zahlungsarten
- 3.2 JTL-WAWI
- 3.2.1 Zahlungsart einrichten
- 3.1 Shop
- 4 Betrieb
- 4.1 Shop
- 4.2 JTL-WAWI
- 4.2.1 +++ ACHTUNG, WICHTIG +++
- 4.3 BegriffsklƤrung / Glossar
- 5 Individualisierung
- 6 Troubleshooting
- 6.1 Meldungen
- 6.2 Logs prĆ¼fen
- 6.2.1 Browser-Log
- 6.2.2 Shop-Log
- 6.2.3 Webserver-Log
- 7 Changelog
- 8 Support und Kontakt
Einleitung
Dieses Plugin integriert die Zahlungsart Riverty in Ihren JTL-Shop. Die Riverty GmbH ist ein international zugelassenes Zahlungsinstitut und erbringt PSD2-konforme Zahlungsdienste. Riverty ermƶglicht es Bestellungen Ć¼ber Rechnung, Lastschrift und Ratenzahlung zu bezahlen.
Die Begriffe Zahlungsart und Zahlungsmethode werden oft synonym verwendet. In diesem Kontext beschreibt der Begriff āZahlungsartā Riverty als einen Anbieter mehrerer mƶglicher Zahlungsmethoden, wie Rechnung, Lastschrift bzw. Ratenzahlung.
Features
Frontend:
Zahlungsart Riverty Rechnung
Zahlungsart Riverty Lastschrift
Zahlungsart Riverty Ratenzahlung
Backend:
Ćbersicht und Suche von Bestellungen
Ć¼bergeordnete Aktionen auf Zahlungen (Capture, Refund, Void)
Cross-Funktionale Aktionen zwischen JTL-WAWI und Shop (Capture, Void)
Konfigurationshilfe zum Plugin
Installation / Update
Systemvoraussetzungen
JTL-Shop 4.06+ und dessen Voraussetzungen
PHP7.4 bis PHP8.1
Weitere Voraussetzungen
Sie benƶtigen ein Riverty HƤndlerkonto. Bitte wenden Sie sich hierzu an Riverty.
Beta-Tester registrieren sich auf der Sandbox und erstellen die lƤnderspezifischen API-Keys unter dem Tab-MenĆ¼punkt Credentials:
Plugin-Installation
Die Installation des Plugins erfolgt nach JTL-Standard, wie es hier beschrieben ist oder sie kƶnnen Ihre vorhandene ZIP-Datei des Plugins auch Ć¼ber den Reiter āUploadā in der Plugin-Verwaltung bereitstellen und anschlieĆend im Reiter āVorhandenā die Installation starten.
Plugin-Update
Bei einem Update auf eine neuere Version kƶnnen Sie der allgemeinen Installation folgen mit dem Unterschied, dass Sie direkt in der Pluginverwaltung den Update-Button zur Aktualisierung betƤtigen mĆ¼ssen.
Konfiguration
Shop
Das Plugin unterstĆ¼tzt Sie bei der Einrichtung der Zahlungsart, wƤhlen Sie dafĆ¼r den Reiter āHilfeā im Riverty Plugin aus. Sie erhalten dort eine Ćbersicht Ć¼ber die Konfiguration zum Plugin. ĆberprĆ¼fen Sie and der Stelle die von Ihnen hinterlegten Einstellungen zu den Zahlungs- und Versandarten.
Zahlungsarten
Die Konfiguration der Zahlungsart erfolgt Ć¼ber die Standard-Verwaltung im JTL-Shop. Sie finden die Zahlungsarten unter Storefront ā Zahlungsarten ā Ćbersicht. Einen direkten Link dahin finden Sie auch auf der Hilfe-Seite des Plugins. Sie kƶnnen hier alle drei Zahlungsmethoden von Riverty einzeln konfigurieren.
Ā
Das Plugin implementiert die 2-Step-Authorisierung, d.h. die verfĆ¼gbaren Zahlungsmethoden sind bereits vor dem Abschluss der Bestellung identifiziert. Eine āZahlung nach Bestellabschlussā ist nicht mƶglich.
Aus technischen GrĆ¼nden muss die Option āZahlung vor Bestellabschlussā auf āJaā stehen. Sonst wird die Zahlungsart nicht angeboten.
Ā
Neben den Standard-Einstellungen fĆ¼r Zahlungsarten finden sich im Plugin unter Einstellungen die Ć¼bergeordneten Einstellungen zur Zahlungsart Riverty.
Sie kƶnnen hier Ihre Merchant-ID und den Capture-Modus einstellen,
Option | Bedeutung |
---|---|
Merchant-ID | Tragen Sie hier Ihre Merchant-ID ein. Diese erhalten Sie von Riverty zugewiesen. Sie wird verwendet um die Riverty-seitigen Verlinkungen mit ihrer GeschƤftsfirmierung zu personalisieren. |
Capture-Modus | Sie kƶnnen zwischen zwei Modi beim Capture wƤhlen, dabei wird immer ein Full-Capture durchgefĆ¼hrt. Diese Option kommt zum Tragen, wenn der Versandstatus (Teilgeliefert/Verpackt und versendet) fĆ¼r eine Bestellung in der JTL-WAWI geƤndert wird. Capture beim ersten Teilversand bedeutet, dass sobald eine Teillieferung erfolgt, der ganze Rechnungsbetrag bezahlt wird. Capture bei Komplettversand hingegen bedeutet, dass der Rechnungsbetrag bezahlt wird, wenn die gesamte Bestellung versendet worden ist. Ā |
sowie den Betriebsmodus wƤhlen und die lƤnderspezifischen API-Keys eingeben.
Option | Bedeutung | Standard |
---|---|---|
[DE] Deutschland | Aktivieren Sie hier Riverty fĆ¼r Deutschland, indem Sie diese in den Sandbox-, Partner- oder Live-Modus setzen. | nicht aktiv |
[DE] API-Key | Geben Sie hier den lƤnderspezifischen API-Key ein. | - |
[AT] Ćsterreich | Aktivieren Sie hier Riverty fĆ¼r Ćsterreich, indem Sie diese in den Sandbox-, Partner- oder Live-Modus setzen. | nicht aktiv |
[AT] API-Key | Geben Sie hier den lƤnderspezifischen API-Key ein. | - |
[CH] Schweiz | Aktivieren Sie hier Riverty fĆ¼r die Schweiz, indem Sie diese in den Sandbox-, Partner- oder Live-Modus setzen. | nicht aktiv |
[CH] API-Key | Geben Sie hier den lƤnderspezifischen API-Key ein. | - |
[NO] Norwegen | Aktivieren Sie hier Riverty fĆ¼r Norwegen, indem Sie diese in den Sandbox-, Partner- oder Live-Modus setzen. | nicht aktiv |
[NO] API-Key | Geben Sie hier den lƤnderspezifischen API-Key ein. | - |
[SE] Schweden | Aktivieren Sie hier Riverty fĆ¼r Schweden, indem Sie diese in den Sandbox-, Partner- oder Live-Modus setzen. | nicht aktiv |
[SE] API-Key | Geben Sie hier den lƤnderspezifischen API-Key ein. | - |
[FI] Finnland | Aktivieren Sie hier Riverty fĆ¼r Finnland, indem Sie diese in den Sandbox-, Partner- oder Live-Modus setzen. | nicht aktiv |
[FI] API-Key | Geben Sie hier den lƤnderspezifischen API-Key ein. | - |
[DK] DƤnemark | Aktivieren Sie hier Riverty fĆ¼r DƤnemark, indem Sie diese in den Sandbox-, Partner- oder Live-Modus setzen. | nicht aktiv |
[DK] API-Key | Geben Sie hier den lƤnderspezifischen API-Key ein. | - |
FĆ¼r eine gĆ¼ltige API-Konfiguration muss ein Rechnungsland aktiv sein und der lƤnderspezifische API-Key hinterlegt sein..
Profile Tracking
Diese Technologie wird eingesetzt, um die verwendeten GerƤte (z. B. PCs, Smartphones, Tablets usw.) zu erkennen und zu identifizieren und um mƶgliche Betrugsversuche erkennen zu kƶnnen. Sie kƶnnen diese Lƶsung nutzen indem Sie sich bei Riverty dafĆ¼r freischalten lassen.
Option | Bedeutung |
---|---|
Profile Tracking ID | Diese ID erhalten Sie von Ihrem Riverty Ansprechpartner. Ohne diese ID ist die Funktion stets deaktiviert. |
Profile Tracking Modus | Stellen Sie hier den Betriebsmodus des Profile Trackings ein. Erforderlich beschreibt, dass der Kunde seine Zustimmung Ć¼ber eine eigene Checkbox geben muss. Optional beschreibt, dass er diese auslassen kann. Ansonsten erfolgt kein Tracking und es wird keine Checkbox angezeigt. |
ZusƤtzliche Datenschutz-URL (Profile Tracking) | Link fĆ¼r eine alternative Datenschutzrichtlinie fĆ¼r das Profile-Tracking. |
Wenn der Kunde durch Anklicken des KontrollkƤstchens mit dem Datenschutz beim Profil-Tracking von Riverty einverstanden ist, wird das Profil-Tracking-Skript auf der Bezahlseite geladen. Die Profile Tracking-Werte (profileTrackingId und IP-Adresse) werden dann an Riverty Ć¼bermittelt.
Erweiterte Einstellungen zu den Zahlungsarten
Ab Version 107 stehen Ihnen separate Einstellungen fĆ¼r die Aktivierung einzelner Zahlungsarten pro Land zur VerfĆ¼gung. Sie kƶnnen hiermit steuern welche Zahlungsarten im Shop angeboten werden unabhƤngig von den von Riverty warenkorbbasierten Zahlungsarten. Die Zahlungsart Rechnung kann aktiviert werden sofern sie Ihre API-Zugangsdaten angegeben haben. Ist Rechnung aktiviert, dann kƶnnen Sie auch Lastschrift oder Ratenzahlung aktivieren. Rechnung ist die Basis der Zahlungsarten und muss neben Lastschrift oder Ratenzahlung immer aktiv sein. Sie kƶnnen Rechnung nur dann deaktivieren, wenn keine weiteren Zahlungsarten fĆ¼r dieses Land aktiv sind. Kurzum:
Riverty Rechnung kann nur fĆ¼r ein Land deaktiviert werden, wenn Riverty Lastschrift und Riverty Ratenzahlung fĆ¼r dieses Land deaktiviert ist!
Versandarten
Weisen Sie nun Riverty den gewĆ¼nschten Versandarten/LƤndern unter Storefront ā Kaufabwicklung ā Versandarten zu. Das Plugin berĆ¼cksichtigt auch etwaige AufschlƤge zur Zahlungsmethode. Einen direkten Link dahin finden Sie auch auf der Hilfe-Seite des Plugins.
JTL-WAWI
Damit die Ć¼ber Riverty getƤtigten Bestellungen in der JTL-WAWI abgearbeitet werden kƶnnen, sind hier weiterfĆ¼hrende Einstellungen vorzunehmen. Die Bestellungen sind eingangs in der JTL-WAWI ānicht bezahltā (Authorized) und mĆ¼ssen ohne Zahlungseingang versendet werden kƶnnen.
Zahlungsart einrichten
Ćffnen Sie in der JTL-WAWI die Zahlungsartenverwaltung Ć¼ber Zahlungen ā Zahlungsarten.
Legen Sie als Zahlungsarten Riverty Rechnung, Riverty Lastschrift und Riverty Ratenzahlung an. Beachten Sie, dass die Zahlungsarten dem āAngezeigten Namenā im JTL-Shop entsprechen mĆ¼ssen. So auch gleichermaĆen in Englisch Riverty Invoice, Riverty Direct Debit und Riverty Fix installments.
Aktivieren Sie bei allen Zahlungsarten die Option āAuslieferung vor Zahlungseingang mƶglichā.
Betrieb
Shop
Frontend
Die Zahlungsart Riverty steht Kunden nur unter gewissen Voraussetzungen zur Auswahl zur VerfĆ¼gung.
Ihr Shop muss Deutschland, Ćsterreich, Schweiz, Norwegen, Schweden, Finnland oder DƤnemark (zukĆ¼nftig auch Belgien, Niederlande) als Rechnungsland unterstĆ¼tzen und die WƤhrungen Euro und Schweizer Franken sowie Norwegische, Schwedische oder DƤnische Krone entsprechend dem Rechnungsland anbieten.
Eine abweichende Lieferadresse in unterschiedliche LƤnder wird nicht unterstĆ¼tzt.
Eine vom Rechnungsland abweichende WƤhrung ist nicht zulƤssig.
Der Gesamtbetrag der Ć¼ber Riverty bezahlt werden kann ist auf 99.9 Millionen limitiert.
Besonderheiten
Der JTL-Shop arbeitet mit fest definierten Zahlungsarten. Diese sind auch fĆ¼r den reibungslosen Abgleich mit der JTL-WAWI notwendig. Allerdings kƶnnen die auswƤhlbaren Riverty Zahlungsmethoden variieren, dies ist von internen Faktoren abhƤngig.
Initial sind alle drei Zahlungsmethoden im Shop verfĆ¼gbar, sofern die o. g. Voraussetzungen erfĆ¼llt sind. Nachdem der Kunde eine Zahlungsmethode ausgewƤhlt und die zusƤtzlich erforderlichen Felder ausgefĆ¼llt hat, wird eine Anfrage an Riverty gesendet und die verfĆ¼gbaren Zahlungsmethoden fĆ¼r den aktuellen Warenkorb zurĆ¼ckgegeben. Es erfolgt ein Abgleich, dabei werden nur die verfĆ¼gbaren Zahlungsmethoden aktiviert. Ist z. B. ein Warenkorb-Betrag fĆ¼r Ratenzahlung zu gering, so wird Ratenzahlung nicht angeboten, bis sich der Warenkorb-Betrag vergrƶĆert hat oder der Kauf abgeschlossen wurde. Im Fehlerfall wird eine entsprechende Meldung ausgegeben.
Backend
Im Plugin-Backend kƶnnen Sie die Bestellungen einsehen, die mit Riverty bezahlt wurden. Die Suche unterstĆ¼tzt Sie dabei die gewĆ¼nschten Bestellungen zu finden.
Spalte | Bedeutung |
---|---|
Bestell-Nr. | Bestellnummer im Onlineshop |
Name | Vorname und Name des Kunden |
Zahlungsart | Die gewƤhlte Riverty Zahlungsmethode |
Status | Zahlungsstatus der Bestellung (Authorized, Captured, Refunded, Cancelled) |
Land | Rechnungsland der Bestellung |
Betrag | Betrag der Reservierung (Authorize) |
Capture | Betrag der Zahlung (Capture) |
Storno | Summe der RĆ¼ckzahlungen (Refund) |
Ablauf | Ablaufdatum der Autorisierung |
Aktionen | Anzeigen, Capture, Stornieren |
Aktionen
Anzeigen - Klicken Sie auf das Auge-Symbol, um die Details der Bestellung anzuzeigen. Neben den Bestelldaten und Zahlungsinformationen werden hier auch die RĆ¼ckzahlungen aufgelistet.
Erstatten - Bestellungen mit dem Zahlungsstatus āFullyCapturedā oder āPartiallyRefundedā bieten positionsbezogene Checkboxen fĆ¼r die Erstattung (Refund) an. Aktivieren Sie alle Checkboxen, um ein āFull-Refundā durchzufĆ¼hren oder nur einzelne Positionen fĆ¼r einen āPartial-Refundā. Im Eingabefeld ist der komplette Betrag der Position vorgegeben, Sie haben jedoch die Mƶglichkeit auch einen Teilbetrag zu erstatten. BestƤtigen Sie mit āErstattenā, um die Aktion auszufĆ¼hren.
Bezahlen (Capture) - Klicken Sie auf das Dollarzeichen, um die Bezahlung (Capture) zu tƤtigen. BestƤtigen Sie mit āCaptureā, um die Aktion auszufĆ¼hren.
Stornieren - Klicken Sie auf das Kreuz, um die Autorisierung zu stornieren. BestƤtigen Sie mit āStornierenā, um die Aktion auszufĆ¼hren.
JTL-WAWI
Eingehende Bestellungen und getƤtigte Zahlungen werden von der JTL-WAWI durch den Onlineshop-Abgleich eingelesen und verarbeitet (siehe Zahlungsart einrichten).
Bestellung bezahlen
Die Zahlungen (Captures) werden vollautomatisch von der WAWI Ć¼ber das Shop-Plugin durchgefĆ¼hrt und als bezahlt markiert, sobald die erste Teillieferung oder der Komplettversand stattgefunden hat.
Bestellung stornieren
Gehen Sie in die JTL-WAWI ā F6 ā Auftrag wƤhlen ā rechte Maustaste ā Storno ā Stornieren
FĆ¼hren Sie anschlieĆend einen Onlineshop Abgleich durch
Ist der Status der Bestellung āAuthorizedā (Reserved), dann wird dieser bei Riverty storniert (Cancelled).
Ist die Bestellung allerdings schon āCapturedā, āRefundedā oder āCancelledā, dann wird keine Aktion ausgefĆ¼hrt. Eine automatisierte RĆ¼ckzahlung ist an der Stelle nicht vorgesehen, Sie kƶnnen allerdings manuell Ć¼ber das Plugin-Backend eine (teilweise) RĆ¼ckzahlung durchfĆ¼hren.
BegriffsklƤrung / Glossar
Riverty betitelt seine GeschƤftsprozesse analog zu den in der Kreditkartenwirtschaft, somit wird hier von einer
Pre-Autorisierung (Ermittlung der verfĆ¼gbaren Zahlungsmethoden),
Autorisierung (Reservierung des Rechnungsbetrages),
Capture (Zahlung),
Refund (Teil- bzw. RĆ¼ckzahlung) und
Void (Cancel bzw. Storno)
gesprochen. Diese Begriffe finden sich teilweise im Adminbereich wieder.
Individualisierung
Die Zahlungsart wird in der Standardauswahl der Zahlungsarten im JTL-Shop eingeblendet und hat keine individualisierbaren Elemente.
Troubleshooting
Sollten Sie Probleme mit dem Plugin beobachten, prĆ¼fen Sie zunƤchst die Logs und wenden Sie sich ggf. an unseren Support oder Ihren Service-Partner, wenn Sie das Problem nicht selbstƤndig lƶsen kƶnnen.
Je mehr Informationen Sie dem Support bei einem Problem geben kƶnnen, desto eher sind wir in der Lage, Ihnen zu helfen. Nicht reproduzierbare Probleme sind dagegen auch nur schwer zu analysieren.
Meldungen
Die GĆ¼ltigkeitsprĆ¼fung der Webseite validiert nur formal die Eingabe und prĆ¼ft, ob das Geburtsdatum der SSN korrekt ist. Die inhaltliche Richtigkeit einer SSN wird von Riverty festgestellt.
Ā
Dies ist der Fall, wenn der Kunde auf der Zusammenfassung-Seite versehentlich die WƤhrungsanzeige verstellt hat. In diesem Fall wird er auf die Versand- und Zahlungsart-Seite zurĆ¼ckgefĆ¼hrt. Hier hat er die Mƶglichkeit entweder eine Zahlungsart passend zur gewĆ¼nschten WƤhrung auszuwƤhlen oder die WƤhrungsauswahl zu korrigieren. Dann wird Barzahlen auch wieder als Zahlungsart angeboten.
Ā
Diese Meldung wird angezeigt, wenn die eingangs gewƤhlte Zahlungsmethode (z.B. Ratenzahlung) durch die Pre-Autorisierung nicht bestƤtigt wurde. D.h., dass diese nicht zu den angebotenen Zahlungsmethoden gehƶrt. Dies kann der Fall sein, wenn Ratenzahlung mit einen viel zu niedrigen Warenkorbbetrag gewƤhlt wurde oder eine Firma (USTID) diese Zahlart auswƤhlt. Aus technischen GrĆ¼nden mĆ¼ssen initial alle Riverty Zahlungsarten fĆ¼r den JTL-Shop angeboten werden.
Ā
Dieser Fehler tritt auf, wenn die Autorisierung nicht im Status āAcceptedā endet. Tritt ein anderer Status auf wie z.B. āPendingā, dann kann keine Zahlung durchgefĆ¼hrt werden.
Ā
Tritt ein Fehler in der Kommunikation mit Riverty auf, dann wird der Kunde auf die Zahlungsseite zurĆ¼ckgefĆ¼hrt und Riverty nicht weiter als mƶgliche Zahlungsart fĆ¼r die aktuelle Session angeboten.
Ā
Reduzieren Sie die Warenkorbsumme unter 99.9 Millionen.
Logs prĆ¼fen
Im Plugin-Backend werden dem HƤndler zu jeder Aktion Erfolgs- und Fehlermeldungen angezeigt. Insbesondere werden Fehler in das Shop-Log geschrieben. Die Fehlermeldungen und die allgemeinen Kommunikation mit der Riverty API kann dann bequem mit dem PrƤfix āRiverty>ā gefiltert werden.
Um herauszufinden, wo ein Problem liegt, helfen Ihnen und uns die Logs. Je nach Fehlerbild ist eines der folgenden 3 Logs dafĆ¼r mehr oder weniger relevant.
Browser-Log
Das Browser-Log ist meist relevant, wenn irgendwas im Frontend des Shops sich merkwĆ¼rdig verhƤlt oder nicht reagiert. (Beispiel: Sie klicken einen Button und augenscheinlich passiert gar nichts.)
Das Browser-Log sehen Sie, wenn Sie im Browser F12 drĆ¼cken und dort dann auf Konsole (oder Console) wechseln. Manchmal ergibt sich auch durch das Browser-Log, dass die Informationen eher im Shop-Log zu suchen sind.
Shop-Log
Das Shop-Log ist immer dann interessant, wenn im Frontend unerwartete Fehlermeldungen ausgegeben werden oder das Plugin zwar auf Eingaben im Frontend reagiert, aber nicht das Ergebnis liefert, was erwartet wurde.
Das Shop-Log finden Sie im JTL-Adminbereich unter System ā Wartung ā Log.
Webserver-Log
Das Webserver-Log wird dann relevant, wenn Sie irgendwo auf einen Error 500 (= weiĆe Seite) stoĆen.
Das Webserver-Log kann Ihnen Ihr Hoster zur VerfĆ¼gung stellen.
Changelog
v1.1.3 (Februar 2023)
Fix: CSS Styling update
v1.1.2 (Januar 2023)
Fix: Wawi-Abgleich hƤngt
v1.1.1 (November 2022)
KompatibilitƤt zu JTL-Shop 5.2
Neue API Endpunkte (riverty.io)
v1.1.0 (November 2022)
Rebranding Riverty
Erweiterung: Logging der API-Kommunikation in Shop-Log
v1.0.5 (Juli 2022)
Aktualisierung API-Client
v1.0.4 (Juni 2022)
Aktualisierung der Rechtstexte
AfterPay Profile Tracking hinzugefĆ¼gt
Credentials Check (PrĆ¼fung der API Zugangsdaten)
v1.0.3 (Mai 2022)
Fix: API Url
v1.0.2 (April 2022)
Aktualisierung der Rechtstexte fĆ¼r Deutschland
Fix: DirectDebit Setter korrigiert
Fix: Validierung zusƤtzlicher Adressfelder
Redundaten Code entfernt
v1.0.1 (MƤrz 2022)
Fix: PrĆ¼fung auf BestellbestƤtigungsseite, ob mit AfterPay bezahlt wurde
Fix: API-URL korrigiert
Anzeige der Zahlarten im Checkout mit AfterPay-Logo
Merchant-ID ist nun optional in den Plugin-Einstellungen
v1.0.0 (September 2021)
Initiales Release
Support und Kontakt
sieheĀ Support und Kontakt