Prerequisites

• MultiSafepay account
• Odoo 18.0, Odoo 19.0 or Odoo 20.0
• Python 3.9+ (tested on 3.12)
• Administrator privileges on your Odoo instance

Installation

It includes:

• payment_multisafepay_official: Core MultiSafepay payment provider integration.
• payment_multisafepay_enhanced: Optional enhanced business logic on top of the core addon.

Download a release that matches your Odoo version:

• Odoo 18.0: 18.0.x.x.x
• Odoo 19.0: 19.0.x.x.x
• Odoo 20.0: 20.0.x.x.x

Each release contains a single ZIP bundle (e.g. multisafepay_<version>.zip) that includes the full multi-module suite under a multisafepay/ folder.

Before installing the modules, make sure all their Python dependencies are installed in the same Python environment used by your Odoo instance:

cd multisafepay/
pip install -r requirements.txt

The modules can be installed in two ways:

Installation on a Self-Hosted or Docker Odoo Instance

This method applies to administrators with direct access to the Odoo server. In this case, the module must be deployed directly on the server. You can use an existing custom addons directory, or create a new one.

1. Edit the configuration file (odoo.conf). Add (or update) the addons_path entry to include the directory where the module is located:

       # In your odoo.conf file
       addons_path = /path/to/odoo/addons,/path/to/custom_addons/multisafepay

Odoo only scans direct children of each addons_path entry. Make sure the addons_path points to the folder that directly contains payment_multisafepay_official/ (and optionally payment_multisafepay_enhanced/).

2. Download the ZIP bundle from our releases, extract it, and copy the multisafepay/ folder into your custom addons directory:

     # Example
       unzip multisafepay_<version>.zip
       cd /path/to/custom_addons
       cp -r /path/to/extracted/multisafepay ./

3. Restart your Odoo server:

   • Docker: docker compose restart odoo
   • Systemd: sudo systemctl restart odoo

4. Sign in to your Odoo backend as Administrator and go to Apps > Update Apps List.

5. Search for MultiSafepay in the Apps list.

6. Click Install.

7. (Optional) Install MultiSafepay Enhanced if you need the additional business logic.

8. Go to Apps > MultiSafepay and click Activate.

9. Go to Invoicing > Payment Providers to activate and configure MultiSafepay.

Installation on Odoo.sh

1. In your Odoo.sh project, open the Git repository connected to your instance.
2. Clone the repository locally:

    git clone <your-odoo-sh-repository-url>
    cd <your-odoo-sh-project>

3. Add the official MultiSafepay Odoo connector as a Git submodule inside your addons folder:

    git submodule add https://github.com/MultiSafepay/odoo.git <your-addons-directory>/multisafepay

Ensure your addons_path includes <your-addons-directory>/multisafepay (Odoo only scans direct children of each addons_path entry).
4. Commit and push your changes:

 git add .
 git commit -m "Add MultiSafepay module"
 git push origin main

5. Odoo.sh will automatically build and deploy your changes.
6. Sign in to your Odoo backend as Administrator and go to Apps > Update Apps List.
7. Go to Apps > MultiSafepay and click Activate.
8. Go to Invoicing > Payment Providers to activate and configure MultiSafepay.

Configuration

1. Sign in to your Odoo backend.
2. Go to Invoicing > Configuration > Payment Providers.
3. Click MultiSafepay.
4. Under State, select Test Mode and enter your test API Key.
5. Save your changes.
6. Go to Configuration and click Pull Payment Methods to synchronize and activate all available payment methods from your MultiSafepay account.
7. Run a test transaction to confirm the integration is working.
8. When ready, change State to Enabled to switch to Live Mode and enter your live API Key.
9. Verify that your payment method settings remain intact after switching.
10. Set the provider to Published so it becomes available at checkout.

User guide

Orders

Your customers can place orders through the checkout page, and administrators can also create invoices directly from the Odoo backend.

Refunds

In Odoo, you can process full and partial refunds. Orders that have been shipped cannot be refunded unless returned. To process a refund for an order:

1. Sign in to your Odoo backend.
2. Go to Website > eCommerce > Orders.
3. Click the relevant order you want to refund.
4. On the order page, go to Invoices > Payments.
5. Click Refund. Enter the maximum allowed amount for a full refund or modify it to process a partial refund.
6. Click Refund.

Payment methods

By default, any payment method you activate in your MultiSafepay account will be available for your backend. Newly activated payment methods must be enabled manually in your backend settings.

To configure your payment methods:

