Online payments

# Online payments

Odoo embeds several payment providers that allow your customers to pay online, on their customer portals , or on your eCommerce website . They can pay sales orders, invoices, or
subscriptions with recurring payments using their favorite payment methods, such as credit cards .
Each payment provider is linked to a list of supported payment methods that can be (de)activated based on your needs.
Odoo apps delegate the handling of sensitive information to the certified payment provider so
that you donât ever have to worry about PCI compliance. No sensitive information (such as credit
card numbers) is stored on Odoo servers or Odoo databases hosted elsewhere. Instead, Odoo apps
use a unique reference number for the data stored safely in the payment providersâ systems.

## Supported payment providers

To access the supported payment providers, go to Accounting â£ Configuration â£
Payment Providers , Website â£ Configuration â£ Payment Providers , or Sales â£ Configuration â£ Payment Providers .

### Online payment providers

Amazon Payment Services
The providerâs website
The providerâs website
The providerâs website
The providerâs website
The providerâs website
The providerâs website
The providerâs website
The providerâs website
Odoo or the providerâs website
Refer to the Xendit documentation for more information.
- Each provider has its own specific configuration flow, depending on which feature is
available.
Each provider has its own specific configuration flow, depending on which feature is
available.
- Some of these online payment providers can also be added as bank accounts , but this is not the same process as adding them as payment
providers. Payment providers allow customers to pay online, and bank accounts are added and
configured in the Accounting app to do a bank reconciliation .
Some of these online payment providers can also be added as bank accounts , but this is not the same process as adding them as payment
providers. Payment providers allow customers to pay online, and bank accounts are added and
configured in the Accounting app to do a bank reconciliation .
In addition to the regular payment providers that integrate with an API, such as Stripe, PayPal,
or Adyen, Odoo bundles the Demo payment provider . This payment
provider allows you to test business flows involving online payments. No credentials are required
as the demo payments are dummy payments.

### Bank payments

- Wire Transfer When selected, Odoo displays your payment information with a payment reference. You have to
approve the payment manually once you have received it in your bank account.
- SEPA Direct Debit Your customers can make a bank transfer to register a SEPA Direct Debit mandate and get their
bank account charged directly.

## Enabling a payment provider

To add a new payment provider and make its related payment methods available to your customers,
proceed as follows:
- Go to the payment providerâs website, create an account, and make sure you have the API
credentials requested for third-party use. These are necessary for Odoo to communicate with the
payment provider.
Go to the payment providerâs website, create an account, and make sure you have the API
credentials requested for third-party use. These are necessary for Odoo to communicate with the
payment provider.
- In Odoo, navigate to the Payment providers by going to Accounting â£
Configuration â£ Payment Providers , Website â£ Configuration â£ Payment
Providers , or Sales â£ Configuration â£ Payment Providers .
In Odoo, navigate to the Payment providers by going to Accounting â£
Configuration â£ Payment Providers , Website â£ Configuration â£ Payment
Providers , or Sales â£ Configuration â£ Payment Providers .
- Select the provider and configure the Credentials tab.
Select the provider and configure the Credentials tab.
- Set the State field to Enabled .
Set the State field to Enabled .
- The fields available in the Credentials tab depend on the payment provider. Refer
to the related documentation for more
information.
The fields available in the Credentials tab depend on the payment provider. Refer
to the related documentation for more
information.
- Once you have enabled the payment provider, it is automatically published on your website.
If you wish to unpublish it, click the Published button. Customers cannot make
payments through an unpublished provider, but they can still manage (delete and assign to a subscription) their existing tokens linked to such a provider.
Once you have enabled the payment provider, it is automatically published on your website.
If you wish to unpublish it, click the Published button. Customers cannot make
payments through an unpublished provider, but they can still manage (delete and assign to a subscription) their existing tokens linked to such a provider.

### Test mode

We recommend using the test mode on a duplicate or a test database to avoid potential
issues with invoice numbering.
To try a payment provider without affecting live transactions, set the State field in
the payment provider form to Test mode . Then, enter the providerâs dedicated test or
sandbox credentials in the Credentials tab. Each payment provider has its own separate
test account or environment for this purpose.
By default, the payment provider remains unpublished in test mode so that itâs not visible to
visitors.

## Payment methods

Each payment provider is related to a list of supported payment methods; the methods listed in the Payment methods field in the Configuration tab of the payment provider form
are the ones that have been activated. To activate or deactivate a payment method for a provider,
click Enable Payment Methods , then click the toggle button of the related method.
Payment methods are displayed on your website based on their sequence order. To reorder them,
click Enable Payment Methods in the payment provider form, then, in the Payment Methods list, drag and drop the payment methods in the desired order.

### Icons and brands

The icons displayed next to the payment method on your website are either the icons of the brands
activated for the payment method or, if there arenât any, the icons of the payment methods
themselves. To modify them, go to Accounting â£ Configuration â£ Payment Methods , Website â£ Configuration â£ Payment Methods or Sales â£
Configuration â£ Payment Methods , then click on the payment method.
To modify a payment methodâs icon, hover your mouse over the image in the upper-right corner of the
payment methodâs form and click the ( pencil ) icon.
Select the Brands tab to view the brands that have been activated for the payment
method. The brands and their related icons are displayed based on their sequence order; to reorder
them, drag and drop them in the desired order. To modify a brandâs icon, select the brand, then,
in the popup window that opens, hover the mouse over the image in the upper-right corner and click
the ( pencil ) icon.

### Advanced configuration

To configure payment methods further, go to Accounting â£ Configuration â£ Payment
Methods , Website â£ Configuration â£ Payment Methods or Sales
â£ Configuration â£ Payment Methods . Click on the payment method, then activate the developer mode . Click the Configuration tab to adapt the
features.
- Each payment method is preconfigured in a way that aligns with the payment providersâ
behavior and their integration with Odoo. Any change to this configuration may result in errors
and should be tested on a duplicate or test database first.
Each payment method is preconfigured in a way that aligns with the payment providersâ
behavior and their integration with Odoo. Any change to this configuration may result in errors
and should be tested on a duplicate or test database first.
- Modifications to the payment methodâs configuration only work to the extent of the methodâs
and providerâs capabilities. For example, adding countries for a payment method only supported in one country or
enabling tokenization for a method linked to a provider
that does not support it will not produce the intended results.
Modifications to the payment methodâs configuration only work to the extent of the methodâs
and providerâs capabilities. For example, adding countries for a payment method only supported in one country or
enabling tokenization for a method linked to a provider
that does not support it will not produce the intended results.

## Tokenization

If the payment provider supports this feature , customers
can save their payment method details for later. To enable this feature, go to the Configuration tab of the selected payment provider and enable Allow Saving
Payment Methods .
In this case, a payment token is created in Odoo to be used as a payment method for subsequent
payments without the customer having to enter their payment method details again. This is
particularly useful for the eCommerce conversion rate and subscriptions that use recurring payments.
To add or delete their saved payment method details, customers can click Manage
payment methods in the customer portal .
PCI DSS and Attestation of Compliance
Odoo is not PCI DSS-certified because it does not
store cardholder data or process payments. Instead, it outsources tokenization and payment to external payment providers , which means that as an
Odoo customer, you only need to complete the minimal Self-Assessment Questionnaire (SAQ) with
the provider to obtain the Attestation of Compliance (AoC) and achieve PCI compliance. Odoo
should not be mentioned as a payment processor or a third-party service provider in the SAQ .

## Manual capture

If the payment provider supports this feature , you can
authorize and capture payments in two steps instead of one. To enable this feature, go to the Configuration tab of the selected payment provider and enable Capture Amount
Manually .
When you authorize a payment, the funds are reserved on the customerâs payment method but not
immediately charged. They are charged when you manually capture the payment later on. You can also
void the authorization to cancel it and release the reserved funds. Capturing payments manually is
helpful in many situations:
- Receive the payment confirmation and wait until the order is shipped to capture the payment.
Receive the payment confirmation and wait until the order is shipped to capture the payment.
- Review and verify that orders are legitimate before the payment is completed and the fulfillment
process starts.
Review and verify that orders are legitimate before the payment is completed and the fulfillment
process starts.
- Avoid potentially high refund fees for refunded payments: payment providers will not charge you
for voiding an authorization.
Avoid potentially high refund fees for refunded payments: payment providers will not charge you
for voiding an authorization.
- Hold a security deposit to return later, minus any deductions (e.g., in case of damages).
Hold a security deposit to return later, minus any deductions (e.g., in case of damages).
To capture the payment after it was authorized, go to the related sales order or invoice and click
the Capture Transaction button. To release the funds, click the Void
Transaction button.
- Some payment providers support capturing only part of the authorized amount. The remaining
amount can then be either captured or voided. These providers have the value Full and
partial in the table above . The providers that
only support capturing or voiding the total amount have the value Full only .
Some payment providers support capturing only part of the authorized amount. The remaining
amount can then be either captured or voided. These providers have the value Full and
partial in the table above . The providers that
only support capturing or voiding the total amount have the value Full only .
- The funds are likely not reserved forever. After a certain time, they may be automatically
released back to the customerâs payment method. Refer to your payment providerâs documentation
for the exact reservation duration.
The funds are likely not reserved forever. After a certain time, they may be automatically
released back to the customerâs payment method. Refer to your payment providerâs documentation
for the exact reservation duration.
- Adyen and Stripe allow to capture payments
manually directly from their website interface.
Adyen and Stripe allow to capture payments
manually directly from their website interface.

## Refunds

If your payment provider supports this feature, you can refund payments directly from Odoo. It does
not need to be enabled first. To refund a customer payment, navigate to it and click the Refund button.
- Some payment providers support refunding only part of the amount. The remaining amount can then
optionally be refunded, too. These providers have the value Full and partial in the table above . The providers that only support
refunding the total amount have the value Full only .
Some payment providers support refunding only part of the amount. The remaining amount can then
optionally be refunded, too. These providers have the value Full and partial in the table above . The providers that only support
refunding the total amount have the value Full only .
- Adyen and Stripe allow to refund payments
directly from their website interface.
Adyen and Stripe allow to refund payments
directly from their website interface.

