PHPackages                             clearpay/module-clearpay - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Payment Processing](/categories/payments)
4. /
5. clearpay/module-clearpay

ActiveMagento2-module[Payment Processing](/categories/payments)

clearpay/module-clearpay
========================

Magento 2 Clearpay Payment Module

5.4.4(9mo ago)4138.1k↓11.6%61Apache-2.0PHPPHP >=7.4.0

Since Dec 18Pushed 9mo ago2 watchersCompare

[ Source](https://github.com/clearpayeu/clearpay-magento-2)[ Packagist](https://packagist.org/packages/clearpay/module-clearpay)[ RSS](/packages/clearpay-module-clearpay/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (10)Dependencies (6)Versions (55)Used By (1)

Clearpay for Magento 2
======================

[](#clearpay-for-magento-2)

Installation
------------

[](#installation)

### Install using Composer (Recommended)

[](#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 versionCommand to run2.4.\*composer require clearpay/module-clearpay:^52.3.\*composer require clearpay/module-clearpay:^4< 2.3.0composer 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

[](#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 versionDownload2.4.\*[Clearpay](https://github.com/clearpay/clearpay-magento-2/archive/refs/heads/main.zip)2.3.\*[Clearpay:4.\*](https://github.com/clearpay/clearpay-magento-2/archive/refs/heads/2.3-main.zip)< 2.3.0[Clearpay:legacy](https://github.com/clearpay/clearpay-magento-2/archive/refs/heads/legacy-main.zip)
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
-----------------------

[](#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
-------

[](#upgrade)

### Composer Upgrade (Recommended)

[](#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 versionCommand to run2.4.\*composer require clearpay/module-clearpay:^52.3.\*composer require clearpay/module-clearpay:^4< 2.3.0composer 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

[](#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.

***Note:** \[MAGENTO\] refers to the root folder where Magento is installed.* 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 versionDownload2.4.\*[Clearpay:latest](https://github.com/clearpay/clearpay-magento-2/archive/refs/heads/main.zip)2.3.\*[Clearpay:4.\*](https://github.com/clearpay/clearpay-magento-2/archive/refs/heads/2.3-main.zip)< 2.3.0[Clearpay:legacy](https://github.com/clearpay/clearpay-magento-2/archive/refs/heads/legacy-main.zip)
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
---------

[](#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
----------------

[](#headless-support)

Module supports GraphQL and REST API. See [GraphQL](Docs/GraphQL.md) and [Rest API](Docs/RestAPI.md)

###  Health Score

49

—

FairBetter than 95% of packages

Maintenance57

Moderate activity, may be stable

Popularity38

Limited adoption so far

Community15

Small or concentrated contributor base

Maturity71

Established project with proven stability

 Bus Factor1

Top contributor holds 97.4% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~41 days

Recently: every ~87 days

Total

51

Last Release

281d ago

Major Versions

4.3.0 → 5.3.02024-02-01

4.3.1 → 5.3.22024-08-07

4.3.2 → 5.4.12024-08-27

4.3.3 → 5.4.22024-11-08

4.3.5 → 5.4.42025-08-11

PHP version history (5 changes)5.0.0PHP ~7.4.0||~8.0.0

4.0.0PHP ~7.1.3||~7.2.0||~7.3.0

4.0.1PHP ~7.1.3||~7.2.0||~7.3.0||~7.4.0

5.0.1PHP ~7.4.0||~8.1.0

5.1.2PHP >=7.4.0

### Community

Maintainers

![](https://www.gravatar.com/avatar/6a19a246d05e7bb54380ee9308994fddb59c3a60a577ba39409b03908ffe987d?d=identicon)[clearpay](/maintainers/clearpay)

---

Top Contributors

[![clearpayplugins](https://avatars.githubusercontent.com/u/54883417?v=4)](https://github.com/clearpayplugins "clearpayplugins (38 commits)")[![benfterpay](https://avatars.githubusercontent.com/u/28610907?v=4)](https://github.com/benfterpay "benfterpay (1 commits)")

### Embed Badge

![Health badge](/badges/clearpay-module-clearpay/health.svg)

```
[![Health](https://phpackages.com/badges/clearpay-module-clearpay/health.svg)](https://phpackages.com/packages/clearpay-module-clearpay)
```

###  Alternatives

[mollie/magento2

Mollie Payment Module for Magento 2

1121.6M10](/packages/mollie-magento2)[afterpay-global/module-afterpay

Magento 2 Afterpay Payment Module

25312.6k2](/packages/afterpay-global-module-afterpay)[dotdigital/dotdigital-magento2-extension

Dotdigital for Magento 2

50374.2k18](/packages/dotdigital-dotdigital-magento2-extension)[pagbank/payment-magento

PagBank - Payment for Magento and Adobe

2128.3k7](/packages/pagbank-payment-magento)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)