Adobe Commerce (Magento 2)

๐Ÿ“˜

Note

Until recently Adobe Commerce was called Magento 2.

Before you begin

  • The Clearpay Extension for Adobe Commerce is compatible with Adobe Commerce version 2.3.5-p1 or greater
  • The plugin relies on a dedicated Website Scope being used for each market region (country) with a corresponding Base Currency set in Adobe Commerce Admin. To set the Base Currency, go to
    Stores > Configuration > Currency Setup and set the currency to match your Clearpay account region

Installing and configuring the Clearpay extension

  1. Download the Clearpay extension from the GitHub repository and unzip it.

  2. Install the extension. It can be installed with or without using Composer:

    To install the Clearpay extension using Composer:
    a. Open a command line interface and navigate to the Adobe Commerce directory on your server.
    b. In CLI, run the below command to install Clearpay module: composer require clearpay-global/module-clearpay:^5
    c. At the Composer request, enter your Adobe Commerce (Magento) marketplace credentials (public key - username, private key - password)
    d. Make sure that Composer finished the installation without errors.
    e. Run the Adobe Commerce (Magento) setup upgrade: php bin/magento setup:upgrade
    f. Run the Adobe Commerce (Magento) Dependencies Injection Compile: php bin/magento setup:di:compile
    g. Run the Adobe Commerce (Magento) Static Content deployment: php bin/magento setup:static-content:deploy

    To install the Clearpay extension without using Composer:
    a. Create directory Clearpay/Clearpay' in [MAGENTO]/app/code
    b. Copy the files to the 'Clearpay/Clearpay' folder
    c. Open the Command Line Interface (CLI) and run the commands below:

CommandDescription
php bin/magento module:enable Clearpay_ClearpayEnable Clearpay extension.
php bin/magento setup:upgradeAdobe Commerce (Magento) setup upgrade.
php bin/magento setup:di:compileAdobe Commerce (Magento) dependencies injection complile.
php bin/magento setup:static-content:deployAdobe Commerce (Magento) static content deployment.
  1. Login to Adobe Commerce Admin and go to Stores > Configuration > Sales > Payment Methods > Clearpay (scroll to bottom)
  2. Enter the following basic settings:
SettingValue
EnabledYes - Clearpay turned on.
No - Clearpay disabled.
API ModeSandbox - for development or staging environments.
Production - for your live website.
TitleInstallments by Clearpay - the title of payment method at checkout.
Merchant IDYour 9 digit Sandbox or Production Clearpay Merchant ID.
Merchant KeyYour Sandbox or Production Clearpay Secret Key.
Payment ActionAuthorise and Capture.
  1. Enter the following advanced settings:
SettingValue
Minimum/Maximum Order TotalClick *Update Limits button to obtain your current minimum and maximum Clearpay order thresholds.
Cross-Border TradeEnabled - this is enabled via speaking to your Clearpay Representative.
DebugYes - Debug logs are written to "h-0": "/var/log/afterpay.log.
No - Disabled.
Sort Order(Order of payment methods at checkout).
HTTP Version Header SupportNo - normal value.
Yes - if "Invalid header line detected" errors occur.
Exclude CategorySelect relevant categories to exclude Clearpay from being available.
Payment FlowImmediate Payment Flow - Capture full payment.
Deferred Payment Flow - Capture incremental amounts as items are despatched.
  1. Go to Country Specific Settings.
  2. Set Payment from Applicable Countries to 'Specific Countries'
  3. Set Payment from Specific Countries to match the region of your Clearpay account.
  4. Click Save Config in the upper-right.
  5. Flush the Adobe Commerce system cache by navigating to System > Cache Management. Then select Flush Cache Storage.

If you are using Express Checkout:

  1. Enter the following settings:
SettingValue
Enabled for Product PageYes - Can checkout directly from Product Page
No
Enabled for Cart PageYes - Can checkout directly from Cart Page
No
Enabled for Mini-Cart PageYes - Can checkout directly from Mini-Cart
No

Updating the Clearpay extension

To update to the latest version of the Clearpay extension:

  1. Remove files in: [Adobe-Commerce]/app/code/Clearpay/Clearpay. [Adobe-Commerce] refers to the root folder where you have installed your version of Adobe Commerce.
  2. Follow the installation process above.

๐Ÿ“˜

Supported Countries

Clearpay is available for Adobe Commerce (Magento) merchants with a store address in these countries:

๐Ÿ‡ฌ๐Ÿ‡ง UK

As Afterpay in these countries.
๐Ÿ‡บ๐Ÿ‡ธ United States
๐Ÿ‡ฆ๐Ÿ‡บ Australia
๐Ÿ‡ณ๐Ÿ‡ฟ New Zealand
๐Ÿ‡จ๐Ÿ‡ฆ Canada