## Express checkout

If the payment provider supports this feature , you can
allow customers to use the Google Pay and Apple Pay buttons and pay their
eCommerce orders in one click. When they use one of these buttons, customers go straight from the
cart to the confirmation page without filling out the contact form. They just have to validate the
payment on Googleâs or Appleâs payment form.
To enable this feature, go to the Configuration tab of the selected payment provider and
enable Allow Express Checkout .
All prices shown on the express checkout payment form always include taxes.

## Availability

You can adapt the payment providerâs availability by specifying the Maximum amount allowed and modifying the Currencies and Countries in the Configuration tab.
To display an availability report for payment providers and payment methods, and to help diagnose
potential availability issues on the payment form, enable the Developer mode (debug mode) , then click
the ( bug ) icon next to the Choose a payment method heading on the payment form. The report includes a list of enabled payment providers and payment
methods, reasons for any payment providers or methods not being available, if applicable, and a
list of supported providers for each payment method.

### Currencies and countries

All payment providers have a different list of available currencies and countries. They serve as a
first filter during payment operations, i.e., the payment methods linked to the payment provider are
not available for selection if the customerâs currency or country is not in the supported list. As
there might be errors, updates, and unknowns in the lists of available currencies and countries,
adding or removing a payment providerâs supported currencies or countries is possible.
- Payment methods also have their own list of
available currencies and countries that serves as another filter during payment operations.
Payment methods also have their own list of
available currencies and countries that serves as another filter during payment operations.
- If the list of supported currencies or countries is empty, it means the list is too long to be
displayed, or Odoo does not have information on that payment provider. The payment provider
remains available, even though it is possible the payment will be refused at a later stage
should the country or currency not be supported.
If the list of supported currencies or countries is empty, it means the list is too long to be
displayed, or Odoo does not have information on that payment provider. The payment provider
remains available, even though it is possible the payment will be refused at a later stage
should the country or currency not be supported.

### Maximum amount

You can restrict the Maximum Amount that can be paid with the selected provider. Leave
the field to 0.00 to make the payment provider available regardless of the payment amount.
`0.00`
This feature is not intended to work on pages that allow the customer to update the payment
amount, e.g., the Donation snippet and the Checkout page when paid shipping methods are enabled.

## Payment journal

A payment journal must be defined for the payment provider to record the
payments on an outstanding account . By default, the Bank journal is added as the
payment journal for all payment providers. To modify it, go to the Configuration tab of
the selected payment provider and select another Payment journal .
- The payment journal must be a Bank journal.
The payment journal must be a Bank journal.
- The same journal can be used for several payment providers.
The same journal can be used for several payment providers.
- Payment journals must only be configured if the Invoicing or Accounting app is installed.
Payment journals must only be configured if the Invoicing or Accounting app is installed.

### Accounting perspective

From an accounting perspective, there are two types of online payment workflows: the payments that
are directly deposited into your bank account and follow the usual reconciliation workflow, and those coming from third-party online payment
providers and require you to follow another accounting
workflow. For these payments, you need to consider how you want to record your paymentsâ journal
entries. We recommend you ask your accountant for advice.
By default, the Bank Account defined for the payment journal is used, but you can also specify an outstanding account for each payment provider to separate the providerâs
payments from other payments.
- Wire transfers
- SEPA Direct Debit
- Authorize.Net
- AsiaPay
- Buckaroo
- Mercado Pago
- Mollie
- PayPal
- Razorpay
- Stripe
- Worldline
- Xendit
- Bank and cash accounts
Bank and cash accounts

Supported payment providers
Online payment providers
Bank payments
Enabling a payment provider
Test mode
Payment methods
Icons and brands
Advanced configuration
Tokenization
Manual capture
Refunds
Express checkout
Availability
Currencies and countries
Maximum amount
Payment journal
Accounting perspective


Adyen

# Adyen

Adyen is a Dutch company that offers several online payment
possibilities.
Adyen only works with customers processing more than 10 million annually or invoicing a minimum of 1000 transactions per month .

## Adyen configuration

- Create an Adyen account if necessary and log into your Adyen Customer Area. Tip Log into your Test account to try the integration without charging customers.
Switch to your Live account once you are ready to accept payments.
Create an Adyen account if necessary and log into your Adyen Customer Area.
Log into your Test account to try the integration without charging customers.
Switch to your Live account once you are ready to accept payments.
- Contact the Adyen support team to enable the Multiple partial capture feature.
Contact the Adyen support team to enable the Multiple partial capture feature.
- In the Adyen Customer Area, go to Developers â£ API credentials and click the
relevant API credential user name in the list or click Create new credential to
create a new one.
In the Adyen Customer Area, go to Developers â£ API credentials and click the
relevant API credential user name in the list or click Create new credential to
create a new one.
- In the Server settings section, click Generate API key , then click the ( Copy API key ) icon and save the value for the Odoo configuration step.
In the Server settings section, click Generate API key , then click the ( Copy API key ) icon and save the value for the Odoo configuration step.
- In the Client settings section, click Generate client key , then
click the ( Copy API key ) icon and save the value for
the Odoo configuration step.
In the Client settings section, click Generate client key , then
click the ( Copy API key ) icon and save the value for
the Odoo configuration step.
- Enter your Odoo website URL in the Add allowed origins field, then click Add .
Enter your Odoo website URL in the Add allowed origins field, then click Add .
- Click Save changes at the bottom of the page.
Click Save changes at the bottom of the page.
- Go to Developers â£ Webhooks in the left menu and click Create new
webhook .
Go to Developers â£ Webhooks in the left menu and click Create new
webhook .
- In the Create new webhook popup, click Add on to the Standard
webhook line.
In the Create new webhook popup, click Add on to the Standard
webhook line.
- On the Webhook generation form, in the Server configuration section,
enter your Odoo database URL followed by /payment/adyen/notification .
On the Webhook generation form, in the Server configuration section,
enter your Odoo database URL followed by /payment/adyen/notification .
`/payment/adyen/notification`
- In the Security section, click Generate under HMAC , then
click the ( Copy HMAC to the clipboard ) icon and save the value for
the Odoo configuration step.
In the Security section, click Generate under HMAC , then
click the ( Copy HMAC to the clipboard ) icon and save the value for
the Odoo configuration step.
- Click Save configuration at the bottom of the page.
Click Save configuration at the bottom of the page.
- Go to Developers â£ API URLs , then copy the Prefix and save it for
the Odoo configuration step.
Go to Developers â£ API URLs , then copy the Prefix and save it for
the Odoo configuration step.

## Odoo configuration

- Navigate to the Adyen payment provider .
Navigate to the Adyen payment provider .
- Fill in the Merchant account , API Key , Client Key , HMAC Key , and API URL Prefix fields with the values saved at the Adyen configuration step .
Fill in the Merchant account , API Key , Client Key , HMAC Key , and API URL Prefix fields with the values saved at the Adyen configuration step .
- Configure the remaining options as needed.
Configure the remaining options as needed.
- Set the State field to Enabled .
Set the State field to Enabled .
If you want to test Adyen without affecting live transactions , use your Test account credentials, enter https://checkout-test.adyen.com in the API URL Prefix field, and set the State field to Test Mode .
`https://checkout-test.adyen.com`

## Manual capture

To enable manual capture for Adyen payments, follow
these steps:
- Navigate to the Adyen payment provider .
Navigate to the Adyen payment provider .
- Go to the Configuration tab and enable Capture Amount Manually .
Go to the Configuration tab and enable Capture Amount Manually .
- Log in to your Adyen Customer Area, then go to Settings and click Company in the Account management section.
Log in to your Adyen Customer Area, then go to Settings and click Company in the Account management section.
- In the General section, click the ( Edit property )
icon next to the Capture Delay field.
In the General section, click the ( Edit property )
icon next to the Capture Delay field.
- In the popup, set the Capture delay field to Manual and click Save .
In the popup, set the Capture delay field to Manual and click Save .
- If the transaction is not captured within 7 days, the customer is entitled to revoke it.
If the transaction is not captured within 7 days, the customer is entitled to revoke it.
- You can manually capture and refund payments directly from your Adyen Customer Area.
You can manually capture and refund payments directly from your Adyen Customer Area.

Adyen configuration
Odoo configuration
Manual capture


Amazon Payment Services

# Amazon Payment Services

Amazon Payment Services or APS is an online payment provider
established in Dubai offering several online payment options.

## Configuration on APS Dashboard

- Log into your Amazon Payment Services Dashboard and go to Integration Settings â£ Security Settings . Generate the Access Code if none has been generated yet. Copy the values of the Merchant Identifier , Access Code , SHA Request Phrase and SHA Response Phrase fields, and save them for later.
Log into your Amazon Payment Services Dashboard and go to Integration Settings â£ Security Settings . Generate the Access Code if none has been generated yet. Copy the values of the Merchant Identifier , Access Code , SHA Request Phrase and SHA Response Phrase fields, and save them for later.
- Enter your Odoo database URL in the Origin URL , for example: https://yourcompany.odoo.com/ . Then, click on Save Changes .
Enter your Odoo database URL in the Origin URL , for example: https://yourcompany.odoo.com/ . Then, click on Save Changes .
`https://yourcompany.odoo.com/`
- Navigate to Integration Settings â£ Technical Settings and click on Redirection . Make sure Status is set to Active and select your
preferred payment methods underneath in Payment Options .
Navigate to Integration Settings â£ Technical Settings and click on Redirection . Make sure Status is set to Active and select your
preferred payment methods underneath in Payment Options .
`Active`
- Set Send Response Parameters to Yes and enter your database URL
followed by /payment/aps/return in the Redirection URL . For example https://yourcompany.odoo.com/payment/aps/return . Enter your database URL followed by /payment/aps/webhook in the Direct Transaction Feedback and Notification URL fields. For example https://yourcompany.odoo.com/payment/aps/webhook . Click on Save Changes .
`/payment/aps/return`
`https://yourcompany.odoo.com/payment/aps/return`
`/payment/aps/webhook`
`https://yourcompany.odoo.com/payment/aps/webhook`
- Under Integration Settings â£ Payment Page Template you can customize the
look and feel of the Amazon Payment Services payment page (where customers fill out their
credit card details during payment).
Under Integration Settings â£ Payment Page Template you can customize the
look and feel of the Amazon Payment Services payment page (where customers fill out their
credit card details during payment).

