Introduction

This guide describes the functionalities of the Riverty plugin for Shopware 6.4 and how to set it up in your webshop.

In this Shopware plugin we offer 3 different payment options:

• 14-day invoice - This is the default 14-day invoice payment method in Riverty. It is always available in every market where Riverty operates. It is primarily meant for business-to-consumer sales.
• Direct Debit - This is a Direct Debit version of the 14-day invoice payment method Instead of receiving an invoice to be paid via their bank, the customer enters their bank details, and the money is immediately deducted from their bank account.
• Instalments - This is a Part Payment invoice. The customer can split their purchase over multiple monthly fixed payments.
• Pay in 3 - This is a part payment product, but unlike regular installment plans this product offering is not bound by the consumer credit laws as our payments will be always completed within 90 days.

The payment methods that are available via this plugin are:

Setup

Here's how to get started with using Riverty

1. You need a running Shopware instance, installed on your webserver (up to version 6.4.8.2)
2. Login to the admin section of Shopware and navigate the main menu to Extenstions -> Store.
3. Search for Riverty and once you find it, press Add Extension.

To configure the plugin access the settings section under the Shopware menu My Extensions.

API Credentials

First thing to set up is your Riverty Credentials and API key. Make sure to enter the API key for the corresponding country where your webshop will be accepting payments.

• If you just want to try Riverty without commitment, you can get one via the Developer Sandbox.
• Access to Partner Test credentials will be provided by your Implementation Manager at Riverty.
• When you are ready to go live, contact your Implementation Manager at Riverty. They
  will configure your webshop in the Riverty backend, and give you your Production API Key.

On you have set up your API credentials choose an Environment to connect to:

• Sandbox
• Partner Test
• Production/Live

Use the TEST button to check if the connection is established correctly.

With a successful connection running you can start testing and accepting payments with Riverty.

Basic configuration

The Riverty plugin provides extra settings that can be used to customize the behavior further.

Capture

• 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. In case of the later, make sure to set that up and integrate the Riverty Capture API call in your ERP system.
• Manual set to paid - Capture call 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 whether the order's delivery statushas be set to SHIPPED or order's payment status is set to PAID.

Profile Tracking

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

• Enabled - Mandatory - when enabled the consumer must accept the use of their data in accordance with our fraud screening
• Enabled - Optional - when enabled the end consumer has a choose to either accept or refuse to their data being processed
• Disabled - no additional consumer data will be processed. Can lead to increase of consumer rejection rates.
• Profile Tracking Client ID - Provided by Riverty during your onboarding process.

Sales Channel

Make sure to select for which channel the plugin will be active.

• Headless
• All channels
• Webshop

Logging

• Log full body of every request - Defines the logging level. Log files will be stored in the plugin folder.

Payment method settings

Payment method settings can be accessed from the Shopware main menu under Settings -> Shop ->Payment.

Available payment methods:

• 14-day invoice
• Direct Debit
• Instalments

For detailed definitions of the available payment methods please see the Introduction.

In the “Payment method” section, you can set general settings for the payment method.

In the “Availability rule” section, you can set existing rules or create new rules.

The availability of payment methods defers per country because of local demand and legislation. The currently available payment methods per country can be seen in the Introduction chapter.

To ensure successful integration of the Riverty services, it is vital that a vigorous testing is performed. Please refer to the Testing section of the Riverty integration guide for detailed guidelines on testing scenarios.

Go-live

In this chapter, we will explain which steps you need to take to enable the payment method on production.

Configure live mode

Once you and your Implementation Manager are satisfied with the validation of account setup and testing, you will get a Live Auth key and can start offering Riverty to your customers!

Note, you will only get the Live Auth Key after you have signed the contract with Riverty.

Last check (Only applicable for the BeNeLux)

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:

STEP 1
Go to the webshop, and place a product in the shopping cart.

STEP 2
Go to checkout and fill in the necessary information, for the email address you have to enter rejection@afterpay.nl.

STEP 3
Choose the payment method Riverty and finish the order.

RESULT
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.

Done

Congratulations! You just went live with your Riverty connection. Please notify your Riverty Implementation Manager that you went live. If you encounter any issues in the upcoming week you can contact your Riverty Implementation Manager. After that period you can contact our local Merchant Desk for help.

Introduction to the Riverty Merchant Portal

You can go to the Merchant Portal here. Once logged in, you will also see an in-depth guide on how to best use it.

In the merchant portal you can:

• View and mutate your Riverty orders
• Get financial reports
• Setup your branding in the Riverty systems

Manage your orders

Orders

All orders placed are listed in the Shopware 6 backend under the menu tab Orders. Here you can get all the necessary information about the orders.

View details of an order

Under the View tab, you can get more information about a particular order and adjust its status.

In the Details section, you can see all the information about the order. In addition, the order statuses are displayed, which can be changed here.

In the Status section you can adjust the status of the order and see the old order statuses.

Capture

Manual capture

The plugin offers automatic as well as manual capture options:

• 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. In case of the later, make sure to set that up and integrate the Riverty Capture API call in your ERP system.
• Manual set to paid - Capture call 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 whether the order's delivery statushas be set to SHIPPED or order's payment status is set to PAID.

Scheduled tasks with cronjob

The Riverty module for Shopware makes use of scheduled tasks to capture orders automatically. A 'capture' initiates the invoicing process towards the customer and should start after orders are being shipped. The scheduled task checks if orders are ready to be captured, and if so executes the capture request.

The scheduled task relies on the Shopware system and most probably are already configured on your Shopware environment because other modules make use of this as well. If not, or if you are not sure that this is done, it is best to take a look at the Shopware documentation. It describes how a scheduled task should be configured in your server environment.

If this is all configured, the Riverty module will add an entry to the database table:
scheduled_task
Identified as:
colo_afterpay.capture_payment_task
Normally with the status scheduled or queued. If there is an issue with this scheduled task, then the status will be error. And if so, you should look into the var/log directory to see if there are any descriptions of the problem.