1Einleitung

Diese Anleitung beschreibt die Installation, die Konfiguration und die Nutzung des Zahlungsmoduls für Gambio und EMS eCommerce Gateway.

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

• Sie sollten von EMS eCommerce Gateway eine Store-ID (in der Regel 11-stellige Zahlenkombination) erhalten haben.
• Shared Secret für die Nutzung von Connect (Shared Secret Connect Interface)
• Sofern Sie im Besitz der professional Version des Moduls sind und die API Schnittstelle bei EMS eCommerce Gateway beantragt haben, haben Sie zusätzlich eine API UserId, ein Client Zertifikat und die zugehörigen Passwörter erhalten.

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 Grundeinstellungen des Zahlungsmoduls
2. Konfiguration der Zahlungsarten
3. Durchführung einer Testbestellung anhand der beigelegten Testdaten am Ende dieses Dokuments

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 EMS eCommerce Gateway

Wenn Sie nur die Standard Version des Moduls erworben haben, dann müssen Sie nur den Teil Konfiguration des Moduls befolgen.

2.1Test und Live Plattform zur Administration

Die Administration und Transaktionsansicht finden Sie unter folgendem Link:

• https://www.ipg-online.com/emea/login.jsp?lng=de_DE.

Bitte beachten Sie, dass Sie auf die Testplattform nur mit entsprechendem Client Zertifikat welches Sie von EMS eCommerce Gateway erhalten, zugreifen können.

2.2Pflicht: Konfiguration des Moduls

Navigieren Sie in das Hauptmodul in Ihrem Shop. Tragen Sie an der entsprechenden Stelle bitte folgende Daten ein:

• Store ID (erhalten Sie direkt von EMS eCommerce Gateway)
• Shared Secret (erhalten Sie direkt von EMS eCommerce Gateway)

Die restlichen Einstellungen im Hauptmodul betreffen sepzielle Betrugseinstellungen zur Kennzeichnung von Transaktionen ohne 3D Secure. Die Default Einstellungen sind hier für die meisten korrekt eingestellt.

2.3Optional: Professional Version - Erstellen einer Zertifikatsdatei

Mit der Professional Version des Moduls können Sie das Transaktionsmangement direkt aus Ihrem Shop verwalten. Somit ersparen Sie sich die Installation der Zertifikate für den Zugriff auf das Backend. Damit Sie diese Funktionen nutzen können, müssen Sie ursprünglich unter www.sellxed.com/shop die Professional Version des Moduls erworben haben. Sonst stehen Ihnen diese Features nicht zur Verfügung. Um auf die Professional Version zu wechseln treten Sie mit uns in Kontakt.

Sie erhalten von EMS eCommerce Gateway für die Nutzung des Backends und des Transaktionsmanagements ein ZIP, welches den Schlüssel (Dateiendung .key) sowie das Zertifikat (Dateiendung .pem) enthält. Entpacken Sie diese Dateien in ein Verzeichnis Ihrer Wahl und führen dann folgende Schritte durch:

1. Öffnen Sie das Zertifikat (Datei mit der Endung .pem)
2. Öffnen Sie gleichzeitig den Schlüssel (Datei mit der Endung .key)
3. Fügen Sie den Inhalt des Schlüssels unterhalb der Zertifikatsdatei ein.
4. Speichern Sie die Zeritifkatsdatei und kopieren Sie die Datei nach: admin/includes/cw-libs/Customweb/EMSeCommerce/Certificates/Default/
5. Sie können nun den Installationsinstruktionen folgen.

2.4Aktivieren der Zahlungsarten und Testing

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 mittels der publizierten Testdaten in der Anleitung durch. Sofern alle Tests erfolgreich verlaufen Sind, schalten Sie im Hauptmodul den Betriebsmodus auf Live.

3Modul Installation im Gambio 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 Gambio 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.2Sprache

1. Navigieren Sie im entpackten Ordner zum Ordner "lang"
2. Laden Sie mit Ihrem bevorzugten FTP-Client den gesamten Inhalt dieses Ordners in das lang-Verzeichnis Ihres Shops hoch. Stellen Sie sicher, dass die Inhalte nicht überschrieben, sondern nur zusammengeführt werden.

