1Einleitung

Diese Anleitung beschreibt die Installation, die Konfiguration und die Nutzung der Zahlungserweiterung für OXID und Opayo.

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

• Sie sollten von Opayo einen Händlernamen, Benutzernamen sowie ein Passwort für die Live und Test Plattform erhalten haben
• OXID Zahlungsmodul von sellxed.com/shop
• Zugangsdaten zu Ihrem Server und Shop

Falls Sie noch nicht im Besitze eines Vertrags mit Opayo 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 Test-Administrationsoberfläche von Opayo. Sie finden die Tetplattform unter https://test.sagepay.com/mysagepay/loginpage.msp
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, verlangen Sie die Liveschaltung Ihres Account bei Opayo. Mit den erhaltenen Zugangsdaten können Sie sich nun in der Live Umgebung einloggen. Die Live Umgebung finden Sie unter folgender URL: https://live.sagepay.com/mysagepay/loginpage.msp

1.2System Anforderungen

• 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 Opayo - Backend

Loggen Sie sich für die Konfiguration bei Opayo im Administration Tool (MySagePay) ein:

• Test Umgebung: https://test.sagepay.com/mysagepay/loginpage.msp
• Live Umgebung: https://live.sagepay.com/mysagepay/loginpage.msp

Die Parameter welche auf den folgenden Seiten eingestellt werden sind Voraussetzung für die spätere Konfiguration des Hauptmoduls.

2.1Gültige IPs

Damit Sie von Ihrem Shop auf die Payment Page von SagePay zugreifen können muss die IP Ihres Servers bei SagePay als gültige IP eingetragen werden.

2.1.1Identifizieren der IP Adresse Ihres Shops

In einem ersten Schritt müssen Sie die IP Adresse Ihres Shops herausfinden. Dafür haben wir auf der Informationsseite des Plugins für Sie die Anzeige der IP eingebaut. Öffnen Sie dafür die About Seite des Plugins.

Alternativ erfragen Sie Ihre IP einfach direkt bei Ihrem Hoster Ihrer Website.

Abbildung 2.1: Hier ein Beispiel der About Seite mit IP von Magento

2.1.2Eintragen der gültigen IP

Klicken Sie nun auf Hinzufügen und tragen Sie die oben identifizierte IP Adresse ein. Als Subnetzmaske tragen Sie 255.255.255.000 ein.

Abbildung 2.1: Hinzufügen einer IP

3Modul Installation im OXID 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 OXID 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.

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.

4Modul Konfiguration im OXID 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.

4.1Konfiguration des Hauptmoduls

Sie finden die Einstellungen des Hauptmoduls unter Erweiterungen > Module . Installieren Sie das Modul indem Sie auf Aktivieren klicken.

Mit einem Klick auf das Tab Einstellungen gelangen Sie in die Konfiguration des Hauptmoduls. Tragen Sie hier die Daten in die einzelnen Felder ein. Die benötigten Daten haben Sie entweder bereits im Backend von Opayo eingetragen oder von Opayo erhalten. Jede Option wird zudem mit einem kurzen Info Text im Shop nochmals erläutert.

4.1.1Einstellungen

4.1.1.1Update Intervall für Zahlungen

Bezahlungen können periodisch aktualisiert werden (Intervall in Minuten). Um dieses Feature verwenden zu können müssen Sie ein Cron Job einrichten.

4.1.1.2Erstellen der Bestellung

Wählen, wenn die Bestellung erstellt werden soll. Wenn auf 'Before Payment' gesetzt, Bestellungen werden in jedem Fall erstellt. Wenn auf 'After Payment' gesetzt, Bestellung wird nur erstellt, wenn die Bezahlung erfolgreich ist.

4.1.1.3Bestell-ID

Benutze diese Einstellung um die Eindeutigkeit bei der Bestell-ID vorzutäuschen, auch wenn diese nicht gegeben ist.

4.1.1.4Bestellungen im Fehlerfall löschen

Ja zum Löschen der Bestellung setzten, falls die Autorisierung fehlschlägt. Ansonsten den Bestellstatus zu 'PAYMENT_FAILED' setzen.

4.1.1.5Logging Level

Log-Meldungen dieser Stufe oder höher werden gespeichert.

4.1.2OXID 6 Installation

Nachdem das Plugin via S/FTP hochgeladen wurde müssen Sie sich mit SSH mit dem Server verbinden. In dem Hauptverzeichniss von OXID müssen Sie folgende Befehle ausführen damit das Plugin verfügbar ist:

command vendor/console/bin oe:module:install-configuration source/modules/customweb/sagepaycw/

php vendor/bin/oe-console oe:module:activate sagepaycw

php vendor/bin/oe-console oe:module:apply-configuration

4.2Konfiguration der Zahlungsart

Nachdem das Hautpmodul erfolgreich konfiguriert wurde, finden Sie unter Shopeinstellungen > Zahlungsarten die Einstellungen zu den einzelnen Zahlungsarten in Ihrem Shop. Jede Zahlungsart wird Ihnen einzeln aufgelistet.

Installieren Sie jene Zahlungsmethoden, welche Sie Ihren Kunden anbieten möchten. Öffnen Sie die Zahlungsart und setzen Sie bei Aktiv ein Häcklein.

Mit dem Klick auf Opayo Konfiguration können Sie für jede Zahlungsart individuelle Einstellungen vornehmen und so die Zahlung optimal an Ihre Prozesse anpassen.

4.3Direktes 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.

4.4Unsicherer 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.4.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.5Optional: 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 Opayo während dem Autorisierungsprozess. Die Zahlungsmethode wird auf jeden Fall angezeigt.

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 Opayo 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.

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

Bestellungen mit dem Status 'pending Opayo' 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 Opayo blockiert werden. In diesem Fall überprüfen Sie die Einstellungen Ihrer Firewall und bitten den Hoster die IPs und User Agents von Opayo 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.3Opayo Authorisierungsmethoden

Payment Page (Server) und iFrame (Server mit iFrame) sind die Authorisierungsmethoden, für welche keine PCI-zertifizierung erforderlich ist. Auf der Produktbeschreibungseite können Sie die Zahlarten und die konfigurierbaren Authrosierungsmethoden in Echtzeit einsehn. Bei der Authorisierungsmethode Server Authorisierung (Direct) handelt es sich um eine Integrationen, welche eine PCI Zeritifizierung verlangen. Sehen Sie von diesen Integrationen daher unbedingt ab, wenn Sie nicht PCI zertifiziert sind.

5.3.1Wahl der Autorisationsmethode - nationale Zahlarten

Sie haben die Wahl zwischen der Integration via InFrame oder Payment Page. Wenn Sie die nationalen Zahlungsverfahren wie ELV, Sofortüberweisung, etc. nutzen möchten, müssen Sie Payment Page als Autorisationsmethode wählen.

5.3.2Betrugserkennungsregeln

Sie haben die Möglichkeit Bestellungen nach gewissen Kriterien zu filtern und anschliessend vom System markieren zu lassen. Dafür wählen Sie die Regelkombination, welche - kumulativ erfüllt - dazu führt, dass die Bestellungen in einen Wartezustand zur manuellen Prüfung verschoben werden.

Abbildung 5.1: Fraud Rules Konfiguration.

5.4Opayo PayPal

Sie haben die Möglichkeit PayPal ebenfalls via Opayo abzuwickeln. Dazu muss die Zahlungsart in Ihrem Konto aktiviert werden.

Folgen Sie für die Konfiguration den Integrationshandbücher von Opayo. Diese Finden Sie im Administrationsbereich (MySagePay) unter dem Tab 'Zahlungsarten'.

6Das Modul in Aktion

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

6.1Nützliche Transaktionsinformationen zur Bestellung

Sie finden in jeder Bestellung, die mit unserem Modul abgewickelt wurde, im Tab Opayo Transaktionen eine Übersicht über die wichtigsten Informationen zur Bestellung zugehörigen Transaktion. Unter anderem erlauben diese Informationen die eindeutige Zuordnung der Bestellungen zu den Transaktionen, welche Sie bei Opayo im Backend sehen.

Abbildung 6.1: Transaktionsinformationen in OXID eSales

6.2Nutzung des Alias Managers / Token Lösung

Mit dem Alias Manager können Kreditkarten Ihrer Kunden für spätere Einkäufe sicher bei Opayo 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 Integration in OXID eSales

6.3Verbuchen / Stornieren von Bestellungen

Mit unserem Modul können Sie Bestellungen direkt in OXID eSales verbuchen ohne sich bei Opayo einzuloggen.

6.3.1Verbuchen von Bestellungen

Um Bestellungen zu verbuchen, öffnen Sie den Transaktionstab (Opayo Transaktionen). Mit dem Klick auf den Knopf Buchen öffnet sich ein neues Fenster in welchem Sie Transaktionen verbuchen können.

Sie können nun jeden Artikel einzeln verbuchen, sofern Sie nicht alle Artikel auf einmal versenden können. Die Anzahl der Verbuchung von Teilbeträgen hängt von Ihrem Vertrag ab. Erkundingen Sie sich diesbezüglich direkt bei Opayo.

Falls Sie nicht alle Artikel der Bestellung verbuchen wollen, können Sie die Transaktion durch anklicken des Kästchens auch für spätere Verbuchungen schliessen.

Abbildung 6.1: Verbuchen von Bestellungen in OXID eSales.

6.3.2Bestellungen stornieren

Mit dem Klick auf Abbuch erfolgt ein Storno der Transaktion und der reservierte Betrag wird auf der Karte Ihres Kunden sofort freigegeben.

6.4Rückvergüten von Bestellungen

Um Bestellungen rückzuvergüten, öffnen Sie den Transaktionstab (Opayo Transaktionen). Klicken Sie auf den Knopf "Rückvergüten" und es öffnet sich ein neues Fenster.

Sie können jeden einzelnen Artikel oder einen beliebigen Betrag rückerstatten indem Sie die Totalbeträge oder die Anzahl Artikel anpassen.

Abbildung 6.1: Refunds in OXID eSales für Opayo.

Durch das Ausführen einer Gutschrift wird der Zustand der Bestellung nicht verändert.

6.5Einrichten Cron Job

Um die zeitgesteuerten Funktionen des Plugins zu aktivieren (bspw. Update Service, Löschen pendenteter Bestellungen, etc.) müssen Sie in OXID Cron Jobs einrichten. Insbesondere die Update funktion ermöglicht Ihnen nachträgliche Änderungen der Transaktion bei Opayo über die API abzuholen (Bitte beachten Sie es kann sein, dass hier zusätzliche Optionen freigeschaltet werden müssen.

Damit die zeitgesteuerten Aktionen durchgeführt werden richten Sie bitte einen Cron Job in Ihrem Server auf folgenden Controller ein:

http://urltoyourstore.com/index.php?cl=sagepaycw_cron

Wir empfehlen Ihnen hier eine Cron Engine wie beispielsweise EasyCron. Damit können Sie die Datei (URL) mit einem externen Service aufrufen.

7Testing

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

7.1Testdaten

8Fehler 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

8.1Die Referrer URL erscheint in meinem Analytics Tool

Unter Umständen kann die Referrer URL von Opayo 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.

9Kompatibilität zu Third-Party Plugins

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

9.1Geburtstag und Geschlecht in OXID

Für gewisse Zahlungsanbieter ist es nötig den Geburtstag sowie das Geschlecht des Kunden zu prüfen. OXID tut dies standartmässig nicht. Sie können diese Abfrage unter "Settings > Other Settings > Mandatory fields in User Registration Form" aktivieren.

10Error 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.

10.1Log Levels

You can configure the log level in the Opayo settings.

• Error: Logs unexpected errors only. (Default)
• Info: Logs extended information.
• Debug: Logs information helpful for debugging.

10.2Log Location

The log file is stored in the OXID log directory. Please make sure the folder and it is writable by the webserver. (Default Path: {shopRootDirectory}/logs/)

11Erweiterte 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.

11.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.

require_once dirname(__FILE__) . "/bootstrap.php";

require_once 'modules/customweb/sagepaycw/classes/SagePayCwHelper.php';

$transactionById = SagePayCwHelper::loadTransaction(transactionId);
$transactionObject = $transactionById->getTransactionObject();