Plugin
WooCommerce
WooCommerce is a popular extension for the WordPress online publishing platform, which turns a WordPress instance into a fully functional webshop. Riverty has developed a plugin that easily integrates with a WooCommerce webshop. It is a simple way to let your customers start using Riverty at checkout. You don't need advanced technical skills to add Riverty to your webshop!
Website:
https://woocommerce.com/
Type:
Plugin
Introduction
This guide describes the steps to quickly install, configure, test and activate the Riverty payment methods in your WooCommerce store.
We offer 6 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.
- Fixed instalments - This is a Part Payment invoice. The customer can split their purchase over multiple monthly fixed payments.
- Flex payment - This is a flexible instalment plan. Shoppers can alter the amount they are willing to pay every month in Riverty’s customer portal. However, consumers are obliged to pay a monthly minimum as defined by Riverty.
- B2B invoice - This is the B2B consumer version of the default 14-day invoice payment method in Riverty.
- 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 can be found in this table:
| Country | 14-day invoice | Direct Debit | Fixed instalments | Flex payment | B2B invoice | Pay in 3 |
|---|---|---|---|---|---|---|
| The Netherlands | ||||||
| Belgium | ||||||
| Germany | ||||||
| Austria | ||||||
| Switzerland | ||||||
| Sweden | ||||||
| Norway | ||||||
| Finland | ||||||
| Denmark |
Setup
This document assumes you already have a working, configured WordPress site, with the WooCommerce extension installed. If you don't, you can download the software and learn how to use it here.
Many web hosting services have a backend tool that lets you install popular software packages with just a few clicks, and WordPress is often included in those.
In this chapter we will explain how you can install and configure Riverty for your webshop.
Installation
You can install the Riverty plugin via the WordPress Marketplace, by searching from your Plugins tab in the WordPress Admin, or here.
After installing the plugin, make sure to activate it.
Upgrade the plugin
If you have installed the plugin via the WordPress Marketplace, it should update automatically.
Basic settings
Each combination of a country (Netherlands, Germany, Sweden, etc.) and Riverty payment method (14-day invoice, Direct Debit, Part Payment) is a separate payment method under the Payments settings. In some countries, there are also separate B2B payment methods for business-to-business (as opposed to business-to-consumer) sales - this accounts for different tax handling, etc.
You can have more than one payment method enabled in each country.
To configure your payment methods:
1) Open the WordPress Admin Panel.
2) In the left-hand menu, go to WooCommerce > Settings, then select the Payments tab.
3) Flip the Enabled switch for a payment method to enable that combination. (Country and Riverty payment method)
4) Click Manage/Set up next to a payment method to open its configuration screen.
5) Test mode:
-Select Test if you have already received a test API key from Riverty.
-Select Yes - Sandbox if you have created your own Sandbox key via the developer portal.
-Select No to disable Test mode and to use the payment methods in Production set up.
If you are testing the connection on your production environment you need to activate the IP restriction. The payment method will only be shown to the IP address that is entered in WooCommerce. This will prevent customers from seeing the test payment method.
6) Enter your API key for the corresponding environment in the API Key field.
7) After you configure everything you want, click Save changes at the bottom.
Tax settings
Riverty assumes that your WooCommerce webshop already has the correct tax classes - the VAT categories and tax rates for your products. In some countries, certain items such as books, food, event tickets, etc. may have VAT rates that are smaller than usual, or even zero. These rules must be configured to ensure that Riverty handles tax, invoicing and settlement correctly.
See WooCommerce's own documentation for help.
Testing
After completing the setup the next step is to test the connection.
Standard test scenarios
Please submit the following test scenarios. To check your own test transactions proceed to paragraph check test order. Complete the table with your order numbers and send it to your Riverty Implementation Manager. You can put multiple test cases in one order but please refer to the right order number after each testcase.
| # | 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 |
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.
If you want to integrate Direct Debit please proceed with this test order:
| # | Test case | Order number |
|---|---|---|
| D-1. | Test an order with the Direct Debit payment method |
If you want to integrate invoice for Business to Business please proceed with this test order:
| # | Test case | Order number |
|---|---|---|
| B-1. | Test an order with the Business to Business payment method |
If you want to integrate Instalments please proceed with these test orders:
| # | Test case | Order number |
|---|---|---|
| I-1. | Test an order with 3 month instalments | |
| I-2. | Test an order with 6 month instalments (if applicable) | |
| I-3. | Test an order with 12 month instalments (if applicable) |
If you want to integrate a Campaign invoice please proceed with this test order:
| # | Test case | Order number |
|---|---|---|
| C-1. | Test an order with the Campaign invoice payment method |
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 validation error. Please make sure that the customer friendly message is displayed correctly in the check-out.
Check test order
You are able to verify the transactions on the Riverty side by yourself. You can do this with the "GET ORDER" call. You can send these calls for example with Postman. The response will show you how the transactions a registered on the Riverty side. Documentation for the "GET ORDER" call can be found below.
/api/v3/orders/{orderNumber}
Go-live
In this chapter we will explain which steps you need to take to enable the payment method on production.
Configure live mode
1) Make sure you have completed testing with your implementation consultant. Once you have received the production API key you can continue.
2) Make sure you configured the payment methods correctly on the production environment.
3) Enter the Production API key in the API key.
4) Disable testing mode by setting Test mode to No.
5) Enable the payment method
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
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.
Support
Payment method settings
This sections describes the full list of payment methods setting available in the Riverty plugin.
Please note not every setting is available in every payment method.
| Field | Description |
|---|---|
| Enable/Disable | Check the box to make this Riverty payment method available to your webshop's customers in this country. |
| Title | Enter the name of the payment method, as it will appear to the customer on the checkout page. |
| Extra information | Enter the extended information shown to the customer at checkout. This can be a detailed description, information about current campaigns, etc. |
Merchant ID, Portfolio Number, Portfolio Password are only applicable for The Netherlands and Belgium
| Field | Description |
|---|---|
| Portfolio Number | Enter the Portfolio Number you got from your Key Account Manager. |
| Portfolio Password | Enter the Portfolio Password you got from your Key Account Manager. |
| API Key | The Auth key for transactions. You can get a test Auth key from your Key Account Manager. You must use a separate Auth key for each country, but you can use the same Auth key for each payment method in the same country. |
| Lower threshold | The minimum shopping cart value for which Riverty will be available as a payment method. Value is in the country's local currency. |
| Upper threshold | The maximum shopping cart value for which Riverty will be available as a payment method. Value is in the country's local currency. |
| Test Mode | Check this box to tell Riverty that you are making test transactions. In Test Mode, customer verification/risk checks always return positive, transactions won't be rejected because the address is wrong, and the money will not be added to the merchant's settlement account. There will be no emails sent to the customer, and no Customer Portal where they can pay the invoice. |
| Debug mail | If you enter an email address here, the complete technical details of each Riverty transaction in your webshop will be sent to that address. |
| Show phone number | Check the box to ask the customer for their phone number in the Riverty section of the checkout page. If your WooCommerce checkout page is already configured to collect the customer's phone number, you can leave this unchecked. |
| Show date of birth | This setting should be enabled by default. |
| Show terms and conditions | Check the box to display Riverty's Terms & Conditions text and checkbox in the Riverty section of the checkout page. The content is provided automatically by the Riverty plugin. The text will be in the country's local language, and specific to that country's legal requirements. |
| Exclude shipping methods | Do not show Riverty if selected shipping methods are used. |
| Use custom housenumber field | Enter a custom label for the "House Number" field in checkout. Leave empty to use the default label. |
| Use custom housenumber addition field | Enter a custom label for the "Apartment Number" field in checkout. Leave empty to use the default label. |
| IP restriction | If you enter an IP address, this payment method will only be displayed to customers coming from that public IP address.This is useful in testing mode - you can show the payment method only to your own computer or office network until you are ready to go live. To find your current public IP, go to Google.com and type in "what is my ip". |
| Enable captures | If you check this box, the plugin will attempt to Capture the orders automatically. Do not check this box if you have a warehouse/stock management system that is separately integrated with Riverty (using the same Auth key), and it sends the Capture call when an item is shipped, independently of the WooCommerce webshop. |
| Way of captures | Automatically after authorization - the plugin will make a Capture as part of the checkout process. Based on Woocommerce Status - the plugin will make a Capture when the order is set to a particular status in the webshop. (See below) |
| Status to capture based on | If Way of captures is set to Based on Woocommerce status, the plugin will capture the invoice amount as soon as the order is set to this status. |
| Enable refunds | Check this box to allow refunds from the webshop's backend interface. They will be processed by Riverty. Otherwise, any refund to the customer will have to be handled entirely outside Riverty. To refund an order via Riverty, open your Wordpress Admin Panel and go to WooCommerce > Orders > click on an order > Refund. You will have two options: Refund manually (outside of Riverty) and Refund via Riverty. |
| Refund tax percentage | The VAT rate used when you make a refund via Riverty. Because the Riverty module can refund a given amount (but not individual invoice items), the VAT share of the original invoice amount needs to be handled correctly. If you have items that were charged at a non-standard VAT rate, use Refund manually. |
| Compatibility with Germanized | Check this box to use a Title (Mr/Mrs/etc.) field that's customized for German-speaking countries, instead of WooCommerce's generic Title field. |
| Merchant ID | Use this field to configure merchant specific terms and conditions based on the Merchant ID |
Compatibility
The plugin has recently been checked for compatibility with the following Woocommerce versions and external plugins. The compatibility of external plugins is not part of the default test cases for release.
- Woocommerce 6.6.1
- Wordpress 6.0
- Germanized 1.9.6
- Payment Gateway Based Fees and Discounts for WooCommerce 2.3.1
Source code
Our Woocommerce plugin is an open source plugin. The source is maintained in BitBucket, and can be found here:
https://bitbucket.org/afterpay-plugins/afterpay-woocommerce/src/master/
Release notes
version 6.1.1 - Released: 2022-07-12
Changed:
Disabled Riverty Elements Tab
version 6.1.0 - Released: 2022-07-11
Added:
- Added extra information to the order confirmation / ‘thank you’ page
- The terms and conditions will now open in a modal window to improve the checkout process.
- Added the possibility for merchant specific terms and conditions
- Added payment methods Direct Debit and Business 2 Business for the Netherlands.
- Added support for Riverty Elements.
- Added a box with USP’s per payment method.
- Added an intro text to guide the customer into the form fields.
Changed:
- Checked compatibility with Wordpress 6.0
- Checked compatibility with Woocommerce 6.6.1
- Updated to the latest version of the Riverty PHP Library (3.5.3)
- Changed the titles of the payment methods to uniform standard
- Changed the order of the payment methods
- Removed the gender fields
- Changed the styling of the terms and conditions
- Updated the bank account field, with field validation and feedback to improve the user experience.
version 6.0.0 - Released: 2022.03.08
Changed:
Comply to requirements of WordPress.
version 5.9.0 - Released: 2022.02.03
Changed:
- Compatibility with WordPress 5.9 and Woocommerce 6.1.1
Fixed:
- Fix for issue with Flex payment methods in the Nordics.
version 5.8.0 - Released: 2022.01.17
Changed:
- Updated payment methods in DACH (installments + birthday field)
- Updated birthday field in the Netherlands and Belgium.
- Removed Digital Invoice Extra for Germany.
Version 5.7.0 - Released: 04.11.2021
Fixed:
- Fixed issue with conflicting GuzzleHttp libraries.
- Fixed issue with image urls using variables, which are not allowed by the Riverty API.
- Fixed issue with frontend validation on birthdate, when nothing entered.
- Fixed issue with too much decimals in vatAmount.
Version 5.6.0 - Released: 01.11.2021
Fixed:
- Fixed issue with too much decimals in vatAmount.
Version 5.5.0 - Released: 30.09.2021
Added:
- Added plugin data fields in the 'authorize' and 'available payment methods' calls.
- Added Date of Birth to all payment methods for DE, AT, CH, DK, NL and BE.
Changed:
- Updated PHP Library to version 3.4.0.
- Update styling to new logo.
- Removed BIC from bank account validation, direct debit and installments.
Fixed:
- Fixed issue with overwriting settings.
