Shopware 5
Shopware 5
This guide describes how to integrate Sezzle into your Shopware 5 website so that you can provide Sezzle as a payment option for your customers. Additionally, it includes steps to upgrade existing integrations to the latest version of the plugin.
Sezzle's Shopware 5 plugin can be Download from github.
After integrating Sezzle, your site will:
- offer Sezzle as a payment option on the checkout page.
- refund Sezzle payments from your Shopware 5 backend.
- authorize and capture payments.
- offer instant and delayed capture.
Integration Steps Overview
- Install and configure the Sezzle Shopware 5 Plugin
- Test your integration
- (Optional) Sandbox Testing
Before You Begin
- You should have a Sezzle merchant account.
- Please visit our signup page if you don't have an account.
- Make sure you have the following Sezzle details handy.
- Familiarize yourself with the transaction flow when buying with Sezzle.
Install the Sezzle Shopware 5 Plugin
In the following section, [Shopware]
refers to your Shopware 5 root directory.
Using the Composer
Go to the Shopware 5 installation directory, then run the below commands:
- Open terminal and navigate to
Shopware
root path. - Run the below command for the adding the plugin into your codebase:
composer require sezzle/shopware5
Manual Method
- Download the .zip or tar.gz file from
Sezzle's
github repository. - Unzip the file.
- Navigate to
Shopware
[Shopware]/custom/plugins/
either throughSFTP
orSSH
. - Copy
SwagPaymentSezzle
directory from unzipped folder to[Shopware]/custom/plugins/
. - Log in to
Shopware 5
Backend and navigate toConfiguration > Plugin Manager > Management > Installed
. - Find
Sezzle
from theUninstalled
list and click on the+
button to install the plugin. - Once installed, you will see
Sezzle
underInactive
list. Click on thex
button to activate the plugin. - After successful activation, you will be able to see
Sezzle
underConfiguration > Payment Methods
.
Upgrade the Shopware 5 Plugin
Using the Composer
- Change the version number of the
sezzle/sezzlepay
insidecomposer.json
. - Open terminal and navigate to
Shopware
root path. - Run the following command for the updating the plugin to a newer version:
composer update sezzle/sezzlepay
Manual Method
- Download the .zip or tar.gz file from
Sezzle's
github repository. - Unzip the file.
- Delete the contents from
[Shopware]/custom/plugins/SwagPaymentSezzle
. - Copy the contents of
SwagPaymentSezzle
directory from unzipped folder to[Shopware]/custom/plugins/SwagPaymentSezzle/
. - Log in to
Shopware
Backend and navigate toConfiguration > Cache/performance
. - Flush the cache storage by selecting
Clear shop cache
.
Configure Sezzle
Payment Configuration
- Make sure you have the
Merchant UUID
and theAPI Keys
from the Sezzle Merchant Dashboard. You must be registered with Sezzle to access the Merchant Dashboard. - Navigate to
Customers > Payments > Sezzle > Settings
in yourShopware
Backend. - Enable
Sezzle
by checking theEnable for this shop
checkbox. - Set the
Public Key
andPrivate Key
. - For testing, enable the Sandbox mode by checking the
Enable sandbox
checkbox. - You can also verify your
API Keys
by clicking on theTest API Settings
button. - Set the
Merchant UUID
. - Set the
Merchant Location
as per the store origin. - Check the
Enable Tokenization
checkbox to enable customer tokenization in the Sezzle checkout. If the customer agrees to be tokenized, then future checkouts for this customer will not require a redirect to Sezzle. See Customer tokenization - Set
Payment Action
asAuthorize only
for doing payment authorization only andAuthorize and Capture
for doing instant capture. Important: See Authorize Only vs Authorize and Capture for details about the difference between the two choices. - Check the
Enable Widget in PDP
checkbox to add the widget script and theSezzle Widget
Modal to the Product Display Page. - Check the
Enable Widget in Cart
checkbox to add the widget script and theSezzle Widget
Modal to the Cart Page. - Check the
Display errors
checkbox for showing upSezzle
related error code in the web URL on failure. - Set
Logging
toERROR
to log only error messages orALL
to log all messages, including errors, warnings, and notices. - Save the settings and clear the cache.

Your store is now ready to accept payments through Sezzle.
Frontend Functionality
- If you have successfully installed the Sezzle plugin, then Sezzle will be included as a payment method in the checkout page.
- Select
Sezzle
and continue. - Once you click
Complete Payment
, you will be redirected toSezzle Checkout
to complete the checkout. Note: If your account is already tokenized, skip the next two steps as you will not be redirected to Sezzle. - [Optional] On the final page of Sezzle Checkout, check the
Approve {Store Name} to process payments from your Sezzle account for future transactions. You may revoke this authorization at any time in your Sezzle Dashboard
to tokenize your account. - Finally, click on
Complete Order
to complete your purchase. - On successful order placement, you will be redirected to the order confirmation page.