3.3Updates 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.3.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.3.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 Gambio 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 "Module > Modul-Center > EMS eCommerce Gateway Base Module" . Installieren Sie das Modul und klicken Sie auf Tragen Sie auf "Hauptkonfiguration öffnen". Es sollte sich nun ein neues Fenster öffnen. Tragen Sie hier die einzelnen Optionen ein, welche Sie teilweise bereits oben in der Konfiguration in der Administrationsoberfläche von EMS eCommerce Gateway festgelegt haben. Sollte Ihnen eine Option nicht klar sein, erhalten Sie durch klicken auf das Fragezeichen weitere Informationen zu den Einstellungen. Die zentralsten Einstellungen werden hier nochmals kurz erwähnt.

4.1.1Ausstehende Bestellungen erstellen

Sie haben die Möglichkeit ausstehende Bestellungen zu erstellen. In diesem Fall wird in Ihrem Shop eine temporäre Bestellung angelegt mit dem Status "bevorstehende Zahlung". Dies ermöglicht, dass der Warenbestand in Ihrem Shop blockiert wird und an EMS eCommerce Gateway jeweils die identische Bestellnummer wie im Shop übermittelt werden kann. Sollte der Kunde den Kauf jedoch abbrechen bleibt die Bestellung bestehen, ausser Sie aktivieren die Option abgebrochene Bestellungen entfernen. Dies führt dazu, dass die abgebrochenen Bestellungen regelmässig gelöscht werden. Wenn Sie keine ausstehenden Bestellungen erstellen möchten bleiben Sie beim Standardverhalten von xt:Commerce. In diesem Fall ist es jedoch auch nicht mögich, dass die Referenz (Zahlungsid) bei EMS eCommerce Gateway der Bestellnummer im Shop entspricht. Es steht Ihnen jedoch frei beide Varianten zu benutzen.

4.1.2Datenbank Codierung

Wenn Sie beim Anlegen Ihrer Datenbank nicht UTF-8 als Standard gewählt haben, kann dies zu Codierungsproblemen bei Parametern mit Umlauten führen. Wählen Sie in diesem Fall die Option, dass die Daten noch UTF-8 Codiert werden bevor diese zu EMS eCommerce Gateway gesendet werden.

4.2Direktes 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.3Unsicherer 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.3.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.4Optional: 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 EMS eCommerce Gateway 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 EMS eCommerce Gateway 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 EMS eCommerce Gateway' 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 EMS eCommerce Gateway blockiert werden. In diesem Fall überprüfen Sie die Einstellungen Ihrer Firewall und bitten den Hoster die IPs und User Agents von EMS eCommerce Gateway 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.2.3Code Anpassungen für die Integration von MasterPass (Gambio GX 1.x)

Wenn Sie Gambio GX 2.x verwenden sind die folgenden Code Anpassungen für Sie nicht relevant.

Damit der Button "Zahlen mit MasterPass" beim Warenkorb für die Verwendung des External Checkouts mit Adressübergabe erscheint, müssen Sie bitte folgenden Anpassungen am Code durchführen. Wenn Sie MasterPass nur als normale Zahlungsart ohne Adressübergabe verwenden möchten, sind keine Änderungen nötig.

