sylius/mollie-plugin

Mollie payment plugin for Sylius applications.

Maintainers

Details

github.com/Sylius/MolliePlugin

Source

Issues

Fund package maintenance!
sylius

Installs: 1

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 10

Forks: 1

Open Issues: 2

Type:sylius-plugin

v1.0.0 2025-04-03 05:19 UTC

Requires

Requires (Dev)

Conflicts

MIT 3ec8ce08bedec50e2eb66b90309b57951f73f0d7

This package is auto-updated.

Last update: 2025-04-04 02:31:15 UTC

README

Sylius Logo.

Mollie Payments Plugin

This plugin provides seamless Mollie integration for Sylius stores.

Accept payments through over 20 different methods with Mollie – trusted by over 70,000 businesses in Europe.

Table of Contents

Overview

Screenshot showing payment methods show in shop Screenshot showing payment methods show in admin Screenshot showing payment method config in admin

Mollie is one of the most advanced and developer-friendly payment gateways in Europe. This plugin integrates Mollie into Sylius and is officially certified by Mollie.

Our mission is to create a greater playing field for everyone. By offering convenient, safe world-wide payment solutions we remove barriers so you could focus on growing your business.

Mollie provides a powerful API allowing webshop and app developers to implement over 20 payment methods with ease. Their services are fast, reliable, and constantly innovating the European payments landscape.

Demo

You can quickly test the plugin using Docker. Just run:

docker run -p 8080:80 -p 8025:8025 ghcr.io/sylius/mollieplugin:1.0

If you'd like to run it in development mode (with debug tools enabled), use:

docker run -p 8080:80 -p 8025:8025 -e APP_ENV=dev -e APP_DEBUG=1 ghcr.io/sylius/mollieplugin:1.0

Installation

Beware!

This installation instruction assumes that you're using Symfony Flex. If you don't, take a look at the legacy installation instruction. However, we strongly encourage you to use Symfony Flex, it's much quicker!

1. Ensure that you have wkhtmltopdf installed, and that you have the proper path to it set in the .env file (WKHTMLTOPDF_PATH and WKHTMLTOIMAGE_PATH variables)(Visit RefundPlugin for more information).

2. Require Mollie plugin with composer:

composer require sylius/mollie-plugin --no-scripts -W

3. Update the GatewayConfig entity class with the following code:

<?php

declare(strict_types=1);

namespace App\Entity\Payment;

use Doctrine\ORM\Mapping as ORM;
use SyliusMolliePlugin\Entity\GatewayConfigInterface;
use SyliusMolliePlugin\Entity\GatewayConfigTrait;
use Doctrine\Common\Collections\ArrayCollection;
use Sylius\Bundle\PayumBundle\Model\GatewayConfig as BaseGatewayConfig;

/**
 * @ORM\Entity
 * @ORM\Table(name="sylius_gateway_config")
 */
#[ORM\Entity]
#[ORM\Table(name: 'sylius_gateway_config')]
class GatewayConfig extends BaseGatewayConfig implements GatewayConfigInterface
{
    use GatewayConfigTrait;

    public function __construct()
    {
        parent::__construct();

        $this->mollieGatewayConfig = new ArrayCollection();
    }
}

Ensure that the GatewayConfig resource is overridden in the Sylius configuration file:

# config/packages/_sylius.yaml
...

sylius_payum:
    resources:
        gateway_config:
          classes:
              model: App\Entity\Payment\GatewayConfig

4. Update the Order entity class with the following code:

<?php

declare(strict_types=1);

namespace App\Entity\Order;

use Doctrine\ORM\Mapping as ORM;
use Sylius\Component\Core\Model\Order as BaseOrder;
use SyliusMolliePlugin\Entity\AbandonedEmailOrderTrait;
use SyliusMolliePlugin\Entity\MolliePaymentIdOrderTrait;
use SyliusMolliePlugin\Entity\OrderInterface;
use SyliusMolliePlugin\Entity\QRCodeOrderTrait;
use SyliusMolliePlugin\Entity\RecurringOrderTrait;

