Odoo

Integrate Hesabe Payment Gateway with your Odoo application. Comprehensive business management software with powerful payment processing capabilities.

Important : Before utilizing this module, ensure you have

  • Installed the pycryptodome Python library for encryption purposes
  • Odoo Payment and eCommerce modules installed and configured
  • All accounting settings properly configured
  • Important: Restart your Odoo server after major configuration changes

Compatibility

Accept KNET, Visa, Mastercard, and American Express through Hesabe wherever Odoo accepts payments from eCommerce checkout and portal invoices to invoices collected via SMS payment links

Odoo 19.0 · Supports Odoo.sh and On-Premise deployments. Not supported on Odoo Online, as it does not allow third-party modules. KWD-only transactions are supported.

Installation

Download Plugin

Get the Odoo 19 module from its GitHub repository:

Payment TypesPayment MethodInvoicesPlugin Link
Odoo v19InDirectYesClick here

Install the SDK

The module talks to Hesabe through the hesabe-python SDK:

pip install --no-deps https://github.com/ruptyx/hesabe-python/archive/refs/tags/v1.3.0.tar.gz

--no-deps is required

The SDK needs cryptography and requests, which Odoo already ships. Skipping --no-deps lets pip upgrade cryptography inside the Odoo environment.

On Odoo.sh, commit the module's requirements.txt to your project root instead — Odoo.sh installs it on build.

Add and Activate the Module

