Plugin Configuration

Last update: August 3, 2023

General Overview

Once the merchant agreement has been validated by Oney and signed by both parties, Oney's integration team sends to the company signatory (or any other designated technical point of contact) the following mandatory elements:

Merchant GUID
PSP GUID
Payment key
Marketing key

Oney uses the default country of your store. So, it is necessary to check the default country filled in configuration at " Stores" -> "Configuration" -> " General" -> "Country Option" -> " Default Country". It needs to be in the list of supported countries listed above.

For more information : configuration magento

Oney API needs some information about the customer to security from fraud. The name prefix is needed to assure the well-behaviour of the Oney service. The value can be set in Configuration at " Stores" -> "Configuration" -> " Customers" -> " Customer Configuration" -> " Name and Address Options" -> " Prefix Dropdown Options".

This value needs to be "Mr;Mrs;Ms".

You will need to fill out the associated fields in the Back Office of Magento. These fields are located in

" Stores" -> "Configuration" -> " Sales" -> " Payment Methods" -> " Oney".

Environment : This feature allows you to switch from development environment (to realize all tests provided by Oney's teams) to Production environment (Once you receive the "go live" from Oney's teams; Note that this validation will be given only after passing the tests).
Merchant GUID : credential shared by Oney's team integration (mandatory)
Secret Key : this field is deprecated.Leave the field empty. (optional)
PSP GUID : credential shared by Oney's team integration (mandatory)
Active Logs : this feature is optional.There are types of files which main mission is to store a history of events. We recommend activating this feature when testing your integration. In case you activate logs, a file will be sent to the module into the folder named "logs".
Automatic Confirmation : this feature allows you to set an automated behaviour over the order process. This automated behaviour will automatically "ship" the order if the following conditions are respected:
- If Oney Web Service return a FAVORABLE status
- If quantities of the ordered item(s) are available in your stock
  
  Once the automatic validation is "yes" and the conditions described before are respected, on every order the process will automatically "ship" the order to the customer without waiting manual intervention.
  In case there isn't enough stock registered on your Magento's Back Office, you will have to ship manually the order.
Website Type : Since the 2.1.0 version, this field is associated to the products your website is selling. For anti-fraud reason, this field is mandatory. It needs to be filled with the most accurate value, which is the kind of products you sell the most. Each category corresponds to a number sent to Oney's API.
Marketing API Key : credential shared by Oney's team integration (mandatory)
Payment API Key : credential shared by Oney's team integration (mandatory)

To be able to connect with Oney Services and Oney API, you will receive from Oney, 4 credentials

Merchant GUID
PSP GUID
Marketing API key
Payment API key

Please copy/past this information into the corresponding field without any space.

Testing & Production Modes

A document will be provided by Oney in order to validate the activation of your payment module. This part is important, it will be necessary to use the test mode with the associated credentials.

Switching Mode

In order to switch from modes, you will need to go to configuration of Oney Module located in Stores" -> "Configuration" -> " Sales" -> " Payment Methods" -> " Other Payment Methods". The field "Environnement" can be filled with two options:

Production => for Production Mode
Preproduction => for Testing Mode

At the end of the testing phase, Oney sends the merchant its final configuration keys, which must be entered in the Configuration we have seen above.

Activation of Legal Texts (ONLY PORTUGAL)

Portugal includes legal content. In order to activate it you will need to feed the following fields.

This information will be provided by Oney:

Credit Intermediary : Enable this option and fill the other fields. It will modify the banners and the frontend element for Oney 3x 4x.
Exclusivity Regime : If your contract with Oney indicate your regime as exclusive, the legal texts for Oney will show this information to your customers.
Legal Designation : This element must be the official designation of your company shown in legal text.
Legal Document : A document with more legal information from Bank of Portugal.

Activation of the payment options

Depending on the contract established with Oney, the tab "Oney Payments" allows you to choose between a list of available transactions. If these transactions are not present in the Back Office, please check your Oney credentials.

Select your preferences and click on the save button.

WARNING : In order to view the front office modifications on the website it can be necessary to flush and clean your cache.

Please refer to Front End Expected Behaviour part to see the different Oney's elements that will be displayed on your website.

Carrier Configuration

To configure the delivery methods , Oney adds fields for each shipping method. The following steps are important for anti-fraud verification.

For each transporter, 4 configurations are added:

Please select for each the most proper attribute for carrier.

Oney will need to have the address of your store. For this go to " Stores" -> "Configuration" -> "General" -> "Store information".

