GuidesAPI Reference

Magento 2

Suggest Edits

📘

Supported Countries

Clearpay is available for Magento 2 merchants with a store address in these countries:

🇬🇧 UK
🇫🇷 France
🇮🇹 Italy
🇪🇸 Spain

As Afterpay in these countries.
🇺🇸 United States
🇦🇺 Australia
🇳🇿 New Zealand
🇨🇦 Canada

Before you begin

  • The Clearpay Extension for Magento 2 is compatible with Magento 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 Magento 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 Magento directory on your server.
    b. In CLI, run the below command to install Clearpay module: composer require clearpay-global/module-clearpay
    c. At the Composer request, enter your Magento marketplace credentials (public key - username, private key - password)
    d. Make sure that Composer finished the installation without errors.
    e. Run the Magento setup upgrade: php bin/magento setup:upgrade
    f. Run the Magento Dependencies Injection Compile: php bin/magento setup:di:compile
    g. Run the Magento Static Content deployment: php bin/magento setup:static-content:deploy

    To install the Clearpay extension without 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:

Command

Description

php bin/magento module:enable Clearpay_Clearpay

Enable Clearpay extension

php bin/magento setup:upgrade

Magento setup upgrade

php bin/magento setup:di:compile

Magento dependencies injection complile

php bin/magento setup:static-content:deploy

Magento static content deployment

  1. Login to Magento Admin and go to Stores > Configuration > Sales > Payment Methods > Clearpay (scroll to bottom)
  2. Enter the following basic settings:

Setting

Value

Enabled

Yes - Clearpay turned on
No - Clearpay disabled

API Mode

Sandbox - for development or staging environments
Production - for your live website

Title

Installments by Clearpay - the title of payment method at checkout

Merchant ID

Your 9 digit Sandbox or Production Clearpay Merchant ID

Merchant Key

Your Sandbox or Production Clearpay Secret Key

Payment Action

Authorise and Capture

  1. Enter the following advanced settings:

Setting

Value

Minimum/Maximum Order Total

Click *Update Limits button to obtain your current minimum and maximum Clearpay order thresholds

Debug

Yes - Debug logs are written to [Magento]/var/log/afterpay.log
No - Disabled

Sort Order

(Order of payment methods at checkout)

HTTP Version Header Support

No - normal value
Yes - if "Invalid header line detected" errors occur

  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 Magento system cache by navigating to System > Cache Management. Select Flush Cache Storage.

If you are using Express Checkout:

  1. Enter the following settings:

Setting

Value

Enabled for Product Page

Yes - Can checkout directly from Product Page
No

Enabled for Cart Page

Yes - Can checkout directly from Cart Page
No

Enabled for Mini-Cart Page

Yes - 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: [MAGENTO]/app/code/Clearpay/Clearpay. [MAGENTO] refers to the root folder where you have installed your version of Magento.
  2. Follow the installation process above.

Updated about 1 month ago