## Configuration on Odoo

- Navigate to the payment provider Amazon Payment Services ,
change its state to Enabled , and make sure it is Published .
Navigate to the payment provider Amazon Payment Services ,
change its state to Enabled , and make sure it is Published .
- In the Credentials tab, fill the Merchant Identifier , Access Code , SHA Request Phrase and SHA Response Phrase with
the values you saved at the step Configuration on APS Dashboard .
In the Credentials tab, fill the Merchant Identifier , Access Code , SHA Request Phrase and SHA Response Phrase with
the values you saved at the step Configuration on APS Dashboard .
- Configure the rest of the options to your liking.
Configure the rest of the options to your liking.

Configuration on APS Dashboard
Configuration on Odoo


AsiaPay

# AsiaPay

AsiaPay is an online payments provider established in Hong Kong and
covering several Asian countries and payment methods.

## Configuration on AsiaPay Dashboard

- Log into AsiaPay Dashboard according to the account provided by AsiaPay. PayDollar : For markets in HK,
CN, MO, TW, SG, MY, IN, VN, NZ and AU PesoPay : For market in PH SiamPay : For market in TH BimoPay : For market in ID
Log into AsiaPay Dashboard according to the account provided by AsiaPay.
- PayDollar : For markets in HK,
CN, MO, TW, SG, MY, IN, VN, NZ and AU
PayDollar : For markets in HK,
CN, MO, TW, SG, MY, IN, VN, NZ and AU
- PesoPay : For market in PH
PesoPay : For market in PH
- SiamPay : For market in TH
SiamPay : For market in TH
- BimoPay : For market in ID
BimoPay : For market in ID
- Go to Profile â£ Account Information . Copy the values of the Currency and Secure Hash fields and save them for later.
Go to Profile â£ Account Information . Copy the values of the Currency and Secure Hash fields and save them for later.
- Go to Profile â£ Payment Account Settings and enable the option Return Value Link (Datefeed) ; Enter your Odoo database URL followed by /payment/asiapay/webhook in the Return Value Link (Datefeed) text field. For example: https://yourcompany.odoo.com/payment/asiapay/webhook ; Click on Test to check if the webhook is working correctly.
`/payment/asiapay/webhook`
`https://yourcompany.odoo.com/payment/asiapay/webhook`
- Click on Update to finalize the configuration.
Click on Update to finalize the configuration.

## Configuration on Odoo

- Navigate to the payment provider AsiaPay and change its state
to Enabled .
Navigate to the payment provider AsiaPay and change its state
to Enabled .
- In the Credentials tab, choose the Brand of your Asiapay account. Then
fill in the Merchant ID and Secure Hash Secret , and the Currency in the Configuration tab with the values you saved at the
step Configuration on AsiaPay Dashboard ; By default, the payment provider AsiaPay is configured to verify the secret hash with the hash
function SHA1 . If a different function is set on your account , activate the developer mode and set the same value to the field Secure Hash Function in the Credentials tab.
`SHA1`
- Configure the rest of the options to your liking.
Configure the rest of the options to your liking.
- Online payments

Configuration on AsiaPay Dashboard
Configuration on Odoo


Authorize.Net

# Authorize.Net

Authorize.Net is a United States-based online payment solution
provider, allowing businesses to accept credit cards .

## Configuration

- Enabling a payment provider
Enabling a payment provider

### Credentials tab

Odoo needs your API Credentials & Keys to connect with your Authorize.Net account, which
comprise:
- API Login ID : The ID solely used to identify the account with Authorize.Net.
API Login ID : The ID solely used to identify the account with Authorize.Net.
- API Transaction Key
- API Signature Key
- API Client Key
To retrieve them, log into your Authorize.Net account, go to Account â£ Settings
â£ Security Settings â£ API Credentials & Keys , generate your Transaction Key and Signature Key , and paste them on the related fields in Odoo. Then, click on Generate Client
Key .
To test Authorize.Net with a sandbox account, change the State to Test
Mode . We recommend doing this on a test Odoo database, rather than on your main database.
If you use the Test Mode with a regular account, it results in the following error: The merchant login ID or password is invalid or the account is inactive .

### Configuration tab

#### Place a hold on a card

With Authorize.Net, you can enable the manual capture . If enabled, the funds are reserved for 30 days on the
customerâs card, but not charged yet.
After 30 days , the transaction is voided automatically by Authorize.Net.
- Online payments

## ACH payments (USA only)

ACH is an electronic funds transfer system used between bank
accounts in the United States.

### Configuration

To give customers the possibility to pay using ACH, sign up for Authorize.Net eCheckâs service . Once eCheck is activated, duplicate the
previously configured Authorize.Net payment provider on Odoo by going to Accounting
â£ Configuration â£ Payment Providers â£ Authorize.net . Then, click the cog icon
( â ) and select Duplicate . Change the providerâs name to differentiate both
versions (e.g., Authorize.net - Banks ).
`Authorize.net-Banks`
When ready, change the providerâs State to Enabled for a regular account or Test Mode for a sandbox account.

## Import an Authorize.Net statement

### Export from Authorize.Net

Download the Excel import template.
`DownloadtheExcelimporttemplate.`
- Log in to Authorize.Net.
Log in to Authorize.Net.
- Go to Account â£ Statements â£ eCheck.Net Settlement Statement .
Go to Account â£ Statements â£ eCheck.Net Settlement Statement .
- Define an export range using an opening and closing batch settlement. All transactions within
the two batch settlements will be exported to Odoo.
Define an export range using an opening and closing batch settlement. All transactions within
the two batch settlements will be exported to Odoo.
- Select all transactions within the desired range, copy them, and paste them into the Report 1 Download sheet of the Excel import template .
Select all transactions within the desired range, copy them, and paste them into the Report 1 Download sheet of the Excel import template .
In this case, the first batch (01/01/2021) of the year belongs to the settlement of 12/31/2020,
so the opening settlement is from 12/31/2020.
Once the data is in the Report 1 Download sheet:
- Go to the Transaction Search tab on Authorize.Net.
Go to the Transaction Search tab on Authorize.Net.
- Under the Settlement Date section, select the previously used range of batch
settlement dates in the From: and To: fields and click Search .
Under the Settlement Date section, select the previously used range of batch
settlement dates in the From: and To: fields and click Search .
- When the list has been generated, click Download to File .
When the list has been generated, click Download to File .
- In the pop-up window, select Expanded Fields with CAVV Response/Comma Separated ,
enable Include Column Headings , and click Submit .
In the pop-up window, select Expanded Fields with CAVV Response/Comma Separated ,
enable Include Column Headings , and click Submit .
- Open the text file, select All , copy the data, and paste it into the Report
2 Download sheet of the Excel import template .
Open the text file, select All , copy the data, and paste it into the Report
2 Download sheet of the Excel import template .
- Transit lines are automatically filled in and updated in the transit for report 1 and transit for report 2 sheets of the Excel import template . Make sure all entries are present, and if not , copy the formula
from previously filled-in lines of the transit for report 1 or 2 sheets
and paste it into the empty lines.
Transit lines are automatically filled in and updated in the transit for report 1 and transit for report 2 sheets of the Excel import template . Make sure all entries are present, and if not , copy the formula
from previously filled-in lines of the transit for report 1 or 2 sheets
and paste it into the empty lines.
To get the correct closing balance, do not remove any line from the Excel sheets.

### Import into Odoo

To import the data into Odoo:
- Open the Excel import template .
Open the Excel import template .
- Copy the data from the transit for report 2 sheet and use paste special to only
paste the values in the Odoo Import to CSV sheet.
Copy the data from the transit for report 2 sheet and use paste special to only
paste the values in the Odoo Import to CSV sheet.
- Look for blue cells in the Odoo Import to CSV sheet. These are chargeback entries
without any reference number. As they cannot be imported as such, go to Authorize.Net â£ Account â£ Statements â£ eCheck.Net Settlement Statement .
Look for blue cells in the Odoo Import to CSV sheet. These are chargeback entries
without any reference number. As they cannot be imported as such, go to Authorize.Net â£ Account â£ Statements â£ eCheck.Net Settlement Statement .
- Look for Charge Transaction/Chargeback , and click it.
Look for Charge Transaction/Chargeback , and click it.
- Copy the invoice description, paste it into the Label cell of the Odoo
Import to CSV sheet, and add Chargeback / before the description.
Copy the invoice description, paste it into the Label cell of the Odoo
Import to CSV sheet, and add Chargeback / before the description.
`Chargeback/`
- If there are multiple invoices, add a line into the Excel import template for each invoice and copy/paste the description into each respective Label line.
If there are multiple invoices, add a line into the Excel import template for each invoice and copy/paste the description into each respective Label line.
For combined chargeback/returns in the payouts, create a new line in the Excel import
template for each invoice.
- Next, delete zero transaction and void transaction line items, and change the format
of the Amount column in the Odoo Import to CSV sheet to Number .
Next, delete zero transaction and void transaction line items, and change the format
of the Amount column in the Odoo Import to CSV sheet to Number .
- Go back to eCheck.Net Settlement Statement â£ Search for a Transaction and
search again for the previously used batch settlements dates.
Go back to eCheck.Net Settlement Statement â£ Search for a Transaction and
search again for the previously used batch settlements dates.
- Verify that the batch settlement dates on eCheck.Net match the related paymentsâ dates found in
the Date column of the Odoo Import to CSV .
Verify that the batch settlement dates on eCheck.Net match the related paymentsâ dates found in
the Date column of the Odoo Import to CSV .
- If it does not match, replace the date with the one from eCheck.Net. Sort the column by date ,
and make sure the format is MM/DD/YYYY .
If it does not match, replace the date with the one from eCheck.Net. Sort the column by date ,
and make sure the format is MM/DD/YYYY .
`MM/DD/YYYY`
- Copy the data - column headings included - from the Odoo Import to CSV sheet, paste
it into a new Excel file, and save it using the CSV format.
Copy the data - column headings included - from the Odoo Import to CSV sheet, paste
it into a new Excel file, and save it using the CSV format.
- Open the Accounting app, go to Configuration â£ Journals , tick the Authorize.Net box, and click Favorites â£ Import records â£ Load
file . Select the CSV file and upload it into Odoo.
Open the Accounting app, go to Configuration â£ Journals , tick the Authorize.Net box, and click Favorites â£ Import records â£ Load
file . Select the CSV file and upload it into Odoo.
List of eCheck.Net return codes