Capture Payment
- If
Payment Action
is set toAuthorize and Capture
, capture will be performed instantly from the plugin after order is created and validated inShopware
. - If
Payment Action
is set toAuthorize
, capture needs to be performed manually from theShopware
backend. Follow the below steps to capture. - Go the order and click on
Sezzle
tab. - Enter a value in
Amount
field and click onCapture
to capture the payment inSezzle
.
Refund Payment
- Go the order and click on
Sezzle
tab. - Enter a value in
Amount
field and click onRefund
to refund the payment inSezzle
.
Release Payment
- Go the order and click on
Sezzle
tab. - Enter a value in
Amount
field and click onRelease
to release the payment inSezzle
.
Order Verification in Shopware Backend
Merchants should always check the payment status and amount of all orders. The following steps ensure that each action has been completed as expected.
- Log in to
Shopware
admin and navigate toCustomers > Orders
.

- Proceed into the corresponding order.
- Payment is successfully captured by
Sezzle
when: - Current Payment Status is
Completely Paid
. Capture Amount
equals theAuth Amount
.- Payment is only authorized when:
- Current Payment Status is
Open
. Auth Amount
equals theOrder Amount
.Capture Amount
equals0
.- Payment is refunded when:
- Current Payment Status is
Re-crediting
. Refund Amount
is equal to or less than theCapture Amount
.- Payment is released when:
- Current Payment Status is
The process is cancelled for a full release or Open for a partial release
. - Amount will be deducted from
Auth Amount
and should appear inReleased Amount
.

Order Verification in Sezzle Merchant Dashboard
- Log in to
Sezzle Merchant Dashboard
and navigate toOrders
. - Proceed into the corresponding order.
- Payment successfully captured has a status of
Approved
. - Payment authorized but not captured has a status of
Authorized, uncaptured
. - Payment refunded has a status of
Refunded
orPartially refunded
. - Payment released or not captured before the authorization expired has a status of
Deleted due to checkout not being captured before expiration
.
Customer Tokenization Details
- Log in to
Shopware
Backend and navigate toCustomers > Customers
. - Select customer to view tokenization details.
Sezzle Customer UUID
,Sezzle Customer UUID Expiry
andSezzle Customer UUID Status
will appear underFree text fields
.

Shopware 5 Sandbox Testing
- In the
Sezzle
settings page of yourShopware
Backend, enter theSandbox
API Keys
from your Sezzle Sezzle Merchant Dashboard and check theEnable sandbox
checkbox, then save the configuration. Make sure you are doing this on yourdev/staging
website. - On your website, add an item to the cart, then proceed to
Checkout
and selectSezzle
as the payment method. - Once you click
Complete Payment
, you will be redirected toSezzle Checkout
to complete the checkout. Note: If your account is already tokenized, skip the next four steps as you will not be redirected to Sezzle. - Sign In or Sign Up to continue.
- Enter the payment details using test data then click
Complete Order
. - [Optional] Check the
Approve {Store Name} to process payments from your Sezzle account for future transactions. You may revoke this authorization at any time in your Sezzle Dashboard
to tokenize your account. - Finally, click on
Complete Order
to complete your purchase. Sandbox
testing is complete. You can log in to yourSezzle Merchant Sandbox Dashboard
to see the test order you just placed.
Shopware 5 Live Checkout
- In the
Sezzle
settings page of yourShopware
Backend, enter theAPI Keys
from your Sezzle Merchant Dashboard and uncheck theEnable sandbox
checkbox, then save the configuration. - On your website, add an item to the cart, then proceed to
Checkout
and selectSezzle
as the payment method. - Click
Complete Payment
. - If you are redirected to the Sezzle checkout page, your integration is complete. Congratulations!
- Warning Don't complete the payment. Your checkout is now live, so you will be charged if you complete it.
Troubleshooting
Sezzle
plugin creates logs ofSezzle
action.- In the event that
Merchant Success
andSupport
teams are unable to resolve any issue, the Merchant may request that these logs be forwarded to thePlatform Integrations
team for further troubleshooting.. - Logs are named as
plugin_dev-<current-date>.log
. To facilitate troubleshooting, we recommend sending thecore_dev-<current-date>.log
as well.. - Logs can be find in
[Shopware]/var/log/
.
Updated 8 months ago