How to integrate General conditions?

Last update: April 12, 2024

As a credit institution, the Oney Payment Method is legally controlled. In order to give your customers all information they need to process the payment, we provide a dynamic General Conditions wording. Once integrated, it allows you to stay up to date and legally compliant without any more developments.

Getting started

Add a script tag linking to the loader javascript file found at: “loader.min.js“ (187 bytes) in the page where the Simulation Popin is to be displayed. You can remove the "-staging" in the URL for Production environment.

Example:

<script type="text/javascript" src="https://assets-staging.oney.io/build/loader.min.js"></script>

In your javascript create a function that will be called on click of the button to load the General Conditions popin. For this example, this is called showGeneralConditions but can be changed to any desired name.
Set the onclick function for the button that loads the Oney General Conditions Popin to the showGeneralConditions function created in step 2 above.
In the showGeneralConditions function created in step 2, create a variable named options, with the following mandatory fields:

Field name	Mandatory - Optional	Description
`country`	M	Merchant Country code in ISO 3166-1 alpha-2 format
`language`	M	Merchant Language code in ISO 3166-1 alpha-2 format
`merchant_guid`	M	Merchant global unique identifier given by Oney to the partner
`payment_amount`	M	Amount of asked payment
`free_bts`	M	Boolean value

let options = {        
    country: "FR",
    language: "FR",
    merchant_guid: "4ee34660-1659-4d8e-8849-544c46f4954b",
    payment_amount: 560.00,
    free_bts: true
};

5. In the showGeneralConditions function created in step 2, include the following call to the loadOneyWidget function which is found in the “loader.min.js” file included in step 1 above:

loadOneyWidget(function () {
oneyMerchantApp.loadGeneralConditions({ options });
});

The showOneyWidget function should look like the following sample:

let options = {        
    country: "FR",
    language: "FR",
    merchant_guid: "4ee34660-1659-4d8e-8849-544c46f4954b",
    payment_amount: 560.00,
    free_bts: true
};

loadOneyWidget(function () {
oneyMerchantApp.loadGeneralConditions({ options });
});

Make sure the function names are input exactly.

The ‘options’ variable is mandatory, and the fields in the above sample are all mandatory.

6. You can now click on the button to show the Oney General Conditions Popin (step 3 above) and the layer should display.

Country-specific parameters

These parameters can be added to the ‘options’ object above and will be displayed exactly as passed in.

The following parameters are mandatory so that the general conditions displayed are compliant. Information will be shown as blank in the text if not passed in, making it not compliant.

Field name	Mandatory - Optional	Description
`document_type`	M	Possible value "3x4xCB", "10x12xCB" or "10x12xIBAN". If you selected 10x12 CB or 10x12 IBAN, you need to provide specific information linked to an Orias registration. Registration is valid until 28th February of the following year and must be renewed each year by the 31st of January the latest. Our teams remain at your disposal to guide you.
`merchant_orias_number`	M	The Orias number of the merchant, to be displayed in the legal text
`merchant_name`	M	The name of the merchant to be displayed in the legal text
`merchant_address`	M	The merchant head office address to be displayed in the legal text

Advanced Configuration

The ‘options’ object above can be expanded with the following optional fields:

If showAsModal option below is set to ‘false’, the responseType and successCallback parameters become mandatory.

showAsModal
A boolean value which will determine whether a popup modal is displayed with the result
responseType
Can be one of two values, “html” or “json”, depending on whether the rendered or unrendered input is required
successCallback
it has to be a function accepting two parameters (similar to errorCallback below)
- status
  An integer with the HTTP status code of the response
- response
  A string (which can be a stringified JSON object, or the rendered HTML) with the details of the response
errorCallback
The options object can be expanded to receive a response that can be handled by the developer when something goes wrong.
This will be especially useful when setting up, or to have the possibility to log errors.
The correct value to pass in is a function accepting two parameters:
- status
  An integer with the HTTP status code of the response
- response
  A string (which can be a stringified JSON object) with the details of the response

The errorCallback function will look something like the following example:

options.errorCallback = function (status, response) {
    console.log(status + " - " + response);
}

loadOneyWidget(function() {
    oneyMerchanApp.loadGeneralConditions({ options });
});

In this case, the only action being performed is outputting the error to the console, but this can be changed to fit your needs.

Full example

Sample with all options, with the returned HTML being injected directly into a page element:

<html>
    <head>    
    </head>
    <body>
        <h2>Merchant Website</h2>
        <button onclick="showGeneralConditions()">
            Load general conditions
        </button>
        <div class="generalConditions"></div>
        <script type="text/javascript" src="https://assets.oney.io/build/loader.min.js"></script>
        <script>
            function showGeneralConditions () {

                let options = {        
                    country: "FR",
                    language: "FR",
                    merchant_guid: "10253268-215b-4f98-92df-d936ec4e3354",
                    payment_amount: 560.00,
                    free_bts: true,
                    showAsModal: false,
                    document_type: "3x4xCB",
                    responseType: "html"
                };

                options.successCallback = function (status, response) {
                    document.getElementsByClassName("generalConditions")[0].innerHTML = response;                
                };

                options.errorCallback = function (status, response) {
                    console.log(status + " - " + response);
                };

                loadOneyWidget(function () {
                    oneyMerchantApp.loadGeneralConditions({ options });
                });
            }
    
        </script>
    </body>
</html>