Configuration
Credentials tab
Configuration tab
ACH payments (USA only)
Configuration
Import an Authorize.Net statement
Export from Authorize.Net
Import into Odoo


Buckaroo

# Buckaroo

Buckaroo is a Dutch-based company that offers several online payment
possibilities.

## Configuration on Buckaroo Plaza

- Log into Buckaroo Plaza , go to My Buckaroo â£
Websites and select the Push settings tab.
Log into Buckaroo Plaza , go to My Buckaroo â£
Websites and select the Push settings tab.
- Tick the Enable Push Response check box in the Delayed and Push responses section.
Tick the Enable Push Response check box in the Delayed and Push responses section.
- Enter the URL of your Odoo database, followed by /payment/buckaroo/webhook in both the Push URI Success/Pending and Push URI Failure text fields. For example: https://yourcompany.odoo.com/payment/buckaroo/webhook .
Enter the URL of your Odoo database, followed by /payment/buckaroo/webhook in both the Push URI Success/Pending and Push URI Failure text fields. For example: https://yourcompany.odoo.com/payment/buckaroo/webhook .
`/payment/buckaroo/webhook`
`https://yourcompany.odoo.com/payment/buckaroo/webhook`
- Leave the other fields as they are and click Save .
Leave the other fields as they are and click Save .
- In the General tab, copy the website Key (i.e., the key used to uniquely
identify your website with Buckaroo) and save it for later.
In the General tab, copy the website Key (i.e., the key used to uniquely
identify your website with Buckaroo) and save it for later.
- Go to Configuration â£ Security â£ Secret key , enter or Generate a Secret key and click Save . Save the key for later.
Go to Configuration â£ Security â£ Secret key , enter or Generate a Secret key and click Save . Save the key for later.

## Configuration on Odoo

- Navigate to the payment provider Buckaroo and change its state
to Enabled .
Navigate to the payment provider Buckaroo and change its state
to Enabled .
- In the Credentials tab, fill the Website Key and Secret Key fields with the values you saved at the step Configuration on Buckaroo Plaza .
In the Credentials tab, fill the Website Key and Secret Key fields with the values you saved at the step Configuration on Buckaroo Plaza .
- Configure the options in the other tabs to your liking.
Configure the options in the other tabs to your liking.

Configuration on Buckaroo Plaza
Configuration on Odoo


Demo

# Demo

Odooâs Demo Payment Provider allows you to test business flows involving online transactions
without requiring real banking credentials.

## Configuration

Enabling a payment provider
Switch the state to Test Mode .

## Payment outcome

Upon checkout or when paying a bill online, you can choose the payment outcome when using the demo
payment provider. To do so, click on the Payment Status drop-down menu and select the
desired outcome.

## Transaction state

If you selected Pending as payment outcome , you can change the state of the
transaction straight from its form view. To access a transactionâs form view, activate the developer mode , and go to Accounting / Website â£
Configuration â£ Payment Transactions . Then, change the status of a transaction by clicking on the
state bar ( Draft, Pending, Authorized, Confirmed, Cancelled, Error ).

Configuration
Payment outcome
Transaction state


Flutterwave

# Flutterwave

Flutterwave is an online payments provider established in Nigeria and
covering several African countries and payment methods.

## Configuration on Flutterwave Dashboard

- Log into Flutterwave Dashboard and go to Settings â£ API . Copy the values of the Public Key and Secret Key fields and save them for later.
Log into Flutterwave Dashboard and go to Settings â£ API . Copy the values of the Public Key and Secret Key fields and save them for later.
- Go to Settings â£ Webhooks and enter your Odoo database URL followed by /payment/flutterwave/webhook in the URL text field. For example: https://yourcompany.odoo.com/payment/flutterwave/webhook .
`/payment/flutterwave/webhook`
`https://yourcompany.odoo.com/payment/flutterwave/webhook`
- Fill the Secret hash with a password that you generate and save its value for later.
Fill the Secret hash with a password that you generate and save its value for later.
- Make sure all the remaining checkboxes are ticked.
Make sure all the remaining checkboxes are ticked.
- Click on Save to finalize the configuration.
Click on Save to finalize the configuration.

## Configuration on Odoo

- Navigate to the payment provider Flutterwave and change its
state to Enabled .
Navigate to the payment provider Flutterwave and change its
state to Enabled .
- In the Credentials tab, fill the Public Key , Secret Key , and Webhook Secret with the values you saved at the step Configuration on Flutterwave Dashboard .
In the Credentials tab, fill the Public Key , Secret Key , and Webhook Secret with the values you saved at the step Configuration on Flutterwave Dashboard .
- Configure the rest of the options to your liking. Important If you choose to allow saving payment methods, it is recommended to only enable card payments
from Flutterwave dashboard, as only cards can be saved as payment tokens. To do so, go to your
Flutterwave Dashboard and then to Settings â£ Account Settings .
Configure the rest of the options to your liking.
If you choose to allow saving payment methods, it is recommended to only enable card payments
from Flutterwave dashboard, as only cards can be saved as payment tokens. To do so, go to your
Flutterwave Dashboard and then to Settings â£ Account Settings .
- Online payments

Configuration on Flutterwave Dashboard
Configuration on Odoo


Mercado Pago

# Mercado Pago

Mercado Pago is an online payment provider covering several
countries, currencies and payment methods in Latin America.

## Configuration on Mercado Pago Dashboard

- Log into the Mercado Pago Dashboard and select your application or create a new one.
Log into the Mercado Pago Dashboard and select your application or create a new one.
- Select Credenciales de producciÃ³n in the left part of the application page, then
select the industry, optionally enter your domain, and click Activar credenciales
de producciÃ³n .
Select Credenciales de producciÃ³n in the left part of the application page, then
select the industry, optionally enter your domain, and click Activar credenciales
de producciÃ³n .
- Copy the Access token and save it for later.
Copy the Access token and save it for later.
If you are trying Mercado Pago as a test, select Credienciales de prueba in the left
part of the application page, then copy the test Access token .

## Configuration on Odoo

- Navigate to the payment provider Mercado Pago and change its
state to Enabled .
Navigate to the payment provider Mercado Pago and change its
state to Enabled .
- In the Credentials tab, fill in the Access Token with the value you saved
at the Configuration on Mercado Pago Dashboard step.
In the Credentials tab, fill in the Access Token with the value you saved
at the Configuration on Mercado Pago Dashboard step.
- Configure the rest of the options to your liking.
Configure the rest of the options to your liking.
- Online payments
- Mercado Pago Odoo webinar
Mercado Pago Odoo webinar

Configuration on Mercado Pago Dashboard
Configuration on Odoo


Mollie

# Mollie

Mollie is an online payments platform established in the Netherlands.

## Mollie configuration

- Create a Mollie account if necessary
and log in to the Mollie Dashboard .
Create a Mollie account if necessary
and log in to the Mollie Dashboard .
- Go to Payments in the top menu, then click API keys .
Go to Payments in the top menu, then click API keys .
- Copy the Live API Key (or the Test API Key if you
wish to test the integration without affecting live transactions) and save it for the Odoo configuration step.
Copy the Live API Key (or the Test API Key if you
wish to test the integration without affecting live transactions) and save it for the Odoo configuration step.

## Odoo configuration

- Navigate to the payment provider Mollie
Navigate to the payment provider Mollie
- Fill in the API Key with the value previously saved .
Fill in the API Key with the value previously saved .
- Configure the remaining options as needed.
Configure the remaining options as needed.
- Set the State field to Enabled (or Test Mode if you
want to test the integration without affecting live transactions ).
Set the State field to Enabled (or Test Mode if you
want to test the integration without affecting live transactions ).


Nuvei

# Nuvei

Nuvei is a Canadian-based payment solution provider that covers
several Latin American countries, the US, and Canada. It allows businesses to accept credit cards
and several local payment methods.

## Configuration on the Nuvei Dashboard

- Create a Nuvei account, if necessary, via our referral page .
Create a Nuvei account, if necessary, via our referral page .
- Nuvei uses two separate portals for Sandbox and Production environments. Utilize the Sandbox Dashboard to test the integration without charging
your customers. Once you are ready to accept payments, switch to the Production Dashboard .
Nuvei uses two separate portals for Sandbox and Production environments. Utilize the Sandbox Dashboard to test the integration without charging
your customers. Once you are ready to accept payments, switch to the Production Dashboard .
- Go to Settings in the left sidebar, select My Integration Settings , then
select your payment page in the Website dropdown menu.
Go to Settings in the left sidebar, select My Integration Settings , then
select your payment page in the Website dropdown menu.
- Copy the Merchant ID and Site ID values and save them for later .
Copy the Merchant ID and Site ID values and save them for later .
- Click Reveal , then copy the Secret Key and save it for later .
Click Reveal , then copy the Secret Key and save it for later .
Nuvei supports additional functionality relating to error handling from the same page as above.
For example, the following options are available for handling failed transactions: Enable User Trap to redirect users back to the payment page and allow them to attempt
another deposit or Decline Recovery to display a popup suggesting alternative or
similar payment methods.

## Configuration on Odoo

- Navigate to the payment provider Nuvei and fill in the Merchant Identifier , Site Identifier , and Secret Key fields
with the information saved at the step Configuration on the Nuvei Dashboard .
Navigate to the payment provider Nuvei and fill in the Merchant Identifier , Site Identifier , and Secret Key fields
with the information saved at the step Configuration on the Nuvei Dashboard .
- To activate the provider, change its state to Enabled or Test Mode .
To activate the provider, change its state to Enabled or Test Mode .
- Configure the rest of the options to your liking.
Configure the rest of the options to your liking.
You can also test Nuvei using the test mode and your Sandbox
Dashboard values.

