For the complete documentation index, see llms.txt. This page is also available as Markdown.

Payments

To accept orders, your store needs at least one payment method. This page explains how payments work in Sylius, what you get out of the box, and how to connect a payment provider.

A payment method defines how customers can pay. Sylius separates two concepts here:

Payment gateway — the integration with an external payment provider (PayPal, Mollie, Stripe, Adyen, etc.). Gateways are provided by plugins.

Payment method — the configuration layer on top of a gateway. One gateway can power multiple payment methods (e.g. a "Credit Card" method and a "Pay Later" method, both using the same gateway).

The built-in Offline gateway

Sylius ships with one built-in gateway: Offline. It's useful for orders that are paid manually — bank transfer, cash on delivery, invoiced B2B orders — and needs no external account.

Configured by default in Sylius-Standard

A fresh Sylius-Standard install already comes with two ready-to-use payment methods, both based on the Offline gateway:

Name
Code
Gateway

Cash on delivery

cash_on_delivery

Offline

Bank transfer

bank_transfer

Offline

These come from the example data (fixtures) and are there to get you started — rename them, reconfigure them, or remove them to match your store.

Payments, taken care of

For online card and wallet payments, Sylius partners with leading payment service providers (PSPs). Their plugins come pre-installed in Sylius-Standard, so you don't build an integration from scratch — going live is a matter of onboarding, not development.

To start accepting payments with a provider, complete the onboarding flow inside its payment method to connect your store to your provider account (for example, your PayPal business account). Each provider's documentation walks you through it step by step:

Provider

PayPal

Read the docs

Stripe

Read the docs

Adyen

Read the docs

Mollie

Read the docs

On a Sylius-Standard release older than 2.2? Some of these plugins may not be bundled yet — we still recommend installing them to accept online payments. Each plugin's documentation covers installation.

Through these partnerships, payments come with SLA-backed support handled on the provider's side, by teams offering professional, dedicated customer service.

Creating a payment method

Whichever gateway you use, a payment method is created the same way in the admin panel:

  1. Go to Configuration → Payment Methods

  2. Click Create and select a gateway

  3. Set a name (shown to customers at checkout) and a code

  4. Assign it to a Channel

  5. Enable the method and save

For the preferred PSPs above, installing the plugin makes its gateway available here — create a payment method with that gateway, then follow the provider onboarding in the plugin's documentation to connect it to your account.

What's next

store

With payments configured, the next step is setting up how orders are delivered on the Shipments page.

Last updated

Was this helpful?