worldline Direct
Sign up

Einführung

Unser Magento Plugin bietet regelmäßige Updates und einen vollständigen Integrationssupport. So verfügen Sie über eine flexible, außergewöhnliche Lösung für die reibungslose Annahme von Online-Zahlungen:

  • Unterstützt die folgenden Integrationsmodi:
  • Bietet die folgenden Zahlungsmethoden auf unserer Plattform:
    Alipay+
    American Express
    Apple Pay
    Bancontact
    Bizum
    Carte Bancaire
    Cpay
    Diners Club
    Google Pay
    iDEAL
    Illicado
    Intersolve
    JCB
    Maestro
    MasterCard
    Multibanco
    PayPal
    Visa
    WeChatPay

Beachten Sie unser Änderungsprotokoll, um über Updates und neue Funktionen auf dem Laufenden zu bleiben (z.B. Zahlungsmethoden, Features, Integrationsmodi), die wir diesem Plugin hinzugefügt haben.

Schauen Sie sich unsere Dokumentation an, um zu erfahren, wie Sie Ihren Store direkt mit unserer Plattform verbinden, um von all diesen Vorteilen zu profitieren!

GitHub-Repository / Marketplace-Repository

GitHub repository

Marketplace repository

Konto erstellen

Um Transaktionen mit diesem Plugin zu verarbeiten, benötigen Sie ein Konto auf unserer Plattform.

Dieses Plugin funktioniert sowohl in unserer Test- als auch Live-Umgebung. Mit einem Testkonto können Sie sich mit dem Plugin und unserer Plattform vertraut machen. Wenn Sie dann live gehen möchten, erstellen Sie ein Produktionskonto oder kontaktieren uns.

Plugin installieren

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

Element Beschreibung
Plugin-Paket

Laden Sie das Plugin herunter

Direct Anmeldedaten
Magento

Kompatibel mit PHP 8.1+

Kompatibel mit Magento-Versionen v2.4.4-p2 und v2.4.5-p1

Auf der Magento Support-Seite finden Sie einen ausführlichen Überblick über die Kompatibilitäten.

PHP

PHP-Version 8.1+

PCI-Konformität

SAQ A

Die eingebauten Eigenschaften des Plugin erfüllen die Anforderungen dieser Sicherheitsstufe. Aber dennoch müssen Sie das Zertifikat bei Ihrem Acquirer einholen.

Das Plugin unterstützt sowohl die Installation als ein lokales Composer-Paket als auch über GitHub.

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 
    
Achten Sie darauf:
  • Ein Backup Ihres bestehenden Projektes zu erstellen, bevor Sie neue Erweiterungen installieren
  • Ihr neues Projekt in der Staging-Umgebung von Magento zu testen, bevor Sie neuen Code in der Produktionsumgebung bereitstellen

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


We strongly advise to create a DB dump before executing this action.

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

Configure plugin

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

Für einige Merkmale erlaubt Magento die Verwendung des Standardwertes, der auf Systemebene definiert ist. Wenn Sie sich dafür entscheiden, aktivieren Sie entsprechend „Use system value
  1. Klicken Sie zum Bestätigen Ihrer Konfiguration auf „Save Config
Dieses Bild zeigt, wo Sie das Modul „Connection“ im Magento Back Office

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 Direct 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
Für einige Merkmale erlaubt Magento die Verwendung des Standardwertes, der auf Systemebene definiert ist. Wenn Sie sich dafür entscheiden, aktivieren Sie entsprechend „Use system value
  1. Klicken Sie zur Bestätigung „Save Config“ und säubern Sie Ihren Cache
Dieses Bild zeigt, wo Sie das Modul „Webhooks“ im Magento Back Office finden

Zahlungsarten konfigurieren

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

  • As the plugin supports Hosted Checkout Page (Hosted Checkout), Hosted Tokenization Page (Credit Card) and Single payment buttons (Redirect Payments), you can customise your customers’ payment experience by selecting payment methods for either mode and even use both flows together
  • Mind that card payments are available for both modes, whereas alternative payment methods are available only for Hosted Checkout Page and Single payment buttons
