README

Installation

Install using Composer (Recommended)

1. From the CLI, run the following commands to install the Clearpay module.
   The right installation command is dependent on your Magento 2 version:

   Magento version	Command to run
   2.4.*	composer require clearpay/module-clearpay:^5
   2.3.*	composer require clearpay/module-clearpay:^4
   < 2.3.0	composer require clearpay/module-clearpay:^3

2. Run Magento install/upgrade scripts: php bin/magento setup:upgrade
3. Compile dependency injection: php bin/magento setup:di:compile
4. Deploy static view files (production mode only): php bin/magento setup:static-content:deploy
5. Flush Magento cache: php bin/magento cache:flush

Install manually

1. Download the Clearpay module for Magento 2 - Available as a .zip or tar.gz file from the Clearpay GitHub directory.
   The right installation module is dependent on your Magento 2 version:

   Magento version	Download
   2.4.*	Clearpay
   2.3.*	Clearpay:4.*
   < 2.3.0	Clearpay:legacy

2. Unzip the file
3. Create directory `Clearpay/Clearpay` in: [MAGENTO]/app/code/
4. Copy the files to `Clearpay/Clearpay` folder
5. Run Magento install/upgrade scripts: php bin/magento setup:upgrade
6. Compile dependency injection: php bin/magento setup:di:compile
7. Deploy static view files (production mode only): php bin/magento setup:static-content:deploy
8. Flush Magento cache: php bin/magento cache:flush

Clearpay Merchant Setup

Complete the below steps to configure the merchant’s Clearpay Merchant Credentials in Magento Admin. Note: Prerequisite for this section is to obtain an Clearpay Merchant ID and Secret Key from Clearpay.

1. Navigate to Magento Admin/Stores/Configuration/Sales/Payment Methods/Clearpay
2. Enter the Merchant ID and Merchant Key.
3. Enable Clearpay plugin using the Enabled checkbox.
4. Configure the Clearpay API Mode (Sandbox Mode for testing on a staging instance and Production Mode for a live website and legitimate transactions).
5. Save the configuration.
6. Navigate to Magento Admin/System/Tools/Cache Management
7. Click Flush Magento Cache button

Upgrade

Composer Upgrade (Recommended)

This section outlines the steps to upgrade the currently installed Clearpay plugin version using composer.

Notes: Prerequisite for this section is that the module should be installed using composer. Please see section 'Install using Composer' for guidelines to install Clearpay module using composer.

[MAGENTO] refers to the root folder where Magento is installed.

1. Open Command Line Interface and navigate to the Magento directory on your server
2. In CLI, run the below command to update Clearpay module:
   The right installation command is dependent on your Magento 2 version:

   Magento version	Command to run
   2.4.*	composer require clearpay/module-clearpay:^5
   2.3.*	composer require clearpay/module-clearpay:^4
   < 2.3.0	composer require clearpay/module-clearpay:^3

3. Make sure that Composer finished the update without errors
4. Run Magento install/upgrade scripts: php bin/magento setup:upgrade
5. Compile dependency injection: php bin/magento setup:di:compile
6. Deploy static view files (production mode only): php bin/magento setup:static-content:deploy
7. Flush Magento cache: php bin/magento cache:flush

Manual Upgrade

This section outlines the steps to upgrade the currently installed Clearpay plugin version.
The process of upgrading the Clearpay plugin version involves the complete removal of Clearpay plugin files.

1. Remove Files in: [MAGENTO]/app/code/Clearpay/Clearpay
2. Download the Magento-Clearpay plugin - Available as a .zip or tar.gz file from the Clearpay GitHub directory.
   The right Clearpay module upgradation is dependent on your Magento 2 version:

   Magento version	Download
   2.4.*	Clearpay:latest
   2.3.*	Clearpay:4.*
   < 2.3.0	Clearpay:legacy

3. Unzip the file
4. Copy the files in folder to: [MAGENTO]/app/code/Clearpay/Clearpay
5. Open Command Line Interface
6. In CLI, run the command to enable Clearpay module: php bin/magento module:enable Clearpay_Clearpay
7. Run Magento install/upgrade scripts: php bin/magento setup:upgrade
8. Compile dependency injection: php bin/magento setup:di:compile
9. Deploy static view files (production mode only): php bin/magento setup:static-content:deploy
10. Flush Magento cache: php bin/magento cache:flush

Uninstall

1. From the CLI, run the following commands to uninstall Clearpay module: bin/magento module:uninstall Clearpay_Clearpay
2. Run Magento install/upgrade scripts: php bin/magento setup:upgrade
3. Compile dependency injection: php bin/magento setup:di:compile
4. Deploy static view files (production mode only): php bin/magento setup:static-content:deploy
5. Flush Magento cache: php bin/magento cache:flush

Headless support

Module supports GraphQL and REST API. See GraphQL and Rest API