What's new?

Release Notes - 2021

Computop

Ingenico

MultiSafepay

Cardgate

PayPro

DigiWallet

Buckaroo

CM.com

Adyen

Pay.

Partner & Integrations

PSPs

Magento

OXID

Magento 1 

Magento 2

WooCommerce

Lightspeed

Shoppagina

Shopware 6.4

Shopware 5

Shopware

Shoptrader

MyShop

Logic4

050media

NextChapter

Mijnwebwinkel

CCV Shop

Cloudcommerce

Prestashop

Divide

Lightspeed App

Plugins

Postman

Swagger

SDKs

Our standardized connections

Our standardised integrations

Get Started

thumbnail_magento-logo.jpg

magento-logo.jpg

Magento is a popular open-source e-commerce platform. You can use our plugin to add Riverty to your Magento-based webshop.

#### Versions
Riverty supports multiple versions of Magento. Please select your version to proceed to the manual.

- [Magento 2](../../plugins/magento-2)
- [Magento 1](../../plugins/magento-1)

thumbnail_OXID_eShop_Logo.png

OXID_eShop_Logo.png

OXID  is a popular e-commerce platform. You can use our plugin to add Riverty to your webshop.

## Introduction
This guide describes the steps to quickly install, configure, test and activate the Riverty payment methods in your Oxid version 6 store. 

Riverty offers 3 different payment options via Oxid: 
- **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 payments. 

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

|Country|14-day invoice|Direct Debit|Fixed instalments|
|---|---|---|---|
|**Germany**| <center>x<center/>|<center>x<center/>|<center>x<center/>|
|**Austria**| <center>x<center/>|<center>x<center/>|<center>x<center/>|
|**Switzerland**| <center>x<center/>| | |

## Setup

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

### Prerequisite

This module is compatible with versions 6.1.5 of the Community, Professional and Enterprise Editions. Please first make sure that this module is compatible with your shop version. Otherwise cancel the installation and contact us. Please note that the module requires an access key to function correctly, which you will receive from us. A contract on the payment methods to be offered is therefore a prerequisite for installation.

### Installation

Use Composer in the console and add the module to your shop. To do this, change to the directory in which the shop's "composer.json" is located. Call the following command:

```composer require oxid-professional-services/arvatoriverty```

Now navigate in the admin area (so-called backend) to Extension > Module and select "Arvato::Riverty". Click on overview and activate the module. 

Doublecheck if the button now shows the text "Deactivate" instead of "Activate". Now navigate to **Service > Tools** and click on **"Update DB Views now"**. Then delete the contents of the folder **SHOP-STAMMVERZEICHNIS/tmp**, only leave files that begin with a dot. You may have to log out of the backend and log back in to see all the changes. Finally, check that you can see the tab "Riverty" under **Administer Orders > Orders**. If not, carefully repeat the steps in this section.

### Basic settings
Please log into your Oxid admin page and navigate to Riverty Module.

#### General settings
- **Default Shipping Company:** Name of the delivery service that should be pre-filled when shipping is registered, e.g. "DHL" or "UPS" 
- **Standard refund description:** Text to be pre-filled for refunds, e.g. "Refund"
- **Risk management - ChannelType:** As communicated by Riverty
- **Risk management - DeliveryType:** As communicated by Riverty

