Dokumentation Barzahlen Plugin für modified

Inhalt

1. Installation

1.1 Download

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

Entpacken Sie das geladene Archiv in einen Ordner Ihrer Wahl. Der Unterordner src enthält mehrere PHP- und TXT-Dateien, eingepasst in eine Ordnerstruktur, die der Ordnerstruktur des Webshops auf Ihrem Webserver entspricht.

  • admin
  • callback
  • includes
  • lang
  • log
  • templates

1.2 Einfügen in das Dateisystem

1.2.1 Inhalte der TXT-Dateien einfügen

In den Textdokumenten sind Quellcodeteile enthalten, welche in die vorhandenen Kerndateien eingepasst werden müssen, um einen störungsfreien Ablauf zu garantieren.

checkout_success_php.txt

Fügen Sie den Inhalt in die Datei checkout_success.php im Hauptverzeichnis Ihres Shop hinter der Zeile „$order_status = $orders['orders_status'];“ ein.

$order_status = $orders['orders_status'];

//BOF - Barzahlen - 2013-01-28: Barzahlen Checkout-Page
$payment_query = xtc_db_query("SELECT payment_method FROM ".TABLE_ORDERS." WHERE orders_id = '".$last_order."' LIMIT 1");
$payment = xtc_db_fetch_array($payment_query);
if($payment['payment_method'] === 'barzahlen') {
    if (isset($_SESSION['infotext-1'])) {
        $smarty->assign('INFOTEXT_1',$_SESSION['infotext-1']);
        unset($_SESSION['infotext-1']);
    }
}
//EOF - Barzahlen - 2013-01-28: Barzahlen Checkout-Page

template/[your_template]/module/checkout_success_html.txt

Achten Sie darauf, das aktuelle Template Ihres Shops auszuwählen. Fügen Sie den Inhalt in die Datei checkout_success.html, welche sich im Unterordner module Ihres Templates befindet, an die Stelle in, wo sie die Barzahlen Informationen anzeigen wollen.

<!--BOF - Barzahlen - 2013-01-28: Barzahlen Checkout-Page-->
{if $INFOTEXT_1 != ''}
{$INFOTEXT_1}
{/if}
<!--EOF - Barzahlen - 2013-01-28: Barzahlen Checkout-Page-->

admin/start_php.txt

Fügen Sie den Inhalt in die Datei start.php im admin-Verzeichnis Ihres Shop nach der Zeile "<?php include(DIR_WS_MODULES.FILENAME_SECURITY_CHECK); ?>" ein.

<?php include(DIR_WS_MODULES.FILENAME_SECURITY_CHECK); ?>

<!--BOF - Barzahlen - 2013-05-17: Barzahlen Version Check-->
<?php include(DIR_WS_MODULES . "barzahlen_version_check.php"); ?>
<!--EOF - Barzahlen - 2013-05-17: Barzahlen Version Check-->

1.2.2 PHP-Dateien und Log-Datei einfügen

Fügen Sie alle die Dateien, die nicht auf .txt enden, in die bestehende Ordnerstruktur Ihres Webshops ein.

1.3 Einstellungen auf dem Webserver

Stellen Sie sicher, dass der Unterordner log in Ihrem Shopverzeichnis die Berechtigung 777 besitzt. Um die Berechtigungen zu ändern oder genauer Informationen zu erhalten, führen Sie einen Rechtsklick in Ihrem FTP-Programm auf den Ordner aus und wählen Sie Dateiberechtigungen.

Falls nicht bereits eingestellt, ändern Sie die Berechtigungen auf 777.

2. Konfiguration

2.1 Modul aktivieren

Loggen Sie sich in den Administrationsbereich Ihres Onlineshops ein und wählen Sie in der Menüleiste Module / Zahlungsoptionen aus.

Klicken Sie anschließend auf Barzahlen, um es aus der Liste der Zahlungsoptionen auszuwählen. Es erscheint eine Infobox, in welcher das Modul kurz erläutert wird, auf der rechten Seite und ein Button für die Installation.

Betätigen Sie diesen Button und das Modul wird installiert.

2.2 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 callback/barzahlen/callback.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/callback/barzahlen/callback.php

2.3 Modul konfigurieren