## Payment methods

Most Nuvei payment methods are region specific . The supported payment methods and brands for
each country are listed below:
- Boleto
- Card (AMEX, Mastercard, Visa)
Card (AMEX, Mastercard, Visa)
- Card (AMEX, Mastercard, Visa)
Card (AMEX, Mastercard, Visa)
- AstroPay TEF (Banco Guayaquil,
Banco Pichincha, Facilito)
AstroPay TEF (Banco Guayaquil,
Banco Pichincha, Facilito)
- Boleto
- Card (AMEX, Mastercard, Visa)
Card (AMEX, Mastercard, Visa)
- Card (AMEX, Mastercard, Visa)
Card (AMEX, Mastercard, Visa)
- Oxxo Pay
- Card (AMEX, Mastercard, Visa)
Card (AMEX, Mastercard, Visa)
- Card (AMEX, Mastercard, Visa)
Card (AMEX, Mastercard, Visa)
- Boleto
- Card (AMEX, Mastercard, Visa)
Card (AMEX, Mastercard, Visa)
- WebPay
- Card (AMEX, Mastercard, Visa)
Card (AMEX, Mastercard, Visa)
- Card (AMEX, Mastercard, Visa)
Card (AMEX, Mastercard, Visa)
- Card (AMEX, Mastercard, Visa)
Card (AMEX, Mastercard, Visa)
- Local Payments (Abitab,
RedPagos)
Local Payments (Abitab,
RedPagos)

Configuration on the Nuvei Dashboard
Configuration on Odoo
Payment methods


PayPal

# PayPal

Paypal is an American online payment provider available worldwide and
one of the few that does not charge a subscription fee.
While PayPal is available in over 200 countries/regions , only a selection of currencies are
supported .

## Configuration in PayPal

- Log into your PayPal Developer Dashboard .
Log into your PayPal Developer Dashboard .
- Click Apps & Credentials and click Create App .
Click Apps & Credentials and click Create App .
- Enter an App Name and click Create App .
Enter an App Name and click Create App .
- Copy the Client ID and Secret and save them for later .
Copy the Client ID and Secret and save them for later .
If you use customer names or addresses that include accented or non-Latin characters, you must configure the encoding format of the payment request sent by Odoo to PayPal to avoid
transaction failures without notice. To do so, access the PayPal button language encoding
setting , click More Options , and set the Encoding field to UTF-8 .
If you are trying PayPal as a test, access your PayPal Sandbox account and configure the encoding format for your sandbox account .
For encrypted website payments & EWP_SETTINGS errors, please check the PayPal documentation .

## Configuration in Odoo

- Navigate to the payment provider PayPal .
Navigate to the payment provider PayPal .
- In the Credentials tab, enter the Email linked to your PayPal account,
then fill in the Client ID and Client Secret fields with the values you
saved at the step Configuration in PayPal .
In the Credentials tab, enter the Email linked to your PayPal account,
then fill in the Client ID and Client Secret fields with the values you
saved at the step Configuration in PayPal .
- Click Generate your webhook to create the Webhook ID .
Click Generate your webhook to create the Webhook ID .
- Set the State field to Enabled , and make sure the PayPal payment provider
is Published .
Set the State field to Enabled , and make sure the PayPal payment provider
is Published .
- Configure the remaining options as desired.
Configure the remaining options as desired.

## Testing

PayPal provides two sandbox accounts that you can use to simulate live transactions:
- A business account (to use as the merchant account, e.g., ab-1abc12345678@business.example.com );
A business account (to use as the merchant account, e.g., ab-1abc12345678@business.example.com );
`ab-1abc12345678@business.example.com`
- A default personal account (to use as the shopper account, e.g., ba-9cba87654321@personal.example.com ).
A default personal account (to use as the shopper account, e.g., ba-9cba87654321@personal.example.com ).
`ba-9cba87654321@personal.example.com`
To test the PayPal payment workflow in Odoo:
- Log into the Paypal Developer Site using your PayPal
credentials and go to Testing Tools â£ Sandbox Accounts .
Log into the Paypal Developer Site using your PayPal
credentials and go to Testing Tools â£ Sandbox Accounts .
- Click the ( ellipsis ) icon next to the sandbox business account
and select View/Edit account .
Click the ( ellipsis ) icon next to the sandbox business account
and select View/Edit account .
- Copy the Email , Client ID , and Secret and save them for the
next step.
Copy the Email , Client ID , and Secret and save them for the
next step.
- In Odoo, configure the PayPal payment provider with the values saved at the previous step and set the State field to Test Mode .
In Odoo, configure the PayPal payment provider with the values saved at the previous step and set the State field to Test Mode .
You can then run a test transaction from Odoo using the sandbox personal account.
- Test mode
- Online payments

Configuration in PayPal
Configuration in Odoo
Testing


Razorpay

# Razorpay

Razorpay is an online payments provider established in India that
supports more than 100 payment methods.

## Create a Razorpay account with Odoo (Indian companies only)

- This method is only available for Indian companies.
This method is only available for Indian companies.
- This flow does not support the test mode .
This flow does not support the test mode .
- Navigate to the Razorpay payment provider and
click Connect .
Navigate to the Razorpay payment provider and
click Connect .
- Go through the account creation process and enter the verification codes when prompted. Tip If you already have a Razorpay account, enter your Razorpay credentials, select the account
you want to link to your Odoo database (if applicable), then click Continue .
Go through the account creation process and enter the verification codes when prompted.
If you already have a Razorpay account, enter your Razorpay credentials, select the account
you want to link to your Odoo database (if applicable), then click Continue .
- At the end of the process, click Authorize . If all required information
has been submitted, you are then redirected to Odoo, and the payment provider is Enabled .
At the end of the process, click Authorize . If all required information
has been submitted, you are then redirected to Odoo, and the payment provider is Enabled .

## Manual credentials and webhook input

### Razorpay configuration

- Create a Razorpay account if necessary and log into the Razorpay Dashboard .
Create a Razorpay account if necessary and log into the Razorpay Dashboard .
- Go to the Payments tab at the top of the page.
Go to the Payments tab at the top of the page.
- Toggle the Test Mode switch in the left menu to try the integration without
charging customers. Toggle it off once you are ready to accept real payments.
Toggle the Test Mode switch in the left menu to try the integration without
charging customers. Toggle it off once you are ready to accept real payments.
- Click Account & Settings in the left menu, then, under Website and app
settings , select API Keys .
Click Account & Settings in the left menu, then, under Website and app
settings , select API Keys .
- Copy the values of the Key Id and Secret Key fields and save them for
later.
Copy the values of the Key Id and Secret Key fields and save them for
later.
- Click Account & Settings in the left menu, then, under Website and app
settings , select Webhooks .
Click Account & Settings in the left menu, then, under Website and app
settings , select Webhooks .
- Click Add New Webhook , then enter your Odoo database URL followed by /payment/razorpay/webhook in the Webhook URL field. For example: https://example.odoo.com/payment/razorpay/webhook .
`/payment/razorpay/webhook`
`https://example.odoo.com/payment/razorpay/webhook`
- Fill the Secret field with a password of your choice and save it for later.
Fill the Secret field with a password of your choice and save it for later.
- Enable the following events: payment.authorized , payment.captured , payment.failed , refund.failed , and refund.processed .
Enable the following events: payment.authorized , payment.captured , payment.failed , refund.failed , and refund.processed .
- Click Create Webhook to finalize the configuration.
Click Create Webhook to finalize the configuration.
The Recurring payments feature must
be activated to accept recurring payments. To enable this feature, submit a request to the Razorpay Support team .

### Odoo configuration

- Activate developer mode .
Activate developer mode .
- Navigate to the Razorpay payment provider .
Navigate to the Razorpay payment provider .
- In the Credentials tab, fill the Key Id , Key Secret , and Webhook Secret with the values you saved during Razorpay configuration .
In the Credentials tab, fill the Key Id , Key Secret , and Webhook Secret with the values you saved during Razorpay configuration .
- Configure the remaining options as needed.
Configure the remaining options as needed.
- Set the State field to Enabled (or Test Mode if you are
trying Razorpay as a test ).
Set the State field to Enabled (or Test Mode if you are
trying Razorpay as a test ).
If you configure Odoo to capture amounts manually :
- Manual voiding of a transaction is not supported by Razorpay.
Manual voiding of a transaction is not supported by Razorpay.
- Transactions that remain uncaptured for more than five days are automatically voided .
Transactions that remain uncaptured for more than five days are automatically voided .


SEPA Direct Debit

# SEPA Direct Debit

SEPA (Single Euro Payments Area) is a payment-integration initiative of the European Union that
facilitates standardized and simplified electronic payments in euros across participating countries.
SEPA Direct Debit (SDD) is a payment provider that allows future payments to be collected from
customersâ bank accounts based on a signed SEPA Direct Debit mandate . This is particularly useful for recurring payments based on a subscription .
To use the SEPA Direct Debit (SDD) payment provider and create SEPA Direct Debit mandates :
- The invoice being paid must be for an amount in euros.
The invoice being paid must be for an amount in euros.
- The SEPA Direct Deposit (SDD) feature must be enabled, and the companyâs Creditor Identifier must be defined in the Accounting or Invoicing settings .
The SEPA Direct Deposit (SDD) feature must be enabled, and the companyâs Creditor Identifier must be defined in the Accounting or Invoicing settings .

## Configuration

