1Einleitung

Diese Anleitung beschreibt die Installation, die Konfiguration und die Nutzung der Zahlungsmoduls für Shopware und Open Payment Platform.

Bevor Sie mit der Installation beginnen können, stellen Sie sicher, dass Sie im Besitz aller notwendigen Daten sind:

  • Benutzername und Passwort zum Login des Backends von Open Payment Platform
  • Shopware Zahlungsmodul von sellxed.com/shop
  • Zugangsdaten zu Ihrem Server und Shop

Falls Sie noch nicht im Besitze eines Vertrags mit Open Payment Platform sind, können Sie diesen gerne auch direkt durch uns beziehen.

Beachten Sie, dass Sie für unsere Plugins mindestens die PHP Version 5.6 verwenden müssen. PHP 8 oder höher wird derzeit nicht unterstützt.

1.1Ablauf der Installation

In diesem Dokument erhalten Sie alle Informationen, welche für die Installation des Moduls notwendig sind. Für die Inbetriebnahme des Moduls sollten Sie die einzelnen Punkte der Checkliste strikt befolgen. Nur so kann ein sicherer Einsatz in Übereinstimmung mit allen Sicherheitsregularien gewährleistet werden.

  1. Konfiguration der Testoberfläche anhand der Integrationsdaten von Open Payment Platform. Sie finden die Tetplattform unter
  2. Konfiguration der Grundeinstellungen des Zahlungsmoduls
  3. Konfiguration der Zahlungsarten
  4. Durchführen einer Testbestellung anhand der beigelegten Testdaten am Ende dieses Dokuments
  5. Sofern der Test erfolgreich verlaufen ist, erfolgt die Konfiguration der Live Daten in Ihrem Shop. Mit den erhaltenen Zugangsdaten können Sie sich in der Live Umgebung einloggen:
Installationsservice

Unsere Zahlungsmodule sind standardmässig so vorkonfiguriert, dass die Installation gleich nach dem Eintragen der benötigten Keys funktionieren sollte. Sollten Sie einen Setting aus der Konfiguration des Moduls nicht kennen, können Sie sich gerne mit unserem Support in Verbindung setzen.

Unser Support Team steht Ihnen während der Geschäftszeiten gerne zur Verfügung: http://www.sellxed.com/support. Sie haben zudem jederzeit die Möglichkeit unseren Installationsservice zu bestellen. Wir sorgen für eine reibungslose Installation in Ihrem Shop: http://www.sellxed.com/shop/de/integration-und-installation.html

.htaccess Verzeichnisschutz

Für den Test des Zahlungsmoduls muss jeglicher Verzeichnisschutz oder IP Sperre auf Ihrem Server zwingend ausgeschaltet sein, sonst kann es sein, dass das Zahlungsfeedback von Open Payment Platform nicht bis zu Ihrem Shop durchdringt.

1.2System Anforderungen

Generell hat das Plugin die gleichen Anforderungen an das System wie Shopware selber. Nachfolgend finden Sie die wichtigsten Anforderungen des Plugins:
  • PHP Version: 5.4.x oder höher
  • OpenSSL: Aktuelle Version mit Unterstützung von TLS 1.2 oder höher.
  • fsockopen: Die PHP Funktion fsockopen muss zur Verfügung stehen. Das Plugin muss Verbindungen zu anderen Servern öffnen können.
  • PHP Funktionen: Im weiteren müssen alle gängigen PHP Funktionen zur Verfügung stehen.

2Konfiguration

2.1Grundkonfiguration des Hauptmoduls

Die Zugangsdaten für die Testumgebung erhalten Sie von Open Payment Platform.

Navigieren Sie zum Hauptmodul in Ihrem Shop und tragen dort die folgenden Zugangsdaten ein:

  • Authorization Bearer Token (Access Token)
  • Entity ID (CHANNEL ID )
  • Die Parameter User ID und User Password sind veraltet und werden nicht mehr benötigt, verwenden Sie stattdessen das Authorization Bearer Token.
  • Den Parameter Security Sender und Security und Hash Secret benötigen Sie für die vorligende Integration nicht mehr. Sie können diese Eingaben einfach ignorieren.
Abbildung 2.1: Die Authorization Bearer Token Information im Open Payment Platform Backend.

Daneben haben Sie noch weitere Eingabemöglichkeiten wie zum Beispiel die Custom Parameters. Diese lassen Sie grundsätzlich leer ausser Sie werden von Open Payment Platform zu einer Eingabe aufgefordert.

2.2Konfiguration Zahlungsarten