Klicken Sie auf den Button Bearbeiten. Geben Sie im oberen Bereich die Daten für Shop-ID, Zahlungsschüssel und Benachrichtigungsschlüssel, welche Sie nach Ihrer Registrierung im Händlerbereich (https://partner.barzahlen.de) erhalten haben, ein.

Geben Sie den maximalen Betrag ein, bis zu welchem Sie Bestellungen mit Barzahlen akzeptieren wollen. Verwenden Sie als Trennzeichen zwischen Euro und Cent einen Punkt ("."). Bitte bedenken Sie, dass Zahlungen mit Barzahlen unter 1000 Euro liegen müssen, demzufolge ist der maximal mögliche Betrag 999.99 Euro.

Fahren Sie im unteren Bereich fort, indem Sie dort den verschiedenen Barzahlen Status einen Bestellstatus zuweisen. Die gewählten Status werden Bestellungen automatisch zugewiesen, wenn sich am Status der Barzahlen Transaktion etwas ändert.

Information

Zusätzliche Bestellstatus können Sie unter Konfiguration / Bestellstatus festlegen. Klicken Sie auf den Button Einfügen, welcher sich unter der Tabelle befindet. Geben Sie die Titel des neuen Status in den gewünschten Sprachen an und bestätigen Sie anschließend mit einem Klick auf Einfügen.

Am Ende der Einstellungsspalte gibt es noch die Möglichkeit, ein erweitertes Logging einzustellen. Besonders, wenn es zu Problemen kommt, kann diese Einstellung helfen, schneller Probleme zu lokalisieren. Nachdem Sie alle Einstellungen vorgenommen haben, setzten Sie die Einstellung Barzahlen Modul aktivieren auf True und wählen den Button Aktualisieren. Lassen Sie den Test-Modus vorerst eingeschaltet, um das Modul anschließend testen zu können.

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 callback/barzahlen/callback.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/callback/barzahlen/callback.php

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

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 Status abgelaufen gesetzt.

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 log/.

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

7.1 Temporär deaktivieren

Um das Barzahlen Plugin lediglich temporär als Zahlungsweise zu deaktivieren, wählen Sie in der Menüleiste Module / Zahlungsoptionen. Selektieren Sie das Barzahlen Modul und klicken Sie auf den Button Bearbeiten. Wählen Sie unter der Option Barzahlen Modul, aktivieren Sie False und sichern Sie ihre Einstellung anschließend mit Klick auf Aktualisieren. Sie erhalten zu bereits erstellten Transaktionen Statusänderungen (z.B. wenn ein Kunde bezahlt), auch wenn das Zahlungsmodul für neue Bestellungen deaktiviert ist.

7.2 Deinstallieren

Information

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

Falls Sie Barzahlen deinstallieren möchten, wählen Sie an gleicher Stelle (Module / Zahlungsoptionen) das Barzahlen Modul aus und klicken auf den Button Deinstallieren. Das Plugin wird dadurch automatisch deinstalliert. Bitte beachten Sie, dass eine Deinstallation zum Verlust der getätigten Einstellungen führt.

7.3 Komplett löschen

Um das Modul vollständig aus Ihrem Shop zu löschen, führen Sie zuerst eine Deinstallation durch. Danach sind folgende Ordner und Dateien aus der Struktur Ihres Shopsystems zu entfernen:

  • /admin/includes/modules/barzahlen
  • /admin/includes/modules/barzahlen_version_check.php
  • /callback/barzahlen/
  • /includes/modules/payment/barzahlen.php
  • /includes/modules/payment/ca-bundle.crt
  • /lang/english/modules/payment/barzahlen.php
  • /lang/german/modules/payment/barzahlen.php
  • /log/barzahlen.log

Weiterhin können Sie die Tabelle barzahlen_transactions aus Ihrer Shopdatenbank löschen. Abschließend sollten Sie die zugefügten Quellcodeteile aus den folgenden Dateien entfernen:

  • /admin/start.php
  • /checkout_success.php
  • /template/[your_template]/module/checkout_success.html

8. Plugin Update

Information

Ab Version 1.1.6 des Barzahlen Plugins werden Sie in wöchentlichen Abständen über Updates automatisch nach dem Login in den Administrationsbereich informiert.

Um das Plugin auf eine neue Version zu aktualisieren, öffnen Sie zuerst den Administrationsbereich Ihres Onlineshops ein und wählen Sie in der Menüleiste Module / Zahlungsoptionen aus.

Wählen Sie Barzahlen aus der Liste aus und klicken Sie anschließend auf den Button . Getätigte Bestellungen mit Barzahlen bleiben erhalten und werden nach dem Update auch wieder durch Benachrichtigungen aktualisiert. Laden Sie sich die aktuelle Version des Plugins herunter und entpacken Sie diese in einen Ordner ihrer Wahl. Führen Sie anschließend die Installation des Plugins wie im Nutzerhandbuch beschrieben durch. Achten Sie besonders darauf, die unter Inhalte der TXT-Dateien einfügen beschriebenen Quellcodeteile zu aktualisieren. Bestätigen Sie beim Hochladen das Überschreiben der alten Dateien.

Loggen Sie sich erneut in den Administrationsbereich Ihres Onlineshops ein und wählen Sie in der Menüleiste Module / Zahlungsoptionen aus. Klicken Sie anschließend auf Barzahlen und klicken Sie auf den Button . Fahren Sie anschließend, wie im Kapitel Konfiguration beschrieben, mit dem Setzen der Einstellungen fort.

8.1 Update auf Version 1.1.0+

Löschen Sie gegebenfalls die alte barzahlen.log Datei aus dem Webshop-Verzeichnis /includes/modules/payment.

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.