Sie finden im Zip in Ordner /changes/*.txt die Dateien mit den notwendigen Änderungen. Bitte kopieren Sie den Code dieser Dateien an die jeweilige Stelle wie unten beschrieben.

5.2.3.1Anpassungen im File: shopping_cart.php

Bitte kopieren Sie den Codeschnipsel, den Sie in der Datei in /changes/shopping_cart.php.txt finden, vor folgenden Code:

$smarty->assign('language', $_SESSION['language']); (ca. auf Zeile 140)

5.2.3.2Anpassungen im Files templates/[current-active-template]/module/shopping_cart.html

Bitte kopieren Sie den Code denn Sie in der Datei /changes/shopping_cart.html.txt finden vor die die Stelle vor dem Tag-{/if}:

5.2.4Diverses

Die Zahlungsart MasterPass mit External Checkout kann nicht in Zusammenhang mit Gutscheinen verwendet werden. Wenn der Kunde einen Gutschein einlösen will, dann muss der Standard Checkout durchlaufen werden.

6Das Modul in Aktion

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

Abbildung 6.1: Transaktionsinformationen

6.1Nützliche Transaktionsinformationen zur Bestellung

Sie finden in jeder Bestellung, die mit unserem Plugin abgewickelt wurde, eine Übersicht über die wichtigsten Informationen zur Transaktion. Unter anderem erlauben diese Informationen die eindeutige Zuordnung der Bestellungen zu den Transaktionen, welche Sie bei EMS eCommerce Gateway im Backend sehen.

Abbildung 6.1: Transaktionsinformationen.

6.2Zahlungen im Gambio Backend auslösen

Mit dem Gambio Zahlungsmodul können Sie Bestellungen auch direkt aus dem Shop auslösen, sogenannte Mail Order / Telephone Order (MOTO).

1. Gehen in die Kundenübersicht und aktivieren Sie einen Kunden. Durch Klick auf "Bestellung anlegen" öffnet sich ein neues Fenster zur Erfassung der Bestellung.
2. Klicken Sie auf Bearbeiten und wählen Sie Artikel und Artikeloptionen sowie Zahlunsgweisen aus.
3. Im Feld Zahlungsart, wählen Sie die gewünschte Zahlungsart und klicken auf "Bestellung abschliessen".
4. Abhängig von der Autorisierungsart, welche Sie bei der ausgewählten Zahlungsart hinterlegt haben, öffnet sich die Payment Page von EMS eCommerce Gateway oder eine Eingabe für die Kreditkarte wie im Bild unten. Erfassen Sie die Kreditkarte Ihres Kunden.

6.2.1Rückvergüten von Bestellungen

Um Bestellungen rückzuvergüten, öffnen Sie die Transaktionsinformationen (vgl. oben). Sie erhalten Sie Informationen zur Transaktion dargestellt. Klicken Sie auf 'Rückerstattung' und wählen Sie den Artikel aus, den Sie zurückerstatten möchten. Mit einem Klick auf 'Rückerstattung' wird der Refund Request an EMS eCommerce Gateway übermittelt.

Abbildung 6.1: Rückerstattung

Das Auslösen einer Gutschrift verändert den Zustand der Bestellung nicht.

6.3Verbuchen / Stornieren von Bestellungen

6.3.1Verbuchen / stornieren von Bestellungen

Um Bestellungen zu verbuchen, öffnen Sie die Transaktionsinformationen (vgl. oben). Sie erhalten Sie Informationen zur Transaktion dargestellt. Weiter unten finden Sie ein Input Feld in welchem Sie den Betrag den Sie verbuchen möchten angeben können. Mit einem Klick auf "verbuchen" wird die Buchung an EMS eCommerce Gateway übermittelt. Sie brauchen sich nicht mehr in das Backend von EMS eCommerce Gateway einzuloggen.

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

Abbildung 6.1: capture oder cancel button.

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 EMS eCommerce Gateway gespeichert werden. Die Nutzung wird aktiviert indem Sie die Option "Alias Manager" in der Konfiguration derZahlungsart 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

6.5Einrichten Cron Job

Um die zeitgesteuerten Funktionen des Plugins zu aktivieren (bspw. Update Service, Löschen pendenteter Bestellungen, etc.), richten Sie in Ihrem Hosting einen zeitgesteuerten Request auf die Datei emsecommercecw_cron.php ein. Der regelmässige Aufruf löst die entsprechenden Aktionen aus. Wir raten zu einem generellen Itervall von ca. 15 Minuten

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 EMS eCommerce Gateway 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.

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.

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.

include ('includes/application_top.php');

require_once DIR_FS_DOCUMENT_ROOT.'admin/includes/EMSeCommerceCw/init.php';
require_once DIR_FS_DOCUMENT_ROOT.'admin/includes/EMSeCommerceCw/classes/EMSeCommerceCw/Entity/Util.php';

$transactionById = EMSeCommerceCw_Entity_Util::findTransactionByTransactionId($transactionId);
$transactionObject = $transactionById->getTransactionObject();

$transactionById = EMSeCommerceCw_Entity_Util::findTransactionEntityByTransactionExternalId($externalId);
$transactionObject = $transactionById->getTransactionObject();

$transactionsByOrderId = EMSeCommerceCw_Entity_Util::findTransactionsEntityByOrderId($orderId);
foreach($transactionsByOrderId as $transaction){
	$transactionObject = $transaction->getTransactionObject();
	//Do something with each object
}