Magento

Plugin installieren

Der erste Schritt zur Nutzung des Plugin ist die Installation. Vorab sollten Sie sicherstellen, dass Ihre Infrastruktur die folgenden Systemanforderungen erfüllt:

Als Local Composer Paket installieren

Danach führen Sie die folgenden Schritte aus:

1. Loggen Sie sich bei Ihrem Server ein (z.B. via SSH).
2. Navigieren Sie zum Stammordner Ihrer Adobe Commerce/Magento Installation.
3. Erstellen Sie im Stammverzeichnis Ihrer Adobe Commerce/Magento Installation einen Ordner (z.B. „local_packages“).
4. Laden Sie das Plugin herunter. Laden Sie das Zip-Paket in den Ordner hoch. Dekomprimieren Sie nicht das Archiv!
5. Führen Sie den folgenden Befehl aus. Der gegebene Pfad ist ein vollständiger Serverpfad des Ordners, der das Paket mit der Erweiterung enthält:

   
   composer config repositories.worldline artifact /full/server/path/to/local_packages/ 
   composer require worldline/module-magento-payment 

   
   

6. Führen Sie die folgenden Befehle aus:

   
   php bin/magento setup:upgrade 
   php bin/magento cache:clean 
   php bin/magento setup:di:compile 
   php bin/magento setup:static-content:deploy 
   

Von GitHub installieren

1. Plugin installieren:
   
   • Erstellen Sie im Stammverzeichnis Ihrer Adobe Commerce/Magento Installation einen Ordner (z.B. „local_packages“)
   • Führen Sie den folgenden Befehl aus. Der gegebene Pfad ist ein vollständiger Serverpfad des Ordners, der das Paket mit der Erweiterung enthält:
     

     
     composer config repositories.worldline git https://github.com/wl-online-payments-direct/plugin-magento.git
     composer require worldline/module-magento-payment
     

2. Aktivieren Sie das Plugin:
   
   

   /usr/local/php74/bin/php74 bin/magento module:enable Worldline_Payment 
   /usr/local/php74/bin/php74 -d memory_limit=-1 /usr/bin/composer update --with-dependencies
   

3. Bauen Sie Ihre Website neu auf
   
   

   php bin/magento setup:upgrade 
   
   php bin/magento cache:clean 
   
   php bin/magento setup:di:compile
    
   php bin/magento setup:static-content:deploy 

   
   
   

To uninstall the plugin with all the related data, execute the following command:

composer remove worldline/module-magento-payment

Alternatively, you can use the following command:

composer remove worldline/module-magento-payment \
worldline/module-magento-payment-core \
worldline/module-magento-payment-credit-card \
worldline/module-magento-payment-hosted-checkout \
worldline/module-magento-payment-redirect-payment \
worldline/module-magento-recurring-payments \
worldline/module-magento-payment-graph-ql

To remove extensions with their related data, please use the following command:

bin/magento module:uninstall \
Worldline_Payment \
Worldline_PaymentCore \
Worldline_CreditCard \
Worldline_HostedCheckout \
Worldline_RedirectPayment \
Worldline_GraphQl

To remove the plugin with all their related data, execute the following commands instead:

bin/magento module:uninstall \
Worldline_Payment \
Worldline_PaymentCore \
Worldline_CreditCard \
Worldline_HostedCheckout \
Worldline_RedirectPayment \
Worldline_RecurringPayments

If the recurring add-on has been installed, execute the following command:

composer remove worldline/module-magento-recurring-payments

Plugin konfigurieren

Nach der Installation müssen Sie das Plugin konfigurieren, um Ihren Store mit unserer Plattform zu verbinden.

Verbindung konfigurieren

1. Loggen Sie sich im Adobe Commerce/Magento Back Office ein. Gehen Sie zu Stores > WORLDLINE ONLINE PAYMENTS > Connection
2. Konfigurieren Sie in Connection die folgenden Einstellungen:
   

   Merkmal	Beschreibung/Aktionen
   Environment mode	Wählt zwischen „Test“ oder „Production“, um Ihren Shop mit der jeweiligen Umgebung zu verbinden. Je nach Ihrer Wahl sendet das Shop-Modul die Transaktionsanfragen an die Test- oder Produktionsumgebung Achten Sie darauf: nicht die Anmeldedaten von „Test“ mit „Production“ zu verwechseln (und umgekehrt), wenn Sie die Felder Merchant ID (PSPID)/API Key/API Secret und die webhooks-Anmeldedaten konfigurieren Auf „Production“ umzustellen, nachdem Sie Ihre Tests beendet haben
   API Key	Geben Sie den API-Schlüssel Ihrer Test- oder Live-PSPID ein. Lesen Sie in unserer Anleitung, wie Sie eines generieren
   API Secret	Geben Sie das API-Geheimnis Ihrer Test- oder Live-PSPID ein. Lesen Sie in unserer Anleitung, wie Sie eines generieren
   Merchant ID (PSPID)	Geben Sie die PSPID von unserer Plattform ein, die Sie für die Verarbeitung der Transaktionen verwenden möchten

