Configuration
Everything here happens in the Sylius back office, under Configuration → Payment methods.
Each payment method you create is one gateway, connected to one Payplug account, serving one set of channels. Create as many as you need.
Configuration → Payment methods → Create, then pick the gateway type — Payplug, Oney by Payplug, Bancontact by Payplug, and so on.
Fill in the usual Sylius fields (code, name, channels), set the Payplug options described below, and save.
Saving a new Payplug payment method sends you to Payplug to log in. Once you authorize the connection you land back on the payment method, now connected: the plugin has stored the credentials it will use for every call on this gateway.
The account you connected is shown on the payment method's edit screen, under Connected Payplug account. If it reads "Re-authenticate to display the connected account", the gateway was connected before the plugin started recording it — reconnect to fill it in.
To connect to a different account, tick Force OAuth reconnection and click Update. This starts the login flow again and replaces the stored credentials.
Every Payplug gateway has a LIVE Mode checkbox:
- unticked — TEST mode. No real money moves. The shop displays a TEST Mode badge.
- ticked — LIVE mode. Real payments.
The credentials for both modes are created when you connect the account, so switching is just this checkbox.
| Option | What it does |
|---|---|
| Enable One click | Shoppers can save a card and reuse it. They manage saved cards from their account area. Needs the feature enabled on your Payplug account. |
| Enable deferred capture | Authorize at checkout, capture later. Your code must trigger the capture — nothing captures automatically. |
| Display mode | How the card form appears. See below. |
The display mode is a three-way radio choice:
- Enable redirected payment (the default) — the shopper leaves for a Payplug-hosted page and comes back. Works in any currency.
- Enable payment integrated — card fields embedded in your checkout. EUR only: Sylius refuses to save the method if any selected channel's base currency is not EUR. Needs the feature enabled on your account.
- Advanced (beta) Hosted Fields — see below.
Card fields hosted by Payplug but rendered inside your own checkout. Two extra things are needed:
- Account ID — a mandatory field that appears when you select this mode. Your account manager provides it. Saving without it fails with "Advanced features require an Account ID, please contact your Account Manager."
-
A webhook receiver pointing at
https://your-shop.example.com/payplug/v2/ipn, configured once per merchant in the Payplug Cockpit. See Installation → Webhooks.
| Option | What it does |
|---|---|
| The fees are | For you — you absorb the financing fees. Split between you and your customers — the customer sees the cost in their schedule. |
Oney shows the shopper a simulated payment schedule at checkout. Two limits apply beyond the usual amount range: a cart of 999 items or more cannot be paid with Oney, and a payment can only be refunded 48 hours after the last transaction on it.
| Option | What it does |
|---|---|
| Minimum amount / Maximum amount | Narrows the range Scalapay is offered in. Leave empty to use the limits authorized by Payplug. |
The values are in EUR and can only tighten your account's limits, never widen them — the form rejects a range outside what Payplug authorizes.
No options beyond LIVE Mode. All four are EUR only.
You can run one Payplug payment method per channel, each connected to a different Payplug account — one per shop, one per country, however your business is organized.
One rule: a channel can be linked to at most one enabled payment method of a given gateway type. Two card gateways may coexist as long as their channels do not overlap.
The form enforces this as you go. A channel already taken by another enabled method of the same type is greyed out, and hovering it tells you which method holds it:
Channel WEB_FR is already linked to the enabled payment method "Card FR". Disable it, or remove that channel from one of the two.
To move a channel between two gateways of the same type, disable the one holding it first.
A configured payment method is not automatically offered. At checkout the plugin asks your Payplug account what it allows, and hides the method when:
- the order's currency is not one your account advertises for that method;
- the order total falls outside the minimum or maximum your account sets for that currency (or, for Scalapay, outside the range you configured above);
- the billing country is not among those the method accepts.
So a method that disappears for one cart and appears for another is usually working as intended. If it never appears, check the account first.
After every save, the plugin validates the payment method against your Payplug account — that the features you ticked are actually enabled on it, that required fields are filled. If a check fails, it disables the payment method and explains why in a red banner at the top of the screen:
⚠️ The payment method has been disabled because some validation criteria are not met.
Fix what the banner names, then re-enable the method.
The same applies to refunds: a payment can only be refunded through Payplug if its gateway is
listed in sylius_refund.supported_gateways
(Installation → step 4). The minimum
refundable amount is €0.10.
Official Payplug payment plugin for Sylius
Guides