/**
 * @ORM\Entity
 * @ORM\Table(name="sylius_order")
 */
#[ORM\Entity]
#[ORM\Table(name: 'sylius_order')]
class Order extends BaseOrder implements OrderInterface
{
    use AbandonedEmailOrderTrait;
    use RecurringOrderTrait;
    use QRCodeOrderTrait;
    use MolliePaymentIdOrderTrait;
}

Ensure that the Order resource is overridden in the Sylius configuration file:

# config/packages/_sylius.yaml
...

sylius_order:
    resources:
        order:
            classes:
                model: App\Entity\Order\Order

5. Update the Product entity class with the following code:

<?php

declare(strict_types=1);

namespace App\Entity\Product;

use Doctrine\ORM\Mapping as ORM;
use Sylius\Component\Core\Model\ProductTranslationInterface;
use SyliusMolliePlugin\Entity\ProductInterface;
use SyliusMolliePlugin\Entity\ProductTrait;
use Sylius\Component\Core\Model\Product as BaseProduct;

/**
 * @ORM\Entity
 * @ORM\Table(name="sylius_product")
 */
#[ORM\Entity]
#[ORM\Table(name: 'sylius_product')]
class Product extends BaseProduct implements ProductInterface
{
    use ProductTrait;

    protected function createTranslation(): ProductTranslationInterface
    {
        return new ProductTranslation();
    }
}

Ensure that the Product resource is overridden in the Sylius configuration file:

# config/packages/_sylius.yaml
...

sylius_product:
        resources:
            product:
                classes:
                    model: App\Entity\Product\Product

6. Update the ProductVariant entity class with the following code:

<?php

declare(strict_types=1);

namespace App\Entity\Product;

use Doctrine\ORM\Mapping as ORM;
use Sylius\Component\Core\Model\ProductVariant as BaseProductVariant;
use Sylius\Component\Product\Model\ProductVariantTranslationInterface;
use SyliusMolliePlugin\Entity\ProductVariantInterface;
use SyliusMolliePlugin\Entity\RecurringProductVariantTrait;

/**
 * @ORM\Entity
 * @ORM\Table(name="sylius_product_variant")
 */
#[ORM\Entity]
#[ORM\Table(name: 'sylius_product_variant')]
class ProductVariant extends BaseProductVariant implements ProductVariantInterface
{
    use RecurringProductVariantTrait;

    protected function createTranslation(): ProductVariantTranslationInterface
    {
        return new ProductVariantTranslation();
    }

    public function getName(): ?string
    {
        return parent::getName() ?: $this->getProduct()->getName();
    }
}

Ensure that the ProductVariant resource is overridden in the Sylius configuration file:

# config/packages/_sylius.yaml
...

sylius_product:
        resources:
          product_variant:
                classes:
                    model: App\Entity\Product\ProductVariant

7. Add image directory parameter in config/packages/_sylius.yaml:

# config/packages/_sylius.yaml

   parameters:
       images_dir: "/media/image/"

8. Update your database

After running all the above-mentioned commands, run migrate command

bin/console doctrine:migrations:migrate

9. Copy Sylius templates overridden in plugin to your templates directory (e.g templates/bundles/):

Note: Some directories may already exist in your project

mkdir -p templates/bundles/SyliusAdminBundle/
mkdir -p templates/bundles/SyliusShopBundle/
mkdir -p templates/bundles/SyliusUiBundle/
mkdir -p templates/bundles/SyliusRefundPlugin/

Note: Be aware that the following commands will override your existing templates!

