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

# Odoo Plugin Installation

> Install the Tabby module on Odoo, configure your API keys, and take the integration live.

<Note>
  Tabby works on the Odoo platform for all supported countries. Odoo versions 17, 18, and 19 are supported.
</Note>

<Warning>
  The Tabby module can be installed on self-hosted (on-premise) Odoo and Odoo.sh. Odoo Online (SaaS) does not support the installation of custom modules.
</Warning>

## Installation Steps

<Steps>
  <Step
    stepNumber={1}
    title={(
  <span>
    <a href="https://merchant.tabby.ai/">
      Register with Tabby
    </a>
    <span style={{ fontWeight: 'normal', fontSize: '0.9em' }}>
      &nbsp;(KSA: <a href="https://merchant.tabby.sa/">merchant.tabby.sa</a>)
    </span>
    <span style={{ fontWeight: 'normal' }}>
      &nbsp;and fill all required business details
    </span>
  </span>
)}
  />

  <Step
    stepNumber={2}
    title={(
  <span style={{ fontWeight: 'normal' }}>
    Receive test API keys from your Tabby account manager
  </span>
)}
  />

  <Step
    stepNumber={3}
    title={(
  <span>
    <a href="/e-commerce-platforms/odoo/odoo-plugin-installation#download-the-tabby-module">
      Download the Tabby module
    </a>
    <span style={{ fontWeight: 'normal' }}>
      &nbsp;matching your Odoo version
    </span>
  </span>
)}
  />

  <Step
    stepNumber={4}
    title={(
  <span>
    <a href="/e-commerce-platforms/odoo/odoo-plugin-installation#install-the-odoo-module">
      Install the module
    </a>
    <span style={{ fontWeight: 'normal' }}>
      &nbsp;and&nbsp;
    </span>
    <a href="/e-commerce-platforms/odoo/odoo-plugin-installation#configure-tabby-as-a-payment-method">
      configure Tabby as a payment method
    </a>
  </span>
)}
  />

  <Step
    stepNumber={5}
    title={(
  <span>
    <a href="/e-commerce-platforms/odoo/odoo-plugin-installation#test-your-integration">
      Test your integration
    </a>
  </span>
)}
  />

  <Step
    stepNumber={6}
    title={(
  <span>
    <span style={{ fontWeight: 'normal' }}>
      Receive live API keys and&nbsp;
    </span>
    <a href="/e-commerce-platforms/odoo/odoo-plugin-installation#connect-to-the-live-tabby-environment">
      deploy to production
    </a>
  </span>
)}
  />
</Steps>

### Download the Tabby Module

Tabby provides a separate module build for each supported Odoo version. Download the archive matching the major version of your Odoo installation:

| Odoo version | Module download                                                                        |
| ------------ | -------------------------------------------------------------------------------------- |
| Odoo 19      | <a href="https://storage.googleapis.com/plgns/odoo19-latest.zip">odoo19-latest.zip</a> |
| Odoo 18      | <a href="https://storage.googleapis.com/plgns/odoo18-latest.zip">odoo18-latest.zip</a> |
| Odoo 17      | <a href="https://storage.googleapis.com/plgns/odoo17-latest.zip">odoo17-latest.zip</a> |

Each archive contains the `payment_tabby` module folder — this folder is the unit of installation.

### Install the Odoo Module

1. Extract the downloaded archive and locate the `payment_tabby` module folder inside it
2. Copy the `payment_tabby` folder into your Odoo addons directory — any directory listed in the `addons_path` parameter of your `odoo.conf` (commonly a `custom_addons` folder). Make sure the copied files are readable by the user running the Odoo service
3. Restart the Odoo service
4. Activate the developer mode: go to ***Settings -> General Settings***, scroll down to **Developer Tools** and click **Activate the developer mode**
5. Go to ***Apps*** and click ***Update Apps List*** in the top menu, then confirm the update
6. In the Apps search bar remove the default filters, search for **Tabby** and click **Activate** on the "Payment Provider: Tabby" module

<Note>
  **Odoo.sh:** instead of copying files to the server, add the `payment_tabby` folder to your Odoo.sh project's GitHub repository and deploy the branch — the module then appears in the Apps list after **Update Apps List**.
</Note>

#### Optional: Updating the Odoo Module

When a new version of the Tabby module is released:

1. Download the latest archive for your Odoo version and replace the existing `payment_tabby` folder in your addons directory with the new one
2. Restart the Odoo service
3. Go to ***Apps***, remove the default filters, find the **Tabby** module and click ***Upgrade*** from the module's menu

### Configure Tabby as a Payment Method

1. Go to ***Website -> Configuration -> Payment Providers*** (the same screen is also available via ***Invoicing -> Configuration -> Payment Providers*** and ***Sales -> Configuration -> Payment Providers***)
2. Open **Tabby** in the list of providers
3. In the **Credentials** tab, enter the **Tabby Public Key** and **Tabby Secret Key** you received from your account manager
4. Set the **State** to **Enabled**
5. Click **Save**

Once the provider is enabled, it is automatically published on your website and Tabby appears among the payment methods on Checkout.

<Note>
  Tabby requires the order currency to match the customer's country: UAE-AED, KSA-SAR, Kuwait-KWD. Make sure the currency of your website/pricelist is set accordingly — Tabby will not be displayed on Checkout for unsupported currencies.
</Note>

### Test Your Integration

After completing your integration, make an order and refund it to ensure that everything works as expected.

**Coordinate Testing with Tabby**

Before deploying Tabby integration to your production site, Tabby needs to validate the correctness of the integration. Contact your account manager to coordinate this test.

### Connect to the Live Tabby Environment

1. Get your Public and Secret keys for the live environment. Ask your account manager to share the keys
2. Set your live keys in the Odoo admin panel: go to ***Website -> Configuration -> Payment Providers -> Tabby***, open the **Credentials** tab and replace the test keys
3. **Launch to Production**<br />
   After you've connected to the live environment and we've tested your integration, you're ready to offer Tabby payment methods to your customers.

### Feedback and Support

If you face any issues during installation or testing, don't hesitate to get in touch with `partner@tabby.ai` / `partner@tabby.sa` with the store link, issue description, and screenshots or screencasts of the observed behaviour.