configuration.md

Configuration

🏠 Access

To access to Clearpay admin panel, we need to open the Magento admin panel and follow the next steps:

1. System => Configuration

2. Scroll down and search the section SALES => Payment Methods

3. Scroll down to find the Clearpay Payment Method and fill the fields with your configuration.

📋 Options

In the Clearpay admin panel, we can set the following options:

Field	Description
Module enabled	* Yes => Activates the payment method (Default) * No => Disables the payment method
Public Key(*)	String.
Secret Key(*)	String.
Simulator is enabled	* Yes => Display the installments simulator (Default) * No => Do not display the simulator

ℹ️ - Your keys are located on your Clearpay profile

📋 Advanced configuration:

While we recommend using the Clearpay module as is , you can customize some settings as shown below.

You have to ways to edit your settings:

• Database queries
• HTTP requests

List of settings and their description.

Static values cannot be edited.

Field	Description
CLEARPAY_TITLE	Payment title to show in checkout page. By default:"Instant financing".
CLEARPAY_SIMULATOR_DISPLAY_TYPE	Installments simulator on the product page. Static value: 'pgSDK.simulator.types.PRODUCT_PAGE'.
CLEARPAY_SIMULATOR_DISPLAY_SKIN	Skin of the product page simulator. Recommended value: 'pgSDK.simulator.skins.BLUE'.
CLEARPAY_SIMULATOR_START_INSTALLMENTS	Default number of installments to use in the simulator.
CLEARPAY_SIMULATOR_DISPLAY_CSS_POSITION	The position where the simulator widget will be placed. Recommended value: 'pgSDK.simulator.positions.INNER'.
CLEARPAY_SIMULATOR_CSS_PRICE_SELECTOR	CSS selector of the DOM element containing the total amount value.
CLEARPAY_SIMULATOR_CSS_POSITION_SELECTOR	CSS Selector to place the widget. (Example: '#simulator', '.PgSimulator')
CLEARPAY_SIMULATOR_CSS_QUANTITY_SELECTOR	CSS selector of the DOM element containing the quantity selector value.
CLEARPAY_FORM_DISPLAY_TYPE	Allows you to select the way the Clearpay payment form is displayed site
CLEARPAY_DISPLAY_MIN_AMOUNT	Minimum amount to use the module and show the payment method in the checkout page and in product page.
CLEARPAY_DISPLAY_MAX_AMOUNT	Maximum amount to use the module and show the payment method in the checkout page and in product page.
URL_OK	Location where user will be redirected after a successful payment. This string will be concatenated to the base url to build the full url
URL_KO	Location where user will be redirected after a wrong payment. This string will be concatenated to the base url to build the full url
CLEARPAY_ALLOWED_COUNTRIES	Array of country codes where Clearpay will be used as a payment method.

Edit your settings using database queries

1. Open your database management (Commonly Cpanel->phpmyadmin depending on your hosting solution)

2. Connect to the magento database.

3. Launch a query to check if the table exists:

• Query: SELECT * FROM clearpay_config;

  

4. Find the setting CLEARPAY_TITLE, in this example we are going to change 'Instant Financing' to 'New Title'

5. Launch the following query to edit the value:

• Query: UPDATE clearpay_config SET value='New title' WHERE config='CLEARPAY_TITLE';

  

6. After the modification, you can verify it with the following query :

• Query: SELECT * FROM clearpay_config;

  

7. Finally you can see the result on checkout page
   

Edit your settings using Postman

1. Open the application
   

2. Set the mode of the request
   2.1 Click on BODY tag
   2.2 Click on x-www-form-urlencoded

3. Set your request
   3.1 On the upper-left side, you need to set a POST request
   3.2 Fill the url field with your domain, and your secret key which is located on your Clearpay profile.
   3.3 Set the config key to modify.List of config keys.
   3.4 Set the value for the selected key
   

4. Press SEND
   

5. If everything works correctly, you should see the edited config as show below