Copy the payment_hesabe folder into your addons path (not Odoo's core addons directory, which is overwritten on upgrade), then restart Odoo.

Enable developer mode, go to Apps → Update Apps List, search for payment_hesabe, and click Activate.

Update Apps ListFind and activate the module in Apps

Configure Payment Provider Credentials

Go to Invoicing → Configuration → Payment Providers and open Hesabe.

Payment Providers list

Copy all credentials from merchant panel (Merchant ID, Access Code, Secret Key and IV Key) from Profile → Account section and configure them in your application.

Sandbox Access Keys

Below configuration for sandbox testing only. Never use these sandbox configurations in production environment.

Sandbox ParameterSandbox Value
Merchant Code
842217
Access Code
c333729b-d060-4b74-a49d-7686a8353481
Secret Key
PkW64zMe5NVdrlPVNnjo2Jy9nOb7v1Xg
IV Key
5NVdrlPVNnjo2Jy9

Production Access Keys

  • Copy all credentials from production merchant panel (Merchant ID, Access Code, Secret Key and IV Key) from Profile → Account section and configure them in your application.
EnvironmentMerchant Panel URL
Production
https://merchant.hesabe.com/merchant
  • Else, obtain the production keys from Hesabe merchant support team using your registered email address.
Hesabe Support Team:support@hesabe.com
Credentials tab

Set State to Test Mode for sandbox or Enabled for production, then tick Published

Published follows State

Choosing Enabled ticks Published automatically; choosing Test Mode unticks it. If Hesabe is missing at checkout during sandbox testing, check Published first.

Credential fields are visible only to system administrators — whoever onboards a merchant needs Settings access, not just Accounting.

Configure Payment Methods

KNET and Card activate automatically once the provider leaves Disabled — no separate step needed.

Payment methods
MethodBehavior
KNETSends the customer straight to the bank's payment page
CardOpens Hesabe's hosted page for Visa, Mastercard, Amex and wallets
HesabeShips inactive; activate it (and deactivate KNET/Card) for a single option that always opens Hesabe's hosted picker — useful for rails Odoo has no method for, like Deema or Google Pay

Invoice Payment Links

Fill in Merchant Panel Username and Merchant Panel Password (your Hesabe panel login, not more gateway keys) to let invoices collect payment by SMS link.

Leave this empty and the provider still works as a plain checkout gateway — the SMS option is simply absent from the invoice Send dialog.

Enable "Send Payment Link on Invoice Confirmation" to have Odoo text the link automatically the moment a qualifying invoice is confirmed.

Using Hesabe in Odoo

Paying an Invoice

Confirm a customer invoice in Invoicing → Customers → Invoices, then Send or Preview it.

The customer gets a Pay Now button — KNET goes straight to the bank's page, Card opens Hesabe's hosted page.

Once paid, the invoice is marked Paid and reconciled automatically.

With the merchant-panel login configured, the invoice Send dialog gains a pre-ticked "Hesabe payment link (SMS)" checkbox.

Hesabe sends the SMS itself, in the customer's language, and the customer pays on Hesabe's hosted page.

Sending a payment link by SMS
RuleDetail
Phone formatInternational form (+965) required — otherwise the send goes ahead by email only
Validity windowPayable until the invoice due date (one-week minimum) — only unpaid KWD invoices qualify
Re-sendingUpdates the same link rather than creating a duplicate
Amount range0.300–15,001 KWD

eCommerce Checkout

Hesabe appears at checkout for any KWD order. With Website → Configuration → Settings → Invoicing → Automatic Invoice enabled, a paid order raises, posts, and reconciles its invoice with no manual step.

Payment Confirmation

Every inbound notification is verified, not trusted: Odoo re-reads the transaction from Hesabe's API and checks the confirmed amount before recording payment.

A scheduled job re-checks anything unfinished every 15 minutes (widening to daily over four days for abandoned checkouts), so a dropped webhook never leaves a paid order looking unpaid.

Troubleshooting

SymptomCause
Hesabe missing at checkoutOrder isn't in KWD, or the provider isn't Published (Test Mode unticks it)
Credential fields not visibleUser lacks Settings access — credentials are restricted to system administrators
Payments not reconcilingBank journal has no inbound payment method line, or the scheduled job is inactive
No SMS checkbox on SendMerchant Panel credentials aren't set, provider is disabled, invoice isn't KWD, or it's already paid
SMS never arrivesCustomer's phone number doesn't parse into +965… form
Link paid but invoice still openConfirmation arrives via webhook or the scheduled job — check web.base.url is reachable from the internet

Need Help?

Contact Hesabe Technical Support:itsupport@hesabe.com

Download Plugin

Download the appropriate plugin according to your Odoo version and payment type:

Payment TypesPayment MethodPlugin Link
Odoo v18 (Latest)IndirectClick here
Odoo v17IndirectClick here

Extract and Copy Plugin

After downloading, extract the plugin and copy the hesabepayment folder to your Odoo installation path: server\odoo\addons directory.

Install Module

Go to Apps → Search payment_hesabe module → Click Install module

Search Module

Activate Payment Provider

You need to activate Hesabe Payment Provider from Website → Configuration → Payment Providers

Activate Payment Method

You need to activate Hesabe Payment Method from Website → Configuration → Payment Methods

Payment Method

Configure Credentials

Configure the credential information which consists of Merchant Code, Access Code, Working Key, IV Key and API Version.

Make sure you use correct credentials for Test and Production

Provider Settings

Download Plugin

Download the appropriate plugin according to your Odoo version and payment type:

Payment TypesDownload Link
KNET v16Click here
Visa/Master v16Click here
KNET v15Click here
Visa/Master v15Click here
KNET v14Click here

Upload to Addons Folder

Upload it to the path odoo/addons folder of your Odoo application.

Install Module

Go to Apps → Search payment_hesabe module → Click Install module

Install Module

Configure Payment Acquirers

Go to Website → Configuration → eCommerce → Payment Acquirers → Search Hesabe.

Select the Hesabe payment method by clicking into the card to configure credential information.

Payment Acquirers

Select Payment Method

Select the Hesabe payment method by clicking into the card and you will see the following screen.

Select any of the payment options:

Payment Method Selection

Configure Credentials

Configure the credential information which consists of Merchant Code, Access Code, Working Key, IV Key and API Version.

Make sure you use correct credentials for Test and Production:

Credentials Configuration

Install Chart of Accounts

You need to install at least one Chart of Account of your country.

For Example: Go to Apps → Search l10n_ → Install chart of account of your country: