1Einleitung

Diese Anleitung beschreibt die Installation, Konfiguration und Nutzung des Zahlungsmoduls für OXID und Trustly.

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

  • Trustly Username und Passwort
  • Trustly RSA Private Key
  • OXID Zahlungsmodul von sellxed.com/shop
  • Zugangsdaten zu Ihrem Server und Shop

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, die 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. Bevor Sie mit der Einrichtugn des Moduls beginnen können, brauchen Sie zwingend Username und Passwort, welches Sie von Ihrem Integration Manager erhalten.
  2. Generieren Sie einen neuen RSA Private und RSA Public Key
  3. Konfiguration des Hauptmoduls
  4. Konfiguration der akzeptierten Zahlungsarten inkl. Authorisationsmethoden
  5. Durchführung einer Testbestellung
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 Trustly nicht bis zu Ihrem Shop durchdringt.

1.2System Anforderungen

Generell hat das Plugin die gleichen Anforderungen an das System wie OXID 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.

1.3Konfiguration des Hauptmoduls

Für die Inbetriebnahme des Hauptmoduls müssen Sie als Erstes einen Public und Private RSA Schlüssel generieren. Sie müssen den generierten RSA Public Key anschliessend am Trustly Integration Manager senden. Sie erhalten danach einen Benutzernamen und ein Passwort, die während der Hauptkonfiguration des Moduls benötigt werden.

1.3.1Erstellen eines RSA Private und Public Keys

Sie finden unter Extensions > Trustly einen RSA Key Generator. Sie finden einen Generator für Live und Test Zertifikate. Hier können Sie entweder ein neues Keypair generieren oder den Public Key hier herunterladen. Der Private Key ist sicher in der Konfiguration des Moduls hinterlegt. Klicken Sie auf Download um den Public Key zu downloaden. Diesen senden Sie in der Folge an Ihren Kontakt bei Trustly zur Aktivierung.

1.3.2Konfiguration Username und Passwort

Für die Konfiguration des Hauptmoduls müssen Sie Ihr Passwort und Username, welches Sie von Ihrem Trustly Integration Manager erhalten haben, im Backend von ihrem Shopsystem eingeben.

1.3.3Wichtiger Hinweis für Händler im Finanzdienstleistungssektor

Sollten Sie im finanziellen Dienstleistungssektor tätig sein, müssen Sie zusätzlich im Backend die Option Mobile Phone Number auf "Mobile is Required" umstellen.

1.4Konfiguration der Zahlungsarten

Weitere Informationen zu den Konfiguration der Zahlungsarten und der Bedeutung der einzelnen Einstellungen finden Sie hier. Nach Aktivierung und der Konfiguration der Zahlungsarten führen Sie einen Test durch.

1.5Aktivierung des Kontos

Nach erfolgreicher Durchführung der Tests beantragen Sie direkt bei Ihrem Integrations Manager die Aktivierung Ihres Accounts. Tragen Sie die neu erhaltenen Live Credentials für die Live Umgebung im Hauptmodul ein. Generieren Sie ebenfalls für den Live Zugang ein entsprechendes Keypair und senden dieses wiederum Ihrem Kontkat bei Trustly zu.

2Modul Installation im OXID Shop

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

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

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

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

3Modul 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.

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.

3.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 Trustly eingetragen oder von Trustly erhalten. Jede Option wird zudem mit einem kurzen Info Text im Shop nochmals erläutert.

3.1.1Einstellungen

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

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

3.1.1.3Bestell-ID

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

Ändern der Einstellungen 'Erstellen der Bestellung' und 'Bestell-ID'

Das Ändern dieser Einstellungen wenn Transaktionen bereits angelegt wurden kann dazu führen dass doppelte IDs vergeben werden und Transaktionen nicht korrekt verarbeitet werden. Wenn Sie diese Einstellungen ändern müssen Sie die Datenbanktabelle welche die Transaktionen des Moduls enthalten leeren.

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

3.1.1.5Logging Level

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

3.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/trustlycw/

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

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

3.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 Trustly Konfiguration können Sie für jede Zahlungsart individuelle Einstellungen vornehmen und so die Zahlung optimal an Ihre Prozesse anpassen.

Zahlungsarten nicht im Checkout verfügbar

Sollten die einzelnen Zahlugnsweisen nicht im Checkout angezeigt werden, überprüfen Sie ob, die Zahlungsart den Ländern sowie den Kundengruppen zugewiesen wurde.

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

Unterschiedliche Einstellungen zwischen Trustly - Backend und Modul

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

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

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

3.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 Trustly während dem Autorisierungsprozess. Die Zahlungsmethode wird auf jeden Fall angezeigt.

4Einstellungen / Konfiguration von Zahlungsarten

4.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 Trustly 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.

4.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 Trustly oder einen ähnlich lautenden pending status, der durch das Modul eingeführt wird.

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

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

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

5Das Modul in Aktion

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

5.1Nützliche Transaktionsinformationen zur Bestellung

Sie finden in jeder Bestellung, die mit unserem Modul abgewickelt wurde, im Tab Trustly 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 Trustly im Backend sehen.

Abbildung 5.1: Transaktionsinformationen in OXID eSales

5.2Rückvergüten von Bestellungen

Um Bestellungen rückzuvergüten, öffnen Sie den Transaktionstab (Trustly 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 5.1: Refunds in OXID eSales für Trustly.
Maximaler Refund

Mit unserem Zahlungsmodul können Sie nie mehr als 100% des ursprünglich autorisierten Betrages zurückerstatten.

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

5.3Einrichten 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 Trustly ü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=trustlycw_cron

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

6Testing

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.

6.1Testdaten

Nachfolgend finden Sie die Testdaten für die Zahlungsmethoden:

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

7.1Die Referrer URL erscheint in meinem Analytics Tool

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

8Kompatibilität zu Third-Party Plugins

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

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

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

9.1Log Levels

You can configure the log level in the Trustly settings.

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

9.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/)

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

10.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 OXID in Ihrem Script, dies ist nötig um die Verbindung zur Datenbank herzustellen.
require_once dirname(__FILE__) . "/bootstrap.php";
Inkludiern Sie die Modulklassen.
require_once 'modules/customweb/trustlycw/classes/TrustlyCwHelper.php';
Nun können Sie die Transaktion laden und das transactionObject extrahieren.
Laden der Transaktion per Id:
$transactionById = TrustlyCwHelper::loadTransaction(transactionId);
$transactionObject = $transactionById->getTransactionObject();