1.1 New Clearpay Installation

This section outlines the steps to install the Clearpay plugin on your Magento instance for the first time.

Magento can be installed in any folder on your server. For the purposes of this document, [MAGENTO] will refer to the root folder where Magento is installed.

1. The Clearpay plugin for Magento 1 is available as a .zip or tar.gz file from the Clearpay GitHub repository
2. Unzip the file and copy everything in /src/ to [MAGENTO]/
3. Login to the Magento Admin and navigate to "System > Cache Management"
4. Flush the cache storage by selecting Flush Cache Storage

1.2 Website Configuration

Clearpay operates under a list of assumptions based on Magento configurations. To align with these assumptions, the Magento configurations must reflect the below.

1. Website Currency must be set to GBP

   Inside the Magento Admin, navigate to "System > Configuration > Currency Setup". Set the base, display and allowed currency as appropriate to match your Clearpay Merchant Account.

2. Postal Code must be mandatory

   Inside the Magento Admin, navigate to "System > Configuration > General". Ensure Postal Code is not configured as optional for any country that Clearpay is being applied to.

1.3 Clearpay Merchant Setup

To configure your Clearpay Merchant Account credentials in the Magento Admin, please complete the steps below. The prerequisite for this section is to obtain a Clearpay Merchant ID and Secret Key from Clearpay.

1. Inside the Magento Admin, navigate to "System > Configuration > Sales > Payment Methods > Clearpay"
2. Enter the Merchant ID and Merchant Secret Key (provided by Clearpay)
3. Enable Clearpay by selecting "Yes" from the Enabled dropdown
4. Configure the API Mode - select Sandbox for testing on a staging instance, or Production for a live website with legitimate transactions
5. Save the configuration
6. Click the Update Payment Limits button to retrieve the Minimum and Maximum Clearpay Order values

1.4 Clearpay Display Configuration

1. Inside the Magento Admin, navigate to "System > Configuration > Sales > Clearpay"
2. Enable Debug Mode to log transactions and additional valuable data
3. Configure the display of the Clearpay elements presented on Product Detail Pages (PDP), the cart page and at the checkout
4. After saving any changes, navigate to "System > Cache Management"
5. Flush the cache storage by selecting Flush Cache Storage

1.5 Upgrade Of Clearpay Installation

This section outlines the steps to upgrade an existing installation of the Clearpay plugin to a new version.

The process of upgrading the Clearpay plugin for Magento 1 involves the complete removal of all plugin files, followed by copying the new files.

[MAGENTO] will refer to the root folder where you have installed your version of Magento.

1. Remove folder: [MAGENTO]/app/code/community/Clearpay
2. Remove folder: [MAGENTO]/app/design/adminhtml/default/default/template/clearpay
3. Remove file: [MAGENTO]/app/design/frontend/base/default/layout/clearpay.xml
4. Remove folder: [MAGENTO]/app/design/frontend/base/default/template/clearpay
5. Remove file: [MAGENTO]/app/etc/modules/Clearpay_Clearpay.xml
6. Remove folder: [MAGENTO]/js/Clearpay
7. Remove folder: [MAGENTO]/skin/frontend/base/default/clearpay
8. The Clearpay plugin for Magento 1 is available as a .zip or tar.gz file from the Clearpay GitHub repository
9. Unzip the file and copy everything in /src/ to [MAGENTO]/
10. Login to the Magento Admin and navigate to "System > Cache Management"
11. Flush the cache storage by selecting Flush Cache Storage