Um die Zahlungsarten zu aktivieren und weitere zahlartenspezifische Einstellungen vorzunehmen, navigieren Sie zu deren Einstellungen. (Wo Sie diese finden wird sonst hier erklärt.

Sie können in der Konfiguration der Zahlungsmethoden anhand der Regeln definieren, welche Entity ID (Channel ID) für welche Beträge verwendet werden soll. Dies ermöglicht Ihnen beispielsweise für kleinere Beträge einen non-3D Secure Channel zu verwenden. Für das Set Up und die entsprechenden Verträge setzen Sie sich mit Open Payment Platform in Verbindung.

Abbildung 2.1: Konfiguration der Zahlungsart am Beispiel Magento (Symbolbild, die Darstellung kann bei Ihnen abweichen).
PCI: Neue Autorisierungsmethode Widget

Beachten Sie, dass die Verwendung des Hidden Mode an zusätzliche Zertifizierungsanfoderderungen geknüpft ist (vgl unser Blogeintrag zu diesem Thema). Aus diesem Grund wird dieser in den neuen Versionen nicht mehr ausgeliefert. Sollten Sie in Ihren Zahlmethoden noch den Hidden Mode verwenden. Nutzen Sie zukünftig bitte nur noch Widget. Der Hidden Mode Support wird in den kommenden Monaten eingestellt.

2.3Konfiguration Webhook

In Ausnahmefällen kann es passieren, dass die Zahlungsbenachrichtigung an Ihren Shop fehlgschlägt, weil diese nicht bis zu Ihrem Shop durchdringt oder der Käufer den Browser unmittelbar nach dem Kauf schliesst. Hierzu empfehlen wir ein sogenanntes Webhook im Open Payment Platform Backend unter Administration > Webbhook einzurichten. Bitte achten Sie darauf, dass Sie die von unserem Modul dynamisch konfigurierte URL verwenden. Diese URL entnehmen Sie dem installieren Modul in Ihrem Shopware Shop unter Configuration > Open Payment Platform > Setup.

2.3.1Konfiguration Webhook durch Händler

Wenn Sie das Webhook nicht durch Open Payment Platform konfigurieren lassen können, müssten Sie bitte wie wie oben beschrieben, die URL aus Ihrem Shopware Shop unter Configuration > Open Payment Platform > Setup kopieren und das Open Payment Platform Backend unter Administration > Webbhook einfügen. Des weiteren müssten Sie bitte ein selbst festgelegtes "secret for encryption" generieren und die Werte in die darauf folgenden Felder, wie auf dem Bild unten zu Sehen, speichern.

Customweb "secret for encryption" Generator

Bitte beachten Sie, dass für den Schlüssel nur ASCII Zeichen verwendet werden dürfen. Damit Sie keine unerlaubten Zeichen benutzen, verwenden Sie bitte unseren Schlüssel Generator

Abbildung 2.1: Open Payment Platform Webhook Beispielkonfiguration in Ihrem Backend unter Administration > Webbhook.

2.3.2Konfiguration Webhook durch Open Payment Platform

Wenn Sie das Webhook durch Open Payment Platform konfigurieren lassen können, müssten Sie bitte wie wie oben beschrieben, die URL aus Ihrem Shopware Shop unter Configuration > Open Payment Platform > Setup an Open Payment Platform übermitteln. Open Payment Platform wird Ihnen anschliessend ein sog. "secret for encryption" zustellen, welches Sie bitte in der Hauptmodulkofniguration des Moduls speichern müssten.

2.4Aktivierung und Testing

Nach der Aktivierung und der Konfiguration der Zahlungsarten führen Sie einen Test mittels der in der Anleitung publizierten Testdaten durch.

Sofern diese Tests erfolgreich verlaufen sind, schalten Sie den Operation Mode vom Testmodus in den "Live Mode" und ersetzen die obigen Sicherheitsmerkmale durch Ihre persönlichen Zugangsdaten für die Live Plattform. Diese Daten erhalten Sie direkt von Ihrem Payment Service Provider. In der Regel sollten USER ID etc für den Live Mode identisch sein.

3Modul Installation im Shopware Shop

3.1Installation

Sie sollten zu diesem Zeitpunkt bereits im Besitz des Moduls sein. Falls nicht erhalten Sie die Moduldateien in Ihrem Benutzerkonto im sellxed Shop (Menüpunkt "Meine Downloadartikel"). Um das Modul in Ihrem Shopware Shop zu installieren, führen Sie bitte folgende Schritte durch:

  1. Laden Sie das Plugin herunter. Den Download finden Sie in Ihrem sellxed.com Account unter "Meine Downloadartikel".
  2. Entpacken Sie das Archive, welches Sie heruntergeladen haben.
  3. Im entpackten Ordner finden Sie einen Ordner "files"
  4. Für einige Shops werden verschiedene Versionen des Plugins zur Verfügung gestellt.
  5. Laden Sie nun mit Ihrem preferierten FTP Programm den ganzen Inhalt dieses Ordners ins Stammverzeichnis Ihres Shops. Bei gewissen Shops gibt es einen spezifischen Ordner, welcher die Plugins enthält. Sollte dies der Fall sein laden Sie das Plugin in diesen Ordner hoch. Stellen Sie sicher, dass die Ordner nur zusammengeführt werden und nicht ersetzt.
  6. Falls nicht bereits geschehen, loggen Sie sich bitte in Ihrem Shop ein.

3.2Updates und Upgrades

Während der Supportdauer, erhalten Sie unbeschränkten Zugriff auf Updates und Upgrades in Ihrem Kundenkonto. Um über solche Updates informiert zu werden abonnieren Sie bitte den RSS-Feed. Mehr Informationen hierzu finden Sie hier: http://www.sellxed.com/de/updates_upgrades.

3.2.1Update Checklist

Bitte führen Sie vor jedem Update folgende Schritte durch:

  1. Erstellen Sie immer ein Backup der Files und der Datenbank, bevor Sie mit dem Update beginnen
  2. Testen Sie das Update auf einem Testsystem. Wir testen die Module intern, es kann aber sein, dass im Zusammenspiel mit anderen Plugins weitere Fehler auftreten.
  3. Warten Sie bis die Files vollständig auf den Server gespielt sind und besuchen Sie dann die Konfigurationsseite des Hauptmoduls. Falls vorhanden leeren Sie bitte auch noch alle Caches des Shopssystems

Je nach Update kann es sein, dass eine Datenbankmigration durchgeführt werden muss. Wir empfehlen Ihnen daher, dass Update zu einem Zeitpunkt durchzuführen, an dem nicht zu viele Kunden auf Ihrem Shop zugreifen.

Vorsicht bei Updates im Live Shop

Besondere Vorsicht ist bei Updates im Live Shop geboten. Testen Sie ein Update immer zuerst in einem Testsystem. Unser Support Team hilft Ihnen gerne bei Problemen. Bei Updates direkt im Live-System kann es jedoch zu unterbrüchen kommen, welche je nach Support Ressourcen bis zu 2 Tage dauern können.

3.2.2Update Instruktionen

Bevor Sie das Update aufspielen, lesen Sie bitte die Update Instruktionen. Diese finden sich am Ende der Pluginseite im Changelog. Sofern nichts weiteres in den Update Instruktionen steht, können die Files einfach überschrieben werden.

3.2.3Updaten des Plugin von der OPPCw zur CwbOPPCw Version.

Wir planen dieses Plguin in kürze im Showpare Store zu veröffentlichen. Damit dies möglich ist möglich ist musste unser Code angepasst werden. Die grössten Änderungen betreffen ein Prefix für unsere PHP Klassennamen, sowie das Umbennen des Plugin Ordners. Dadurch ist es nicht möglich ein Update durch einfaches überschrieben der existierenden Dateien durchzuführen. Dieser Abschnitt erklärt die benötigten Schritte für ein Update.

Vorsicht bei Updates im Live Shop

Bitte testen Sie ein Update zuerst in Ihrem Testsystem, damit Sie das Update verifizieren können.

Mehrere Plugins

Falls Sie mehrere Plugins von uns benutzn, müssen alle geupdated werden.If you are using multiple plugins from us. You need to update all of them to the new version.

  1. Den Wartungsmodus des Shops aktivieren.
  2. Erstellen Sie ein BackUp ihrer Datenbank und den Datein auf dem Server. Ohne dies können Sie bei einem Problem, nicht auf die alte Version zurückfallen.
  3. Laden Sie die neuen Dateien hoch.
  4. Deaktivieren Sie das existierende Plugin. Das Plugin noch nicht deinstallieren.
  5. Installieren und aktivieren Sie das neue Plugin.
  6. Falls Sie eigenes CSS oder Template Datein für unsere Modul haben, müssen Sie dies fürs neue Plugin anpassen.
  7. Falls Sie den Shopware API Endpoint dieses Plguins benutzen, müssen Sie die URL auf den neuen Endpoint ändern.
  8. Überprüfen Sie die Haupt-und Methodeneinstellungen.
  9. Deinstallieren Sie das alte Plugin.
  10. Löschen Sie die Dateien des alten Plugins. Die folgenden Dateien und Ordner müssen gelöscht werden falls sie existieren:
    • engine/Shopware/Plugins/Local/Frontend/OPPCw
    • engine/Library/Customweb
    • engine/Library/Crypt
    • engine/Library/File
    • engine/Library/Math
    • engine/Library/Mobile
    • engine/Library/Net
    • engine/Library/PhoneNumber
    • engine/Library/System
    • engine/Library/loader.php
    • engine/Library/openssl.cnf
  11. Führe Sie eine Testtransaktion durch, um das Update zu überprüfen.
  12. Den Wartungsmodus des Shops deaktivieren

4Modul Konfiguration im Shopware Shop

Die Konfiguration teilt sich in zwei Stufen. Der erste Schritt umfasst die Konfiguration des Hauptmoduls mit den Grundeinstellungen (vgl. Konfiguration des Hauptmoduls). In einem zweiten Schritt können für jede Zahlungsart individuelle Konfigurationen vorgenommen werden. Dies bringt Ihnen volle Flexibilität und grösste Anpassung an Ihre Prozesse.

Erstellen Sie Backups!

Bitte erstellen Sie auf jeden Fall ein Backup des Hauptverzeichnises Ihres Shops. Bei Problemen können Sie so jederzeit wieder zum Ursprungszustand zurückkehren.

Im Weiteren empfehlen wir Ihnen die Integration zuerst auf einem Testsystem durchzuführen. Es kann immer wieder zu Komplikationen mit von Ihnen installierten Drittmodulen kommen. Bei Fragen steht Ihnen unser kompetenter Support gerne zur Verfügung.

4.1Konfiguration des Hauptmoduls

Um das Hauptmodul zu installieren suchen Sie unter Einstellungen > Plugin Manager nach Open Payment Platform. Klicken Sie auf das + Symbol um den Installationsprozess zu starten. Anschliessend öffnen Sie mit dem Klick auf das "bearbeiten" Symbol die Einstellungsmaske und konfigurieren das Hauptmodul.

Tragen Sie die einzelnen Optionen ein, welche Sie teilweise bereits oben in der Konfiguration in der Administrationsoberfläche von Open Payment Platform festgelegt haben. Sollte Ihnen eine Option nicht klar sein, erhalten Sie durch klicken auf das Fragezeichen weitere Informationen zu den Einstellungen.

4.2Konfiguration der Zahlungsart

Nachdem das Hautpmodul erfolgreich konfiguriert wurde, finden Sie unter Einstellungen > Zahlungsarten alle mitgelieferten Zahlungsarten. Aktivieren Sie jede Zahlungsart, welche Sie im Shop anbieten möchten. Sie können für jede Zahlungsart pro Shop (im Falle eines Multishop Set-Ups) individuelle Einstellungen vornehmen und so die Zahlung optimal an Ihre Prozesse anpassen. Die zentralen Optionen werden in der Folge genauer erläutert.

Abbildung 4.1: Konfiguration der Zahlungsart.

4.3Zuordnung der Zahlungsart zu den Versandkosten

Damit die Transaktionen und Versandkosten richtig den Zahlungsweisen zugeordnet werden müssen Sie zwingend die Zahlungsarten den Versandarten zuordnen. Dafür Klicken Sie auf Einstellungen > Versandkosten. Öffnen Sie alle Versandkosten und fügen Sie unter Zahlungsartauswahl die Zahlungsart hinzu.

Abbildung 4.1: Zuordnung der Zahlungsart zur Versandart.
Zuordnung von Zahlungsmethoden zur Versandart

Abhängig von der Zahl der mitgelieferten Zahlungsarten kann es sein, dass Sie die Zahlungsarten nicht der Versandart zu ordnen können, weil nicht alle Zahlungsarten angezeigt werden können. Dies ist ein bekannter Fehler in Shopware. Es werden lediglich die ersten 30 Zahlungsarten angezeigt. Löschen Sie alle Zahlungsarten, welche Sie nicht verwenden und die anderen Zahlungsarten werden dann automatisch sichtbar.

4.4Direktes Verbuchen von Bestellungen

Mit der Option "Buchung" legen Sie fest, ob Zahlungen direkt verbucht, oder zuerst autorisiert werden. Sofern Sie in einem ersten Schritt nur autorisieren möchten, stellen Sie sicher, dass die Zahlungen später verbucht werden.

Eine Reservation ist, abhängig von Ihrem Acquiring Vertrag, nur eine gewisse Zeit garantiert. Sollten Sie in dieser Zeit nicht verbuchen, kann es sein, dass die Autorisierung nicht mehr garantiert wird. Weitere Informationen zum Prozess der Verbuchung finden Sie weiter unten.

Unterschiedliche Einstellungen zwischen Open Payment Platform - Backend und Modul

Es kann sein, dass die Einstellungen im Modul für die Zahlungsweise Ihre Einstellungen im Backend von Open Payment Platform einfach überschreiben.

4.5Unsicherer Status

Sie können Bestellungen, für welche die Zahlung noch nicht garantiert werden kann, speziell markieren. Dies erlaubt Ihnen diese Bestellung vor dem Versand noch einmal manuell zu prüfen.

4.5.1Setzen von Order-Status

Sie können für jede Zahlungsart festlegen in welchen Status die Bestellung je nach Buchungsstatus verschoben werden soll. Es handelt sich hier um den initialen Status der Bestellung.

4.6Optional: Validierung

Mit der Validierung steuern Sie den Zeitpunkt wann eine Zahlungsart im Checkout angezeigt werden soll. Diese Einstellung ist für Module relevant bei denen die Benutzung von Voraussetzungen Ihres Kunden abhängig ist. Beispielsweise wenn noch eine Bonitätsprüfung erfolgen soll, oder die Zahlungsart nur in gewissen Ländern verfügbar ist. Es kann sein, dass diese Einstellung bei Ihnen nicht ersichtlich ist. Dann überspringen Sie diesen Punkt. Damit die Bonitätsprüfung beziehungsweise Adressvalidierung auch mit europäischen Zeichen funktioniert, muss bei gewissen PSP-Einstellungen das Charset des "Blowfish mode" auf "UTF-8" gesetzt werden.

Sollte die Einstellung ersichtlich sein, haben Sie die Wahl zwischen folgenden Optionen:

  • Validierung vor Auswahl der Zahlungsmethode: Es erfolgt vor der Auswahl der Methode eine Validierungsprüfung. Sofern die Voraussetzungen nicht erfüllt sind, wird die Zahlungsart nicht angezeigt.
  • Validierung nach der Auswahl der Zahlungsmethode: Die Prüfung der Voraussetzung erfolgt nach der Wahl und vor der Bestätigung der Bestellung.
  • Während der Autorisierung: Die Validierungsprüfung erfolgt durch Open Payment Platform während dem Autorisierungsprozess. Die Zahlungsmethode wird auf jeden Fall angezeigt.

4.6.1Nutzung der integrierten Multi-Shop Funktionalität von Shopware

Das Zahlungsmodul unterstützt das Multishop Feature von Shopware. Wenn Sie mehrere Shops über dieselbe Administrationsoberfläche von Shopware verwalten sind keine weiteren Anpassungen in der Konfiguration notwendig. Das Modul erkennt automatisch, welchem Shop die Bestellung zugeordnet werden muss. Voraussetzung ist jedoch, dass die einzelnen Subshops innerhalb von Shopware richtig konfiguriert wurden.

5Einstellungen / Konfiguration von Zahlungsarten

5.1Allgemeine Informationen zu den Zahlungsarten

Das Plugin wird mit einer grossen Auswahl von Zahlungsarten ausgeliefert. Sollte eine Zahlungsart nicht verfügbar sein, bitten wir Sie sich mit uns in Verbindung zu setzen.

Für die Nutzung einer Zahlungsmethode muss die Zahlungsart in Ihrem Konto bei Open Payment Platform und im Shop aktiviert sein. Informationen zur Konfiguration des Zahlungsmoduls finden Sie weiter oben.

In den folgenden Punkten finden Sie wichtige Informationen zu bestimmten Zahlungsarten, die sich vom Standard unterscheiden.

5.2Informationen zum Zahlungszustand

Sie können für jede Zahlungsart den initialen Zahlungsstatus individuell definieren (Status für autorisierte Zahlungen etc). Dabei definieren Sie den Zahlungsstatus für die einzelnen Zustände abhängig von der Verarbeitungsart der Bestellung (verbucht, autorisiert, etc.). Es handelt sich dabei um den initialen Status, welcher die Bestellung annimmt. Abhängig von der durch Sie durchgeführten Mutationen kann sich der Status ändern.

Wichtige Info bezüglich dem Bestellstatus

Setzen Sie den Status nie auf Pending Open Payment Platform oder einen ähnlich lautenden pending status, der durch das Modul eingeführt wird.

5.2.1Bestellstatus "ausstehend" / bevorstehende Zahlung (oder ähnlich)

Bestellungen mit dem Status 'pending Open Payment Platform' sind pendente Bestellungen. Der Status wird gesetzt, wenn der Kunde für die Zahlung umgeleitet wird aber nicht erfolgreich zurückkehrt oder das Feedback nicht bis zu Ihrem Shop gekommen ist (Kunde hat das Fenster auf der Payment Page geschlossen und die Zahlung nicht abgeschlossen). Abhängig von der Zahlungsart werden diese Bestellungen automatisch in abgebrochene Bestellungen umgewandelt und der Lagerbestand wieder freigegeben (sofern der Cronjob Aktiviert ist). Diese Zeitspanne hängt von den Eigenheiten der Zahlungsart ab, und kann nicht konfiguriert werden.

Wenn Sie eine Vielzahl ausstehender Bestellungen haben, deutet dies in der Regel darauf hin, dass die Notifikationen von Ihrem Webserver zu Open Payment Platform blockiert werden. In diesem Fall überprüfen Sie die Einstellungen Ihrer Firewall und bitten den Hoster die IPs und User Agents von Open Payment Platform zu aktivieren.

5.2.2Abgebrochene / stornierte Bestellungen

Bestellungen, die als abgebrochen markiert werden, wurden wie oben beschrieben automatisch in diesen Status aufgrund des Timeouts versetzt. Abgebrochen werden aber auch alle Bestellungen, welche von den Kunden aktiv abgebrochen wurden.

5.3Klarna

Sie können Klarna direkt über Open Payment Platform abwickeln. Wir gehen in der Folge auf die Besonderheiten des Klarna Setups ein.

5.3.1Unterstützte / Nicht unterstützte Funktionen

Das Modul unterstützt folgende Funktionen nicht:

  • Es können keine Bestellungen im Backend von Shopware angelegt oder verändert werden.
  • Teilaktivierungen und Teilgutschriften können nur direkt aus dem Backend von Open Payment Platform erstellt werden. Aktivierungen oder Gutschriften der gesammten Rechnung sind innerhalb von Shopware möglich. Mehr Informationen dazu finden Sie im Kapitel Transaktionsmanagement.
Bearbeiten von Klarna Transaktionen in Shopware

Bitte beachten Sie, dass Sie in keinem Fall eine Klarna Transaktion in Shopware bearbeiten dürfen.

Die restlichen Funktionen können durch das Modul durchgeführt werden. Im Folgenden finden Sie eine Beschreibung der wichtigsten Funktionen.

5.3.2Set UP / Einrichten der Zahlart

Aktivieren Sie die Zahlart an gewohnter Stelle. Beachten Sie bitte folgendes bei der Installation:

5.3.2.1Anpassen des Anzeigenamens der Zahlart

Den angezeigten Namen im Frontend ändern Sie unter Titel. Bitte verwenden Sie den Titel Rechnung für die Zahlart. Im Weiteren definieren Sie unter Anzeigen des Logos, ob das Klarna Logo dem Kunden im Frontend entsprechend angezeigt wird.

5.3.2.2Anpassen der Zahlartbeschreibung

Die Beschreibung der Zahlart können Sie unter Description ändern. Bitte hinterlegen Sie hier folgenden Text: "In 14 Tagen bezahlen".

5.3.2.3Wahl der Autorisierungsmethode

Wir empfehlen Ihnen die Autorisierungsmethode in der Zahlart auf Server einszustellen. In diesem Fall findet keine Weiterleitung auf die Payment Page von Open Payment Platform statt und Sie können im Shop den gesamten Checkout Flow kontrollieren.

5.3.2.4Klarna Merchant ID

Tragen Sie in den Einstellungen der Zahlart die Klarna Merchant ID ein. Diese erhalten Sie entweder direkt von Open Payment Platform oder finden Sie in Ihrem Klarna Vertrag.

5.3.3Stornieren der Rechnung

Wie Sie Rechnungen stornieren können, wird weiter unten im Kapitel Verbuchen / Stornieren von Bestellungen beschrieben. Mehr Informationen dazu finden Sie im Kapitel Transaktionsmanagement.

Verzögerte Rechnungsaktivierung

Beachten Sie, dass Sie in der Einstellung der Zahlart sicherstellen müssen, dass die Rechnungserstellung auf verzögert eingestellt werden muss, damit Sie die Rechnungen in Shopware aktivieren können.

5.3.4Aktivierung von Rechnungen

Wie Sie Rechnungen aktivieren (verbuchen) können, wird weiter unten beschrieben. Mehr Informationen dazu finden Sie im Kapitel Transaktionsmanagement. Teilaktivierungen sind nur im BIP von Open Payment Platform möglich.

Verzögerte Rechnungsaktivierung

Beachten Sie, dass Sie in der Einstellung der Zahlart sicherstellen müssen, dass die Rechnungserstellung auf verzögert eingestellt werden muss, damit Sie die Rechnungen in Shopware aktivieren können.

5.3.5Teilgutschriften und Teilaktivierungen

Teilgutschriften und Teilaktivierungen können nur direkt im BIP von Open Payment Platform durchgeführt werden.

5.3.6On Hold Bestellungen (Pending)

Pending Bestellungen werden vom Modul nicht unterstützt. Damit diese vom System richtig gehandelt werden, müssen Sie im BIP für die Zahlungsart Klarna das "Status Check interval" Feld leerlassen. Bitte wenden Sie sich an Open Payment Platform um diese Einstellung vorzunehmen.

Sofern Sie dieses Szenario testen möchten, verweisen wir hier auf die Testinformationen von Klarna (vgl. unten)

5.3.7Testing

Um die Zahlart Klarna zu testen, sollten spezielle Testdaten verwendet werden. Stellen Sie aber zuerst sicher, dass der Operation Mode auf Test ist und der Testmode auf External.

Die offiziellen Testdaten von Klarna finden Sie direkt im Developper Portal von Klarna unter diesem Link: https://developers.klarna.com/en/de+php/kpm/test-credentials.

5.3.8Zahlungsgebühren

Sofern Sie Zahlungsgebühren für eine Zahlart erheben möchten, nutzen Sie bitte die kompatiblen Zahlungsgebühren Module. Diese Gebühren werden dann direkt an Klarna übertragen.

Zahlungsgebühren

Bitte beachten Sie, dass Sie keine Zahlungsgebühren im BIP von Open Payment Platform setzen dürfen. Dafür nutzen Sie bitte die kompatiblen Zahlungsgebühren Module.

6Das Modul in Aktion

In der Folge finden Sie eine Übersicht über die wichtigsten Funktionen im täglichen Gebrauch des Open Payment Platform Moduls.

6.1Verbuchen / Stornieren von Bestellungen

6.1.1Verbuchen von Bestellungen

Beachten Sie

Das Transaktionsmanagement zwischen Open Payment Platform und Shopware ist nicht synchronisiert. Wenn Sie Zahlungen bei Open Payment Platform verbuchen, wird der Status im Shop nicht angepasst und ein zweites Verbuchen im Shop ist nicht möglich.

Damit Sie Bestellungen verbuchen können, müssen Sie sicherstellen, dass Sie in den Einstellungen in der Zahlungsart die Verbuchung auf deferred eingestellt haben.

Öffnen Sie die Bestellung welche Sie verbuchen möchten und wechseln Sie in den Tab Transaktionen. Innerhalb der Transaktionsansicht finden Sie den Tab Buchungen. Tragen Sie einen beliebigen Betrag ein welchen Sie der Kundenkarte belasten möchten. Mit dem Klick auf Buchen erfolgt eine direkte Verbuchung der Bestellung bei Open Payment Platform.

6.1.2Stornieren

Mit dem Klick auf den Button Stornieren löschen Sie die initiale Autorisation auf der Kundenkarte. Der vorautorisierte Betrag wird auf der Kreditkarte Ihres Kunden sofort entlastet.

Abbildung 6.1: Verbuchen/Stornieren von Bestellungen innerhalb von Shopware

6.2Nützliche Transaktionsinformationen zur Bestellung

Sie finden nach dem Öffnen jeder Bestellung, welche mit unser Modul abgewickelt wurde, eine Übersicht über die wichtigsten Informationen zur Transaktion, sowie eine Transaktionshistory, welche Aufschluss gibt, was bisher mit der Transaktion passiert ist.

Um zur Ansicht der Transaktionsinformationen zu gelangen öffnen Sie die Bestellung und welchseln Sie in den Tab Transaktionen. Hier finden Sie alle Autorisierungsversuche und dazugehörige Informationen.

Abbildung 6.1: Transaktionsinformationen innerhalb Shopware.

6.3Gutschriften

Für belastete Transaktionen können Sie Gutschriften direkt im Shop erstellen und automatisch an Open Payment Platform übermitteln. Zu diesem Zweck öffnen Sie die Bestellung. Wechseln Sie in den Tab Transaktionen. Es öffnet sich ein neues Fenster. Wechseln Sie anschliessend in den Tab Gutschriften um Bestellungen rückzuvergüten.

Um die Rückerstattung eines oder mehreren Artikel geben Sie die gewünschte Anzahl ein. Mit dem Klick auf Gutschreiben wird die Gutschriftsanfrage direkt an Open Payment Platform übermittelt. Diese wird dann über die vom Kunden für die Transaktion ausgewählte Zahlungsmethode rückerstattet.

Abbildung 6.1: Rückerstattungen von Bestellungen innerhalb von Shopware.

Bitte beachten Sie, dass Sie maximal 100% des ursprünglich gebuchten Betrags rückvergüten können.

Das Ausführen einer Gutschrift verändert nicht den Status der Bestellung.

6.4Nutzung des Alias Managers / Token Lösung

Mit dem Alias Manager können Kreditkarten Ihrer Kunden für spätere Einkäufe sicher bei Open Payment Platform gespeichert werden. Die Nutzung wird aktiviert indem Sie die Option "Alias Manager" in der Konfiguration der Zahlungsart aktivieren. Für spätere Einkäufe kann der Kunde zwischen den bereits gespeicherten Karten wählen und muss so nicht die gesamte Karte nochmals erfassen.

Abbildung 6.1: Alias Manager Nutzung innerhalb von Shopware.
Bitte beachten Sie!

Die Nutzung des Alias Managers benötigt die Freischaltung der entsprechenden Option bei Open Payment Platform. Nehmen Sie dafür bitte direkt Kontakt mit dem Support von Open Payment Platform auf.

7Abrufen der Kreditkarteninformationen via Shopware REST API

Bei der Anbindung von ERP Systemen an Shopware kann es sein, dass Sie zusätzliche Informationen über die Shopware API benötigen. Unser Modul stellen Ihnen zahlreiche Zahlungsinformationen über die Shopware REST API zur Verfügung.

Informationen über die Verwendung der Shopware REST API finden Sie in der Shopware Developers Guide.

Der Service kann unter https://www.shop-url.com/path/to/shop/api/CwboppcwTransactions aufgerufen werden. Der Aufruf obiger URL führt dazu, dass alle Transaktionen aufgelistet werden. Sie können durch das Anhängen der Transaction ID nach der jeweiligen Transaktions ID filtern. Die Transaktions ID finden Sie in den Bestellungen (Customer > Payments > Open Payment Platform ).

Zusätzlich kann auch über die Payment ID (wird durch Open Payment Platform vergeben) auf die Transaktion zugegriffen werden. Dazu muss noch 'usePaymentId=1' as Parameter an die URL angehängt werden.

7.1Einrichten Cron Job

Um die zeitgesteuerten Funktionen des Plugins zu aktivieren (bspw. Update Service, Löschen pendenter Bestellungen, etc.) müssen Sie in Shopware Cron Jobs einrichten. Insbesondere die Update funktion ermöglicht Ihnen nachträgliche Änderungen der Transaktion bei Open Payment Platform über die API abzuholen. Für Zahlungsarten welche eine verzögerte Autorisierung verwenden wird dies zwingend benötigt. Es kan sein, dass hier zusätzliche Optionen freigeschaltet werden müssen.

Dass Modul verwendet den Standard Shopware Cron. Informationen zur Einrichtung finden Sie hier: https://community.shopware.com/Cronjobs_detail_1102.html.

8Testing

Bevor Sie vom Test Modus in den Live Modus wechseln, sollten Sie das Modul ausführlich testen.

Testen

Vergessen Sie nicht, nach erfoglreichem Testing den Betriebsmodus von Test auf Live umzustellen.

8.1Testdaten

Nachfolgend finden Sie die Testdaten für die Zahlungsmethoden:
American Express
Kartennummer
377777777777770
Verfallsdatum
12/2020
CVC:
123
No 3D Secure
Kartennummer
375987000000005
Verfallsdatum
12/2020
CVC:
123
3D Secure
Carte Bleue
Kartennummer
5555555555554444
Verfallsdatum
12/2020
CVC:
123
Dankort
Kartennummer
5019717010103742
Verfallsdatum
12/2020
CVC:
123
Diners Club
Kartennummer
36961903000009
Verfallsdatum
12/2020
CVC:
123
Sepa Direct Debits
IBAN
AT152011128161647502
BIC
GIBAATWWXXX
Austria (AT)
IBAN
DE23100000001234567890
BIC
MARKDEF1100
Germany (DE)
IBAN
ES9121000418450200051332
BIC
CAIXESBBXXX
Spain (ES)
Discover Card
Kartennummer
6011587918359498
Verfallsdatum
12/2020
CVC:
123
giropay
IBAN
AT152011128161647502
BIC
GIBAATWWXXX
Austria (AT)
IBAN
DE23100000001234567890
BIC
MARKDEF1100
Germany (DE)
IBAN
ES9121000418450200051332
BIC
CAIXESBBXXX
Spain (ES)
JCB
Kartennummer
3541599999092431
Verfallsdatum
12/2020
CVC:
123
Klarna Invoice
Klarna (Approved)
Klarna (Denied)
Klarna (Pending -> Approved)
Klarna (Pending -> Denied)
Maestro
Kartennummer
6799851000000032
Verfallsdatum
12/2021
CVC:
123
MasterCard
Kartennummer
5454545454545454
Verfallsdatum
12/2021
CVC:
123
No 3D Secure
Kartennummer
5212345678901234
Verfallsdatum
12/2021
CVC:
123
3D Secure
Visa
Kartennummer
4200000000000000
Verfallsdatum
12/2020
CVC:
123
No 3D Secure
Kartennummer
4012001037461114
Verfallsdatum
12/2020
CVC:
123
3D Secure
Kartennummer
4000000000000010
Verfallsdatum
12/2021
CVC:
123
3D Secure 2.0
V PAY
Kartennummer
4822000000000000003
Verfallsdatum
12/2020
CVC:
123

9Fehler und deren Lösungen

Sie finden ausführliche Informationen unter http://www.sellxed.com/de/faq. Sollte sich Ihr Problem mit den zur Verfügung gestellten Informationen nicht lösen lassen, melden Sie sich bitte direkt bei uns: http://www.sellxed.com/de/support

9.1Die Referrer URL erscheint in meinem Analytics Tool

Unter Umständen kann die Referrer URL von Open Payment Platform fälschlicherweise im Analytics Tool erscheinen. Dies passiert, wenn der Kunde mit einer HTTP Header Weiterleitung zurück in den Shop geleitet wird. Die meisten Analytic Tools können dieses Problem jedoch minimieren, indem die entsprechende URL aus dem Report ausgeschlossen wird.

Für Google Analytics hilft dieses Step-by-Step Guide am Beispiel von PayPal: Weitere Infos sind unter Punkt 4 beschrieben.

10Kompatibilität zu Third-Party Plugins

Unten aufgeführte Plugins sind kompatibel mit unseren Zahlungsmodulen und erleichtern Ihnen in gewissen Bereichen die Arbeit.

10.1Geburtstag und Geschlecht in Shopware

Für gewisse Zahlungsanbieter ist es nötig den Geburtstag sowie das Geschlecht des Kunden zu prüfen. Shopware tut dies standartmässig nicht. Um diese Abfrgaen zu aktivieren navigieren Sie zu "Einstellungen > Grundeinstellungen > Frontend > Anmeldung / Registrierung" und aktivieren die folgenden Parameter:

  • Geburtstag anzeigen
  • Geburtstag ist ein Pflichtfeld
  • Anrede anzeigen

11Error Logging

Das Modul logged verschiedene unerwartete Fehler und sonstige Fehler abhängig vom konfigurierten Logging Level. Sollte es ein Problem mit dem Modul geben kann das Log Hinweise auf dessen Ursache liefern.

12Erweiterte Informationen

Dieser Abschnitt des Manuals beinhaltet Informationen für Anwender mit speziellen Anforderungen. Sämtliche hier aufgeführte Informationen und Konfigurationen sind optional und für die normale Verwendung des Plugins nicht erforderlich.

12.1Transaction Object

In diesem Abschnitt finden Sie Informationen wie Sie Daten zu einer Transaktion aus der Datenbank auslesen können um diese, z.B. in einem ERP System, weiter zu verarbeiten.

Für die Code Snippets in diesem Abschnitt wird angenommen, dass sich Ihr Script im Stammordner des Shops, in einer Standart Ordnerstruktur befindet.

Initialisieren Sie Shopware in Ihrem Script, dies ist nötig um die Verbindung zur Datenbank herzustellen.
require __DIR__ . '/autoload.php';
use Shopware\Kernel;
$environment = 'production';
$kernel = new Kernel($environment, false);
$kernel->boot();
Registrieren Sie die Modulklassen.
$pluginPath = 'engine/Shopware/Plugins/Local/Frontend/CwbOPPCw';
Shopware()->Loader()->registerNamespace('Customweb', 'Customweb/');
Shopware()->Loader()->registerNamespace('CwbOPPCw_Helpers', $pluginPath . '/Helpers/');
Shopware()->Loader()->registerNamespace('CwbOPPCw_Entities', $pluginPath . '/Entities/');
Shopware()->Loader()->registerNamespace('CwbOPPCw_Components', $pluginPath . '/Components/');
Shopware()->Loader()->registerNamespace('Shopware\Components\Api', $pluginPath . '/Components/Api/');

require_once $pluginPath . '/Library/loader.php';
Customweb_Core_Util_Class::registerClassLoader(function ($className){
	return Shopware()->Loader()->loadClass($className);
});	
Damit alte Transaktionen geladen werden können, muss ein Lgacy Classloader registriert werden.
	Customweb_Core_Util_Class::registerClassLoader(function($className){
		if(strpos($className, 'OPPCw') === 0){
			$fileName = substr($className, strrpos($className, '_')+1).".php";
			if(file_exists('engine/Shopware/Plugins/Local/Frontend/CwbOPPCw/Legacy/'.$fileName)){
				require_once 'engine/Shopware/Plugins/Local/Frontend/CwbOPPCw/Legacy/'.$fileName;
				return true;
			}
		}
		return false;
	});
	
Nun können Sie die Transaktion laden und das transactionObject extrahieren.
Laden der Transaktion per Id:
$transactionById =  CwbOPPCw_Helpers_Util::loadTransaction($transactionId);
$transactionObject = $transactionById->getTransactionObject();