Home

SyliusPayPlugPlugin

Official Payplug payment plugin for Sylius.

It adds Payplug's payment methods to your shop's checkout and lets you refund them from the Sylius back office. Payplug builds and maintains it.

This page is the overview — what the plugin offers and what it needs. Each topic has its own page; the guide map below tells you where to go.

Requirements

• PHP ^8.2, Sylius ^2.0, Symfony ^6.4. Tested in CI against PHP 8.2–8.4, Sylius 2.0–2.1 and Symfony 6.4–7.3. For Sylius 1.x, use this repository's 1.x branch.
• A Payplug account, with each payment method you intend to offer already activated on it.
• A publicly reachable shop. Payplug confirms payments by calling your shop back, so a localhost install never sees a payment complete.
• wkhtmltopdf, if you want refunds — Sylius Refund Plugin needs it to generate credit memos.

Payment methods

Method	Gateway type in the admin	Currency
Card	Payplug	Any, except in integrated-payment mode (EUR)
Oney — pay in 3 or 4 installments	Oney by Payplug	EUR
Bancontact	Bancontact by Payplug	EUR
Scalapay — buy now, pay later	Scalapay by PayPlug	EUR
Apple Pay	Apple Pay by Payplug	EUR
American Express	American Express by Payplug	EUR
Wero	Wero by PayPlug	EUR

The EUR-only methods require the channel's base currency to be EUR; Sylius refuses to save the payment method otherwise. Options for each method are on Payment methods.

What the plugin also gives you

• Three card display modes — redirected, integrated, or Hosted Fields (beta). See Payment methods.
• One click — shoppers save a card and reuse it, managed from their account area.
• Deferred capture — authorize at checkout, capture when you ship. See Deferred capture.
• Refunds — full or partial, from the Sylius back office, through Sylius Refund Plugin. See Refunds.
• Multi-channel, multi-account — one payment method per channel, each connected to its own Payplug account. See Multiple channels and accounts.

Guide map

I want to…	Read
Install the plugin	Installation
Create a payment method and connect my Payplug account	Configuration
Set the options of a given payment method	Payment methods
Run several shops, countries or companies from one Sylius	Multiple channels and accounts
Use Hosted Fields	Hosted Fields
Capture a payment later	Deferred capture
Refund an order	Refunds
Understand payment notifications, recover a lost one, read the logs	Webhooks and logging
Work out why a method is missing or a payment is stuck	Troubleshooting

Getting help

• Plugin bugs and questions: GitHub issues
• Your account, activating a payment method, or its limits: your Payplug account manager
• Testing the plugin against a Payplug test environment: contact your Payplug account manager

License

MIT