It is possible to configure several store addresses switching to Parent scope as Main Website and Default Config.

Click on the link to see the official Magento documentation regarding heritage: User Guide configuration

Important! If you don't have the kind of delivery, it is better to configurate with your company's address and realise the test anyway.

Use cases:

Important note! "delivery_option" and "priority_delivery_code" selectors are already filled, so, there is no need to change its.

Delivery mode 1 - Collection of the goods in the merchant store

If Delivery mode selected value is 1 - Collection of the goods in the merchant store

Address type selected value is 1 – Merchant

configuration.

"delivery": {
    "delivery_date":"YYYY-MM-DD",
    "delivery_mode_code":"1",
    "delivery_option":"1",
    "priority_delivery_code":"1",
    "address_type":"1",
    "delivery_address":{…}
},

Delivery mode 2 - Third party relay point

If Delivery mode selected value is 2 - Third party relay point

Address type selected value is 2 - Third party relay point

"delivery": {
    "delivery_date":"YYYY-MM-DD",
    "delivery_mode_code":"2",
    "delivery_option":"1",
    "priority_delivery_code":"1",
    "address_type":"2",
    "delivery_address":{…}
},

Delivery mode 3 - Collection in an airport, train station or travel agency

If Delivery mode selected value is 3 - Collection in an airport, train station or travel agency

Address type selected value is 3 - Collection in an airport, train station or travel agency

"delivery": {
    "delivery_date":"YYYY-MM-DD",
    "delivery_mode_code":"3",
    "delivery_option":"1",
    "priority_delivery_code":"1",
    "address_type":"3",
    "delivery_address":{…}
},

Delivery mode 4 - Carrier (La Poste, Colissimo, UPS, DHL...or any private carrier)

If Delivery mode selected value is 4 - Carrier (La Poste, Colissimo, UPS, DHL...or any private carrier)

Address type selected values are 4 - Billing address or 5 – Delivery address.

"delivery": {
    "delivery_date":"YYYY-MM-DD",
    "delivery_mode_code":"4",
    "delivery_option":"1",
    "priority_delivery_code":"1",
    "address_type":"4|5",
    "delivery_address":{…}
},

Special case:

For Address type set to 5 – Delivery address the "recipient" object is mandatory and must be filled up with customer's information.

"delivery": {
    "delivery_date":"YYYY-MM-DD",
    "delivery_mode_code":"4",
    "delivery_option":"1",
    "priority_delivery_code":"1",
    "address_type":"5",
    "recipient":{
        "recipient_honorific_code":1|2,
        "surname":"Customer's last name",
        "first_name":"Customer's first name",
        "phone_number":"Customer's cell phone number (considering country format)"
    },
    "delivery_address":{…}
},

Delivery mode 5 - Electronic ticket issuance, download, etc.

If Delivery mode selected value is 5 - Electronic ticket issuance, download, etc.

Address type pre-selected value is 6 - Electronic way (ticket, download)

Priority_delivery_code is 4 - 24/24 7/7

"delivery": {
    "delivery_date":"YYYY-MM-DD",
    "delivery_mode_code":"5",
    "delivery_option":"1",
    "priority_delivery_code":"4",
    "address_type":"6",
    "delivery_address":{…}
},

This section corresponds to our documentation. By selecting values in the module configuration, you may find the corresponding values to send to Oney WebService:

Legend :

O : Optional
M : Mandatory

Front office integration

Once the module is installed and fully set up, the previously selected payment options will be automatically available for the products or baskets within the price range, for example 150 euros to 2 000 euros (ranges can be different from one country to another).

For this part, no further action is required on your side.

In addition, the module will integrate to your e-shop the followings:

Oney banner on homepage and catalog (If you have configurate during the configuration step that you want these banners to be displayed)
Oney's instalment icons and sentence on the product page of the eligible products.
Oney's simulation tooltip on product page (details of the instalments)
Oney's Pedagogical Popin (payment process)
Oney's instalment icons and sentence on the shopping cart page of the eligible order.
Oney's simulation tooltip on shopping cart page (details of the instalments)
Oney payment options on the final checkout page.

WARNING : **In order to show the vertical banner on catalog or the horizontal banner on Home page, you will need to configure it on Back Office under "Stores" -> "Configuration" -> "Sales" -> "Payment Methods" -> "Oney" -> "Template Options" configuration menu.

WARNING : In order to view the front office modifications on the website it can be necessary to flush and clean your cache.

Please refer to Front End Expected Behaviour part to see the different Oney's elements that will be deplayed on your website.