Riverty Logo


    Please select your page


    This guide describes the steps to quickly install, configure, test and activate the Riverty payment methods in your Magento 2 store.

    Riverty offers 5 different payment options via Magento 2:

    • 14-day invoice - This is the default 14-day invoice payment method in Riverty. It is always available in every market where AfterPay operates. It is primarily meant for business-to-consumer sales.
    • Campaign invoice - During peak seasons, such as Christmas, merchants may use campaign invoicing, which allows shoppers extended payment terms per purchase or a fixed due date.
    • 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 payments.
    • B2B invoice - This is the B2B consumer version of the default 14-day invoice payment method in Riverty.

    The available payment methods per country for Magento 2 can be found in this table:

    Country 14-day invoice Direct Debit Campaign invoice Fixed instalments Flex payment B2B invoice
    The Netherlands


    In this chapter we will explain how you can install and configure Riverty for your Magento webshop.


    There are two ways to install our plugin. You can install the plugin via SSH through composer. This is the recommended way due to the availability of direct updates. Or you can install the plugin via the Marketplace. At the moment updates are not directly available through the marketplace as Magento is reviewing every release before they publish it. Having a magento webshop running with version 2 or above is a prerequisite.

    SSH (recommended)

    You can install the extension through SSH, using composer. Updates are directly available via SSH.

    1) Change the directory to project root/ folder, and run the following command to install and update the Riverty module and dependencies:

    composer require arvato/afterpay-magento-2-extension

    2) Upgrade and flush Magento cache

    php bin/magento setup:upgrade php bin/magento cache:flush


    You are also able to install the plugin via the Magento Marketplace. Due to the currently long release reviews by Magento the updates will only be available with delays. You can find the Riverty extension here.

    Basic settings

    Please log into your Magento admin page and navigate to Stores -> Configuration -> Sales -> Payment Methods.

    The Riverty payment methods are split per country. Therefore, activate the Riverty payment method based on the countries with the values shown below and from the mail you received from your Riverty implementation consultant.

    Important: For backwards compatibility in The Netherlands and Belgium, Legacy SOAP payment methods are still included. Please do not use those unless specified otherwise by Riverty.

    Magento Test mode settings.png

    Advanced settings (optional)

    Advanced settings are optional. Everything is setup correctly as standard. Only for some special integrations it can be necessary to amend these settings. Be careful when changing these settings. Please contact your Implementation Manager when you are in doubt.

    You will find the advanced and developer settings here.


    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.

    GET /api/v3/orders/{orderNumber}

    Returns the contents of the specified order

    Visual guidelines

    In this chapter we will explain the Riverty visual guidelines you need to apply to your webshop.

    Logos and banners

    For convenience and a familiar customer experience, please integrate/enclose the Riverty logo in your Checkout next to the payment method. Please refer to our Merchant Playbook for full details on how to make the customer experience smooth and frictionless.

    When Implementing the Riverty logo throughout the shopping experience please ensure you are using our URL, not by downloading the image. The Riverty logos are hosted on a Content Delivery Network (CDN) to ensure the best performance and availability for your website. Furthermore, you do not have to care about changes, which are all done by Riverty.

    We provide two types of logos through our CDN - .svg and .png. We recommend using the Riverty logo as a .svg file with regard to the quality and size of the file. If you prefer .png just change the end of the URL to .png. We also offer the Riverty logo in different color schemes. Depending on your individual website background, choose the Riverty logo that fits best.

    DescriptionCopy URLLogo
    Riverty-AfterPay Checkout Logo in SVGhttps://cdn.riverty.design/logo/riverty-checkout-logo.svgRiverty-AfterPay Checkout Logo in SVG

    Terms and conditions

    Riverty mandates that it is mandatory for a consumer to be presented with Riverty's terms and conditions and Privacy Policy upon checkout. Thus the option to display the T&C should be always enabled in the plugin configuration. In certain cases where you would like to incorporate the Riverty T&C and Privacy Policy within your own Terms and Conditions, this must be done only with approval from Riverty's legal counsel. After approval include the country specific T&C and Privacy Policy resources.


    In this chapter we will explain which steps you need to take to enable the payment method on production. For the final go-live a contract between you and Riverty is required.

    Configure live mode

    Magento 2 settings screenshot.png


    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


    Advanced payment method settings

    Magento 2 - Advanced settings.png

    Order management settings

    If you have to adjust the settings, do not forget to refresh the configuration cache in System => Cache management.

    Magento Developer Settings Capture 1.png

    - Off - Disable all communication regarding capturing and refunding towards Riverty. For example an invoice will not have the option to 'online' capture the order.
    This is applicable if you don't want any order management (captures / refunds) communication with Riverty. For example if Riverty has the auto-capture functionality enabled in the Riverty back-end systems.

    - Yes, at shipping - After authorization, the order will be created and set to processing. But no invoice is created. This will be created and captured when a shipment is created. In case you can only ship when an invoice is created, then the configuration should be set to 'manual'. Then you will get an option for 'auto invoice creation', which should be set to 'yes'. Same as for the options "Force invoice state to PAID instead of PENDING" and "Force capture to be triggered by shipment".
    This is applicable if you have different processing times of the shipment. This will be the default in the next release, because this setting is applicable for the majority of merchants.

    - Yes, at selected status - After authorization, the order will be created and set to processing. But no invoice is created. This will be created and captured when the order is set to the configured status.
    This is applicable if you use order statuses, and want to use a specific order status to trigger capture.

    Screenshot 2021-12-21 Invoice Creation.png
    Magento Developer Settings Syayus Capture.png
    Magento Developer Settings bottom 2.png


    The Riverty Magento 2 module is tested up until version 2.4.3 of Magento 2.

    Module version 2.0 and up is up to the new standards with Magento 2, and therefore more stable and useful. But it has a dependency which requires a minimum of Magento version 2.2.4.

    Merchants who use a version older than Magento 2.2.4 can use version 1.9.1 of the Riverty module, but we advise to update your Magento environment to the latest version to be able to use the latest Riverty module.

    The compatibility is tested with the following external plugins:

    Release notes

    Our complete release notes can be found on our repository page: https://packagist.org/packages/afterpay/afterpay-module

    Riverty 2022