SOFORT Überweisung Classic (JTL-Shop 5)
- Kristian Stantschew (Unlicensed)
- Chris Podubrin
- Michael Sauer (Unlicensed)
- 1 Einleitung
- 2 Installation / Update
- 3 Konfiguration
- 3.1 Shop
- 3.1.1 Zahlungsarten
- 3.1.2 Versandarten
- 3.2 JTL-Wawi
- 3.2.1 Zahlungsart einrichten
- 3.2.2 Auftragsattribute anlegen
- 3.2.2.1 Anlage in Wawi 1.6.x
- 3.1 Shop
- 4 Betrieb
- 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 SOFORT Überweisung Classic in Ihren JTL-Shop.
SOFORT Überweisung Classic ist ein Online-Bezahlsystem der Sofort GmbH (Klarna Gruppe) zur bargeldlosen Zahlung im Internet und funktioniert ähnlich einem Vorkasse-System. Der Kunde wird zum Betreiber geleitet, übermittelt auf der Plattform seine Kontoverbindung und Zugangsdaten, gibt die Anweisung an den Händler mittels TAN frei und wird zum Onlineshop zurückgeleitet. Der Händler erhält eine Zahlungsbestätigung und ist in der Lage die Bestellung zu bearbeiten.
SOFORT Überweisung Classic ermöglicht es Bestellungen über Onlinebanking zu bezahlen.
Features
Frontend:
Zahlungsart “SOFORT Überweisung Classic”
Backend:
Übersicht und Suche von Bestellungen
Manuelles und automatisches Aktualisieren der Bestellungen
Konfigurationshilfe zum Plugin
Installation / Update
Systemvoraussetzungen
JTL-Shop 5.00+ und dessen Voraussetzungen
Weitere Voraussetzungen
Sie benötigen ein Händlerkonto, das Sie zuerst erstellen müssen. Jetzt zu Sofortüberweisung!
Im Anschluss müssen Sie ein neues Projekt anlegen, wählen Sie dafür das “Gateway-Projekt” aus:
Vergeben Sie einen Projektnamen und füllen Sie alle erforderlichen Felder aus.
Wählen Sie unter Shop-System “Anderes Shop-System“ aus und aktivieren Sie unter Zahlarten Sofort als Zahlungsart aus. Mit dem +-Zeichen können weitere Einstellungen eingeblendet werden. Hier aktivieren oder deaktivieren Sie den Testmodus. Gültige Testkonten finden Sie bei Sofort unter Projekt testen.
Nachdem Sie erfolgreich das Projekt angelegt haben, können Sie - erneut das Projekt öffnend - die für den Betrieb im Plugin notwendigen Daten unter “Allgemeine Einstellungen” einsehen.
Sie benötigen die Kundennummer, Projekt-ID und den API-Key. Der Konfigurationsschlüssel wird auf Basis dieser drei Daten vom Plugin automatisch erstellt und ist dann auf der Hilfe-Seite im Plugin sichtbar.
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 Pluginverwaltung 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 Plugin aus. Sie erhalten dort eine Übersicht über die Konfiguration. Überprüfen Sie an 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 Administration → Zahlungsarten. Einen direkten Link dahin finden Sie auch auf der Hilfe-Seite des Plugins. Wählen Sie SOFORT Überweisung Classic über das Stift-Symbol aus und konfigurieren Sie die Zahlungsmethode bei Bedarf.
Unter “Bild-URL” können Sie ein Logo einfügen. Dies führ jedoch dazu, dass der “Angezeigte Name” der Zahlungsmethode nicht mehr erscheint. Dies ist ein bekanntes Verhalten im JTL-Shop. Um dennoch hier eine präzisere Betitelung zu erhalten, können sie den Namen der Zahlungsmethode unter “Hinweistext Onlineshop” hinterlegen. Dieser Text erscheint dann unter dem Logo in der entsprechenden Sprache.
Verfügbare Bild-URLs / Klarna-Logos:
plugins/s360_sofortueberweisung_shop5/frontend/badges/klarna.png
plugins/s360_sofortueberweisung_shop5/frontend/badges/klarna_white.png
plugins/s360_sofortueberweisung_shop5/frontend/badges/klarna_black.png
Neben den Standard-Einstellungen für Zahlungsarten befinden sich im Plugin unter Einstellungen die übergeordneten Einstellungen zur Zahlungsart. Hier können Sie die für den Betrieb im Plugin notwendigen Daten aus den Projekteinstellungen (siehe Voraussetzungen) unter “Allgemein” hinterlegen:
Option | Bedeutung |
|---|---|
Kundennummer | Die Kundennummer des Händlers bei SOFORT Überweisung |
Projekt-ID | Die von SOFORT Überweisung erzeugte Projekt-ID |
API-Key | Der von SOFORT Überweisung generierte API-Key, nachdem ein Gateway-Projekt angelegt wurde |
Begünstigter | Name und Land des Begünstigten |
Zahlungseingänge setzen | Zahlungseingänge setzen ja/nein: Option, ob das Plugin die Zahlungseingänge für die JTL-Wawi setzen soll. Diese Option dient dem Szenario, dass der Händler die Zahlungen auf andere Art und Weise in der JTL-Wawi setzen möchte (z.B. manuell) Ein Abgleich über das Zahlungsmodul ist über Bestellattribute, wie das Plugin es verwendet, aktuell nicht möglich. |
Notifications bereinigen | Nach dieser Anzahl Tagen werden erhaltene Update-Benachrichtigungen aus der Datenbank gelöscht. |
Option | Bedeutung | Standard |
|---|---|---|
IP-Prüfung | Wenn aktiv, dann wird die Eigene IP-Liste zur Prüfung der eingehenden Notifications verwendet, anderenfalls wird standardmäßig die Sofort-Liste (https://www.sofort.com/payment/status/ipList) benutzt. | nicht aktiv (empfohlen) |
Eigene IP-Liste | Eigene Liste vertrauenswürdiger IPs für eingehende Notifications (bei vorgelagerten Firewalls, Proxies, etc.) Eine Verifizierung der Herkunft von Notifications (SOFORT) kann darüber nicht mehr sicher erfolgen. In diesem Fall muss auf den vorgelagerten Systemen die Prüfung auf Vertrauenswürdigkeit der Anfrage erfolgen. | nicht aktiv (empfohlen) |
Local Mode (für Entwickler) | Setzt keine Notification-Url für SOFORT Überweisung, Notifications sind dann nicht verfügbar. Z.B. bei nicht validen Domains/TLDs wie 'myshop.local' | nicht aktiv (empfohlen) |
Verbose Mode (für Entwickler und Support) | Ausgabe zusätzlicher Informationen bei der Verarbeitung von Notifications. Diese Ausgaben sind im Sofort Händler-Account unter einer Benachrichtigung (z.B. XML HTTP Post) für eine Transaktion als Antwort vom Webserver einsehbar. | nicht aktiv (empfohlen) |
E-Mail bei Zahlungsfehler | Geben Sie hier eine von der Master-Email-Adresse abweichende Email zu Benachrichtigung bei Zahlungsfehlern an. |
|
Versandarten
Weisen Sie nun SOFORT Überweisung Classic den gewünschten Versandarten/Ländern unter Administration → Versand 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 SOFORT Überweisung Classic getätigten Zahlungen in der JTL-WAWI den Bestellungen zugeordnet werden, sind hier weiterführende Einstellungen vorzunehmen.
Zahlungsart einrichten
Öffnen Sie in der JTL-WAWI die Zahlungsartenverwaltung über Zahlungen → Zahlungsarten.
Legen Sie als Zahlungsart SOFORT Überweisung Classic an. Beachten Sie, dass die Zahlungsarten dem “Angezeigten Namen“ im JTL-Shop entsprechen müssen.
Auftragsattribute anlegen
Das Plugin schreibt in die folgenden Attribute wichtige Informationen (sofern vorhanden) zu Transkationen:
sofort_transaction_idDie Sofort Bestell-ID
Legen Sie diese Attribute unter Verkauf → Auftragsattribute an, damit Sie sie auch an Aufträgen einsehen können. In neueren WaWi Versionen kann die Auftragsattributverwaltung geöffnet werden, wenn man eine Bestellung öffnet. Dort können über den Button “Attribute …” → Attribute definieren → “Anlegen …” neue Attribute angelegt werden
Anlage in Wawi 1.6.x
In der Wawi 1.6.x sind Auftragsattribute zu “Eigene Felder” geworden und nun dort zu finden. Das notwendige Auftragsfeld legen Sie also nun dort an, falls Sie es nicht bereits schon in einer vorherigen Wawi-Version als Auftragsattribut erstellt hatten.
Die Verwaltung öffnen Sie via Admin → Eigene Felder. Legen Sie das Eigene Feld mit dem notwendigen Namen sofort_transaction_id im Bereich “Angebot/Auftrag/Abonnements” an:
Betrieb
Shop
Frontend
Die Zahlungsart SOFORT Überweisung Classic steht den Kunden nur unter gewissen Voraussetzungen zur Auswahl zur Verfügung.
Die unterstützten Währungen sind Euro (EUR), Britischer Pfund (GBP), Polnische Zloty (PLN), Schweizer Franken (CHF), Ungarische Forint (HUF), und Tschechische Krone (CZK).
Ist eine nicht unterstützte Währung im Shop-Frontend gewählt, dann wird SOFORT Überweisung Classic nicht als Zahlungsart angezeigt
Zahlung vor Bestellabschluss:
Aus technischen Gründen muss die Option “Zahlung vor Bestellabschluss” auf “Ja” stehen. Sonst wird die Zahlungsart nicht angeboten.
Ab Version 1.0.7 wurden Änderungen im Rahmen des Bestellabschlusses vorgenommen. Das Anlegen der Bestellung im Shop wird bei erfolgreicher Zahlung nun immer durchgeführt, auch wenn die Prüfung des Warenkorbes nicht erfolgreich war. Änderungen am Warenkorb während des Zahlungsvorgangs bei Sofortüberweisung führen dazu, dass die Prüfung des Warenkorbes fehlschlägt. In diesem Fall wird Ihnen eine E-Mail-Benachrichtigung zugeschickt mit der Bitte die aktuellen Zahlungen über das Plugin zu überprüfen.
Backend
Im Plugin-Backend können Sie die Bestellungen einsehen, die mit SOFORT Überweisung Classic bezahlt wurden. Die Suche unterstützt Sie dabei die gewünschten Bestellungen zu finden.
Spalte | Bedeutung |
|---|---|
Bestell-Nr. | Bestellnummer im Onlineshop |
Betrag Shop | Der Betrag der Bestellung |
Transaktion | Transaktions-ID von SOFORT Überweisung |
Status | Zahlungsstatus der Bestellung (pending, received, untraceable, refunded, loss) |
Betrag Sofort | Betrag der Zahlung |
Erstellt | Zeitpunkt der Erstellung/Bestellung |
Geändert | Zeitpunkt der letzten Änderung/Aktualisierung |
Aktionen | Anzeigen, Aktualisieren |
Aktionen
Anzeigen - Klicken Sie auf das Auge-Symbol, um die Details der Bestellung anzuzeigen. Es werden lediglich die Rohdaten der letzten Transaktion im XML-Format angezeigt.
Aktualisieren - Klicken Sie auf das Aktualisieren-Symbol, um neue Informationen zum Zahlungsstatus der Bestellung abzurufen. Diese Aktion wird normaler Weise über die Notifications von Sofort ausgelöst oder aber im Anschluss eines jeden WAWI-Abgleiches. Hier können Sie den Abruf unabhängig davon auch manuell starten.
Ab Version 1.0.7 sind nun die Bestellungen in der Zahlungsübersicht rot hervorgehoben, bei denen die Beträge in der Bestellung und die der Zahlung nicht übereinstimmen.
WAWI
Bedingt durch die Änderungen in Version 1.0.7 können in der JTL-Wawi nun Bestellungen vorhanden sein, bei denen der Gesamtbetrag und die Höhe der Zahlung voneinander abweichen. In diesem Fall sollte geprüft werden, ob es sich ggf. um einen Betrugsversuch handelt.
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 nur schwer zu analysieren.
Meldungen
Diese Meldung erscheint, wenn Sie die Zahlung auf der Seite von Sofortüberweisung abgebrochen haben und zurückgeleitet wurden zu Zahlungsart-Auswahl des Onlineshops.
Dies ist der Fall, wenn ein Kunde auf der Zusammenfassung-Seite versehentlich die Währungsanzeige auf eine nicht unterstützte Währung verstellt hat. Dies ist ein bekanntes Verhalten vom JTL-Shop. 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 SOFORT Überweisung Classic auch wieder als Zahlungsart angeboten.
Diese Meldung erscheint, wenn keine oder es zu einer fehlerhaften Kommunikation mit der Sofort-API gekommen ist. Für weitere Informationen zum genauen Fehler, schauen Sie bitte in das Shop-Log.
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 API kann dann bequem mit dem Präfix “SOFORT“ 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.
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. Manchmal ergibt sich auch durch das Browser-Log, dass die Informationen eher im Shop-Log zu suchen sind.
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.0.7 (März 2023)
Fix: Bestellungen anlegen, auch wenn Warenkorbsumme ungleich Zahlungsbetrag ist
Benachrichtigung an den Händler bei Fehler im Zahlungsvorgang
v1.0.6 (Februar2022)
JTL Shop 5.2 Kompatibilität
Bugfix: Benutzereingaben trimmen
v1.0.5 (August 2022)
Bugfix: TransactionID Validierung
v1.0.4 (Juni 2022)
Bugfix: Autoloader
v1.0.3 (Juni 2022)
Bugfix: Fehler in Konstante für Zahlungseingang
v1.0.2 (Mai 2022)
Bugfix: Notifications Cleanup
v1.0.1 (April 2022)
Bugfix: Shop hängt beim Abgleich
v1.0.0 (März 2022)
Initiales Release
Support und Kontakt
siehe Support und Kontakt