#### API Settings
- **API request logging:** If logging is activated, every communication with the arvato::Riverty is logged. This log can be found under **rootdirectory/logs/ARVATO.log.**
- **API URL:** The URL to Arvato's API server, starting with https://
- **API key [payment type] [country code] [instalment payment]:** Your password to Arvato's API server, split by country code of your customer. 
- **Sandbox mode:** Instead of API-URL and API-password, Sandbox-API-URL and Sandbox API password are used (https://developer-sandbox.riverty.com/)
- **Sandbox API URL:** The URL to Arvato's API server for test environments **https://devportal-sandbox.riverty.dev/**
- **Sandbox API Key [Payment Type] [Country ID]:** Your password to Arvato's API server for test environments, divided by the country code of your customer. 


**Caution:** The log contains personal data and should be deactivated in production mode to the immense increase in file size. Installation errors are always logged regardless of this setting.

Chose the "Sandbox" to allow you to trigger test orders and test the process, before the module goes live with your shop.

**Caution: Deactivate the sandbox mode before you go live, otherwise unpaid orders may be triggered.**

#### Required fields
According to our risk standards we require mandatory fields, these vary from country to country. Please refer to [Consumer Information](https://developer.riverty.com/documentation/introduction/).

After the module has been installed, activated and configured, you will find the following payment methods in the backend under Shop Settings:
- **arvato::Riverty Invoice**
- **arvato::Riverty direct debit**
- **arvato::Riverty Instalments**

These payment methods are assigned to most customer groups by default, as well as to Germany and the standard delivery method. You can change these settings if you need more information consult the OXID documentation.

### Profile Tracking

- **Activate Profile Tracking:** If contractually agreed with Arvato, profile tracking is activated here.
- **Profile tracking URL:** As communicated by Arvato
- **Profile tracking client ID":** As communicated by Arvato.

Remember to confirm changes with the "Save" button.



### Backend

Once configured, you operate the module by selecting the relevant order under **Administer Orders > Orders** and clicking on the tab **"Riverty".** For technical reasons, the Riverty tab is displayed for all orders. If the order was not paid with Riverty, you will receive the message "No Riverty order" without any further action.

### Actions 
- **Capture pending payments:** Click on Capture to trigger the payment in the selected amount. Depending on the payment method, the buyer receives an invoice, the direct debit is triggered or the first instalment is due.
- **Cancel payment reservation:**At order completion the invoice amount was reserved. If you know that you will no longer collect the payment (for example, because the customer has canceled), you can release it here by clicking void. This makes the amount available to the customer for new purchases. With this step, you relinquish the ability to be able to process the order in the future.
- **Refund captured payments:** Click on Refund to initiate the refund of a payment. The customer is credited with the amount. If you have collected the amount in several steps, you must confirm each refund field once. This field is only visible after a capture.
- **Refund captured payments - Enter any amount:** : By clicking on refund, you can partially or fully refund an invoice previously collected by capture. Enter the gross amount to be refunded. You will find an input mask for each VAT rate in the order (e.g. 19% and 7% for Germany, as of 2018). Be careful not to mix up the VAT rates and assign the respective refunds to the correct tax rate. You can add a description to the refund such as "goodwill", "revocation", etc. or similar. This description will be displayed to the buyer on their credit note. This field is only visible after a capture.
- **Capture delivery information:** Click on Capture Shipping to record the shipment of the order. The buyer will be notified by Arvato::Riverty by e-mail about the shipment. OXID now lists the order as completed. You can specify the delivery in more detail by specifying a delivery service and, in the case of partial delivery, by specifying the goods delivered. This field is only visible after a capture.

Testing

Testing - Standard test scenarios

Testing - Payment method scenarios

Testing - Direct Debit scenarios

Testing - Instalment scenarios

Testing - Customer facing messages

Testing - Check test order

Visual guidelines

Visual guidelines - Logos and banners

Visual guidelines - Terms and conditions

Go-live - Introduction to the merchant portal

thumbnail_computop-logo.jpg

computop-logo.jpg

Computop Paygate offers secure payment processing for all channels including E-Commerce, mobile, and PoS. 

##How to configure Computop & Riverty?

Please click on the link below to find more information on how to set-up Computop and Riverty.

German Documentation

English Documentation

thumbnail_ingenico-logo.jpg

ingenico-logo.jpg

Ingenico is the global trusted partner for financial institutions and retailers, providing the most extensive network connecting acquirers and payment methods.

##How to configure Ingenico & Riverty?

Please click on the link below to find more information on how to set-up Ingenico and Riverty.



Ingenico Online Documentation

thumbnail_postman-logo.jpg

postman-logo.jpg

Download our pre-created Postman collection and start testing our API right away. All examples in the documentation are already there and you can start trying out with ease. 

POSTMAN

##How can I use Postman and Riverty?

**Open Postman** You should see an empty request window. In this window you can specify the type of request (POST, GET etc.), the URL additional field like the Headers, Body, Pre-request Script and Tests. Mostly the Headers contain values which are needed for authentication. In the case of the example for Riverty the API-Key is needed as well as a “Content-Type” which states that the body is in a JSON format. 

Those fields are required regardless of a POST or GET-Request. The Body can be empty (as in a GET-Request) or can contain several key-value pairs needed for manipulation. As the name reveals a Pre-request Script runs before a request is send in order to set some values or similar. However, it can be empty as well. Tests are “Post-Request Scripts” which can check if your request was sent successfully and had the desired results. 

For further readings and first steps in Postman, please feel free to read these instructions (https://www.getpostman.com/docs/requests). 

Postman Environments can be downloaded in the My Account > Credentials section of the Riverty Developer Portal, as they are specific to your API key. 

Riverty_Payment_API_Sandbox_Test_Sets.postman_collection.json

Sandbox Test Sets

Riverty_Payment_API_Sandbox_Environment.postman_environment.json

Sandbox Environment

thumbnail_swagger-logo.jpg

swagger-logo.jpg

We describe our API using Swagger and give you the possibility to generate your own SDK from scratch or stub server.

Get Available Payment Methods

Checkout

Order Management

Additional Services

FastTrack Services

Common

Product

Customer Account

All the API Calls in more detail

# API Documentation
 
The Riverty Management API contains resource collections to get available payment methods, authorization, capture, refund and void operations. On this page, you can find a detailed description of each operation with input parameters, possible responses, sample requests and integration examples for different platforms.

Approves the payment for a specified customer and basket. Main use-cases are One-Step and Two-Step Authorization. Full fraud and credit scoring applied. If the online-shop customer enter the incorrect address data, the system delivers a suggestion for a corrected address.

Authorize payment

Returns the available payment methods for a specified basket value and offers available for client. Returns monthly installment amount, interest and fees. Sending in customer data and contents of the basket to enhance the result is optional. If the online-shop customer enters the incorrect address data, the system delivers suggestion for a corrected address. Main use-case is Two-Step Authorize.

Available Payment Methods

Completes the payment that has been authorized. Typically done when the order is shipped. Can be a full or partial capture of the order amount.

Capture Payment

Notifies about a full or partial return registered by the consumer on the merchants web shop.

Return Notification

Refunds a partially or fully captured payment.

Refund Payment

Void (cancel) an authorization that has not been captured.

Void Authorization

Change the contents of an Authorized but not Captured order. Use this call to add or remove items in an existing Order, without creating a new orderNumber.
You must provide the entire body of the query, in the same format as Authorize, including all Order Items. (If you added an item, Update Order must contain previously Authorized items as well. If you removed an item, Update Order must contain the new full list of Order Items.)
If the TotalGrossAmount has increased compared to the Authorize call for this orderNumber, a new Risk Check will be made for the additional amount. If the additional Risk Check returns a rejection, the original Authorize will remain valid.

Update Order

Returns the contents of the specified order

Get Order

Returns all or specific captured payments of the order

Get Captures

Returns all or specific refunds of the order.

Get Refunds

Returns all or specific voided (cancelled) authorizations of the order.

Get Voids

Add new shipping details information to the capture.

Add Shipping Details

Update shipping details information of the specific capture.

Update Shipping Details

Returns address based on input (Social security number, mobile number, Organization number).

Customer lookup

Update customer

Returns the available installment plans for the specific product/basket value. Returns monthly installment amount, interest and fees. Typically used on a product page.


Available installment plans

Validates and evaluates the account and bank details in the context of direct debit payment. It is possible to transfer either the combination of BankCode and AccountNumber or IBAN and BIC

Validate bank account

Check the delivered customer addresses as well as a phonetic and associative identification of duplicates. Additionally, checks of client-specific negative or positive lists can be processed. Usually, the AddressCheck is used for the pure verification of the address data e.g. for registration processes.

Validate address

Creates an installment and/or direct debit contract that can be displayed for the customer.

Create contract

Apply for account credit

Get remaining credit limit

Add event

Find customer account by SSN (social security number)


Lookup account by SSN

Get Version

All the Checkout API Calls in more detail

# API Documentation
 
## Checkout API Calls

All the Order Management API Calls in more detail

# API Documentation
 
## Order Management

Collecting Consumer Information

Payment Method Presentation

Validations & Error Codes

LegalForm

Documentation

Prepare Checkout

Compliance Requirements

Capture

Void

Refund

Logo & Visual Guidelines

Legal & Privacy Texts

Authorize Payment

Our Payment Methods

Customer Experience

Test API

Sandbox environment

References

Main Flow

Getting Started - Direct Integration 

Getting Started - Plugin Integration

Introduction

Hosted Fields

Customer Lookup

Address Correction

IBAN Tokenization

Idempotency

Strong customer authentication

Reconciliation & Accounting with Riverty

Invoice Element

Pay in X Element

Riverty Elements

Consumer FAQ

Compliance Requirements -New

Merchant Onboarding API

Consolidated Settlement and Reconciliation

Pay in 3

# Welcome to our documentation

This documentation guide gives you an overview of all the features and also instructions on how to use them

### Buy Now Pay Later
Find detailed instructions and guidelines for integrating our Buy Now Pay Later payment methods [here](https://developer.riverty.com/documentation/)

### Recurring Payments
To start integrating our payment subscriptions, please continue to the following [Documentation](https://repaportalsitetest.z6.web.core.windows.net/).

doc.svg

The Prepare Checkout section of our Developers has been created in order to help you to set up your checkout in the way that Riverty is supported in the best way possible. 

Here you get an overview of:
- What information needs to be collected from the customer?
- What logotype to use? 
- How to present the payment options on your payment page? 
- How to deal with error codes. 

In order to see an increase in conversion, higher-order values, and increasing the likelihood of returning customers.

#Consumer Information

In the following table, you can see which information is required per country for sending a complete request. However, check out our Customer LookUp functionality to further reduce the information that has to be provided by the consumer.


|Country|IP Address|SSN|First Name|Last Name|Email|Mobile Phone|Date of Birthday|Country|Postal Code|Street|Street Number|City|
|--- |--- |--- |--- |--- |--- |--- |--- |--- |--- |--- |--- |--- |
|**Germany**| | |&#10004;|&#10004;|&#10004;||&#10004;|&#10004;|&#10004;|&#10004;|&#10004;|&#10004;|
|**Austria**|||&#10004;|&#10004;|&#10004;||&#10004;|&#10004;|&#10004;|&#10004;|&#10004;|&#10004;|
|**Switzerland**|||&#10004;|&#10004;|&#10004;||&#10004;|&#10004;|&#10004;|&#10004;|&#10004;|&#10004;|
|**Netherlands**|&#10004;||&#10004;|&#10004;|&#10004;|&#10004;|&#10004;|&#10004;|&#10004;|&#10004;|&#10004;|&#10004;|
|**Belgium**|&#10004;||&#10004;|&#10004;|&#10004;|&#10004;|&#10004;|&#10004;|&#10004;|&#10004;|&#10004;|&#10004;|
|**Sweden**||&#10004;|&#10004;|&#10004;|&#10004;|||&#10004;|&#10004;|&#10004;||&#10004;|
|**Norway**||&#10004;|&#10004;|&#10004;|&#10004;|||&#10004;|&#10004;|&#10004;||&#10004;|
|**Finland**||&#10004;|&#10004;|&#10004;|&#10004;|||&#10004;|&#10004;|&#10004;||&#10004;|
|**Denmark**||&#10004;|&#10004;|&#10004;|&#10004;||&#10004;|&#10004;|&#10004;|&#10004;|&#10004;|&#10004;|

|DE/AT/CH|Benelux|Sweden|Denmark|Norway|Finland |
|---|---|---|---|---|---|
|<center>Device Finger Printing (Profile Tracking)<center/>||||||
||<center>Separate API keys per payment method<center/>|||||
|||<center>SCA lookup requires SSN<center/>|<center>SCA lookup requires SSN + Postal code<center/>|<center>SCA requires mobile phone number<center/>|<center>SCA lookup requires SSN<center/>|

#Payment Options

Riverty, as illustrated in the Customer Experience page offers various invoice and part payment options. Here is a short recap of how we have structured them and a best-practice example of the way they shall be displayed. To get a more detailed explanation of how to display the different payment options, check our Display Guidelines.

![payments method presentation.png](/uploads/payments_method_presentation_9ad403b52f.png)


For specific verticals, Riverty makes it possible to generate a merchant-specific consolidated invoice that is a standalone Riverty payment option. It allows consolidating all purchases made by the customer into a single invoice. If the consolidated invoice is used, no other Riverty payment options are presented at checkout. Below is how the consolidated invoice is presented at checkout.

![Monthly_invoice.png](/uploads/Monthly_invoice_c5e823c7b7.png)


The available Riverty payment methods within the checkout per country can be found in this table:

|Country|14-day invoice|Direct Debit|Campaign invoice|Fixed instalments|B2B invoice|
|---|---|---|---|---|---|
|**The Netherlands**|<center>x<center/>|<center>x<center/>| | |<center>x<center/>|
|**Belgium**|<center>x<center/>| | | | |
|**Germany**|<center>x<center/>|<center>x<center/>|<center>x<center/>|<center>x<center/>|<center>x<center/>|
|**Austria**|<center>x<center/>|<center>x<center/>| |<center>x<center/>|<center>x<center/>|
|**Switzerland**|<center>x<center/>| | | | |
|**Sweden**|<center>x<center/>| |<center>x<center/>|<center>x<center/>|<center>x<center/>|
|**Norway**|<center>x<center/>| |<center>x<center/>|<center>x<center/>|<center>x<center/>|
|**Finland**|<center>x<center/>| |<center>x<center/>|<center>x<center/>|<center>x<center/>|
|**Denmark**|<center>x<center/>| |<center>x<center/>|<center>x<center/>|<center>x<center/>|


You can check the Merchant Playbook to get more information about payment options and how they are presented at checkout.

Merchant Playbook -  German version

Merchant Playbook - English version

Merchant Playbook - Dutch version

#Compliance Requirements

In order to make the offering of Riverty’s payment method compliant you will have to add one note with two links underneath the Riverty payment method as shown in the picture below:

"The general **Terms & Conditions** for the Riverty Payment Method apply. The privacy policy of Riverty can be found **here**."

**Important for your conversion:** You do not need a confirmation checkbox here.

![MicrosoftTeams-image (84).png](/uploads/Microsoft_Teams_image_84_e22054d000.png)

Find localized links in the tables below. 

###Legal Statements for Riverty Payment Methods
|Language|Legal Text below Payment Method|
|--- |--- |
|Dutch|De algemene voorwaarden voor de betaalmethode Riverty zijn van toepassing. Het privacybeleid van Riverty vind je hier.|
|German|Es gelten die allgemeinen Geschäftsbedingungen für die Zahlungsmethode Riverty. Die Datenschutzbestimmungen von Riverty findest Du hier.|
|English|The general Terms & Conditions for the Riverty Payment Method apply. The privacy policy of Riverty can be found here.|
|Danish|De generelle vilkår og betingelser for Riverty-betalingsmetoden gælder. Riverty's fortrolighedspolitik kan findes her.|
|Finnish|Sovelletaan Riverty-maksutavan yleisiä käyttöehtoja. Rivertyn tietosuojakäytäntö löytyy täältä.|
|French|Les conditions générales du mode de paiement Riverty s'appliquent. La politique de confidentialité d'Riverty peut être consultée ici.|
|Italian|Si applicano i termini e le condizioni generali per il metodo di pagamento Riverty. La politica sulla privacy di Riverty può essere trovata qui.|
|Norwegian|De generelle vilkårene for Riverty-betalingsmåten gjelder. Personvernerklæringen til Riverty finner du her.|
|Swedish|De allmänna villkoren för betalningsmetoden Riverty gäller. Rivertys sekretesspolicy finns här.|

### Terms & Conditions

|Country|Language|URL|
|--- |--- |--- |
|Norway   |Norwegian |[https://documents.myafterpay.com/consumer-terms-conditions/no_no](https://documents.myafterpay.com/consumer-terms-conditions/no_no)  |
|Norway   |English        |[https://documents.myafterpay.com/consumer-terms-conditions/en_no](https://documents.myafterpay.com/consumer-terms-conditions/en_no)  | 
||||
|Sweden  |Swedish  |[https://documents.myafterpay.com/consumer-terms-conditions/sv_se](https://documents.myafterpay.com/consumer-terms-conditions/sv_se)  |
|Sweden  |English  |[https://documents.myafterpay.com/consumer-terms-conditions/en_se](https://documents.myafterpay.com/consumer-terms-conditions/en_se)  |
||||
|Finland  |Finnish  |[https://documents.myafterpay.com/consumer-terms-conditions/fi_fi](https://documents.myafterpay.com/consumer-terms-conditions/fi_fi)  |
|Finland  |English  |[https://documents.myafterpay.com/consumer-terms-conditions/en_fi](https://documents.myafterpay.com/consumer-terms-conditions/en_fi)  |
||||
|Denmark  |Danish  |[https://documents.myafterpay.com/consumer-terms-conditions/da_dk](https://documents.myafterpay.com/consumer-terms-conditions/da_dk)  |
|Denmark  |English  |[https://documents.myafterpay.com/consumer-terms-conditions/en_d](https://documents.myafterpay.com/consumer-terms-conditions/en_dk)  |
||||
|Germany  |German|[https://documents.myafterpay.com/consumer-terms-conditions/de_de](https://documents.myafterpay.com/consumer-terms-conditions/de_de)  |
|Germany  |English  |	[https://documents.myafterpay.com/consumer-terms-conditions/en_de](https://documents.myafterpay.com/consumer-terms-conditions/en_de) |
||||
|Netherlands  |Dutch   |[https://documents.myafterpay.com/consumer-terms-conditions/nl_nl](https://documents.myafterpay.com/consumer-terms-conditions/nl_nl)  |
|Netherlands  |English  |[https://documents.myafterpay.com/consumer-terms-conditions/en_nl](https://documents.myafterpay.com/consumer-terms-conditions/en_nl)  |
||||
|Austria  |German |[https://documents.myafterpay.com/consumer-terms-conditions/de_at](https://documents.myafterpay.com/consumer-terms-conditions/de_at)  |
|Austria  |English  |	[https://documents.myafterpay.com/consumer-terms-conditions/en_at](https://documents.myafterpay.com/consumer-terms-conditions/en_at)  |
||||
|Belgium  |Dutch  |[https://documents.myafterpay.com/consumer-terms-conditions/nl_be](https://documents.myafterpay.com/consumer-terms-conditions/nl_be)  |
|Belgium  |French  |[https://documents.myafterpay.com/consumer-terms-conditions/fr_be](https://documents.myafterpay.com/consumer-terms-conditions/fr_be)  |
|Belgium  |English  |[https://documents.myafterpay.com/consumer-terms-conditions/en_be](https://documents.myafterpay.com/consumer-terms-conditions/en_be)  |
||||
|Switzerland  |German  |[https://documents.myafterpay.com/consumer-terms-conditions/de_ch](https://documents.myafterpay.com/consumer-terms-conditions/de_ch)  |
|Switzerland  |French  |[https://documents.myafterpay.com/consumer-terms-conditions/fr_ch](https://documents.myafterpay.com/consumer-terms-conditions/fr_ch)  |
|Switzerland  |Italian  |[https://documents.myafterpay.com/consumer-terms-conditions/it_ch](https://documents.myafterpay.com/consumer-terms-conditions/it_ch)  |
|Switzerland  |English  |	[https://documents.myafterpay.com/consumer-terms-conditions/en_ch](https://documents.myafterpay.com/consumer-terms-conditions/en_ch)  |

### Privacy policy

|Country|Language|URL
|--- |--- |--- |
|Norway   |Norwegian |[https://documents.myafterpay.com/privacy-statement/no_no](https://documents.myafterpay.com/privacy-statement/no_no)|
|Norway   |English        |[https://documents.myafterpay.com/privacy-statement/en_no](https://documents.myafterpay.com/privacy-statement/en_no)|
||||
|Sweden  |Swedish  |[https://documents.myafterpay.com/privacy-statement/sv_se](https://documents.myafterpay.com/privacy-statement/sv_se)  |
|Sweden  |English  |[https://documents.myafterpay.com/privacy-statement/en_se](https://documents.myafterpay.com/privacy-statement/en_se)  |
||||
|Finland  |Finnish  |[https://documents.myafterpay.com/privacy-statement/fi_fi](https://documents.myafterpay.com/privacy-statement/fi_fi)  | 
|Finland  |English  |[https://documents.myafterpay.com/privacy-statement/en_fi](https://documents.myafterpay.com/privacy-statement/en_fi)  |
||||
|Denmark  |Danish  |[https://documents.myafterpay.com/privacy-statement/da_dk](https://documents.myafterpay.com/privacy-statement/da_dk)  |
|Denmark  |English  |[https://documents.myafterpay.com/privacy-statement/en_dk](https://documents.myafterpay.com/privacy-statement/en_dk)  |
||||
|Germany  |German|[https://documents.myafterpay.com/privacy-statement/de_de](https://documents.myafterpay.com/privacy-statement/de_de)  |
|Germany  |English  |[https://documents.myafterpay.com/privacy-statement/en_de](https://documents.myafterpay.com/privacy-statement/en_de) |
||||
|Netherlands  |Dutch   |[https://documents.myafterpay.com/privacy-statement/nl_nl](https://documents.myafterpay.com/privacy-statement/nl_nl)  |
|Netherlands  |English  |[https://documents.myafterpay.com/privacy-statement/en_nl](https://documents.myafterpay.com/privacy-statement/en_nl)  |
||||
|Austria  |German |[https://documents.myafterpay.com/privacy-statement/de_at](https://documents.myafterpay.com/privacy-statement/de_at)  |
|Austria  |English  |	[https://documents.myafterpay.com/privacy-statement/en_at](https://documents.myafterpay.com/privacy-statement/en_at)  |
||||
|Belgium  |Dutch  |[https://documents.myafterpay.com/privacy-statement/nl_be](https://documents.myafterpay.com/privacy-statement/nl_be)  |
|Belgium  |French  |[https://documents.myafterpay.com/privacy-statement/fr_be](https://documents.myafterpay.com/privacy-statement/fr_be)  |
|Belgium  |English  |[https://documents.myafterpay.com/privacy-statement/en_be](https://documents.myafterpay.com/privacy-statement/en_be)  |
||||
|Switzerland  |German  |[https://documents.myafterpay.com/privacy-statement/de_ch](https://documents.myafterpay.com/privacy-statement/de_ch)  |
|Switzerland  |French  |[https://documents.myafterpay.com/privacy-statement/fr_ch](https://documents.myafterpay.com/privacy-statement/fr_ch)  |
|Switzerland  |Italian  |[https://documents.myafterpay.com/privacy-statement/it_ch](https://documents.myafterpay.com/privacy-statement/it_ch)  |
|Switzerland  |English  |	[https://documents.myafterpay.com/privacy-statement/en_ch](https://documents.myafterpay.com/privacy-statement/en_ch)  |


# Error Codes & Validations

##Error Codes

In the following, you can see the various error codes. You can also download a spreadsheet with the corresponding error messages and action codes.

### Validation error messages



|Error Code|Description|Action code|
|--- |--- |--- |
|400.000	|Unknown error|Unavailable|
|400.001	|Request body missing|Unavailable|
|400.002	|Value is required|Unavailable/ AskConsumerToReEnterData|
|400.003|Value out of range|Unavailable/ AskConsumerToReEnterData|
|400.004|Value format is incorrect|Unavailable/ AskConsumerToReEnterData|
|400.005|A string value exceeds maximum length of {value}|Unavailable/ AskConsumerToReEnterData|
|400.006|A string value with minimum length {value} is required|Unavailable/ AskConsumerToReEnterData|
|400.007|A decimal value has more than allowed decimal digits|Unavailable/ AskConsumerToReEnterData|

### Business error messages

|Error Code|Description|Action code|Field reference|
|--- |--- |--- |--- |
|400.001|Request body is empty or invalid|Unavailable|request|
|400.100|Order number is already used on the client|Unavailable|order.number|
|400.101|TotalNetAmount doesn't match with items prices|Unavailable|order.totalNetAmount|
|400.102|Order gross amount doesn't match with items prices|Unavailable|order.totalGrossAmount|
|400.103|The provided customerNumber differs from the customerNumber specified in the checkout|Unavailable|customer.customerNumber|
|400.108|Invalid payment method selected|Unavailable|payment.type|
|400.109|A valid contract id is required|Unavailable|payment.contractId|
|400.110|Installment profile not found|Unavailable|payment.installment.profileNo|
|400.111|Installment profile plans missing|Unavailable|-|
|400.112|Monthly installment amount is invalid|Unavailable|payment.installment.numberOfInstallments|
|400.113|Number of installments is not allowed for amount|Unavailable|payment.installment.numberOfInstallments|
|400.114|Invalid AccountProfileNo|Unavailable|paymentInfo.account.profileNo|
|400.115|Reservation not found|Unavailable|-|
|400.117|Cannot capture the order because full capture can only be done for the entire reserved amount within the given tolerance level.|Unavailable|-|
|400.118|Capture partial cannot capture more than the current reservation balance|Unavailable|-|
|400.119|Order items missing|Unavailable|-|
|400.120|Cannot capture the order as capture with the specified number is already exists|Unavailable|-|
|400.121|Reservation, to which this order is linked to does not have a checkout|Unavailable|-|
|400.124|The grand total of gross unit prices must be positive|Unavailable|orderItems[].grossUnitPrice|
|400.126|Cannot refund the order because specified capture was not created from reservation, to which this order is linked to|Unavailable|-|
|400.127|Cannot refund the order as refund amount is higher than the capture balance amount|Unavailable|-|
|400.128|Cannot refund the order because there are no captures related to this order|Unavailable|-|
|400.129|Cannot cancel the order, because it is partially or fully captured|Unavailable|-|
|400.131|Order not found|Unavailable|-|
|400.132|Capture not found|Unavailable|-|
|400.133|Refund not found|Unavailable|-|
|400.134|Void not found|Unavailable|-|
|400.135|Customer not found|Unavailable|-|
|400.136|Contract already exists|Unavailable|-|
|400.137|When order items are provided then capture number is mandatory|Unavailable|-|
|400.138|Shipping details not found|Unavailable|-|
|400.139|Valid BankCode is required|Unavailable|payment.directDebit.bankCode|
|400.140|Valid BankAccount is required|Unavailable|payment.directDebit.bankAccount|
|400.142|Checkout not found|Unavailable|-|
|400.144|Validation failed|Unavailable|-|
|400.146|Capture amount can't be with opposite sign to Reservation amount|Unavailable|order.totalGrossAmount|
|400.147|Void amount can't be with opposite sign to Reservation amount|Unavailable|cancellationDetails.totalGrossAmount|
|400.148|Cannot refund a negative invoice|Unavailable|-|
|400.150|Installment profile is not valid for amount|Unavailable|payment.installment.profileNo|
|400.151|IdempotencyKey is aleady used with different endpoint URL|Unavailable|-|
|400.152|DirectDebit is not enabled for client|Unavailable|-|
|400.153|A valid order number can include alphanumeric characters, dashes and underscores|Unavailable|order.number|
|400.154|totalGrossAmount cannot be negative|Unavailable|-|
|400.155|In case of partial request the totalGrossAmount is required|Unavailable|-|
|400.156|The country code is not valid for this customer|AskConsumerToReEnterData|customer.address.countryCode|
|400.157|The currency code is not valid for this customer|Unavailable|-|
|400.158|Reservation is already cancelled, captured, or expired|Unavailable|-|
|400.159|Item gross price, net price and VAT amount must be all positive or all negative|Unavailable|order.items[].grossUnitPrice|
|400.160|Gross unit price must be equal to Net unit price plus VAT amount|Unavailable|order.items[].grossUnitPrice|
|400.161|Item net price can't be bigger than gross price|Unavailable|order.items[].netUnitPrice|
|400.162|Item VAT amount can't be bigger than gross price|Unavailable|order.items[].vatAmount|
|400.166|The provided currency differs from the currency specified in the checkout|Unavailable|-|
|400.167|File format is not supported. We support the following formats: {value}|Unavailable|-|
|400.168|Order items must be specified if order amount is increased within the allowed tolerance level|Unavailable|order.items|
|400.169|Order items must be specified if order amount has changed|Unavailable|order.totalGrossAmount|
|400.170|Full refund is not allowed after partial refund.|Unavailable|-|
|400.171|Cannot refund the order as the total refund amount exceeds the maximum allowed amount.|Unavailable|-|
|400.172|The maximum Idempotency Key length is 50 characters.|Unavailable|-|
|400.173|The Idempotency key may contain alphanumeric characters and hyphens.|Unavailable|-|
|400.174|Active campaign not found.|Unavailable|payment.campaign.campaignNumber|
|400.175|The merchant id is not valid.|Unavailable|merchantId|
|400.176|The merchant id is deactivated.|Unavailable|merchantId|
|400.177|Too many operations with zero amount for this order.|Unavailable|-|
|400.178|Account number is not supported.|AskConsumerToReEnterData|bankAccount|
|400.179|B2B customers not supported for this region.|Unavailable|-|
|400.180|Nonce not found.|Unavailable|nonce|
|400.181|A valid customer card classification can include only digits from 1 to 5.|Unavailable|customer.riskData.customerCardClassification|
|400.182|Virtual bank account not found.|Unavailable|-|
|400.183|The checkout is already used by reservation.|Unavailable|checkoutId|
|400.184|totalGrossAmount is higher than order amount.|Unavailable|order.totalGrossAmount|
|400.185|Both, orderItems and items are used. Please use one or another.|Unavailable|-|


Please notice that besides the error code and action code you will also get a field reference that will help you to understand which field caused an error. For example, you may get a 400.004 error with the action code "AskConsumerToReEnterData" and field reference "customer.mobilePhone" which means that the customer has entered the mobile phone number that was in incorrect format and the customer has to insert the phone number in a correct format.

#### Exemplary Error Message:

### Errors responded by the risk check

As part of the risk assessment the consumer's input is validated against internal and external data sources. Although the input might be well-formatted, the input could be still incorrect (e.g. postal Code has the correct format but does not exist).

| Code    | Description                                                                                                                                         |
|---------|-----------------------------------------------------------------------------------------------------------------------------------------------------|
| 200.001 | Sorry, the age you entered does not meet the minimum requirement (18 years), please choose a different payment method or reenter your date of birth |
| 200.002 | Sorry, B2B purchases are not allowed for this merchant. Please choose another payment method                                                        |
| 200.003 | Sorry, the payment method is currently not available. Please choose another payment method                                                          |
| 200.004 | Pick-Up-point can not be used as billing address                                                                                                    |
| 200.005 | Address of the Pick-Up-point is invalid, please doublecheck and correct it                                                                          |
| 200.006 | Billing and delivery address must be the same                                                                                                       |
| 200.101 | This billing address is invalid, please double check and correct it                                                                                 |
| 200.102 | This delivery address is invalid, please double check and correct it                                                                                |
| 200.103 | The billing address was corrected, please verify  _(not sent for DACH and Benelux)_                                                                                              |
| 200.104 | The delivery address was corrected, please verify _(not sent for DACH and Benelux)_                                                                                           |
| 200.105 | Sorry, the payment method is currently not available. Please choose another payment method _(not sent for DACH and Benelux)_                                                          |
| 200.900 | Sorry, the payment method is currently not available. Please choose another payment method                                                          |
| 200.901 | Sorry, the payment method is currently not available. Please choose another payment method                                                          |
| 200.902 | Sorry, the payment method is currently not available. Please choose another payment method                                                          |
| 200.903 | Sorry, the payment method is currently not available. Please choose another payment method                                                        |
| 200.909 | Account number from this country is not supported for this Riverty merchant|
| 200.910 | Strong identification needed |



## Customer Facing Error Messages

These are the human-readable, descriptive messages returned by the eCom API for common business errors. They are usually due to missing mandatory information, or information provided in the incorrect format. When integrating Riverty in your checkout page, please make sure the contents of these messages are displayed to the customer. In the following you see the customer facing error messages in English. As part of the response of our API they are translated into the local language used by the shopper.

#### Exemplary Error Message:

error-codes.xlsx

To fit into organizing nature of your business the Order Management is an important part of payments. Order Management enables you to manage all transactions that happen for an order. Easily capture previously authorized funds, void an unsettled transaction, or do a full or partial refund of a settled transaction.



type	string Enum:BusinessErrorTechnicalErrorNotificationMessage Message type
code	string <= 100 characters Confirmation or error code
message	string <= 4096 characters Message content
customerFacingMessage	string <= 4096 characters Message to display to customer
actionCode	string Enum:UnavailableAskConsumerToConfirmAskConsumerToReEnterDataOfferSecurePaymentMethodsRequiresSsnAskConsumerToIdentify Possible next action to make
fieldReference	string <= 100 characters Reference to field that caused an error

Update customer

PATH:

PATH PARAMETERS:

REQUEST BODY SCHEMA:

RESPONSES:

RESPONSE SCHEMA:

RESPONSE SCHEMA:

Path

Request samples

Response samples

About Us

Integrate Riverty

Riverty Sandbox