Dokumentation modified Shop Plugin

Maintenance on 02/25/2021 from 7:00 am to 9:00 am. This can lead to severe restrictions and failures in our services.

Maintenance work on February 25th, 2021 from 7:00 a.m. - 9:00 a.m.

modified Shop-Plugin

Available payment methods for this shop version:

payment plugin

Checkliste

Folgende Schritte sind notwendig um die Micropayment Zahlmodule zu implementieren. Alle Details zur Integration finden Sie im weiteren Verlauf dieser Anleitung.

1
Melden Sie sich kostenlos und unverbindlich im Micropayment-ControlCenter an.
2
Legen Sie im Micropayment-Händlerzugang Ihr/e Projekt/e unter
Konfiguration → Projekte
an. Die angemeldeten Projekte werden von unserem Risk-Team schnellstmöglich überprüft.
3
Aktivieren Sie Ihr Projekt. Nachdem Sie alle Einstellungen vorgenommen haben, sind alle Zahlungsarten im Testmodus verfügbar.
4
Beantragen Sie die benötigten Zahlungsarten unter
Kundendaten → Vertragsinformationen → Zahlungsarten.
5
Konfigurieren Sie die gewünschten Zahlungsarten unter
Konfiguration → Zahlungsarten.
6
Nach der Legitimation des Accounts steht Ihnen unser Service vollumfänglich für den LIVE-Betrieb zur Verfügung

Sie haben jederzeit die Möglichkeit, alle Zahlarten im Testmodus zu nutzen. Sollten Sie dazu Fragen haben, steht Ihnen unser Support-Team jederzeit zur Verfügung

Installation

Für die Installation der Bezahlmodule benötigen Sie Zugriff auf die Dateien der Shopsoftware.
Üblicherweise loggen Sie sich hierfür per FTP auf Ihrem Server ein.

Installationsbeginn:

SICHERN SIE BITTE IHR GESAMTES SHOPVERZEICHNIS SOWIE DIE DATENBANK IHRES SHOPS.

Vorwort:
Für die Installation der Bezahlmodule benötigen Sie Zugriff auf die Dateien der Shopsoftware. Üblicherweise loggen Sie sich hierfür per FTP auf ihren Server ein.

Installationsbeginn:
Kopieren Sie alle Dateien aus dem zip-Archiv (mit bestehender Verzeichnis-Hierarchie) in Ihr Shop-Hauptverzeichnis. Bestehende Dateien aus der Oxid eCommerce Software werden dabei nicht überschrieben.

Ausnahme:
Falls Sie bereits ein micropayment™-Modul installiert haben, löschen Sie dieses bitte, BEVOR Sie das neue Modul installieren!

1
Verbinden Sie sich mit dem Dateisystem Ihres Webservers - meist über FTP.
2
Entpacken Sie das Modul-Archiv auf Ihren Computer.
3
Laden Sie den Inhalt anschließend in das Hauptverzeichnis von Modified. Die Verzeichnisse „callback, images, includes und lang“ sollten dabei überschrieben werden. Es werden KEINE vorhandenen Dateien überschrieben
4
Im Ordner „callback“ sollte nun ein „micropayment“ Ordner vorhanden sein.
5
Loggen Sie sich in den Adminbereich Ihres Shops ein und navigieren sie zur Auswahl Module → Zahlungsoptionen.
6
Dort sollten nun die Module von Micropayment angezeigt werden. Die Module heißen „Micropayment Kreditkarte, Micropayment Lastschrift, Micropayment Sofortüberweisung und Micropayment Vorkasse“.
7
Wählen Sie das gewünschte Modul aus, klicken Sie rechts auf „Installieren“ und anschließend auf „Bearbeiten“ um das Modul wie folgt zu konfigurieren:

modified Micropayment Plugin Konfiguration

Konfiguration der Zahlungsarten im Modified Backend

Nachdem Sie das jeweilige Modul installiert haben, müssen Sie für die korrekte Funktionsweise noch einige Optionen anpassen. Gehen Sie dazu in den Administrations Bereich des Shops, und wählen Sie unter „Module -> Zahlungsoptionen“ das Modul aus, für welches Sie die Optionen anpassen wollen.

