riverty logo


Get Started Login

Shopware 6 Manual

Back to Shopware

Before Starting

Available Payment Methods

The payment methods that are available via Shopware 6:

Country 14-day invoice Direct Debit Fixed Installments Pay in 3

Merchant Portal Account

Please be sure to create a free Merchant Portal Account to get in contact with sales and complete the integration process.


Minimum Requirements:

  • Shopware (Version >= 6.4)
  • PHP (Version >= 7.4)
  • Complete installation of shopware (storefront and administration, not headless)

Instruction Screenshots

Please note, the screenshots in the below instructions may vary slightly from your interface due to differing versions of Shopware 6.

Steps for Integration

Group 21669.png

Step 1: Install Plugin

Group 21591 (4) (1).png

  1. Login to Shopware Admin Panel
  2. Click Extensions
  3. Click Store
  4. Search Riverty in the Search Bar
  5. Click Install

Group 21594 (1).png

  1. Click My Extensions
  2. Activate the Riverty Extension

Step 2: Select Plugin Settings

The Riverty Plugin provides several settings which need to be configured before the individual payment methods are configured.
Access Plugin Configuration Panel

Group 21597 (1).png

  1. Click on the Riverty Plugin
  2. Click Configuration
  3. You will need to scroll in the Configuration Panel to access the various settings

Sales Channels

In Shopware, "Sales Channels" refer to different storefronts or sales channels through which you sell your products. Each sales channel represents a separate instance of your online store that can have its own unique branding, product assortment, pricing, and customer base. Sales channels in Shopware allow you to reach different target markets or cater to specific customer segments effectively. Choose the Sales Channel Settings that best fits your shop.


All sales channels

  • This option includes all available sales channels in your Shopware setup.
  • It encompasses storefronts, headless setups, or any other configured sales channels.


  • The storefront sales channel refers to the traditional online store interface.
  • It's the channel that customers typically interact with when browsing products, adding items to their cart, and making purchases.


  • The headless sales channel is an approach to e-commerce where the front-end presentation layer is decoupled from the back-end infrastructure.


Group 21598 (1).png

Log full body of every request

  • This setting should remain enabled for troubleshooting purposes. Log files will be stored in the Shopware installation’s /var/log folder

Enable refund and cancellation

  • Refunds are supported in version 1.5.0 of the Shopware 6.4 module or newer. To make use of this functionality make sure to enable the refunds and cancellation option in the general settings of the module.
  • When this option is enabled, a refund section will appear on the order details page. In this refund section you are able to create a partial or a full refund. These refunds can only be done with orders that are captured from Shopware. See our Transaction Management Instructions for more information.



This setting allows you to connect to 1 of the 3 Riverty environments:



  • Disabled - no capture call towards Riverty will be made via the shop backend. Use this in case you are capturing the orders via the Riverty Merchant Portal or if using your own ERP system to send the capture calls to Riverty. If you are using an ERP, make sure to integrate the Riverty Capture API Request in your ERP system.
  • Manual set to paid- The Capture Request will be sent to Riverty when the order's payment status is set to PAID.
  • Manual set to shipped or paid - If activated, the plugin will trigger an automated capture via cronjob based on whether the order's delivery status has be set to SHIPPED or order's payment status is set to PAID.

Profile Tracking


Profile Tracking (Dropdown)

image-20240201-153713 1 (1).png

The Profile Tracking feature is used to reduce fraud and increase conversion rates. Use this functionality in accordance with the guidelines of the Riverty agreement during your onboarding process.

  • Disabled - no additional consumer data will be processed. Can lead to an increase of consumer rejection rates.
  • Enabled (Mandatory) - when enabled the consumer must accept the use of their data in accordance with our fraud screening

Profile Tracking Client ID

  • Provided by Riverty during your onboarding process

Step 3: Retrieve API Key

Leave your Shopware Settings Panel Open. Choose one of the below options to access and API Key:

Access API Key In Merchant Portal

Group 20079 (6).png

  1. Open the left menu
  2. Choose Developer Info in the left menu
  3. Show your API Key (This is only visible to Merchant Portal users with rights 'Administrator')

Note, you will need to switch countries/shops in the top-right corner of the Riverty Merchant Portal if you plan on using multiple API Keys

  • DACH merchants will receive an API key per country and per webshop
  • BENELUX merchants will receive an API key per country, per webshop, and per payment method

Group 21599 (1) (2).png

Step 4: Configure Payment Settings

Please refer to the table at the top of this page for which payment methods are available in which countries.

Group 21607 (1).png

  1. Enter the API key(s) you retrieved in “Step 3: Retrieve API Key” in API-Key [Country Name]
  2. Click Test API Key and a green checkmark should appear
    • If the API key test fails, double-check the key for typos and confirm the “Endpoint?” you selected in “Step 2” matches the type of API Key your retrieved in “Step 3”
  3. Click Save to save all the changes from “Step 2” and “Step 4”

Step 5: Complete Testing

Please note, this step is optional. However, testing your connection reduces the chance of errors on live transactions.

Self-Check Before Submission

You can self-check your test cases before submission to the Riverty Implementation Manager using the Get Order request. The response will show you how the transactions registered on Riverty’s side. Completing a self-check greatly increases the chances of passing testing on the first attempt. We suggest using Postman to complete a self-check.

Standard Test Scenarios

# Test Case Order Number
1. Test an order with multiple products
2. Test an order with a fixed discount
3. Test an order with a percentual discount
4. Test an order with a shipping fee
5. Test an order with an alternate delivery address
6. Test an order with pick-up points (if applicable)
7. Test an order with store pick-up (if applicable)
8. Test an order with a house number addition
9. Test and make sure the VAT is correctly received by Riverty

Customer Facing Messages

It is also necessary to check if the error messages are correctly shown to the customer.

  • Test a rejected authorize. Please make sure that the customer-friendly message is displayed correctly in the check-out.
  • Test a validation error. Please make sure that the customer-friendly message is displayed correctly in the check-out.

Payment Method Scenarios

After you tested all standard scenarios for the 14-day invoice you should start testing the other payment methods you activated. Please complete the tables with your order numbers and send them to your Riverty Implementation Manager.

Direct Debit

# Test Case Order Number
D-1. Test an order with the Direct Debit payment method

B2B Invoice

# Test Case Order Number
B-1. Test an order with the Business to Business payment method


# Test Case Order Number
I-1. Test an order with 3 month installments
I-2. Test an order with 6 month installments (if applicable)
I-3. Test an order with 12 month installments (if applicable)

Campaign Invoice

# Test Case Order Number
C-1. Test an order with the Campaign invoice payment method

Final Check (BeNeLux Only)

Now that Riverty is live, we only have to check whether orders are also coming in properly. You can test this per Riverty connection by placing a rejected order:

  1. Go to the webshop, and place a product in the shopping cart.
  2. Go to checkout and fill in the necessary information, for the email address you have to enter rejection@afterpay.nl
  3. Choose the payment method Riverty and finish the order
  4. The Riverty order should be rejected. If this is not the case and instead, you receive a technical error or an authorization error, please contact your Riverty Implementation Manager