To configure SEPA Direct Debit , follow these steps:
- Navigate to the SEPA Direct Debit payment provider .
Navigate to the SEPA Direct Debit payment provider .
- In the Configuration tab, select whether the memo or Communication to be
displayed alongside the payment instructions should be: Based on Document Reference : the sales order or invoice number Based on Customer ID : the customer identifier
In the Configuration tab, select whether the memo or Communication to be
displayed alongside the payment instructions should be:
- Based on Document Reference : the sales order or invoice number
Based on Document Reference : the sales order or invoice number
- Based on Customer ID : the customer identifier
Based on Customer ID : the customer identifier
- Select the Enable QR codes check box to activate QR code payments. Note Additional accounting setup is required
to use QR codes.
Select the Enable QR codes check box to activate QR code payments.
Additional accounting setup is required
to use QR codes.
- Edit the default payment instructions in the Messages tab to include your bank
account number . These instructions are displayed at the end of the checkout process on your
ecommerce website or on the customer portal.
Edit the default payment instructions in the Messages tab to include your bank
account number . These instructions are displayed at the end of the checkout process on your
ecommerce website or on the customer portal.
- Set the State field to Enabled .
Set the State field to Enabled .
- Leave the Currencies field set to the default EUR tag to ensure SDD is only available for payments in euros.
Leave the Currencies field set to the default EUR tag to ensure SDD is only available for payments in euros.
- The Bank Account defined for the Payment Journal must be a valid IBAN.
The Bank Account defined for the Payment Journal must be a valid IBAN.
You can also test SEPA direct debit payments using the Test mode .

## Online payments withSDD

Customers selecting SDD as a payment method are prompted to enter their IBAN to complete the SEPA Direct Debit mandate .
The SDD mandate is then automatically created in Draft based on the provided IBAN. To
validate the information, customers must confirm each new mandate with a successful bank transfer of
the expected amount using the specified payment reference (communication) defined in the SEPA Direct Debit payment providerâs form . Once this initial payment is
received and reconciled , the mandate is automatically
validated and updated to the Active status. Once a mandate is active, it is reused for
all subsequent payments made with the SDD payment method. You can then collect them by uploading them to your online banking interface .
SEPA Direct Debit (SDD) customer payments
- Mandates are automatically closed 36 months
after the date of the last collection.
Mandates are automatically closed 36 months
after the date of the last collection.
- SDD is also available as a payment method through other providers, such as Adyen , Buckaroo , and Stripe . In these cases, SDD mandates are handled
externally by the payment provider.
SDD is also available as a payment method through other providers, such as Adyen , Buckaroo , and Stripe . In these cases, SDD mandates are handled
externally by the payment provider.


Stripe

# Stripe

Stripe is a United States-based online payment solution provider allowing
businesses to accept credit cards and other payment methods.
- List of countries supported by Stripe
List of countries supported by Stripe
- List of payment methods supported by Stripe
List of payment methods supported by Stripe
- Online payments
- Use Stripe as a payment terminal in Point of Sale
Use Stripe as a payment terminal in Point of Sale

## Create your Stripe account with Odoo

To create a new Stripe account and link it to your Odoo database, make sure the companyâs Email is configured in the companyâs settings , then
follow the steps below according to your hosting type:
- Navigate to the payment provider Stripe and
click Connect Stripe .
Navigate to the payment provider Stripe and
click Connect Stripe .
- Go through the setup process and confirm your email address when Stripe sends you a
confirmation email.
Go through the setup process and confirm your email address when Stripe sends you a
confirmation email.
- At the end of the process, click Agree and submit . If all requested information
has been submitted, you are then redirected to Odoo, and your payment provider is enabled.
At the end of the process, click Agree and submit . If all requested information
has been submitted, you are then redirected to Odoo, and your payment provider is enabled.
- Navigate to the payment provider Stripe and
click Connect Stripe .
Navigate to the payment provider Stripe and
click Connect Stripe .
- Go through the setup process and confirm your email address when Stripe sends you a
confirmation email.
Go through the setup process and confirm your email address when Stripe sends you a
confirmation email.
- At the end of the process, click Agree and submit ; you are then redirected to
the payment provider Stripe in Odoo.
At the end of the process, click Agree and submit ; you are then redirected to
the payment provider Stripe in Odoo.
- Fill in your credentials .
Fill in your credentials .
- Set the State field to Enabled .
Set the State field to Enabled .
If you have created an account instead of linking an existing one , enable the developer mode , then
click Reset your Stripe Account on the Stripe payment provider form, then fill in your Stripe accountâs credentials .

## Manual credential input

Manual credential input is needed, for example, when linking an existing Stripe account to your
Odoo database, when using an account created on Odoo.sh or On-premise , or when testing Stripe without affecting live
transactions .

### Stripe configuration

- Go to the API keys page on Stripe , or log into
your Stripe dashboard and go to Developers â£ API Keys .
Go to the API keys page on Stripe , or log into
your Stripe dashboard and go to Developers â£ API Keys .
- In the Standard keys section, copy the Publishable key and the Secret key and save them for the Odoo configuration step.
In the Standard keys section, copy the Publishable key and the Secret key and save them for the Odoo configuration step.

### Odoo configuration

- Enable the developer mode .
Enable the developer mode .
- Navigate to the Stripe payment provider .
Navigate to the Stripe payment provider .
- In the Credentials tab, fill in the Publishable Key and Secret Key fields with the values you previously saved .
In the Credentials tab, fill in the Publishable Key and Secret Key fields with the values you previously saved .
- Click Generate your webhook .
Click Generate your webhook .
- Configure the remaining options as needed.
Configure the remaining options as needed.
- Set the State field to Enabled .
Set the State field to Enabled .
- You can also test Stripe without affecting live transactions using the test mode and the API keys of your Stripe accountâs Test Mode or
a sandbox environment .
You can also test Stripe without affecting live transactions using the test mode and the API keys of your Stripe accountâs Test Mode or
a sandbox environment .
- To link the same Stripe account to multiple companies in a database, create an account and fill in the credentials for one company, then reuse the same credentials and
webhook for the others. To view the webhook, go to the Webhooks page on Stripe , or log into your Stripe dashboard and go to Developers â£ Webhooks . Click the destination in the list, then click the ( Reveal secret ) icon next to the Signing secret field and copy the value.
To link the same Stripe account to multiple companies in a database, create an account and fill in the credentials for one company, then reuse the same credentials and
webhook for the others. To view the webhook, go to the Webhooks page on Stripe , or log into your Stripe dashboard and go to Developers â£ Webhooks . Click the destination in the list, then click the ( Reveal secret ) icon next to the Signing secret field and copy the value.

## Enable Apple Pay

To allow customers to use the Apple Pay button to pay for their eCommerce orders, navigate to
the Stripe payment provider , then go to the Configuration tab, enable Allow Express Checkout , and click Enable Apple Pay .
Express checkout and Google Pay
Stripe allows to manually capture and refund payments either from Odoo or directly from the Stripe dashboard.

Create your Stripe account with Odoo
Manual credential input
Stripe configuration
Odoo configuration
Enable Apple Pay


Wire transfers

# Wire transfers

The Wire Transfer payment method allows you to provide payment instructions to your customers,
such as your bank details and a reference to include with the payment. These instructions are
displayed after the customer selects Wire Transfer as the payment method and clicks the Pay now button at the end of the checkout process on your ecommerce website or
on the customer portal.
- While this method is widely accessible and requires minimal setup, it is not efficient
process-wise. It is recommended to set up a payment provider instead.
While this method is widely accessible and requires minimal setup, it is not efficient
process-wise. It is recommended to set up a payment provider instead.
- Online orders remain in the Quotation sent (i.e., unpaid order) stage until you
receive the payment and manually Confirm the order.
Online orders remain in the Quotation sent (i.e., unpaid order) stage until you
receive the payment and manually Confirm the order.
Wire transfer can be used as a template for other payment methods that are processed
manually, such as checks, by renaming or duplicating it.

## Configuration

To configure Wire Transfer :
- Navigate to the Wire Transfer payment provider .
Navigate to the Wire Transfer payment provider .
- In the Configuration tab, select whether the memo or Communication to be
displayed alongside the payment instructions should be: Based on Document Reference : the sales order or invoice number Based on Customer ID : the customer identifier
In the Configuration tab, select whether the memo or Communication to be
displayed alongside the payment instructions should be:
- Based on Document Reference : the sales order or invoice number
Based on Document Reference : the sales order or invoice number
- Based on Customer ID : the customer identifier
Based on Customer ID : the customer identifier
- Enable Enable QR codes to activate QR code payments. Note Additional accounting setup is required
to use QR codes.
Enable Enable QR codes to activate QR code payments.
Additional accounting setup is required
to use QR codes.
- Define the payment instructions in the Messages tab. If a bank account has already been defined, the account number is automatically added to the
default message generated by Odoo. You can also add it afterward and update the message by
clicking Reload pending message .
Define the payment instructions in the Messages tab. If a bank account has already been defined, the account number is automatically added to the
default message generated by Odoo. You can also add it afterward and update the message by
clicking Reload pending message .
- Set the State field to Enabled .
Set the State field to Enabled .
You can also test wire transfers using the Test mode .


Worldline

# Worldline

Worldline is a France-based company and the worldâs fourth largest
payment provider.

## Settings in Worldline

### Create an API user

It is recommended to set up an API user to create transactions from Odoo to ensure that your
Worldline configuration remains safe even if credentials are compromised. Additionally, API users do
not require frequent password updates like regular accounts.
To create an API user , proceed as follows:
- Log into your Worldline Merchant Portal ,
click the ( menu ) icon, and select Back Office .
Log into your Worldline Merchant Portal ,
click the ( menu ) icon, and select Back Office .
- Go to Configuration â£ Users and click on New User .
Go to Configuration â£ Users and click on New User .
- Configure the following fields: Specify a UserID , Userâs name , E-mail address , and Timezone of your choice. Set the Profile field to Admin . Enable Special user for API .
Configure the following fields:
- Specify a UserID , Userâs name , E-mail address , and Timezone of your choice.
Specify a UserID , Userâs name , E-mail address , and Timezone of your choice.
- Set the Profile field to Admin .
Set the Profile field to Admin .
- Enable Special user for API .
Enable Special user for API .
- If you have already set up a user, make sure it is activated without any error.
If you have already set up a user, make sure it is activated without any error.
- To test the payment flow with Worldline, use their test environment together with the test mode .
To test the payment flow with Worldline, use their test environment together with the test mode .

### Set up Worldline for Odoo