1. Sign in to your Odoo backend.
2. Go to Invoicing > Configuration > Payment Providers.
3. To enable or disable payment methods individually, click Enable Payment Methods. Here, you can inspect payment methods, their minimum and maximum amounts and supported currencies.

Updates

Before updating, back up the Odoo database and test the new version in staging.

If you are using self-hosted or Docker Odoo:

1. Replace the existing addon files with the files from the new version.

2. Update the Python dependencies:

   Bash

   pip install 'multisafepay==3.1.0' requests --upgrade

3. Restart Odoo.

4. Upgrade the addon from Apps, or run:

   Bash

     odoo-bin -u payment_multisafepay_official -d your_database_name
     # Optional (only if installed)
     odoo-bin -u payment_multisafepay_enhanced -d your_database_name

5. Run a payment, cancellation, and refund test.

If you are using Odoo.sh:

1. Update the MultiSafepay Odoo module in your Odoo.sh project by pulling or merging the latest version of the MultiSafepay repository into your project.

2. Upgrade the addon from Apps, or run:

   Bash

     odoo-bin -u payment_multisafepay_official -d your_database_name
     # Optional (only if installed)
     odoo-bin -u payment_multisafepay_enhanced -d your_database_name

3. Run a payment, cancellation, and refund test.

Upgrading from previous versions

With the release of versions 18.0.3.0.0 and 19.0.3.0.0, the MultiSafepay module has been renamed from payment_multisafepay to payment_multisafepay_official.

If you're upgrading to either of these versions, follow one of the migration methods below:

• Seamless UI migration (recommended) - Complete the migration through the Odoo web interface without using the command line.
• Command Line (CLI) migration - Complete the migration using CLI commands. Suitable for developers and administrators managing self-hosted, Docker, or Odoo.sh deployments.

Seamless UI migration

Thanks to the automated pre-installation migration hook (pre_init_hook), the existing module data is migrated automatically. Upgrading to payment_multisafepay_official can be completed entirely through the standard Odoo web interface. To complete the migration, follow these steps:

1. Update the module files:
   Ensure the new payment_multisafepay_official directory is placed in your Odoo custom addons folder and restart your Odoo service.

2. Update the apps list:

   • Sign in to Odoo as an Administrator.
   • Navigate to the Apps menu.
   • Click Update Apps List in the top navigation bar (enable Developer mode if this button is not visible) and confirm.

3. Install the new module:

   • In the Apps search bar, search for MultiSafepay Official (or payment_multisafepay_official).
   • Click the Install button.

     ✅

     The built-in pre_init_hook runs during installation, remaps all existing XML IDs, provider credentials, payment methods, and historical transaction logs to payment_multisafepay_official, and removes obsolete module pointers.

Command-line (CLI) migration

An automated migration hook (pre_init_hook) transfers all credentials, payment methods, and transaction history to the new module automatically.

Follow the instructions for your hosting environment:

• On-premises, self-hosted, or Docker: Install the new module using the Odoo CLI.
• Odoo.sh: Deploy the updated module through your Git repository, then install it through the Odoo web interface or CLI.

On-premise / self-hosted / Docker

Replace the old module folder with payment_multisafepay_official in your custom addons path, restart the Odoo service, and run:

# IMPORTANT: Use '-i' (install), NOT '-u' (upgrade)
odoo-bin -i payment_multisafepay_official -d your_database_name

# If using payment_multisafepay_enhanced:
odoo-bin -i payment_multisafepay_official -u payment_multisafepay_enhanced -d your_database_name

Odoo.sh

1. Update repository / submodule:
   Update the MultiSafepay submodule or repository to the latest branch/tag, commit, and push to your Odoo.sh branch:

   Bash

   git submodule update --remote <path_to_submodule>/multisafepay
   git add .
   git commit -m "Update MultiSafepay to payment_multisafepay_official"
   git push origin main

2. Deploy & install via Web UI:
   Once the Odoo.sh build finishes, log into the backend.

   • Go to Apps > Update Apps List.
   • Search for MultiSafepay Official and click Install.
     Alternatively, run the following command via the Odoo.sh Web Shell / CLI tab:
   Bash

   odoo-bin -i payment_multisafepay_official -d your_database_name

Odoo POS

Odoo POS is a ready-made integration that allows you to connect a SmartPOS device to your Odoo backend and process payments with cloud mode. It supports both SmartPOS devices, enabling you to accept payments directly from your Odoo POS system.

Odoo POS

Connect a SmartPOS device to your Odoo backend and process payments with cloud mode

💬

Support

Contact MultiSafepay:

• Email: [email protected]
• GitHub: Create a technical issue