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

# Accept Payments in Odoo with the Payzah Gateway Module

> Install the Payzah Gateway module for Odoo 17, 18, or 19 to accept KNET, Visa, and Mastercard payments through your Odoo eCommerce or invoicing workflow.

The Payzah Gateway module adds Payzah as a payment provider inside Odoo, covering eCommerce checkout and customer invoice payments. Separate builds are published for each supported Odoo version.

## Download the Module for Your Version

Install the module that matches your Odoo version exactly — modules are not cross-compatible between major versions.

<CardGroup cols={3}>
  <Card title="Odoo 17" icon="cube" href="https://apps.odoo.com/apps/modules/17.0/payzah_gateway">
    Payzah Gateway for Odoo 17.
  </Card>

  <Card title="Odoo 18" icon="cube" href="https://apps.odoo.com/apps/modules/18.0/payzah_gateway">
    Payzah Gateway for Odoo 18.
  </Card>

  <Card title="Odoo 19" icon="cube" href="https://apps.odoo.com/apps/modules/19.0/payzah_gateway">
    Payzah Gateway for Odoo 19.
  </Card>
</CardGroup>

## Before You Start

* A Payzah merchant account — register through the [Payzah app](http://onelink.to/gjt5ed)
* Your Payzah API key from your dashboard
* Administrator access to your Odoo instance
* For self-hosted Odoo, filesystem access to your addons directory

## Installation

<Steps>
  <Step title="Download the module">
    Download the module for your Odoo version from the links above.
  </Step>

  <Step title="Add it to your addons path">
    Extract the module folder into your Odoo addons directory, then restart the Odoo service so it is detected.

    <Note>
      On Odoo Online (SaaS), custom modules cannot be installed directly. Contact Payzah support to discuss options for your setup.
    </Note>
  </Step>

  <Step title="Install from the Apps menu">
    In Odoo, enable developer mode, go to **Apps**, and select **Update Apps List**. Search for *Payzah Gateway* and select **Install**.
  </Step>

  <Step title="Configure the payment provider">
    Go to **Invoicing → Configuration → Payment Providers** (or **Website → Configuration → Payment Providers** for eCommerce) and open **Payzah**.

    * Paste your API key from the Payzah dashboard
    * Set the **State** to *Test mode* while you are setting up
    * Assign the payment journal you want transactions posted to
    * Publish the provider so it appears at checkout

    <Warning>
      Use your test key while in test mode, and switch to your production key only when you set the state to *Enabled*.
    </Warning>
  </Step>

  <Step title="Place a test transaction">
    With the provider in test mode, complete a test checkout or invoice payment using the [sandbox test cards](/docs/guides/test-credentials). Confirm the payment is recorded correctly against the order or invoice in Odoo.
  </Step>

  <Step title="Go live">
    Set the provider state to *Enabled*, replace the test key with your production key, and process one small real transaction to verify. Then work through the [Go-Live Checklist](/docs/guides/go-live-checklist).
  </Step>
</Steps>

## Refunds

Refunds can be issued from your Payzah dashboard, or programmatically through the [Refund API](/docs/guides/refund).

<Note>
  Confirm with Payzah support whether your module version supports issuing refunds directly from the Odoo interface.
</Note>

## Troubleshooting

| Symptom                                      | Fix                                                                                                                |
| -------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ |
| Payzah does not appear in the Apps list      | Enable developer mode and select **Update Apps List**. Confirm the module folder sits directly in your addons path |
| Module installed but not offered at checkout | Confirm the provider is published and its state is set to *Test mode* or *Enabled*, not *Disabled*                 |
| Version incompatibility errors               | Install the build matching your Odoo major version. Odoo 17, 18, and 19 modules are not interchangeable            |
| Authentication errors on payment             | Re-paste the API key with no extra whitespace, and confirm it matches the provider state (test or production)      |
| Payment succeeds but the invoice is unpaid   | Check the payment journal is configured on the provider, then verify the transaction in your Payzah dashboard      |

## Support

Contact [Info@payzah.com](mailto:Info@payzah.com) or call [+965 22410760](tel:+96522410760).