Plugins for eCommerce plartforms

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 plartforms

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_Magento2Module --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).
Terminal screen
  1. Log in to your Magento store admin panel.
Magento admin panel login screen

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.
Klix payment method configuration screen in Mozello
  1. 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.
  2. 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.
Checkout payment method selection screen in Mozello store

OpenCart

Compatible versions: 3.0+

Installation instructions:

  1. Click on this link to download Klix OpenCart extension.
  2. Log in to your OpenCart store admin panel by specifying authentication credentials.
OpenCart admin panel login screen
  1. Open "Extensions" -> "Installer" section from the main menu.
OpenCart extension upload screen
  1. Press "Upload" button and select Klix OpenCart extension file downloaded in the first step. Progress bar will indicate extension upload progress.
OpenCart extension install screen
  1. Open "Extensions" -> "Extensions" section from the main menu and filter payment extensions.
Extensions filter screen
  1. Find Klix extension in extension list and press "+" (Install).
Klix extension install screen
  1. Press "Edit" Klix extension.
Klix extension edit button screen
  1. 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.
Klix extension settings edit screen
  1. 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.
Checkout payment method selection screen
  1. 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".
Translation definition screen
  1. Go to your OpenCart store checkout page and preview translations by switching to desired language.
Translated checkout payment method selection screen
  1. Pay Later widget will be enabled after modification refresh. Open "Extensions" -> "Modifications" section. Click on refresh button.
    Refresh modifications

PrestaShop

Compatible versions: 1.7+

Installation instructions:

  1. Click on this link to download Klix PrestaShop plugin in case your store Prestshop version is 1.7.6. or newer. If you use Prestashop version that's older than 1.7.6. then click on this link (note that translations functionality will work only with Prestashop 1.7.6. and newer version).
  2. Log in to your PrestaShop store admin panel by specifying authentication credentials.
PrestaShop admin panel login screen
  1. Open "Modules" -> "Module Manager" section.
Module mangager menu screen
  1. Press "Upload a module" button.
Open upload module dialog screen
  1. Select a module file downloaded in the first step. Selected module file will be installed.
Upload module screen
  1. After module is installed press "Configure" button.
Installed module screen
  1. Enter Brand ID and Secret key provided by Klix contact person, mark "Enable API" to enable Klix payment method.
Klix module configuration screen
  1. 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.
Klix module configuration screen
  1. Then choose your store language for which you would like to enter translations.
Klix module translation language selection screen
  1. And provide translations for all provided texts.
Klix translations screen
  1. 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.
Checkout payment method selection screen

Shopify

Installation instructions:

  1. Add a Klix payments app from Shopify app store.
  2. After an install Shopify will redirect to our Business Portal page. After an install Shopify will redirect to our Business Portal page.
  3. After successful login click on Create in Business Portal. After successful login click on Create in Business Portal.

  4. Business Portal will redirect back to Shopify settings to settings view. In settings click on Activate Klix payments. Business Portal will redirect back to Shopify settings to settings view.

  5. Go to your Shopify store checkout page and check that Klix payment method is available. For test purposes please click on Enable test mode and then on Save.

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.
WooCommerce admin panel login screen
  1. Open "Plugins" -> "Add new" section.
Plugin menu screen
  1. 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.
Upload plugin screen
  1. Press "Activate" button to activate installed Klix WooCommerce plugin.
Finished plugin installation screen
  1. Find Klix plugin and press on "Settings" link.
Plugins screen
  1. Enter Brand ID and Secret key provided by Klix contact person and check Enable API checkbox.
Klix plugin settings screen
  1. 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.
Payment option selection screen
  1. In order to use Klix-Checkout in plugin settings unselect "Enable payment method selection" and select "Enable directed payment".
    Then from shipping options fetch the shipping method titles and send them to support@klix.app.
    In case of pickup in store, please send the list of shop addresses.
Shipping options