Button: Bestellung aufräumen
Ein Button, der alle Bestellungen mit dem Status „Bezahlung steht aus / pending payment“ löscht, die X Tage alt sind. So können nicht-abgeschlossene Bestellungen manuell entfernt werden.

Konfiguration der Zahlungsarten im Modified Backend — Folgende Optionen stehen zur Auswahl

Einstellungen der einzelnen Felder in der Micropayment-Konfigurationsmaske:

Status
Aktivieren (True) Sie hier das Bezahlmodul, um es im Shop verfügbar zu machen.

Mindestbestellwert
Geben Sie hier den Mindestbestellwert ein. Oder eine 0 für keinen Mindestbestellwert

Maximalbestellwert
Geben Sie hier den Maximalbestellwert ein. Oder eine 0 für keinen Maximalbestellwert.

Positionierung
Geben Sie hier die Position an, an der die Bezahlart im Shop angezeigt werden soll. 1 ist oben; umso höher die Zahl, desto tiefer wird das Bezahlmodul angezeigt.

Länderauswahl
Geben Sie hier ein, in welchen Ländern das Bezahlmodul zur Verfügung steht. Falls Sie mehrere Länder angeben möchten, trennen Sie die Länder mit einem Komma z.B.: de, en. Falls Sie keine Einschränkung vornehmen wollen, lassen Sie das Feld leer.

Account-ID
Geben Sie hier Ihre 5-stellige Account-ID von Micropayment ein.

Projekt Kürzel (ID)
Rufen Sie im Micropayment Controlcenter unter Konfiguration → Projekte das Projekt auf und kopieren Sie das dort angegebene Kürzel.

Micropayment Plugin Konfiguration Einstellungen

Accesskey
Dieser ist im Micropayment Controlcenter unter Konfiguration → Accesskey zu finden.

Test Modus
Aktiviert bzw. deaktiviert den Testmodus

Freitext / Bezahltext
Verwendungszweck der Buchung. Wenn leer, wird nur die Bestellnummer [orderId] genutzt. Optional kann ein eigener Text hinzugefügt werden. Beispiel: „[orderId] - Ihr Kauf auf www.ihre-shopurl.de“.

Theme Template
Es stehen die Themes X1 (default) oder X2 für die Darstellung bei Weiterleitungen zur Verfügung. Mehr Informationen über die Themes finden Sie im Micropayment Controlcenter unter Hilfe → Bezahlfenster & Themes

Micropayment Domain
wählen Sie hier je nach Ihrer Micropayment Account Nummer 0-49999 die Micropayment GmbH (.de) bzw. ab 50000-99999 die Micropayment AG (.ch) aus

Logo im Zahlfenster
Sie können im Micropayment Controlcenter (Tools → Bezahlfenster-Grafiken) eigene Logos (nur Theme X1) hinterlegen und den gfx-Code hier angeben.

Hintergrund Farbe
Hier tragen Sie ggf. einen abweichenden Farbcode (Hex-Wert) ein. Mehr Informationen finden Sie im Micropayment Controlcenter unter
Hilfe → Hintergrundgrafik

Hintergrundgrafik
Hier legen Sie die Hintergrundgrafik bei Weiterleitungen fest. Mehr Informationen finden Sie im Micropayment Controlcenter unter
Hilfe → Hintergrundgrafik

Geheimwort / Sicherheitsfeld
Das secretfield finden Sie im Micropayment Controlcenter unter
Konfiguration → Zahlungsarten → Zahlungsart Event → Projekt-konfigurieren → Parameter: Benachrichtigungs-URL → Option bearbeiten

Löschen von nicht bezahlten Bestellungen
Wie lang kann eine Bestellung sich noch im Status "Bezahlung steht aus" befinden, bevor Sie vom "Bestellung aufräumen" Button entfernt wird. Dies wird verwendet um festzusetzen wie alt eine Bestellung mindestens sein muss um von dem „Button: Bestellung aufräumen“ entfernt zu werden. Einstellungen zwischen 3-30 Tage sind möglich.