Worldline must now be configured to accept payments from Odoo.
- From your merchant portal, go to Developer â£ Payment API and click on Generate API key . Copy the API key ID and the Secret API key and save them for later .
From your merchant portal, go to Developer â£ Payment API and click on Generate API key . Copy the API key ID and the Secret API key and save them for later .
- Go to Developer â£ Webhooks and click on Generate webhook keys .
Copy the Webhook ID and the associated Secret webhook key and
save them for later .
Go to Developer â£ Webhooks and click on Generate webhook keys .
Copy the Webhook ID and the associated Secret webhook key and
save them for later .
- Click Add webhook endpoint , enter your Odoo databaseâs URL followed by /payment/worldline/webhook in the Endpoint url field, and Confirm . For example: https://example.odoo.com/payment/worldline/webhook .
`/payment/worldline/webhook`
`https://example.odoo.com/payment/worldline/webhook`

## Settings in Odoo

To set up Worldline in Odoo:
- Navigate to the payment provider Worldline and change its
state to Enabled .
Navigate to the payment provider Worldline and change its
state to Enabled .
- In the Credentials tab, enter the PSPID of your Worldline account and
fill in the API Key , API Secret , Webhook Key , and Webhook Secret with the values you saved at the step Set up Worldline for
Odoo .
In the Credentials tab, enter the PSPID of your Worldline account and
fill in the API Key , API Secret , Webhook Key , and Webhook Secret with the values you saved at the step Set up Worldline for
Odoo .
- Configure the rest of the options to your liking.
Configure the rest of the options to your liking.

Settings in Worldline
Create an API user
Set up Worldline for Odoo
Settings in Odoo


Xendit

# Xendit

Xendit is an Indonesian-based payment solution provider that covers
several Southeast Asian countries. It allows businesses to accept credit cards as well as several
local payment methods.
- Credit card payments are processed through Odoo, while all other payment methods are handled
via Xenditâs website.
Credit card payments are processed through Odoo, while all other payment methods are handled
via Xenditâs website.
- Xendit supports card payment tokenization, provided the customer has requested Merchant
Initiated Transaction (MIT) from Xendit Support .
Xendit supports card payment tokenization, provided the customer has requested Merchant
Initiated Transaction (MIT) from Xendit Support .

## Configuration on the Xendit Dashboard

