Download the Module for Your Version
Install the module that matches your Odoo version exactly — modules are not cross-compatible between major versions.Odoo 17
Payzah Gateway for Odoo 17.
Odoo 18
Payzah Gateway for Odoo 18.
Odoo 19
Payzah Gateway for Odoo 19.
Before You Start
- A Payzah merchant account — register through the Payzah app
- Your Payzah API key from your dashboard
- Administrator access to your Odoo instance
- For self-hosted Odoo, filesystem access to your addons directory
Installation
1
Download the module
Download the module for your Odoo version from the links above.
2
Add it to your addons path
Extract the module folder into your Odoo addons directory, then restart the Odoo service so it is detected.
On Odoo Online (SaaS), custom modules cannot be installed directly. Contact Payzah support to discuss options for your setup.
3
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.
4
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
5
Place a test transaction
With the provider in test mode, complete a test checkout or invoice payment using the sandbox test cards. Confirm the payment is recorded correctly against the order or invoice in Odoo.
6
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.
Refunds
Refunds can be issued from your Payzah dashboard, or programmatically through the Refund API.Confirm with Payzah support whether your module version supports issuing refunds directly from the Odoo interface.