Sicherheitsfeld Name
Hier können Sie sich einen Feldnamen ausdenken, der für die Notifikations-API benutzt wird, um die Kommunikation zwischen den Servern zu sichern. Erlaubt sind Kleinbuchstaben und Zahlen. Sollten Sie einen eigenen Feldnamen verwenden, bitte den GET-Parameter im micropayment™ ControlCenter ebenfalls anpassen. Falls nicht wird „secretfield“ verwendet.

Sicherheitsfeld Wert
Hier tragen Sie bitte einen zufälligen Wert ein. Dieser sollte mindestens 5 Zeichen lang und ebenfalls im ControlCenter als GET-Parameter hinterlegt sein. Erlaubte Zeichen sind a-z, A-Z, 0-9.

Bestellstatus in Bezahlung
(Standard: Bezahlung steht aus)
Wählen Sie hier den Status aus, den eine Bestellung während des Bezahlvorgangs hat.

Bestellstatus bezahlt
(Standard: In Bearbeitung)
Wählen Sie hier einen Status aus, den eine Bestellung erhält, sobald der Kunde bezahlt hat und das Geld bei micropayment™ eingegangen ist.

Bestellstatus Abgebrochen
(Standard: Storniert)
Wählen Sie hier einen Status aus, den eine Bestellung erhält, sobald eine Stornierung des Geldes eingeht.

Bestellstatus: Bezahlung prüfen
(Standard: Bestellung prüfen)
Bei problemen mit der Bezahlung, wird dieser Status gesetzt, damit Sie dies prüfen können.

Bestellstatus: Konflikt
(Standard: Event-Problem!)
Sollte es zu Konflikten im Bezahl-Ablauf kommen, wird dieser Status gesetzt.

Bestellstatus: Vorkasse – Teilzahlung
(Standard: Vorkasse, Teilzahlung)
Wenn ein Zahlungseingang bei Vorkasse gemeldet wird, der zu bezahlende Betrag aber nicht voll erreicht ist, wird dieser Status gesetzt.

Shop-Installation fertig!
Sie haben nun sämtliche Einstellungen in Ihrer Shopsoftware getätigt. Letztlich nehmen Sie bitte noch wichtige Einstellungen im Micropayment ControlCenter vor. Nach Abschluss dieser Einstellungen können Sie die Micropayment Bezahlmodule einsetzen.

Zahlartenkonfiguration im Micropayment Controlcenter

Kreditkarte / SEPA Lastschrift / Vorkasse

Micropayment - Projekteinstellungen
Bevor Sie das Payment-Plugin von Micropayment nutzen können, müssen noch einige Einstellungen im Micropayment Controlcenter vorgenommen werden.

Hinweis:
Einstellungen müssen für alle Zahlungsarten vorgenommen werden, die Sie verwenden möchten. Die Konfiguration für Kreditkarte, SEPA Lastschrift und Vorkasse unterscheidet sich von den weiteren Zahlarten.

Zahlungsart konfigurieren:
Rufen Sie unter Konfiguration → Zahlarten die jeweilige Zahlart auf Kreditkarte → API.Event / Lastschrift → API.Event / Vorkasse → API.Event.

Micropayment Zahlungsarten konfigurieren

Benachrichtigungs-URL:
Tragen Sie hier folgende Benachrichtigungs-URL ein:

Direct debit

https://www.shopurl.de/root-of-shop/

CreditCard

https://www.shopurl.de/root-of-shop/

Bank Transfer

https://www.shopurl.de/root-of-shop/

Aktivieren Sie die Zahlungsart
Klicken Sie hierzu auf "Informationen zur Nutzung der API" und stimmen Sie den Informationen zu. Speichern Sie die Einstellungen.

Aktivieren Sie die Micropayment Zahlungsart