The image shows where to find the “Payment methods” module in the Magento Back Office
  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:

    Wenn die Transaktionsart auf „Authorized (Authorization Only)“ eingestellt ist, müssen Sie auf Folgendes achten:

    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

    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

    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:

    Wenn die Transaktionsart auf „Authorized (Authorization Only)“ eingestellt ist, müssen Sie auf Folgendes achten:

    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

    Sort

    Die Sortierreihenfolge des iFrame definieren. Damit können Sie festlegen, in welcher Reihenfolge die verschiedenen Zahlungsmittel auf Ihrer Kassenseite angezeigt werden

    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

    Filtering

    Sie können auch mit verschiedenen Filtern (Länder, Währungen, Beträge) festlegen, wann Sie Ihren Kunden diese Art der Zahlungsabwicklung vorschlagen

    Process Mealvouchers

    Select "Yes" to be able to process Mealvouchers payment method and configure the different product types you need:

    • Food and Drink
    • Gift and Flowers
    • Home and Garden

Für einige Merkmale erlaubt Magento die Verwendung des Standardwertes, der auf Systemebene definiert ist. Wenn Sie sich dafür entscheiden, aktivieren Sie entsprechend „Systemwert nutzen“
  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:

    Wenn die Transaktionsart auf „Authorized (Authorization Only)“ eingestellt ist, müssen Sie auf Folgendes achten:

    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.

    Sorgen Sie dafür, auf die LIVE-Umgebung zu wechseln, sobald Sie Ihre Tests abgeschlossen haben.

    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
    Die Abbildung zeigt die Filterfunktion des Moduls „Debug“ im Magento-Back Office

    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.

    Configure Amasty Recurring Payments

    Unsere Magento-Erweiterung bietet auch die Möglichkeit, wiederkehrende Zahlungen und Abonnements zu verarbeiten, indem Sie Amasty Recurring Payments module speziell auf Ihre Bedürfnisse zugeschnitten nutzen.

    Zur Erweiterung werden viele Funktionen gehören, die Sie für die Arbeit mit Abonnements brauchen:

    • Vordefinierte oder anpassbare Abonnements
    • Kostenlose Tests, Rabatte und kostenlose Lieferung
    • Gemischte Warenkörbe
    • Produkte nur im Abonnement anbieten
    • Benachrichtigungen per E-Mail bei fehlgeschlagenen Zahlungen

    Selbstverständlich entspricht diese Lösung allen unseren Sicherheitsstandards. Deshalb müssen Sie selbst keine sensiblen Kreditkartendaten speichern! Wir kümmern uns um alles!

    Richten Sie Amasty Recurring Payments ein

    1. Kaufen Sie die Erweiterung auf dem Amasty marketplace
    2. Richten Sie keys nach der Anleitung für Amasty ein
    3. Führen Sie den folgenden Befehl aus. Der angegebene Pfad ist ein vollständiger Serverpfad des Ordners, der das Paket mit der Erweiterung enthält:
      composer require worldline/module-magento-recurring-payments

    Amasty für wiederkehrende Zahlungen konfigurieren

    Gehen Sie nach der Anleitung von Amasty zum Konfigurieren des Plugins vor, damit Sie die Funktionen voll ausschöpfen können. 

    We have developed our plugin with specific consideration of SCA regulations. You will never have to manage sensitive data, as we take care of that. This also enables you to ensure a smooth payment experience by making a clear distinction between CIT and MIT.

    Configure module

    This plugin works in combination with the regular Worldline Online Payments Magento module as described in the previous chapters. All configurations for Hosted Checkout, Credit Card or Redirect Payments will also work via subscription.

    If you have configured "Hosted Checkout", "Credit Card" or "Redirect Payment" in two steps ("Authorise" mode), the plugin overrides this with "Authorize and capture" mode. However, it remains valid for regular payments. The plugin will process mixed baskets (Subscriptions & Single Payments) in "Authorize and capture" mode.

    To configure the extension, follow these steps:

    1. Go to Stores > Configuration > Amasty extensions > Subscriptions & Recurring Payment.
    2. In "General", configure the following settings:
      Property Description/Actions
      Supported Payment Gateways Select the checkout options you wish to propose to your customers for subscription processing.
      Allow for Specifying Subscription and End

      YES: Enable this option to offer your customers to choose the subscription start and end date.

      NO: Process a subscription of indefinite length until cancellation.

      Apply Free Shipping to Subscription Products

      YES: Automatically set the shipping price to free to maximise customer fidelity and engagement.

      NO: Apply she shipping fee you have configured in Magento.

      Enable "Next Billing Date" Explanation Tooltip YES/NO: Define whether to make a ? icon appear with the tooltip in the subscriptions grid on the customers' Storefront. Only available if you have several websites in different time zones.
      Message Text Text displayed in the textbox to the customers.
    3. In "Global Subscription Settings", define whether the products should be used only in the context of subscription and the frequency of the payments.
      Property Description/Actions
      Subscription only YES: Sell your products through regular purchases or only through subscriptions.
      NO: Sell your products either as on-off transactions or as subscriptions.
      Subscription Plans Available to Customers Define the frequencies you wish to propose to your customers for their subscription. You can:

      Select the default values (Daily, Weekly, Monthly, Annual)
      Modify the default values
      Create your own custom plans

    You can add multiple subscription plans in Sales > Amasty > Subscriptions > Subscription Plans. On the "Subscription Plans" grid, you can manage the existing plans and add new plans as per your business needs.

    1. In "Labels & Comments", customise the text displayed when your customers want to add products to the cart
      Property Description/Actions
      Label for the Single Purchase option Text shown on the storefront when your customers want to add a product to the basket as a single purchase.
      Label for the Recurring Purchase option Text shown on the storefront when your customers want to add a product on the basket as a subscription.
    2. In "Email Notifications", configure
      Property Description/Actions
      Send Email as Choose a sender via Stores > Configuration > General > Store email addresses.
      Notify Customers When Subscription is Purchased Inform your customers via email when they have bought a subscription from your website.
      Email Template Choose the email template to contact your customers.
      Notify Customers When Trial Period Ends Inform your customers about the end of a free trial period and the next occurrence when they will be billed.
      Notify Customers When Subscription is Cancelled Send a confirmation e-mail to your customers when their subscription has been cancelled.

    Create and edit subscription plans

    The extension allows you to create and customise an unlimited number of custom subscription plans according to your needs with unique features.

    To do so, go to Sales > Amasty Subscriptions > Subscription Plans > Subscriptions Plans. Our extension offers the following 4 default plans:

    • Daily
    • Weekly
    • Monthly
    • Annual

    You can either:

    • Edit these plans
    • Create your own plans to match your needs

    To edit an existing plan, click Edit in the action column. Click on 'Add New Plan' to display the "Plan Settings" page with the following properties:

    Property Description/Actions
    Subscription Plan Name Define the name of your subscription (not visible for your customers).
    Status Define the status of your subscription. (Default value: "Suspended").
    Billing Frequency Define the amount of *units* after you charge your customers.
    Billing Frequency Unit Define the billing interval (day, week, month or year).
    Enable Free Trials Enable/Disable the option to offer a free trial to your customers.
    Charge Initial fee Charge an initial fee. Choose between a fixed cost or a percentage of the product price.
    Offer Discounted Prices to Subscribers

    YES: Offer discounts against the price your customers pay for a single purchase. Choose between a fixed discount or a percentage of the product price and define how many times to apply it.

    NO: The price for both one-off and subscription payments remain the same.

    Configure subscription products

    To propose subscription to your customers, you need to decide which products to propose. To do so, perform the following steps:

    1. Go to your catalog of products via Catalog > Products.
    2. Select "Products" to propose your products to your customers.
    3. On the "Products" page, make the chosen products from the "Actions" drop-down list available through a subscription. The chosen subscription products appear in the "Subscription Product" column.
      Go into the details of each product to choose between the default configuration for subscriptions or customer settings:

      Propery Description/Actions
      Available by subscription

      Define whether this product:

      Uses custom subscription settings
      Uses default subscription settings
      Is not eligible for subscriptions

      Subscription only Define whether to offer this product for single purchases or through subscriptions only.
      Subscription Plans Available to Customers Defines the plans available to your customers.

    Configure Hyvä Theme

    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.

    Was this page helpful?

    Do you have any comments?

    Thank you for your response.