- Create a Xendit account if necessary
and log in to the Xendit Dashboard .
Create a Xendit account if necessary
and log in to the Xendit Dashboard .
- Check your account mode in the top left corner of the page. Use the Test Mode to try
the integration without charging your customers. Switch to Live Mode once you are
ready to accept payments.
Check your account mode in the top left corner of the page. Use the Test Mode to try
the integration without charging your customers. Switch to Live Mode once you are
ready to accept payments.
- Navigate to Configuration: Settings in the left part of the application page.
In the Developers section, click API Keys .
Navigate to Configuration: Settings in the left part of the application page.
In the Developers section, click API Keys .
- Click Generate Secret Key . In the popup box, enter any API key name ,
select Write for the Money-in Products permission and None for all other permissions then click Generate key .
Click Generate Secret Key . In the popup box, enter any API key name ,
select Write for the Money-in Products permission and None for all other permissions then click Generate key .
- Confirm your password to display your API key. Copy or download the key and save
this information securely for later . This is the only time the API key can be viewed or
downloaded.
Confirm your password to display your API key. Copy or download the key and save
this information securely for later . This is the only time the API key can be viewed or
downloaded.
- Once completed, scroll down the page to the Webhooks section to generate
the webhook token.
Once completed, scroll down the page to the Webhooks section to generate
the webhook token.
- Under Webhook verification token , click View Webhook Verification Token ,
then confirm your password to display the token. Save it for later.
Under Webhook verification token , click View Webhook Verification Token ,
then confirm your password to display the token. Save it for later.
- In the Webhook URL section, enter your Odoo databaseâs URL, followed by /payment/xendit/webhook (e.g., https://example.odoo.com/payment/xendit/webhook ) in the field Invoices paid and click the Test and save button next to it.
In the Webhook URL section, enter your Odoo databaseâs URL, followed by /payment/xendit/webhook (e.g., https://example.odoo.com/payment/xendit/webhook ) in the field Invoices paid and click the Test and save button next to it.
`/payment/xendit/webhook`
`https://example.odoo.com/payment/xendit/webhook`
- To allow recurring payments for credit cards, go to Configuration: Payment
Channels in the left part of the application page. Then, hover your mouse over the Visa, Mastercard, JCB, Amex channel, click View Details , and enable Recurring Payments by toggling the related switch.
To allow recurring payments for credit cards, go to Configuration: Payment
Channels in the left part of the application page. Then, hover your mouse over the Visa, Mastercard, JCB, Amex channel, click View Details , and enable Recurring Payments by toggling the related switch.

## Configuration on Odoo

- Navigate to the payment provider Xendit and change its state
to Enabled .
Navigate to the payment provider Xendit and change its state
to Enabled .
- Fill in the Secret Key and Webhook Token fields with the
information saved at the step Configuration on the Xendit Dashboard .
Fill in the Secret Key and Webhook Token fields with the
information saved at the step Configuration on the Xendit Dashboard .
- Configure the rest of the options to your liking.
Configure the rest of the options to your liking.

Configuration on the Xendit Dashboard
Configuration on Odoo


Apps and modules

# Apps and modules

Install , upgrade and uninstall any needed apps and modules from the Apps dashboard.
By default, an Apps filter is applied. To search for modules too, select Extra from the Filters .
Adding or removing apps can significantly affect other apps in the database and modify
subscription costs. Consider carefully or test the changes in a staging environment before
proceeding.
- Administrators manage the database : The administrator of the database is responsible for
its usage, as they know best how their organization works.
Administrators manage the database : The administrator of the database is responsible for
its usage, as they know best how their organization works.
- Odoo apps can have dependencies : Installing some apps and features with dependencies may
also install additional apps and modules that are technically required, even if database users
do not actively use them.
Odoo apps can have dependencies : Installing some apps and features with dependencies may
also install additional apps and modules that are technically required, even if database users
do not actively use them.
- Duplicate the database to test apps : Testing on a duplicate database reveals what app
dependencies may be required or what database may be erased. Learn how to duplicate an Odoo Online database or an Odoo On-premise
database .
Duplicate the database to test apps : Testing on a duplicate database reveals what app
dependencies may be required or what database may be erased. Learn how to duplicate an Odoo Online database or an Odoo On-premise
database .

## Install apps and modules

From the main Odoo dashboard, open the Apps app, then click on the search bar to
find the app to be installed or scroll to find it. From here, click Activate on the
appâs card.
If the app or module to be installed is not listed, update the app list by activating developer mode , and then go to Apps â£ Update Apps
List , and then click Update .

## Upgrade apps and modules

With each new Odoo release , new improvements
or app features are added. Upgrade the app to use these new improvements and features.
Go to Apps and then on the app to upgrade, click the (vertical ellipsis) icon and select Upgrade .

## Uninstall apps and modules

Uninstalling apps also deletes their database records. Test uninstalling apps on a duplicated
database before removing apps on a production database.
Some apps have dependencies, meaning that one app requires another. Therefore, uninstalling one
app may uninstall multiple apps and modules.
Go to Apps and then on the app to uninstall, click the (vertical ellipsis) icon and select Uninstall to open the Uninstall module pop-up window.
The Apps to Uninstall section lists the applications to be uninstalled.
Select the Show All checkbox to display all module dependencies.
The Documents to Delete section lists the database records to be deleted.
To proceed with uninstalling the app, its dependencies, and all related database records, click Uninstall .
The Restaurant app requires the Point of Sale app to function, so uninstalling the Point of Sale app will also uninstall the Restaurant app, and any related records.

Install apps and modules
Upgrade apps and modules
Uninstall apps and modules


Companies

# Companies

In Odoo, a company is an individual business entity that operates independently, with its own legal
identity, financial records, and specific operational settings.
- Branches
- Multi-company

## Configuration

To set up a company, follow these steps:
- Configure the company details .
Configure the company details .
- Manage users and their access rights .
Manage users and their access rights .
- Customize the document layout .
Customize the document layout .

### Company

To create a company, open the Settings app, navigate to the Companies section, and click Manage Companies . In the Companies list view, click New and configure the following fields:
- Company Name
- Address
- Tax ID : tax identification number.
Tax ID : tax identification number.
- LEI : legal entity identifier.
LEI : legal entity identifier.
- Company ID : companyâs registry number, if different from Tax ID
Company ID : companyâs registry number, if different from Tax ID
- Currency
- Phone and Mobile
- Website
- Email Domain
Upload the companyâs logo and Save .
- Alternatively, it is possible to create a company by going to Settings â£
Users & Companies â£ Companies .
Alternatively, it is possible to create a company by going to Settings â£
Users & Companies â£ Companies .
- The companyâs General information may vary based on the fiscal localization .
The companyâs General information may vary based on the fiscal localization .

### Users

After setting up a company, add users and configure their access and access rights .
Users in multi-company environment

### Document layout

Configure the default layout for all company documents.

## Branches

Branches represent subdivisions within a company, such as regional offices or departments, that
operate under a common parent company. They support hierarchical company structures through configurable settings , enabling comprehensive or branch-specific views with
flexible access control , entity-specific or
shared record visibility , and customizable reporting .
Independent subsidiaries should be created as additional companies, not branches.
- Multi-company
- Branch accounting

### Configuration

Each branch is linked to its parent company but may contain different or specific information, such
as its address or logo. A branch can be a parent company of branches at a lower level to create a
multi-level architecture.
- Clarify the companyâs structure and hierarchy before creating companies and branches in Odoo. A
company defined as a parent cannot be converted into a branch later, as doing so may result in access rights issues.
Clarify the companyâs structure and hierarchy before creating companies and branches in Odoo. A
company defined as a parent cannot be converted into a branch later, as doing so may result in access rights issues.
- Always create the parent company first.
Always create the parent company first.
To create a branch, follow these steps in the Settings app:
- Navigate to the Companies section, click Manage
Companies , or go to Settings â£ Users & Companies â£ Companies .
Navigate to the Companies section, click Manage
Companies , or go to Settings â£ Users & Companies â£ Companies .
- In the Companies list view, open the desired parent company form.
In the Companies list view, open the desired parent company form.
- In the Branches tab, click Add a line and fill in the General
Information fields in the Create Branches window.
In the Branches tab, click Add a line and fill in the General
Information fields in the Create Branches window.
To create branches from a branch and create a multi-level architecture, click Add a line in the new branchâs Branches tab.
Activate the developer mode to set social media accounts and company-specific email system
parameters.
Adding a branch to a company enables multi-company functions.

### Comprehensive or branch-specific view

Selecting the parent company automatically links all its branches, while selecting a branch
connects to that branch only. To switch between them, use the company selector .
All configurations, except for accounting settings inherited from the
parent company, must be set individually per branch. This allows for branch-specific setups such as loyalty programs , price lists , or inventory locations .

#### User access

Like in a multi-company environment, parent companies and branches support flexible user
access control and access rights . User access
can be granted or restricted at the parent company level, the branch level, or both. For example, a
user can be limited to a specific branch, while an administrator with access to the parent company
can manage all associated branches.

#### Shared records

In Odoo, some records are, by default, either specific to a single entity or shared across the
parent company and all its branches.
When creating a quotation, invoice, or vendor bill, the active company or branch is automatically
selected and displayed in the Company field. If the active company is the parent company
or one of its branches, then records specifically linked to that entity are accessible only within
that entity and will only be visible when the company or branch is selected using the company
selector .
In contrast, some records, such as products or contacts , are not tied to any particular entity and are
shared by default across the parent company and all its branches. However, they can be restricted to
a single entity by setting the appropriate value in the Company field, if needed.

#### Reporting

All reports can be generated for the parent company alone
or with its branches, based on user access .

Configuration
Company
Users
Document layout
Branches
Configuration
Comprehensive or branch-specific view


Digest emails

# Digest emails

Digest Emails are periodic snapshots sent via email to users in an organization that include
high-level information about how the business is performing.
To start sending digest emails, begin by navigating to Settings app â£ Statistics
section , activate the Digest Emails feature, and click Save .
A variety of settings can be configured for digest emails, such as:
- Deciding which KPIs are shared in the digest emails
Deciding which KPIs are shared in the digest emails
- Determining how often digest emails are sent
Determining how often digest emails are sent
- Choosing who in the organization receives digest emails
Choosing who in the organization receives digest emails
- Creating custom digest email templates
Creating custom digest email templates
- Adding additional KPIs ( Studio app required)
Adding additional KPIs ( Studio app required)
By default, the Digest Email feature is enabled. Your Odoo Periodic
Digest serves as the primary template, which includes all KPI measurements across the Odoo database, and is sent daily to administrators.
When creating duplicates of databases that have sending capabilities (not testing-mode), the
digest emails continue to send from the duplicate database, unless deactivated.
To deactivate the digest email, navigate to Settings â£ Statistics section .
Then, deactivate the Digest Emails feature, by un-ticking the checkbox, and clicking Save . See the section on Deactivate digest email .

## Customize default digest email

To customize the default digest email ( Your Odoo Periodic Digest ), go to Settings
app â£ Statistics section â£ Digest Email field . Then, select Your Odoo Periodic
Digest , and click on the âï¸ (External link) icon, next to the drop-down menu selection.
A pop-up window appears, and presents a variety of editable settings, which include:
- Digest Name : the name of the digest email.
Digest Name : the name of the digest email.
- Periodicity : control how often digest emails are sent ( Daily , Weekly , Monthly , or Quarterly ).
Periodicity : control how often digest emails are sent ( Daily , Weekly , Monthly , or Quarterly ).
- Next Send Date : the date on which the digest email will be sent again.
Next Send Date : the date on which the digest email will be sent again.
- KPIs tab: check/uncheck each calculated KPI that
appears in digest emails. A ticked box indicates an active KPI in the digest email. See the section on KPIs .
KPIs tab: check/uncheck each calculated KPI that
appears in digest emails. A ticked box indicates an active KPI in the digest email. See the section on KPIs .
- Recipients tab: add/remove users who receive the digest emails. See the section on Recipients .
Recipients tab: add/remove users who receive the digest emails. See the section on Recipients .
The KPIs can be customized using Odoo Studio . Additional
costs to the database subscription are incurred should Studio need to be installed. See this
section on Custom KPIs with Odoo Studio .

## Deactivate digest email

To manually deactivate an individual digest email, first navigate to Settings app
â£ Statistics section , and click Configure Digest Emails . Then, select the desired
digest email from the list that should be deactivated.
Next, click DEACTIVATE FOR EVERYONE to deactivate the digest email for everyone, or UNSUBSCRIBE ME to remove the logged in user from the mailing list. These buttons are
located in the top menu, just above the Digest Name .

## Manually send digest email

To manually send a digest email, first navigate to Settings app â£ Statistics
section , and click Configure Digest Emails . Then, select the desired digest email, and
click SEND NOW . This button is located in the top menu, just above the Digest
Name .

## KPIs

Pre-configured KPIs can be added to the digest email from the KPIs tab of the digest email template form.
First, navigate to Settings app â£ Statistics section , and click Configure Digest Emails .
Then, select the desired digest email, and open the KPIs tab.
To add a KPI to the digest email, tick the checkbox next to the
desired KPI . After all KPIs are added (or deselected), click Save .
The following KPIs are available in the KPIs tab on
a digest email template form out-of-box in Odoo:
- Connected Users
- Messages
- Open Tasks
- Employees
- New Leads/Opportunities
New Leads/Opportunities
- Opportunities Won
- All Sales
- eCommerce Sales
- POS Sales
- % of Happiness
- Conversations handled
Conversations handled
- Time to answer (sec)
- Tickets Closed
- Revenue
- Banks and Cash Moves

## Recipients

Digest email recipients are added from the Recipients tab of the digest email template
form.
To add a recipient, navigate to Settings app â£ Statistics section , and click Configure Digest Emails . Then, select the desired digest email, and open the Recipients tab.
To add a recipient, click Add a line , and an Add Recipients pop-up window
appears, with all available users to add as recipients.
From the pop-up window, tick the checkbox next to the Name of the user(s), and click the Select button.
To remove a user as a recipient, click the â (remove) icon to the far-right of the user
listed in the Recipients tab.
Click Save to implement the changes.

## Create digest emails

To create a new digest email, navigate to Settings app â£ Statistics section , and
click Configure Digest Emails . Then, click Create to create a new digest
email.
A separate page, with a blank digest email template appears, and presents a variety of editable
settings, including:
- Digest Name : the name of the digest email.
Digest Name : the name of the digest email.
- Periodicity : control how often digest emails are sent ( Daily , Weekly , Monthly , or Quarterly ).
Periodicity : control how often digest emails are sent ( Daily , Weekly , Monthly , or Quarterly ).
- Next Send Date : the date on which the digest email will be sent again.
Next Send Date : the date on which the digest email will be sent again.
- KPIs tab: check/uncheck each calculated KPI that
appears in digest emails. A ticked box indicates an active KPI in the digest email. See the section on KPIs .
KPIs tab: check/uncheck each calculated KPI that
appears in digest emails. A ticked box indicates an active KPI in the digest email. See the section on KPIs .
- Recipients tab: add/remove users who receive the digest emails. See the section on Recipients .
Recipients tab: add/remove users who receive the digest emails. See the section on Recipients .
From there, give the digest email a Digest Name , specify Periodicity ,
choose the desired KPIs , and add Recipients , as
needed.
After clicking Save , the new custom digest email is available as a selection in the Digest Email field, located in the Settings app â£ Statistics section .

## Custom KPIs with Odoo Studio

The KPIs on a digest email template form, in the KPIs tab, can be customized using Odoo Studio .
Additional costs to the database subscription are incurred, should Odoo Studio need to be
installed.
To begin, click the ð ï¸ (tools) icon in the top-right of the screen. This is the link to
the Odoo Studio application.
In order to create additional fields, create two fields on the digest object:
- Create a boolean field called kpi_myfield , and display it in the KPIs tab.
Create a boolean field called kpi_myfield , and display it in the KPIs tab.
`kpi_myfield`
- Create a computed field called kpi_myfield_value that computes the customized KPI .
Create a computed field called kpi_myfield_value that computes the customized KPI .
`kpi_myfield_value`
- Select the KPIs in the KPIs tab.
Select the KPIs in the KPIs tab.
Here is the source code for the digest.py file, which guides the programmer in the coding of the computed field.
`digest.py`
Users can also click the Recipients tab, and then the vertical three-dot (kebab) menu to edit this view. Either click EDIT LIST VIEW or EDIT FORM VIEW to modify this tab.

### Computed values reference table

kpi_res_users_connected_value
`kpi_res_users_connected_value`
kpi_mail_message_total_value
`kpi_mail_message_total_value`
kpi_crm_lead_created_value
`kpi_crm_lead_created_value`
kpi_crm_opportunities_won_value
`kpi_crm_opportunities_won_value`
kpi_project_task_opened_value
`kpi_project_task_opened_value`
kpi_helpdesk_tickets_closed_value
`kpi_helpdesk_tickets_closed_value`
kpi_livechat_rating_value
`kpi_livechat_rating_value`
Conversations handled
kpi_livechat_conversations_value
`kpi_livechat_conversations_value`
kpi_livechat_response_value
`kpi_livechat_response_value`
kpi_all_sale_total_value
`kpi_all_sale_total_value`
kpi_website_sale_total_value
`kpi_website_sale_total_value`
kpi_account_total_revenue_value
`kpi_account_total_revenue_value`
kpi_account_bank_cash_value
`kpi_account_bank_cash_value`
`kpi_pos_total_value`
kpi_hr_recruitment_new_colleagues_value
`kpi_hr_recruitment_new_colleagues_value`

Customize default digest email
Deactivate digest email
Manually send digest email
KPIs
Recipients
Create digest emails
Custom KPIs with Odoo Studio
Computed values reference table