Dokumentation Shopware 5 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.

Shopware 5 API 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:

Das Micropayment-Shopware-Plugin kann direkt über Shopware installiert werden

1
Login über das Shopware-Admin-Backend
2
Einstellungen → Plugin Manager → Installiert → Plugin hochladen → Plugin
im .zip Format hochladen
3
Sobald das Plugin installiert wurde, müssen Sie dieses noch aktivieren:
Einstellungen → Plugin Manager → Installiert → aktivieren

Konfiguration der Zahlungsarten im Shopware 6 Backend

Micropayment Shopware 5 Plugin Konfiguration Einstellungen — Login über das ***Shopware-Admin-Backend → Einstellungen → Plugin Manager → Installiert → Micropayment Zahlungsarten → Öffnen → Konfiguration***

Einstellungen der einzelnen Felder in der Micropayment-Konfigurationsmaske:

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

Kampagne
Mit diesem Parameter können Sie den Umsatz über diese Zahlungsschnittstelle einer bestimmten Kampagne zuordnen. Diese muss zuvor im ControlCenter erstellt und aktiviert werden (Konfiguration → Kampagnen). Beim Erstellen der Kampagne können Sie ein Kürzel vergeben. Dieses muss in der Plugin-Konfiguration eingetragen werden.

Produkttext
setzt den Parameter "paytext" (Zahltext) und ist bei Lastschrift auf dem Kontoauszug wieder zu finden.

3d Secure
Aktiviert das 3 Secure für Kreditkarte nur bei der 1. oder bei allen Zahlungen.

Bezeichnung
Legen Sie über Titel fest, wie die Zahlungsart bei Ihnen im Checkout genannt werden soll (z.B.: „Lastschrift“, „SEPA Lastschrift“ oder „Bankeinzug“).

Zusätzliche Beschreibung
Kurze Beschreibung der Zahlungsart und zur Nutzung

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/MicropaymentGateway/Response/

CreditCard

https://www.shopurl.de/MicropaymentGateway/Response/

Bank Transfer

https://www.shopurl.de/MicropaymentGateway/Response/

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.