Odoo
Technical manual for MultiSafepay's free plugin.
Prerequisites
- MultiSafepay account
- Odoo 13.0
- Tested on Python 3.6
Installation
💡 Tip! We recommend first installing the plugin in a test environment, following the Odoo installation procedure. Always make a backup.
- Download the ZIP archive with module.
- Unpack the content of the .ZIP file.
- In your Odoo server (
/mnt/extra-addons/
), under Custom apps, add the payment_multisafepay_official folder. - Install the required Python dependencies:
Alternatively, you can install them manually:pip3 install -r requirements.txt
For more information about dependencies, see Python - MultiSafepay .pip3 install multisafepay==0.2.0
- Restart your Odoo server.
- In your Odoo backend, activate developer mode.
- Go to the Apps menu > Update apps list.
- Search for and open the MultiSafepay payments module
payment_multisafepay_official
. - Click Install.
Configuration
-
Sign in to your Odoo backend.
-
Go to the Invoicing or Website menu > Configuration > Payment acquirers.
-
Select MultiSafepay payment acquirer.
-
Go to Edit mode.
-
To change the acquirer state, click Enabled or Test. (Default: Disabled)
-
Enter Live and/or Test API key.
-
On the Configuration tab, set Journal, and then click Save.
-
To get payment methods from your MultiSafepay account, go the Configuration tab, click Pull payment methods.
Make sure the relevant payment methods are activated for your account. -
Configure each payment method separately:
Payment method settings
- Name
- State
- Country: Disabled for some payment methods
- Customer group
- Order amount: Disabled for some payment methods
- Supported currency: Some payment methods process transactions only in EUR. Orders not created in EUR are converted to the required currency, using Odoo platform currency rate. This can only be configured by a system administrator.
User guide
Generic gateways
The plugin supports generic gateways, which allows you to add a payment method manually. This is particularly useful for integrating gift cards specific to your business.
Supported since release: 1.1.0, July 2nd 2021.
How to configure generic gateways
- Sign in to your Odoo backend.
- Go to Invoicing > Payment method > Other payment acquirer > MultiSafepay.
- In the Title field, set the relevant payment method gateway IDs.
- Set the gateway logo and name.
Orders
How to create orders
- Select the payment method on the checkout page, and then click Pay now.
- Provide any required information (e.g. bank account number), and confirm payment.
- When the transaction is completed, you receive a Order { order ID } Confirmed webhook notification .
How to ship orders
- Go to the Website menu> Orders, and then select the relevant order.
- To mark the order as Shipped, go to Delivery and Validate transfer.
The transaction status changes to Shipped. - Under Order details, you can create an invoice. Its status is Paid right away because the order was prepaid.
- If you want to update the invoice ID of the transaction with MultiSafepay, go to Configuration > Payment transactions, select the relevant transaction, and then click Update invoice ID.
Payment methods
Refunds
How to refund orders
In your Odoo backend, you can only refund Completed orders.
- To create a refund invoice, go to Order invoices, and then click Add credit note.
- Enter a Refund reason and check the invoice lines you want to return, and then click Post.
- To create a refund request, click Refund with MultiSafepay.
- If the request is created successfully, the invoice status changes.
- When the status of the MultiSafepay refund transaction changes to Completed, the status of the refund invoice changes to Paid.
How to refund BNPL orders
For BNPL orders, the refund request must include a shopping_cart
object where:
- The
item_quantity
must not be more thanquantity
in the original order. - The
item_price
must be equal to theunit_price
in the original order.
⚠️ Note: You cannot refund BNPL orders if a gift card or promo code was used for the original order.
Updates
You can update in your backend.
How to update the plugin
- Sign in to your Odoo backend.
- Go to the Apps menu.
- Search for and open the MultiSafepay payments module.
- Click Upgrade.
Support
Contact MultiSafepay:
- Telephone: +31 (0)20 8500 500
- Email: [email protected]
- GitHub: create a technical issue
Updated 2 months ago