Managing Refunds as admin

The Refund Plugin enhances the Sylius Admin Panel with tools to issue refunds, generate Credit Memos (PDFs), and record Refund Payments for clear financial traceability.

Browse all Credit Memos

After installation, the plugin adds an Admin grid for Credit Memos. It lists key information such as credit memo number, related order, customer, issued date, and a Download PDF action (if PDFs are enabled). If you do not see the entry, ensure the plugin’s admin routes are imported and assets are built.

Issue a refund from the Order view

Open Admin → Orders → {Order} and use the refund section on the order page to refund units (items) and/or shipments, either partially or fully. Confirming the refund triggers the flow that creates a Credit Memo and records a Refund Payment.

  • The order shows a new Refund Payment entry.

  • A Credit Memo exists (and if PDFs are enabled, a PDF is available to download).

Download Credit Memo PDFs

Each Credit Memo can be downloaded as a PDF when PDF generation is enabled. The plugin uses wkhtmltopdf; set a custom path if it’s not in the default location, or disable PDFs while keeping refunds functional.

# config/packages/sylius_refund.yaml
sylius_refund:
  pdf_generator:
    enabled: false
# .env
WKHTMLTOPDF_PATH=/path/to/wkhtmltopdf

View Credit Memos for a specific order

On the order details screen, you can see the Credit Memos (and the related Refund Payment entry) linked to that order, making reconciliation straightforward from a single place.

Tips & troubleshooting

  • No menu/grid? Check route import and rebuild Admin assets.

  • PDF not generated? Install wkhtmltopdf, set WKHTMLTOPDF_PATH, or disable PDFs.

  • Refund not possible? Ensure at least one offline payment method or extend parameters.sylius_refund.supported_gateways (online refund API calls remain project-side).

Last updated

Was this helpful?