cp -R vendor/sylius/mollie-plugin/tests/Application/templates/bundles/SyliusAdminBundle/* templates/bundles/SyliusAdminBundle/
cp -R vendor/sylius/mollie-plugin/tests/Application/templates/bundles/SyliusShopBundle/* templates/bundles/SyliusShopBundle/
cp -R vendor/sylius/mollie-plugin/tests/Application/templates/bundles/SyliusUiBundle/* templates/bundles/SyliusUiBundle/
cp -R vendor/sylius/mollie-plugin/tests/Application/templates/bundles/SyliusRefundPlugin/* templates/bundles/SyliusRefundPlugin/

10. Install assets:

bin/console assets:install

Note: If you are running it on production, add the -e prod flag to this command.

11. Add the payment link cronjob:

* * * * * /usr/bin/php /path/to/bin/console mollie:send-payment-link

12. Download the domain validation file and place it on your server at:

public/.well-known/apple-developer-merchantid-domain-association

Frontend Asset Management

  1. Import the plugin's assets into your application's entrypoint files:

    // assets/admin/entry.js

import '../../vendor/sylius/mollie-plugin/src/Resources/assets/admin/entry.js'

    and:

    // assets/shop/entry.js

import '../../vendor/sylius/mollie-plugin/src/Resources/assets/shop/entry.js'

  2. Install assets:

    bin/console assets:install

Installation & Build Process

  1. If you are using Sylius version <= 1.11 ensure that Node version 12 is currently used:

    nvm install 12
nvm use 12

    otherwise Node version 14 should be used.

  2. Install dependencies:

    yarn add @babel/preset-env bazinga-translator intl-messageformat lodash.get node-sass@4.14.1 shepherd.js@11.0 webpack-notifier
yarn add --dev @babel/core@7.16.0 @babel/register@7.16.0 @babel/plugin-proposal-object-rest-spread@7.16.5 @symfony/webpack-encore@1.5.0

  3. Build assets:

    for development:

    yarn install
yarn build
yarn encore dev

    for production:

    yarn install
yarn build
yarn encore production

  4. Clear cache:

    php bin/console cache:clear

  5. [Optional] Load fixtures:

    bin/console sylius:fixtures:load

⚠️ SyliusRefundPlugin Troubleshooting

If you encounter an error related to duplicate transitions in the sylius_refund_refund_payment state machine (e.g. multiple "complete" transitions from "new" state),
you should remove the following file from your project:

config/packages/sylius_refund.yaml

You should remove it if your project does not use Symfony Workflow

Sylius API

In order to create Mollie payment with Sylius API, the following steps must be followed:

  • send the following request to the Sylius API in order to retrieve Mollie payment method configuration: /api/v2/shop/orders/{tokenValue}/payments/{paymentId}/configuration
  • tokenValue represents order token which is saved in the sylius_order DB table
  • response from this endpoint should be in the following format:
{
  "method": "ideal",
  "issuer": "ideal_ABNANL2A",
  "cardToken": null,
  "amount": {"value":"18.75","currency":"EUR"},
  "customerId": null,
  "description": "000000157",
  "redirectUrl": "{redirect_url}",
  "webhookUrl": "{webhook_url}",
  "metadata": {"order_id":170,"customer_id":22,"molliePaymentMethods":"ideal","cartToken":null,"saveCardInfo":null,"useSavedCards":null,"selected_issuer":"ideal_ABNANL2A","methodType":"Payments API","refund_token":"{token}"},
  "locale": "en_US"
}

  • create the payment on Mollie, using Mollie API. Response from the above-mentioned step should be put in the request body. Request should be sent to the POST: https://api.mollie.com/v2/payments. Bearer token should be sent in the request authorization header. Token can be copied from the Mollie admin configuration page.

  • after payment has been created, API response will contain checkout field. User should enter this url in the browser.

{
  "checkout": 
    {
    "href": "https://www.mollie.com/checkout/test-mode?method=ideal&token=6.voklib",
    "type": "text/html"
}}
  • open checkout url in the browser and complete the payment

Usage

During configuration, first save the keys to the database and then click "Load methods".

Rendering Mollie credit card form

You can use:

  • SyliusMolliePlugin:DirectDebit:_form.html.twig
  • @SyliusMolliePlugin/Grid/Action/cancelSubscriptionMollie.html.twig

See these examples.

Security issues

If you think that you have found a security issue, please do not use the issue tracker and do not post it publicly. Instead, all security issues must be sent to security@sylius.com

Community

For online communication, we invite you to chat with us & other users on Sylius Slack.