Dokumentation Barzahlen Plugin für JTL Shop 3

Inhalt

1. Installation

Sofern Sie das Plugin noch nicht heruntergeladen haben, können Sie dies im Integrationsbereich von Barzahlen (https://integration.barzahlen.de/de/shopsysteme/jtl-shop-3) tun.

Entpacken Sie das geladene Archiv. Im Unterordner src befindet sich der Plugin-Ordner barzahlen, welcher die Datei info.xml und das Verzeichnis version enthält. Kopieren Sie den Ordner barzahlen in den Unterordner includes/plugins/ Ihres Shopsystems.

Öffnen Sie anschließend den Administrationsbereich Ihres Onlineshops. Wählen Sie in der Menüleiste Plugins / Pluginverwaltung.

Wählen Sie Barzahlen aus der Liste der verfügbaren Plugins aus.

Klicken Sie anschließend auf . Nach erfolgreicher Installation befindet sich das Zahlungsmodul in der oberen Liste.

2. Konfiguration

2.1 Anmeldung Partnerbereich

Sofern Sie sich bisher noch nicht im Barzahlen-Partnerbereich (https://controlcenter.barzahlen.de/) registriert haben, holen Sie dies bitte nun nach. Nachdem Sie das Registrierungsformular ausgefüllt und Ihre E-Mailadresse durch Klick auf den Bestätigungslink verifiziert haben, loggen Sie sich ein. Wählen Sie den Menüpunkt Einstellungen und dort den Unterpunkt Divisionen.

Auf dieser Seite finden Sie Division ID, API-Schlüssel sowie Benachrichtigungsschlüssel. Weiterhin können Sie an dieser Stelle die Benachrichtigungs-URL für Ihren Shop einstellen, um Statusänderungen bezüglich Transaktionen und Rückzahlungen an das Zahlungsmodul zu senden, damit diese automatisch in Ihren Shop eingetragen werden.

Information

Die Callback-Klasse, welche Benachrichtigungen verarbeitet, wird durch den URL-Zusatz includes/modules/notify.php aufgerufen. Angenommen ihre Shop-URL wäre https://www.beispiel-shop.de/, dann tragen Sie im Feld Benachrichtigungs-URL folgendes ein, um Benachrichtigungen zu erhalten: https://www.beispiel-shop.de/includes/modules/notify.php

2.2 Modul konfigurieren

Wählen Sie in der Menüleiste aus dem Bereich Kaufabwicklung den Unterpunkt Zahlungsarten aus.


Suchen Sie aus der Liste der Zahlungsarten Barzahlen heraus und klicken Sie auf .


Geben Sie die Daten für Shop-ID, Zahlungsschüssel und Benachrichtigungsschlüssel, welche Sie nach Ihrer Registrierung im Händlerbereich (https://partner.barzahlen.de) erhalten bzw. via E-Mail zugesandt bekommen haben, ein.


Wählen Sie eine Obergrenze für den Warenkorbwert bei Zahlungen mit Barzahlen. Denken Sie daran, dass mit Barzahlen nur Zahlungen unter 1.000 Euro möglich sind.

Stellen Sie abschließend sicher, dass der Testmodus aktiviert ist, um im nächsten Schritt das Zahlungsmodul testen zu können.

Sichern Sie die Einstellungen mit einem Klick auf speichern.

Wechseln Sie anschließend zum Menüpunkt Kaufabwicklung/Versandarten.

Wählen Sie nacheinander alle Versandarten aus, die zusammen mit Barzahlen angeboten werden sollen. Klicken Sie dazu auf den Button ändern unter der jeweiligen Versandmethode. Aktivieren Sie im Bereich Akzeptierte Zahlungsarten Barzahlen.

Scrollen Sie anschließend zum Ende der Seite und sichern Sie die Einstellungen mit einem Klick auf Versandart ändern. Wiederholen Sie diesen Schritt für jede Versandmethode, für die Barzahlen angeboten werden soll. Danach ist das Modul eingerichtet und einsatzbereit.

3. Testbestellung durchführen

3.1 Ausgeschlossene Bestellungen

Prüfen Sie, ob die Ausschlusskriterien des Zahlungsplugins korrekt eingestellt sind, indem Sie nacheinander folgende Einkaufsszenarien durchlaufen:

  • Bestellung mit Warenwert größer / gleich 1.000 Euro
  • Bestellung mit einer Kundenadresse außerhalb Deutschlands

Dabei sollte Barzahlen nicht in der Zahlungsauswahl auftauchen, da bei jeder dieser Bedingungen die Zahlscheinanfrage an die Barzahlen-API fehlschlagen würde und der Kunde mit Fehlermeldung zurück zur Zahlungsauswahl geleitet wird. An dieser Stelle gilt es Ärger beim Kunden und einen eventuellen Kaufabbruch zu verhindern.

3.2 Testbestellung

Legen Sie in der Folge einen beliebiges Produkt (Warenwert kleiner 1.000 Euro) in den Warenkorb und gehen Sie zur Kasse. Bestätigen Sie Lieferadresse (innerhalb von Deutschland) sowie Versandart und gehen Sie zum Schritt Zahlungsweise wählen über. Wählen Sie Barzahlen aus der Auswahlliste und fahren Sie mit dem Bestellvorgang fort. Unter dem Erklärungstext werden die Logos unserer Partner angezeigt, wie in der nachfolgenden Grafik vereinfacht dargestellt.



Mit Abschluss der Bestellung bekommen Sie einen Zahlschein angezeigt, den Sie sich ausdrucken oder auf Ihr Handy schicken lassen können. Bezahlen Sie den Online-Einkauf mit Hilfe des Zahlscheins an der Kasse einer Barzahlen-Partnerfiliale.

Bezahlen Sie bei:

Information

Einkäufe, die mit Barzahlen im Testmodus durchgeführt werden, erhalten eine Transaktionsnummer sowie einen Barcode vom Barzahlen Server zugewiesen. Die übermittelten Daten werden nur temporär zu Testzwecken gespeichert. Getätigte Testeinkäufe können später bedenkenlos im eigenen System storniert werden.

Bestätigen Sie Ihre getätigten Angaben, um den Bestellvorgang abzuschließen.

Information

Bitte beachten Sie, dass die SMS-Funktion im Testmodus nicht zur Verfügung steht und dass an den Testkunden keine zusätzliche E-Mail mit dem Zahlschein versendet wird. Weiterhin sind auf dem Zahlschein nicht die nächsten drei Partnerfilialen aufgelistet. Alle Funktionen stehen automatisch im Live-Betrieb bereit.

3.3 Zahlung simulieren

Loggen Sie sich in den Händlerbereich von Barzahlen (https://controlcenter.barzahlen.de/) ein und wechseln sie im Reiter Transaktionen auf den Bereich Sandbox-Transaktionen.

Sie sehen eine Liste aller Sandbox-Transaktionen, welche Sie über ihr Shopsystem testweise getätigt haben. In der rechten Seite haben Sie die Möglichkeit, die Transaktionen mit als bezahlt zu markieren. Ein Klick auf simuliert einen Ablauf der Frist für die Zahlung einer Barzahlen Transaktion und ein Klick auf storniert eine Transaktion.

Bezahlen Sie probeweise eine Transaktion ihrer Wahl. Der Status der Transaktion ändert sich auf bezahlt und sofern die Sandbox-Benachrichtigungs-URL korrekt gesetzt ist, ändert sich der Status der Bestellung in Ihrem System.

Information

Die Callback-Klasse, welche Benachrichtigungen verarbeitet, wird durch den URL-Zusatz aufgerufen. Angenommen ihre Shop-URL wäre https://www.beispiel-shop.de/, dann tragen Sie im Feld Benachrichtigungs-URL folgendes ein, um Benachrichtigungen zu erhalten: https://www.beispiel-shop.de/

4. Shop anpassen

Neben der eigentlichen Integration des Zahlungsplugins gibt es weitere Details, die nach der erfolgreichen Einbindung bedacht werden sollten, um einen reibungslosen Ablauf zu gewährleisten.

4.1 AGB und Datenschutz

Erweiteren Sie ihre allgemeinen Geschäftsbedingungen sowie Datenschutzhinweise um Passagen die Barzahlen als Zahlungsanbieter betreffen. Sie finden vorgefertigete Texte hier: AGB & Datenschutz

4.2 Logos

Sofern Sie Logos von Zahlungsanbietern in der Fußzeile Ihres Online-Shops oder auf der Startseite nutzen, damit Kunden auf den ersten Blick sehen, wie man bei Ihnen den Einkauf bezahlen kann, finden Sie hier Logos um auf Barzahlen als angebotene Zahlungsmethode aufmerksam zu machen: Logos

4.3 Zahlungsbeschreibung

Viele Online-Shops stellen eine zusätzliche Informationsseite bereit auf welcher sich Kunden über die angebotenen Versand- und Zahlungsarten detailiert informieren können. Unter Textvorlagen haben wir Texte in unterschiedlicher Länge für Sie vorbereitet.

4.4 E-Mails

Auch in der Bestätigungsmail sollte die verwendete Zahlungsart neben den bestellten Waren bzw. Dienstleistungen noch einmal aufgeführt werden. Achten Sie darauf, dass Ihr E-Mail-Template keine Überweisungsaufforderung oder ähnliches enthält, um Kunden nach dem Kauf nicht zu verunsichern. Ein Beispiel für eine ausführliche Zahlungsartbeschreibung in der Bestätigunsmail finden Sie unter Textvorlagen.

4.5 Werbemittel

Zusätzliche Werbemittel für Newsletter, Blogs oder Ankündigungen in Ihrem Online-Shop finden Sie unter Banner.

5. Livebetrieb

5.1 Umschalten auf Livebetrieb

Damit Bestellungen über Barzahlen abgerechnet werden können, öffenen Sie im Administrationsbereich Ihres Online-Shops erneut die Konfiguration für das Barzahlen-Zahlungsmodul. Deaktivieren Sie anschließend den Testmodus.

Sichern Sie die Einstellung anschließend mit einem Klick auf Aktualisieren. Dadurch werden alle Anfragen an die produktive API gesendet, welche die übertragenen Daten sichert und die Zahlungsabwicklung gewährleistet.

5.2 Zahlungen verwalten

Rufen Sie Ihre Bestellungen wie gewohnt mit der JTL WaWi ab.

5.2.1 ausstehend

Jede neue Bestellung wird im Status unbezahlt angelegt. Der Kunde erhält nach dem Abschluss des Bestellvorgangs einen Zahlschein, welchen er bei einem Offline-Partner bezahlen kann.

5.2.2 bezahlt

Sobald der Zahlschein beim stationären Partner gescannt und bezahlt wurde, kontaktiert Barzahlen den integrierten IPN-Controller des Zahlungsmoduls, sofern Sie eine Benachrichtigungs-URL im Händlerbereich eingegeben haben. Die Benachrichtigung wird validiert und bei erfolgreichem Abgleich wird die Bestellung mit dem Status bezahlt versehen. Die bestellte Ware ist bezahlt und kann versendet werden.

5.2.3 abgelaufen

Bezahlt der Kunde die Bestellung mithilfe des Zahlscheins nicht innerhalb der vorgegebenen Zeitspanne, erhält das Zahlungsmodul eine entsprechende Benachrichtigung. Der Bestellstatus wird automatisch auf "Storno" gesetzt. Sie können die Bestellung direkt im WaWi löschen. Selektieren Sie dazu die entsprechende Zeile und klicken Sie auf der rechten Seite den Button Löschen.

5.2.4 Zahlschein stornieren

Wenn ein Kunde sich umentscheidet und noch vor Ablauf der Zahlungsfrist die Bestellung storniert oder Sie eine Fake-Bestellung ausmachen, sollten Sie den Zahlschein im Control Center (https://controlcenter.barzahlen.de) stornieren.

6. Fehlerbehandlung

6.1 Übertragungsfehler bei der Bestellung

Bei einer Bestellabwicklung startet das Barzahlen Modul bei einer fehlerhaften oder keiner Rückmeldung vom Server einen zweiten Versuch. Sofern auch der zweite Versuch nicht erfolgreich ist, wird der Kunde zurück zur Auswahl der Zahlungsweise geleitet und kann dort eine Alternative auswählen, um die Bestellung abzuschließen.

Der Grund für den Fehler wird in diesem Fall im Fehler-Log hinterlegt und liefert Ihnen später Aufschluss über die Ursache.

6.2 Error-Logging

Alle aufgetretenen Fehler werden vom Modul automatisch zusammen mit Zeitpunkt und relevanten Daten in die Fehlerdatei barzahlen.log gespeichert. Sie finden diese im Unterordner jtllogs/.

6.3 Erste Hilfe

In der folgenden Tabelle finden Sie Fehlermeldungen, die Sie unter Umständen selbst sehr schnell und einfach beheben können.

"bad request" Wahrscheinlich verwenden Sie eine alte Version des Plugins. Aktualisieren Sie auf die letzte verfügbare Version und testen Sie das Plugin erneut.
"shop not found" Der Barzahlen Server hat die angegebene Shop ID nicht zuordnen können. Bitte überprüfen Sie die eingetragene Shop ID.
"hash not recognized"
oder
"hash comparison failed"
Der gesendete Hash konnte nicht verifiziert werden. Bitte überprüfen Sie die eingetragene Shop ID sowie den Zahlungsschlüssel mit den Daten, die Sie im Control Center finden. (https://controlcenter.barzahlen.de)
"transaction not found"
oder
"refund not found"
oder
"order not found"
Sie erhalten eine dieser Fehlermeldungen, wenn beim Bearbeiten einer Benachrichtigung die Bestellung, die Transaktion oder die Rückzahlung nicht im System gefunden wurde. Stellen Sie sicher, dass Sie den gesuchten Eintrag nicht bereits entfernt haben.
"Warning: error_log(...) failed to open stream: Permission denied" Die notwendigen Dateiberechtigungen für das Log-Verzeichnis sind nicht korrekt (777) gesetzt. Beheben Sie das Problem, wie im Abschnitt Einstellungen auf dem Webserver im Kapitel Vorbereitung beschrieben.

Sollten Sie andere Fehlermeldungen erhalten oder sollten die vorgeschlagenen Lösungsschritte keine Abhilfe schaffen, zögern Sie nicht, den Support zu kontaktieren.

7. Deinstallation

Information

Bitte beachten Sie, dass Sie nach erfolgter Deaktivierung bzw. Deinstallation des Moduls keine Statusänderungen zu offenen Transaktionen erhalten. Diese sind jedoch jederzeit im Händlerbereich (https://partner.barzahlen.de) aufrufbar.

7.1 Temporär deaktivieren

Öffnen Sie im Administrationsbereich des JTL Shop 3 den Unterpunkt Plugins / Pluginverwaltung.

Wählen Sie anschließend das Barzahlen Plugin aus und klicken Sie auf Deaktivieren.

7.2 Deinstallieren

Öffnen Sie im Administrationsbereich des JTL Shop 3 den Unterpunkt Plugins / Pluginverwaltung.

Wählen Sie anschließend das Barzahlen Plugin aus und klicken Sie auf Deinstallieren.

7.3 Komplett löschen

Führen Sie eine Deinstallation, wie im vorhergehenden Punkt beschrieben, durch. Löschen Sie anschließend den Ordner barzahlen aus dem Shopsystem-Ordner includes / plugins.

8. Plugin Update

Laden Sie sich die aktuellste Version des Zahlungsplugins von Barzahlen herunter. Entpacken Sie das geladene Archiv. Im Unterordner src befindet sich der Plugin-Ordner barzahlen, welcher die Datei info.xml und das Verzeichnis version enthält. Kopieren Sie den Ordner barzahlen in den Unterordner includes/plugins/ Ihres Shopsystems.

Öffnen Sie anschließend den Administrationsbereich Ihres Onlineshops. Wählen Sie in der Menüleiste Plugins / Pluginverwaltung. In der Liste der installierten Plugins werden Sie auf das Update hingewiesen.

Klicken Sie auf Updaten. Das Update wird automatisch installiert.

Wählen Sie in der Menüleiste aus dem Bereich Kaufabwicklung den Unterpunkt Zahlungsarten aus.

Suchen Sie aus der Liste der Zahlungsarten Barzahlen heraus und klicken Sie auf einstellen.

Prüfen Sie die Einstellungen und sichern Sie die Einstellungen mit einem Klick auf speichern.

9. Support

Das Team von Barzahlen steht Ihnen bei jeglichen Fragen gern zur Verfügung.

Sie können uns eine E-Mail an support@barzahlen.de senden oder das Kontaktformular verwenden. Ihre E-Mail wird daraufhin in unserem Ticket-System direkt dem zuständigen Mitarbeiter zugeordnet und bearbeitet.