Plugins for eCommerce platforms

Klix provides plugins for most popular eCommerce platforms so that Klix can be integrated as simple as other plugins you might be already using in your shop. Integration using eCommerce platform plugin consists of a plugin installation and configuration. Plugin installation instructions differs between eCommerce platforms but configuration usually consists of two steps:

1. Enabling Klix as a payment method.
2. Specifying Brand ID and Secret key in plugin settings.

If you have already signed Klix merchant agreement and have received production environment API keys then those should be used in these instructions. Otherwise there's an option to use test-environment credentials to preview Klix payment gateway solution functionality.

eCommerce platforms

Magento

Compatible versions: 2.0+

Installation instructions:

1. Connect to Magento server terminal.
2. Create and navigate to a directory app/code/ in your Magento root directory if does not exist already.
3. Download Klix Magento plugin: curl https://portal.klix.app/ecommerce_modules/magento-v2.0+.zip --output magento-v2.0+.zip
4. Extract Klix Magento plugin archive contents to app/code/ directory so that there's app/code/SpellPayment/Magento2Module directory structure after that: unzip -q magento-v2.0+.zip && rm magento-v2.0+.zip
5. Navigate to Magento root directory and run php bin/magento module:enable SpellPayment_ExpressCheckout --clear-static-content
6. Run php bin/magento setup:upgrade

7. Run php bin/magento setup:static-content:deploy (note that message "Manual static content deployment is not required in "default" and "developer" modes" can be ignored).

8. Log in to your Magento store admin panel.

Mozello

Installation instructions:

1. Log in to your Mozello store administration portal.

2. Open Catalog -> Catalog settings -> Payment page and locate Credit cards / payment platforms section.

3. Select "Klix by Citadele" in Connect online payment platform drop down and enter Brand ID and Secret key provided by Klix contact person. Change payment method title in checkout form if needed.

4. Go to your Mozello store checkout page and check that Klix payment method is available. It's advisable to test Klix integration using a real card.

OpenCart

Compatible versions: 3.0-4+

Installation instructions:

1. Download plugin by Opencart version:
   • 3.0+
   • 4.0+

2. Log in to your OpenCart store admin panel by specifying authentication credentials.

3. Open "Extensions" -> "Installer" section from the main menu.

4. Press "Upload" button and select Klix OpenCart extension file downloaded in the first step. Progress bar will indicate extension upload progress.

5. Open "Extensions" -> "Extensions" section from the main menu and filter payment extensions.

6. Find Klix extension in extension list and press "+" (Install).

7. Press "Edit" Klix extension.

8. Enter Brand ID and Secret key provided by Klix contact person, mark "Enable API" to enable Klix payment method and select order payment success and error statuses.

9. Go to your OpenCart store checkout page and check that Klix payment method is available. It's advisable to test Klix integration using a real card.

10. Localize Klix checkout page (optional). By default all Klix payment method section text elements are in English. In order to add translations for Klix section to your store checkout page go to OpenCart store admin panel, open "Design" -> "Language Editor". Press on "+" (add new) button and for each language create translations for required keys: "klix_payment_method_selection" (Klix payment section title), "klix_place_order" (Klix pay button title). Note that empty translation key should be selected in translation key drop-down and one of previously mentioned Klix translation keys should be copied to text input field below translation key drop-down. In a given example translation for default "Select payment method" label is defined for Russian. In a similar way translation for pay button can be changed, the only difference is in translation key which should be "klix_place_order". Note that route should always be "checkout/checkout".

11. Go to your OpenCart store checkout page and preview translations by switching to desired language.

12. Pay Later widget will be enabled after modification refresh. Open "Extensions" -> "Modifications" section. Click on refresh button.

PrestaShop

Compatible versions: 1.7+

Installation instructions:

1. Download plugin by Prestashop version:

   • 1.6 - 1.6.1.11
   • 1.7 - 1.7.5
   • 1.7.6 - 1.7.8.9
   • 8.0 or newer

2. Log in to your PrestaShop store admin panel by specifying authentication credentials.

3. Open "Modules" -> "Module Manager" section.

4. Press "Upload a module" button.

5. Select a module file downloaded in the first step. Selected module file will be installed.

6. After module is installed press "Configure" button.

7. Enter Brand ID and Secret key provided by Klix contact person, mark "Enable API" to enable Klix payment method.

8. Localize Klix checkout page (optional). By default all Klix payment method section text elements are in English. In order to add translations for Klix section to your store checkout page press "Translate" button.

9. Then choose your store language for which you would like to enter translations.

10. And provide translations for all provided texts.

11. Go to your PrestShop store checkout page and check that Klix payment method is available. It's advisable to test Klix integration using a real card.

Shopify

Installation instructions:

1. Login to Business Portal
2. After successful login open Shopify app store in new tab and install the plugin.
3. During instalation Shopify will redirect to our Business Portal page to confirm Shopify store integration.
4. Business Portal will redirect back to Shopify settings to settings view. In settings click on Activate Klix payments.
5. Switch Payment capture method to automatically at checkout.
6. Go to your Shopify store checkout page and check that Klix payment method is available. For test purposes please enable Enable test mode checkbox.

WooCommerce

Compatible versions: 3.5+

Installation instructions:

1. Click on this link to download Klix WooCommerce plugin.

2. Log in to your WooCommerce store admin panel by specifying authentication credentials.

3. Open "Plugins" -> "Add new" section.

4. Press on "Upload Plugin" and select Klix WooCommerce plugin file downloaded in the first step, press "Install Now". In rare cases e.g. if your server is not configured to allow automatic installations you might need to install Klix WooCommerce plugin by manually transfering Klix plugin files onto the server. Follow these instructions in such case.

5. Press "Activate" button to activate installed Klix WooCommerce plugin.

6. Find Klix plugin and press on "Settings" link.

7. Enter Brand ID and Secret key provided by Klix contact person and check Enable API checkbox.

8. Go to your WooCommerce store checkout page and check that Klix payment method is available. It's advisable to test Klix integration using a real card.