> ## Documentation Index
> Fetch the complete documentation index at: https://docs.rc.cleverhub.co/llms.txt
> Use this file to discover all available pages before exploring further.

# Add Hello Clever to Magento

> Download, install, and configure the Hello Clever payment gateway extension for Magento 2 stores to accept PayID, PayTo, and cashback-enabled payments.

This page explains how to add and configure the Hello Clever payment gateway for your Magento 2 store. You will download the extension, install it via FTP or the command line, flush the cache, and configure your API credentials in Magento Admin.

## Requirements

<Info>
  Hello Clever is currently available for Magento merchants with store addresses in **Australia**. Only **AUD (Australian Dollars)** is supported at this time.
</Info>

* **Magento version**: 2.20 or greater.
* **Store currency**: AUD. The plugin requires a dedicated website scope for each market region (country), with the corresponding base currency set in Magento Admin.

To set your store’s base currency to AUD:

1. Navigate to **Stores > Configuration > Currency Setup**.
2. Set the currency to **AUD (Australian Dollars)**.

***

## Installation

### Step 1: Download the extension

1. Download the Hello Clever Magento extension from the [Magento Extension Download](https://helloclever.co/plugins/magento/VERSION/1.0.3/app.zip) page.
2. Once downloaded, you will have the extension files ready to upload to your server.

### Step 2: Install the extension

You can install the extension using either FTP or the command line.

<Tabs>
  <Tab title="Method 1: FTP">
    <Steps>
      <Step title="Upload via FTP">
        Use an FTP client such as FileZilla to upload the module to the `app/code/Clever` directory on your Magento server.
      </Step>

      <Step title="Verify the folder structure">
        Ensure the uploaded directory structure matches the required layout before proceeding.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Method 2: Command line">
    <Steps>
      <Step title="Compress the extension">
        Compress the extension files into `.zip` or `.tar.gz` format.
      </Step>

      <Step title="Copy to your server">
        Transfer the archive to the `app/code/Clever` directory on your server using `scp`:

        ```bash theme={null}
        scp <path_to_your_extension> <ssh_server>:<path_to_clever_directory>
        ```
      </Step>

      <Step title="Decompress the archive">
        Log in to your SSH server, navigate to the Clever directory, and decompress the archive:

        ```bash theme={null}
        unzip <compressed_extension.zip>
        # or for .tar.gz:
        tar -xzvf <compressed_extension.tar.gz>
        ```
      </Step>

      <Step title="Run Magento setup commands">
        Navigate to your Magento root directory (for example, `magento2`) and run the following commands:

        ```bash theme={null}
        sudo php bin/magento setup:upgrade
        sudo php bin/magento setup:di:compile
        sudo php bin/magento setup:static-content:deploy
        ```
      </Step>
    </Steps>
  </Tab>
</Tabs>

### Step 3: Flush the Magento cache

<Steps>
  <Step title="Open Cache Management">
    Log in to Magento Admin and navigate to **System > Cache Management**.
  </Step>

  <Step title="Flush the cache">
    Click **Flush Cache Storage** to clear all cached data.
  </Step>
</Steps>

***

## Configure the extension

<Steps>
  <Step title="Open the Hello Clever settings">
    In Magento Admin, navigate to **Stores > Configuration > Sales > Payment Methods > Hello Clever**.
  </Step>

  <Step title="Enable the plugin">
    Set the **Enabled** field to **Yes**.
  </Step>

  <Step title="Configure your credentials and environment">
    Fill in the following fields:

    * **API Environment**: select `Sandbox` for testing or `Production` for live transactions.
    * **App ID**: copy from your Hello Clever Merchant Dashboard.
    * **Secret Key**: copy from your Hello Clever Merchant Dashboard.
    * **Description**: customise the payment method description shown to customers at checkout.
  </Step>

  <Step title="Test the connection">
    Click **Test Connection** to verify that your credentials are correct and the connection is working.
  </Step>

  <Step title="Save the configuration">
    Click **Save Config** to finalise your settings.
  </Step>
</Steps>

***

## Update the extension

To update to a newer version of the Hello Clever extension, you must remove the old files and reinstall.

<Steps>
  <Step title="Remove old files">
    Delete all files in `root/app/code/Clever`.
  </Step>

  <Step title="Install the latest version">
    Follow the [installation steps](#installation) above to upload and configure the updated extension.
  </Step>

  <Step title="Flush the cache">
    In Magento Admin, navigate to **System > Cache Management** and click **Flush Cache Storage**.
  </Step>
</Steps>


## Related topics

- [Add Hello Clever to Shopline](/integrations/shopline.md)
- [Add Hello Clever to Shopify](/integrations/shopify.md)
- [Add Hello Clever to Xero](/integrations/xero.md)