Zugriffsberechtigung
Geben Sie den Zugriff zur Kommunikation zwischen Ihrem Shop und Micropayment frei. Gehen Sie dazu auf Konfiguration → Zugriffsberechtigungen und anschließend auf neue Zugriffsberechtigung. Tragen Sie hier die IP-Adresse Ihres Shop-Servers ein.

Weitere Zahlungsarten

Grundsätzlich müssen alle Zahlungsarten, die Sie im Shop verwenden möchten, konfiguriert und aktiviert werden. Wählen Sie bitte bei den weiteren Zahlungsarten die Event Option aus (z.B. SOFORT. - Event, paysafecard - Event etc.).

Zahlartenkonfiguration im Micropayment Controlcenter

Aktivieren Sie die von Ihnen gewünschte Zahlungsart

Hinterlegen Sie als API-URL Ihre Shop URL: https://shopurl.de/root-of-shop/

Unter "Parameter: Benachrichtigungs-URL" hinterlegen Sie bitte folgende Werte für diese Zahlungsarten.

Name		Wert
orderid	=	`__$orderid__`

Name		Wert
orderid	=	`__$orderid__`

Name		Wert
orderid	=	`__$orderid__`

Name		Wert
orderid	=	`__$orderid__`

Name		Wert
orderid	=	`__$orderid__`

Name		Wert
orderid	=	`__$orderid__`

Optionen → API-URL: Aktivieren Sie hier das Senden zusätzlicher Daten.

Erweiterte Sicherheit: Aktivieren Sie diese Option.

Testmodus: Aktivieren / Deaktivieren - muss aktiviert sein, falls Sie in Ihrem Shop-Modul Testbestellungen durchführen wollen. Zugehörige Test-Daten können Sie aus dem Micropayment Controlcenter unter Hilfe → Testmodus entnehmen.

Fehler & Abbruch- URL: Hier hinterlegen Sie Ihre URL zum Checkout https://www.shopurl.de/warenkorb/

Aktivieren/Deaktivieren
Aktiviert die Zahlungsart im Shop System → Einstellungen → Sales / Paymement Methods

Die Konfiguration im Micropayment Controlcenter ist nun abgeschlossen.

Wir wünschen Ihnen viel Spaß mit Ihrem Micropayment-Plugin.

Allgemeine Hinweise

Die Bezahlung über die Micropayment-Module können in der Währung € (EUR) durchgeführt werden. Sollten Sie eine andere Währung in Ihrem Shop anbieten, so wird dieser Wert umgerechnet, bzw. für die Kreditkarte, muss ein Währungsterminal beantragt werden.

Bezahlstatus: Initiated payment with Micropayment
Der Kunde hat eine Bestellung ausgelöst. Eine Bestellung kann diesen Status dauerhaft besitzen falls der Kunde die Payment Fenster verlässt und keinen vollständigen Bezahlprozess durchläuft.

Bezahlstatus: Prepayment, outstanding. Deadline till Jahr-Monat-Tag
Bestellung wurde mit Vorkasse durchgeführt. Diese wird angegeben sofern keine Bezahlungseingang vorhanden ist bei eine Vorkassen Bestellung. Angegeben Datum erläutert wann die Vorkassen Bestellung verfällt.

Bezahlstatus: Payment complete. 00.00 EUR Auth xxxxxxxxxxxxxx
Bestellung wurde bezahlt. Angegeben wird Zahlbetrag und die Interne Micropayment Auth Schlüssel. Dies kann verwendet werden im ControlCenter um die Zahlung zu bearbeiten.

Bezahlmodule für weitere Shops finden Sie auf unserer Seite unter Payment Plugins für Ihren Online Shop

Individuelle Grafik für Ihr Bezahlfenster

Sie haben die Möglichkeit, im Bezahlfenster von Micropayment eine individuelle Grafik mit der Größe 200x200px zu hinterlegen. Diese Grafik wird mittels Grafik-Code aufgerufen. In Ihrem Micropayment ControlCenter können Sie diese unter dem Menüpunkt „Tools – Bezahlfenster-Grafiken hochladen. Der generierte Code (Kürzel) wird im folgenden Schritt in Ihrer Konfiguration als Grafik-Code hinterlegt.