OXID 6: Get started

Available payment methods

Mollie for OXID 6 offers a wide range of payment methods that your customers can use to pay during checkout.

Apple Pay, Bancontact, Belfius Pay Button, Billie, Blik, Credit/Debit cards, EPS, Gift cards, iDEAL, iDEAL in3, KBC Payment Button, Klarna, PayPal, paysafecard, Przelewy24, SEPA Bank Transfer, TWINT.

For information on how to select the best payment methods for your business, refer to the Mollie Payment methods guide.

Features

Mollie for OXID 6 offers the following features to effectively manage your online payments:

  • Customize the payment experience
  • Localize your payment methods
  • Offer and manage subscriptions
  • Manage orders and payments

Install and connect

Enhance your OXID 6 shop payment options with Mollie.

What you need to do in advance:

  • Create and successfully log in to your Mollie account.
  • Install Composer.

Install

Composer installation

  1. Connect to your web server via SSH and navigate to the base folder of your OXID eShop where the composer.json is located.
  2. Install the plugin using the following command:
    composer require mollie/mollie-oxid
    

GitHub installation

  1. Download the latest release on GitHub Releases. Please use the attached ZIP file (mollie-oxid6-X.Y.Z.zip) from the list of available assets.

πŸ“˜

Note

Note that only stable and official releases are tested on our side. We do not recommend utilizing pre-releases or self-made versions from commits.

  1. Create the folder mollie in the source/modules folder.
  2. Create the folder molliepayment in the new source/modules/mollie folder.
  3. Copy the content of the downloaded release in the newly created molliepayment folder.
  4. In the composer.json file in the base folder of your OXID shop add the autoload configuration (or
    extend it if it already exists) with the following code:
"autoload": {
  "psr-4": {
    "Mollie\\Payment\\": "./source/modules/mollie/molliepayment",
    "Mollie\\Api\\": "./source/modules/mollie/molliepayment/lib/mollie-api-php/src/"
  }
},
  1. Connect to the web server using the console and navigate to the base folder of your OXID shop.
  2. Execute the following command to regenerate the autoloader files:
     composer dump-autoload
    
  3. Starting with the version 6.2 (older versions can skip this step) you must import the module configuration:
    log in via SSH to the server where your shop installation is located and navigate to the directory with the source and vendor folders. Execute the following commands:
    vendor/bin/oe-console oe:module:install-configuration source/modules/mollie/molliepayment/
    vendor/bin/oe-console oe:module:apply-configuration
    
  4. Run the command:
    vendor/bin/oe-console oe:module:apply-configuration
    
  5. You will receive the following message after the first command: Module configuration has been installed.
    The second command lists all modules available in the shop and the message that the configuration is applied:
    Applying modules configuration for the shop with id 1: Applying configuration for module with id molliepayment
  6. Now you can configure your plugin and activate it in your shop.

Plugin configuration

The plugin will create OXID payment methods that can be used like any other payment methods in your shop. To add these methods, just activate the module in your OXID backend.

Configure the following options in the Extensions > Modules > Settings tab of the Mollie plugin:

  • Basic Configuration - configure these settings to make sure the communication between Mollie and your OXID shop works properly.
ConfigurationDescription
ModeTest - all payments are made using sandbox/testing environment.
Live - plugin is in production mode and actual payments are made.
LIVE API-KeyAPI key for the Live mode. Use this key in production or if you want to test Apple Pay Direct. You can use separate keys for each subshop.
TEST API-KeyAPI key for the Test mode. Use this key to test your payments in the sandbox.
Test API KeysCheck if the communication with Mollie can be properly established based on the entered keys.
Log result of transaction handlingLog the results of the transactions. You can access the log file here: {{SHOPROOT}}/log/Mollie-Transactions.log.
Show iconsShow payment icons at the checkout.
  • Status Mapping - configure your payment flow and how you want to treat your New, Finished or Problems orders by assigning them to "Pending", "Processing" or "Cancelled".
StatusDescription
PendingSet the order status for payments before the customer is redirected to payment gateway.
ProcessingSet the order status for completed payments.
CancelledSet the order status for cancelled orders.
  • Apple Pay - configure whether you want to show the Apple Pay button on the basket and/or product details page.
Option
Shopping cart
Product detail page

See our Apple Pay GitHub page for more information.

  • Cronjobs - configure a cronjob on the webserver of your shop to schedule periodic execution of certain tasks.

Find the cronjob script here:

{{PATH TO YOUR SHOP}}/source/modules/mollie/molliepayment/cron.php

In the Enterprise Edition you can add shop-id as a param to the cron.php call. This will execute cronjobs only for the given shop (this script runs the job only for the shop with the ID 3):

php {{PATH TO YOUR SHOP}}/source/modules/mollie/molliepayment/cron.php 3

Calling the cronjob script via URL

When calling the cronjob via URL you have to configure a secure key of your own choice.

You have to add this secure key as the GET parameter secureKey to the URL call to prevent unauthorized execution of the script:

https://YOUR-SHOP-URL-HERE/modules/mollie/molliepayment/cron.php?secure- Key=YOUR-SECURE-KEY.
Sub-jobDescription
FinishOrders
(Completion of paid but unfinished orders)
This cronjob finishes corrupted orders and completes all the unfinished tasks (e.g sending the order confirmation email).
E.g a customer loses their internet connection after payment or a browser tab is closed before
their redirection to the shop, so the order is not finalized properly.
OrderExpiry
(Cancel unpaid orders automatically)
This cronjob cancels Orders with pending payments automatically after a certain time.
You can configure a timespan between 1 and 30 days or deactivate this for each payment method.
SecondChanceEmail
(Dispatch of payment re- minder email)
This cronjob sends a reminder email to your customer to finish the order. You can configure the day interval between the order attempt and sending the email. You can customize the email text in the CMS block Mollie Second Chance Email.

E.g a customer did not finish the checkout process or their payment failed. Emails are not sent out for paid or cancelled orders.
OrderShipment
(Transmission of shipping status to Mollie)
This cronjob passes shipping status and tracking code to Mollie.
E.g the shipping status in your shop is set via an external system (like an ERP) and not via the "Send Now" button in the OXID backend.
Capture of paymentsThis cronjob captures fulfilled orders.
  • Alternative payment logos - configure your own logos for the individual payment methods. These will be displayed in the checkout instead of the standard logos.

Connect

Mollie gives you two API keys to authenticate OXID 6 requests:

  • Test key: Use this key when setting up and testing Mollie.
  • Live key: Use this key after Mollie has approved your account and you are ready to accept live payments.

To connect with Mollie, follow these steps:

  1. Log in to your Mollie Dashboard.
  2. Select the organization from the menu in the top-left corner of the dashboard's home page.

❗️

Important

To comply with UK regulations, UK-based merchants have to select a UK-registered organization to ensure that they use the correct API keys.

  1. Go to More > Developers > API keys.
  2. Copy the API keys.
  3. Log in to OXID 6.
  4. Go to Extensions > Modules.
  5. Select Mollie Payment.
  6. Open Settings > Basic Configuration and paste the API keys into their respective fields.
  7. Select Test or Live mode depending on the mode you want to use.
    We recommend enabling test mode until you are sure that everything works as you expect.
  8. Click Test API keys to verify that your API keys work.
    NOTE: The Test API Keys button is only available if the keys are saved. If no key is stored in the
    configuration, the button won't show up.
  9. Save the changes.