SolutionsSystem status
Documentation
Create accountContact
Start typing to search…

Odoo

Technical manual for MultiSafepay's free plugin.

⚠️

Note:

The MultiSafepay Odoo plugin is currently in the pilot phase. Features may change. We recommend testing thoroughly in a staging environment before using it in live production setup.

Prerequisites

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

Installation

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

pip install multisafepay

The module can be installed in two ways:

Manual Installation from the Odoo Interface

  1. Download the latest version of the module.
  2. Sign in to your Odoo backend as Administrator.
  3. Go to Apps > Update Apps List. Click Update.
  4. Go to Import module and upload the ZIP file (payment_multisafepay_official.zip).
  5. In the Apps list, search for MultiSafepay.
  6. Click Install.
  7. Go to Apps > MultiSafepay and click Activate.

Server Installation

This installation method is intended for administrators with access to the server where Odoo is running. Unlike the manual upload through the backend, 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
  2. Copy the module into the custom_addons directory: 
    cd /path/to/custom_addons
cp -r /path/to/payment_multisafepay_official .
  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. Go to Apps > MultiSafepay and click Activate.

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.

Checkout page
  1. After selecting an item, click View cart > Checkout.
  2. Enter an existing address or provide a new one. You can configure delivery and billing addresses individually.
  3. Click Confirm.
  4. At the checkout page, select the payment method and click Pay now.
  5. Provide any required information (e.g. bank account number), and confirm payment.
  6. When the transaction is completed, Odoo will receive an Order Confirmed webhook notification and will confirm the order.
  7. You can find your orders confirmed under Website > eCommerce > Orders.
Create an invoice
  1. Sign in to your Odoo backend.
  2. Go to Invoicing > Customer > Invoices
  3. Click New.
  4. Fill the required fields:
  • Select an existing customer or create a new one under Customer > Search More > New.
  • Enter an existing Delivery Address or create a new one.
  • Select the item under Invoice Lines.
  1. Click Send to email the invoice to the customer.
  • The customer can open the invoice from the email and click the Pay Now button if the invoice is unpaid.
  • Alternatively, as an administrator you can generate a Payment Link from the invoice, copy it, and send it manually to the customer.

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 each payment method, their minimum and maximum amounts and supported currencies.

Updates

Before updating:

  • Create a backup of your database, especially before an update.
  • Always download the latest Odoo version from our official MultiSafepay repository.
  • Replace old module files with the updated files.
How to update your plugin
  1. Update the required Python dependencies by entering the following command
cd payment_multisafepay_official/
pip install -r requirements.txt --upgrade
  1. Restart Odoo
  2. Upgrade your Odoo module by going to Apps > MultiSafepay Official > Upgrade.
    You can also upgrade the module via the following command line:
odoo-bin -u payment_multisafepay_official -d your_database_name

💬

Support

Contact MultiSafepay:

Updated about 8 hours ago