1. Klicken Sie zum Bestätigen Ihrer Konfiguration auf „Save Config“

finden

Nachdem Sie die Tabelle ausgefüllt haben, verifizieren Sie die Konfiguration, indem Sie eine Testverbindung zwischen dem Plugin und unserer Plattform herstellen. Klicken Sie auf die Schaltfläche „Test Connection“. Überprüfen Sie, ob sich der Text der Schaltfläche zu „Successful! Test again“ ändert. Wenn sich der Text der Schaltfläche zu „Connection failed! Test again?"“ ändert: Wenden Sie sich an Ihren Systemadministrator, um den Fehler zu überprüfen:

• Nutzen Sie die richtigen Anmeldedaten?
• Ist Ihre PSPID aktiv?
• Senden Sie die Anfrage an die korrekte PSPID/Umgebung (Test vs. Production)?

Webhooks konfigurieren

1. Loggen Sie sich im Adobe Commerce/Magento Back Office ein. Gehen Sie zu Stores > WORLDLINE ONLINE PAYMENTS > Connection
2. Konfigurieren Sie in Webhooks die folgenden Einstellungen:
   
   

   Merkmal	Beschreibung/Aktionen
   Allow Receiving Webhooks	Wählen Sie „Yes“, um webhooks im Magento-Server zu empfangen
   Webhook URL	Kopieren Sie diese URL in die Endpoint URLs-Felder im PAYONE E-Payment Merchant Portal, so wie in unserer Anleitung beschrieben
   Key	Geben Sie den API key Ihrer Test- oder Live-PSPID ein. Lesen Sie in unserer Anleitung, wie Sie eines generieren
   Secret Key	Geben Sie den API secret Ihrer Test- oder Live-PSPID ein. Lesen Sie in unserer Anleitung, wie Sie eines generieren

1. Klicken Sie zur Bestätigung „Save Config“ und säubern Sie Ihren Cache

Zahlungsarten konfigurieren

1. Login to the Adobe commerce/Magento Back Office. Go to Stores > WORLDLINE ONLINE PAYMENTS > Payment methods
   
   

1. Unter „Credit Card“ konfigurieren Sie die folgenden Einstellungen für Transaktionen, die über unsere Hosted Tokenization Page verarbeitet werden
   

   Merkmal	Beschreibung/Aktionen
   Enable Module	Wählen Sie eine der Optionen für die Verarbeitung von Kreditkartenzahlungen „Yes“: Das Modul verarbeitet Kartenzahlungen über den Integrationsmodus Hosted Tokenization Page. Alle Nicht-Kartenzahlungen laufen über Hosted Checkout Page, wie in „Hosted Checkout“ konfiguriert „No“: Statt Hosted Tokenization Page für Kartenzahlungen zu nutzen, werden alle Zahlungsarten via Hosted Checkout Page angeboten, wie in „Hosted Checkout“ konfiguriert
   Title	Entwerfen Sie einen Text für den Bezahlbutton in iFrame auf der Check-out-Seite von Magento
   HTML Template ID	Geben Sie den Dateinamen Ihrer Vorlage ein, um unsere Zahlungsseite an das Design Ihres Shops anzupassen. Hier erfahren Sie, wie Sie Vorlagen erstellen. Sie können dieses Muster als Ihre Standardvorlage verwenden
   Payment Action	Legen Sie fest, ob die Transaktionen im Autorisierungsmodus oder als Direktverkauf bearbeitet werden sollen. Wählen Sie eine der folgenden Optionen: „Authorize & Capture“: Der Betrag soll laut Bestellung in einem Durchgang ausgezahlt werden. Bei diesem Modus erhalten Sie das Geld vor dem Versand der Bestellung. Es sind keine weiteren Aktionen erforderlich, um die Transaktion zu erfassen. Erfolgreiche Transaktionen haben status="CAPTURED" / statusOutput.statusCategory="COMPLETED" / statusOutput.statusCode=9 „Authorized (Authorization Only)“: Der Betrag wird nur auf der Karte Ihres Kunden blockiert. Bei erfolgreichen Transaktionen erscheint: status="PENDING_CAPTURE" / statusOutput.statusCategory="PENDING_MERCHANT" / statusOutput.statusCode=5 (Nutzen Sie diesen Modus, wenn Sie eine Transaktion erst nach dem Versand der Bestellung erfassen möchten.) Wenn die Transaktionsart auf „Authorized (Authorization Only)“ eingestellt ist, müssen Sie auf Folgendes achten: Stellen Sie sicher, dass Sie autorisierte Transaktion später erfassen. Nur dann weist die Transaktion status="CAPTURED" / statusOutput.statusCategory="COMPLETED" / statusOutput.statusCode=9 auf, weshalb Sie die Zahlung für die Transaktion tatsächlich erhalten Erfassen Sie die Transaktion im Magento Back Office mit dem Modul „Order“
   Skip 3DSecure Authentication	Wählen Sie „Yes“ oder „No“, um den Vorgang der 3-D Secure-Authentifizierung für die Zahlungen zu de-/aktivieren Wir empfehlen, "No" auszuwählen, wenn Ihre Kunden in Europa ansässig sind. Deaktivieren Sie diese Option nur, wenn Ihre Kunden anderswo ansässig sind
   Sort	Die Sortierreihenfolge des iFrame definieren. Damit können Sie festlegen, in welcher Reihenfolge die verschiedenen Zahlungsmittel auf Ihrer Kassenseite angezeigt werden
   Filtering	Sie können auch mit verschiedenen Filtern (Länder, Währungen, Beträge) festlegen, wann Sie Ihren Kunden diese Art der Zahlungsabwicklung vorschlagen

