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. For the step-by-step setup, see Installation, then Configuration.

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.

What each method actually allows — currencies, minimum and maximum amounts, accepted billing countries — is read from your Payplug account at checkout, not configured here. A method your account does not cover is simply not offered to the shopper, and a cart outside its limits hides it for that order.

Card payment display modes

The Payplug gateway offers the card form three ways. Pick one per payment method:

Mode	The shopper…	Notes
Redirected (default)	leaves for a Payplug-hosted page and comes back	Works in any currency
Integrated payment	stays on your checkout, card fields embedded	EUR only; needs the feature enabled on your account
Hosted Fields (beta)	stays on your checkout, fields hosted by Payplug	Needs an Account ID and a webhook receiver — see Configuration

What the plugin also gives you

• One click — shoppers save a card and reuse it, managed from their account area.
• Deferred capture — authorize at checkout, capture when you ship. Requires a capture trigger in your own code.
• Refunds — full or partial, from the Sylius back office, through Sylius Refund Plugin.
• Multi-channel — one payment method per channel, each connected to its own Payplug account. See Configuration.

Getting started

1. Installation — require the package, run the migrations, apply the entity traits, enable refunds.
2. Configuration — create a payment method, connect it to your Payplug account, set the per-method options.

Getting help

• Plugin bugs and questions: GitHub issues
• Your account, activating a payment method, or its limits: your Payplug account manager

License

MIT