Magento 2 Installation Guide

These instructions will guide you through installing ClearSale’s extension for your Magento 2 store. You will need admin access to your Magento project directory (SSH access)

If you need any help installing this module, please contact us at


First Step - Install the Module Utilizing Composer

  • Before installing, we advise you to:
  • Backup your database
  • Enable maintenance mode

To install using composer you must:

  1. Get ClearSale from the Magento Marketplace (add it to your purchased modules)
  2. Retrieve the extension’s Composer name and version
  3. Retrieve your authentication keys
  4. Update the composer.json file
  5. Confirm the installation
  6. Enable the extension

Second Step - Get ClearSale from the Magento Marketplace

  1. Search for ClearSale’s Magento 2 module in the Magento Marketplace.
  2. Add it to your account.



Third Step - Retrieving the Extension’s Composer Name & Version

  1. Log into Magento Marketplace
  2. Go to your profile and in the upper-right corner, click on Your Name > My Profile
  3. Click on My Purchases
  4. Under the ClearSale’s extension, click on Technical Details
  5. Copy and save the Component Name and Component Version



Fourth Step - Retrieving Authentication Keys

  1. Go to your profile and in the upper-right corner, click on Your Name > My Profile
  2. Click on Access Keys under the Marketplace tab.
  3. If you don’t have any keys yet, you can click on Create a New Access Key to create new keys for development. Otherwise, copy and save the access keys.



Fifth Step - Updating the composer.json File

This section requires SSH access to your Magento 2.x installation directory. (For details, contact your hosting provider or system administrator)

  1. Navigate to your Magento project directory and update the composer.json file to require ClearSale. (Run the command below)

    $ composer require <component-name>:<version>

    For example,

    $ composer require clearsale/integration:2.9.7

  2. Enter the authentication keys. The public key will be the username and the private key will be the password.
  1. Wait for Composer to complete the task and confirm that no errors were encountered.

Sixth Step - Verify the Extension

  1. To verify the extension was installed properly, run the command below.

    $ bin/magento module:status

  2. If the extension does not appear, try to recompile your Magento project.

    $ bin/magento setup:upgrade
    $ bin/magento setup:di:compile
    $ bin/magento cache:clean

NOTE: After installing the module, remember to disable maintenance mode if it was previously enabled.


Seventh Step - Verify the Extension

  1. Once the ClearSale extension is installed, you can configure its settings. The settings can be found in your installed apps.

    To fully configure ClearSale, you must have already received your integration credentials.

  2. Set the Enabled field to Yes.

  3. Insert your ClearSale credentials (API Key, Client ID, and Client Secret).

  4. If you would like to test the module before sending real orders, you can set the Environment field to Sandbox. Otherwise, you can set it to Production.

  5. Set the Analysis Location to USA.

  6. In the Payment Methods to Send section, please select the payment method(s) you would like to have analyzed by ClearSale.

  7. Select the desired order status for each ClearSale stage or response:

    A-Analyzing ClearSaleClearSale is analyzing this order.
    B-Approved ClearSaleClearSale approved this order.
    C-Denied ClearSaleClearSale was unable to establish contact and/or received an invalid document. These orders should not be fulfilled.
    D-Canceled ClearSale – ClearSale found suspicion for fraud and the order should not be fulfilled. This status can also reflect the merchant manually cancelling the order.

  8. If you would like the ClearSale module to keep a log for future troubleshooting, please set Enable Transaction Log to Yes. The log files can be found in your Magento project’s directory in /var/log


Customer Service – For questions related to order analysis and requests.

Technical Support – For general technical inquiries regarding the extension / functions.

Integration Support – For questions related to the initial setup and use of the extension.



ClearSale Reviews


Excellent service - both timeliness and fraud control

"I have always received immediate response and minimal fraud rejection -- which leads to increased sales."



They are great!

"The competitive rates, their quick response to customer service"

Daniel Esteban C


From the viewpoint of someone who has been the victim of credit card fraud

"We are in the Durable Medical Equipment supply industry and we use Shopify as our shopping cart. With Covid 19 we have seen a tremendous increase web traffic and online purchases. Prior to Covid 19 we had a number of fraudulent transactions that led to multiple investigations on Local, State and Federal levels all of which produced no returns only because the crooks were faster. This cost us in..."



Great fraud prevention for ecommerce sites

"ClearSale has a great fraud protection program using their algorithmic matching of potentially fake orders, and will scan them as they come up and reject them if they are suspected as fraud."

Lee K.


Ready to
Get Started?

Let’s Talk!

Find out how to prevent chargebacks AND sell more.
Talk with a ClearSale CNP fraud expert today!