2. Unter „Hosted Checkout“ konfigurieren Sie die folgenden Einstellungen für Transaktionen, die über unsere Hosted Checkout Page verarbeitet werden
   
   

   Merkmal	Beschreibung/Aktionen
   Enable Module	Wählen Sie eine der Optionen aus für die Verarbeitung von allen Zahlungen „Yes“: Das Modul verarbeitet Zahlungsarten sowohl mit als auch ohne Kartenzahlungen via den Modus Hosted Checkout Page „No“: Das Modul verarbeitet nur Kartenzahlungen über den Integrationsmodus Hosted Tokenization Page Wenn Sie „No“ wählen, sollte im Modul „Credit Card“ „Enable Module“ auf „Yes“ eingestellt sein, um sicherzustellen, dass Kartenzahlungsarten überhaupt möglich sind
   Title	Passen Sie die Überschrift auf Hosted Checkout Page an
   HTML Template ID	Geben Sie den Dateinamen Ihrer Vorlage ein, um unsere Zahlungsseite an das Design Ihres Shops anzupassen. Hier erfahren Sie, wie Sie Vorlagen erstellen
   Payment Action	Legen Sie fest, ob die Transaktionen im Autorisierungsmodus oder als Direktverkauf bearbeitet werden sollen. Wählen Sie eine der folgenden Optionen: „Authorize & Capture“: Der Betrag soll laut Bestellung in einem Durchgang ausgezahlt werden. Bei diesem Modus erhalten Sie das Geld vor dem Versand der Bestellung. Es sind keine weiteren Aktionen erforderlich, um die Transaktion zu erfassen. Erfolgreiche Transaktionen haben status="CAPTURED" / statusOutput.statusCategory="COMPLETED" / statusOutput.statusCode=9 „Authorized (Authorization Only)“: Der Betrag wird nur auf der Karte Ihres Kunden blockiert. Bei erfolgreichen Transaktionen erscheint: status="PENDING_CAPTURE" / statusOutput.statusCategory="PENDING_MERCHANT" / statusOutput.statusCode=5 (Nutzen Sie diesen Modus, wenn Sie eine Transaktion erst nach dem Versand der Bestellung erfassen möchten.) Wenn die Transaktionsart auf „Authorized (Authorization Only)“ eingestellt ist, müssen Sie auf Folgendes achten: Stellen Sie sicher, dass Sie autorisierte Transaktion später erfassen. Nur dann weist die Transaktion status="CAPTURED" / statusOutput.statusCategory="COMPLETED" / statusOutput.statusCode=9 auf, weshalb Sie die Zahlung für die Transaktion tatsächlich erhalten Erfassen Sie die Transaktion im Magento Back Office mit dem Modul „Order“
   Sort	Die Sortierreihenfolge des iFrame definieren. Damit können Sie festlegen, in welcher Reihenfolge die verschiedenen Zahlungsmittel auf Ihrer Kassenseite angezeigt werden
   Filtering	Sie können auch mit verschiedenen Filtern (Länder, Währungen, Beträge) festlegen, wann Sie Ihren Kunden diese Art der Zahlungsabwicklung vorschlagen
   Submit Customer Cart Items Data to Worldline	Legt fest, ob Daten des Warenkorbs Ihres Kunden an Worldline übermittelt werden sollen. Das verbessert die Kundenerfahrung, kann aber zu Fehlern führen, wenn Sie eigene Steuerregeln verwenden

1. Konfigurieren Sie in „Redirect Payment“ die folgenden Einstellungen für Transaktionen, bei denen Ihre Kunden eine Vorauswahl ihrer gewünschten Zahlungsmethode vor der Weiterleitung zu unserer Hosted Checkout Page treffen
   
   

   Merkmal	Beschreibung/Aktionen
   Enable Module	Wählen Sie eine der Optionen aus für die Verarbeitung von allen Zahlungen „Yes“: Das Modul verarbeitet Zahlungsarten sowohl mit als auch ohne Kartenzahlungen über den Modus Hosted Checkout Page „No“: Das Modul verarbeitet nur Kartenzahlungen über den Integrationsmodus Hosted Tokenization Page Wenn Sie „No“ wählen, sollte im Modul „Credit Card“ „Enable Module“ auf „Yes“ eingestellt sein, um sicherzustellen, dass Kartenzahlungsarten überhaupt möglich sind
   Title	Passen Sie die Überschrift auf Hosted Checkout Page an
   HTML Template ID	Geben Sie den Dateinamen Ihrer Vorlage ein, um unsere Zahlungsseite an das Design Ihres Shops anzupassen. Hier erfahren Sie, wie Sie Vorlagen erstellen
   Payment Action	Legen Sie fest, ob die Transaktionen im Autorisierungsmodus oder als Direktverkauf bearbeitet werden sollen. Wählen Sie eine der folgenden Optionen: „Authorize & Capture“: Der Betrag soll laut Bestellung in einem Durchgang ausgezahlt werden. Bei diesem Modus erhalten Sie das Geld vor dem Versand der Bestellung. Es sind keine weiteren Aktionen erforderlich, um die Transaktion zu erfassen. Erfolgreiche Transaktionen haben status="CAPTURED" / statusOutput.statusCategory="COMPLETED" / statusOutput.statusCode=9 „Authorized (Authorization Only)“: Der Betrag wird nur auf der Karte Ihres Kunden blockiert. Erfolgreiche Transaktionen haben status="PENDING_CAPTURE" / statusOutput.statusCategory="PENDING_MERCHANT" / statusOutput.statusCode=5 (Nutzen Sie diesen Modus, wenn Sie eine Transaktion erst nach dem Versand der Bestellung erfassen möchten) Wenn die Transaktionsart auf „Authorized (Authorization Only)“ eingestellt ist, müssen Sie auf Folgendes achten: Stellen Sie sicher, dass Sie autorisierte Transaktion später erfassen. Nur dann hat die Transaktion status="CAPTURED" / statusOutput.statusCategory="COMPLETED" / statusOutput.statusCode=9, was anzeigt, dass Sie die Zahlung für die Transaktion erhalten Erfassen Sie die Transaktion im Magento Back Office mit dem Modul „Order“
   Request 3DS exemption	Select "Yes" if you would like your customers to be potentially exempted from a 3-D Secure check. This applies only to transactions with a basket less than 30 EUR
   Submit Customer Cart Items Data to Worldline	Legt fest, ob Daten des Warenkorbs Ihres Kunden an Worldline übermittelt werden sollen. Das verbessert die Kundenerfahrung, kann aber zu Fehlern führen, wenn Sie eigene Steuerregeln verwenden
   Sort	Die Sortierreihenfolge des iFrame definieren. Damit können Sie festlegen, in welcher Reihenfolge die verschiedenen Zahlungsmittel auf Ihrer Kassenseite angezeigt werden

   Jede Zahlungsmethode können Sie einzeln aktivieren, indem Sie für jede von ihnen Folgende konfigurieren:
   

   Merkmal	Beschreibung/Aktionen
   Enable Module	Wählen Sie eine der Optionen aus für die Verarbeitung von allen Zahlungen „Yes“: Das Modul verarbeitet Zahlungsarten sowohl mit als auch ohne Kartenzahlungen über den Modus Hosted Tokenization Page „No“: Das Modul verarbeitet nur Kartenzahlungen über den Integrationsmodus Hosted Checkout Page Wenn Sie „No“ wählen, sollte im Modul „Credit Card“ „Enable Module“ auf „Yes“ eingestellt sein, um sicherzustellen, dass Kartenzahlungsarten überhaupt möglich sind
   Sort	Die Sortierreihenfolge des iFrame definieren. Damit können Sie festlegen, in welcher Reihenfolge die verschiedenen Zahlungsmittel auf Ihrer Kassenseite angezeigt werden
   Title	Passen Sie die Überschrift auf Hosted Checkout Page an

2. Klicken Sie zum Bestätigen auf „Save Config“

Zahlungen verwalten

Unser Plugin ist so konzipiert, dass Ihre Aufträge automatisch und autonom bearbeitet werden. Das befreit Sie von lästigen Verwaltungsarbeiten. Hier erfahren Sie, wie Sie Ihr Plugin effektiv für Ihre Geschäfte nutzen können.

Bestellstatus aktualisieren

Das Modul stellt mit zwei verschiedenen Mechanismen sicher, dass Ihre Datenbank den Status der Transaktionen auf unserer Plattform widerspiegelt:

• Webhooks: Unsere Plattform sendet bei jeder Aktualisierung eines Transaktionsstatus eine Meldung an das Modul. Lesen Sie das Kapitel „Verbindung konfigurieren“, um webhooks zu konfigurieren
• GET-Aufrufe: Magento sendet proaktiv Anfragen an unsere Plattform, um den Status der Transaktionen zu erfragen, wenn webhooks fehlschlagen

Zum Konfigurieren der GET-Aufrufe führen Sie diese Schritte aus:

1. Loggen Sie sich im Adobe Commerce/Magento Back Office ein. Gehen Sie zu Stores > WORLDLINE ONLINE PAYMENTS > Order status updater

2. Konfigurieren Sie in General die folgenden Einstellungen:
   

   Merkmal	Beschreibung/Aktionen
   Fallback Timeout	Definiert den Zeitraum (in Minuten), nach dem das Modul bei einem Ausfall von Webhooks GET-Calls sendet. Nach dieser Zeitspanne sendet das Modul minütlich Aufrufe
   Fallback Timeout Limit	Definiert den Zeitraum (in Stunden), während der das Modul GET-Aufrufe sendet. Der Standardzeitraum (3 Stunden) entspricht der Sitzungsgültigkeit CreateHostedCheckout / CreateHostedTokenizationSession
   Schedule (Cron Syntax)	Syntax für die Ausführung des Prozesses

3. Klicken Sie zum Bestätigen Ihrer Konfiguration auf „Save Config“

Testtransaktionen durchführen

Verwenden Sie die Test-Umgebung unserer Plattform, um sicher zu gehen, dass Ihr Plugin wie gewünscht funktioniert. Wir bieten Testdaten auf unserer eigens dafür eingerichteten Testszenarios-Seite. Steuern Sie unsere Test-Umgebung wie im Kapitel "Plugin konfigurieren" beschrieben an.

Debug

Für jede Zahlungsmethode können Sie einen Debug-Modus aktivieren (der standardmäßig deaktiviert ist). Wenn er aktiviert ist, erstellt Magento zusätzliche Protokolle aller Anfragen, die das Plugin an die Worldline-Plattform sendet. Diese Protokolle können Sie abrufen.

Zum Zugriff auf die Protokolle melden Sie sich am Administrationspanel von Adobe Commerce/Magento an. Gehen Sie zu “Stores > Settings > Configuration > WORLDLINE > Debug“. Wenn Sie zum Bereich „debug“ blättern, können Sie bestimmte Aktionen in den folgenden Modulen durchführen:

• „General“: Festlegen, wie lange diese Protokolle aufbewahrt werden sollen
• „Debug Logs“: Die Protokolldatei herunterladen oder löschen
• „Wordline Request Logs“ ruft ein Raster auf, in dem Sie die Protokolle filtern können, die Sie sehen möchten. Filtern können Sie z. B. nach HTTP-Statuscodes, nach den verwendeten APIs, nach bestimmten Datumswerten oder nach dem Inhalt der Anfrage/Antwort

You will also be able to request your systems to log all incoming webhooks and display them into a similar grid as by request

Mind that:

• You need to set the "Log webhooks" on "Yes" to log webhooks.
• The time we will keep the logs of the webhooks is equal to the time we log the requests.

Our Magento plugin is compatible with the Hyvä Theme. Therefore, to use our plugin with the Hyvä Theme, you need to buy it first.

This valuable extension is an asset for both you and your customers by offering:

• A new, highly customisable design for your webshop based on the familiar Luma theme.
• An efficient integration which loads only the necessary CSS, Javascript and HTML assets, speeding up your shop front-end.

Read our dedicated chapter with detailed instructions for installing the module.