Install Extension

Overview

There are two ways to install and enable the Adobe Commerce Clearpay Extension:

• Use Composer to automatically download and install the files it gets from Packagist. We recommend this method

• Do a manual install

Both these ways involve locating and installing the Clearpay Extension for Adobe Commerce (Magento 2). Composer does this task automatically. For manual installations, you must locate and download this public repo for Adobe Commerce (Magento 2):

• Clearpay Extension for Magento 2

You can also use the "headless" methods, GraphQL and REST API. See the Headless Support section below.

Composer

We recommend you use Composer to manage your repos and dependencies. This is a recommendation, not a requirement.

If you use Composer, make sure you install the correct module version that corresponds to your Adobe Commerce/Magento version. For example, module version 5.x works with Magento 2.4.x. The various modules and their corresponding Commerce/Magento version appear in this GitHub table. See Step 2 below.

Do the following:

1. In Composer, open the Command Line Interface (CLI) and go to the Adobe Commerce project root directory on your server.

2. In the CLI, run this command to install the Clearpay module: composer require clearpay/module-clearpay:. See the Installation section at the bottom of the GitHub table for the specific Clearpay module you need to specify.

3. Make sure that Composer finishes the installation without errors.

4. Run the Adobe Commerce setup upgrade: php bin/magento setup:upgrade.

5. Run the Adobe Commerce Dependencies Injection Compile: php bin/magento setup:di:compile.

6. Run the Adobe Commerce Static Content deployment: php bin/magento setup:static-content:deploy.

7. Run the Adobe Commerce System Cache Flush: php bin/magento cache:flush.

Manual Procedure

This method does not use Composer. It is a more complex than using Composer, but just as effective when done correctly. Follow the instructions below.

Download the Clearpay Extension

The extension is on the gitHub. Do the following:

1. Go to the GitHub for the link to Magento 2 for the most up-to-date version.

📘

Note

The Clearpay plugins and associated information are all in the Clearpay-Magento-2 part of the GitHub.

The source code needed depends on your version of Magento. See the Readme file in the Clearpay-Magento-2 part of GitHub.

2. Under the green <> Code heading, click HTTPS and click Download ZIP. See screenshot below:

3. Unzip your files and put them into a temporary folder.

📘

Install Folder

You can install Adobe Commerce in any folder on your server. In this guide, [ADOBE-COMMERCE] is the name of the root folder where Adobe Commerce is installed.

Run the Commands

1. Create the folder Clearpay/Clearpay in [ADOBE-COMMERCE]/app/code.

2. Copy the files from your temporary folder to the Clearpay/Clearpay folder. The temporary folder is the one you created in Step 3 in the Download the Clearpay Extension section above.

3. Open the Command Line Interface (CLI) and make sure you are the owner of the [ADOBE-COMMERCE] folder. Run all the CLI commands as the owner of the folder, not root and without sudo.

4. From the CLI, run the commands below:

Headless Support

You can also use GraphQL or REST API to use Clearpay together with Adobe Commerce.

For details, see the following web pages on the GitHub:

• Clearpay GraphQL Support page

• REST API page