Stripe¶
Stripe is a United States-based online payment solution provider, allowing businesses to accept credit cards and other payment methods.
Link your Stripe Account with Odoo¶
The method to acquire your credentials depends on your hosting type:
Go to the eCommerce or the Sales app and click the Activate Stripe or the Set payments button on the onboarding banner.
Fill in the requested information and submit the form.
Confirm your email address when Stripe sends you a confirmation email.
At the end of the process, you are redirected to Odoo. If you submitted all the requested information, you are all set and your payment provider is enabled.
You can continue to Enable local payment methods.
Tip
To use your own API keys, activate the Developer mode and enable Stripe manually. You can then Fill in your credentials, generate a webhook and enable the payment provider.
Go to the eCommerce or the Sales app and click the Activate Stripe or the Set payments button on the onboarding banner.
Fill in the requested information and submit the form.
Confirm your email address when Stripe sends you a confirmation email.
At the end of the process, you are redirected to the payment provider Stripe in Odoo.
Enable the payment provider.
You are all set and can continue to Enable local payment methods.
Tip
To connect your Stripe account after the onboarding has already been completed, go to and click the Connect Stripe button.
Important
If you are testing Stripe (in test mode), change the State to Test Mode. We recommend doing this on a test Odoo database rather than on your main database.
Fill in your credentials¶
In case your API Credentials are required to connect with your Stripe account, these are the credentials that must be completed:
Publishable Key: The key solely used to identify the account with Stripe.
Secret Key: The key to sign the merchant account with Stripe.
Webhook Signing Secret: When you enable your webhook on your Stripe account, this signing secret must be set to authenticate the messages sent from Stripe to Odoo.
To retrieve the publishable and secret keys, follow this link to your API keys, or log into your Stripe dashboard and go to .
Generate a webhook¶
In case your Webhook Signing Secret is required to connect with your Stripe account, you can create a webhook either automatically or manually.
Make sure your Publishable and Secret keys are filled in, then click the Generate your Webhook button.
Tip
To update the webhook, click once again the Generate your Webhook button.
Visit the webhooks page on Stripe, or log into your Stripe dashboard and go to . Then, click Add endpoint and insert the following data in the Listen to Stripe events form:
- In the Endpoint URL field, enter your Odoo database’s URL followed by
/payment/stripe/webhook.For example:https://yourcompany.odoo.com/payment/stripe/webhook At the bottom of the form, click + Select events, then:
In the Charge section, select charge.refunded and charge.refund.updated.
In the Payment Intent section, select payment_intent.amount_capturable_updated, payment_intent.payment_failed and payment_intent.succeeded.
In the Setup Intent section, select setup_intent.succeeded.
Note
It is possible to select other events, but they are currently not processed by Odoo.
Once you have selected the events, click Add events, then Add endpoint to generate your webhook. Click Reveal to display your signing secret.
Tip
To update an existing webhook, click on it. Then, click the three dots at the right side of the Webhook URL and select Update details.
Configuration tab¶
Place a hold on a card¶
Stripe allows you to capture an amount manually instead of having an immediate capture. This feature earmarks an amount on the customer’s account for a determined period of time that depends on the payment method used.
To set it up, enable the Capture Amount Manually option in Odoo, as explained in the payment providers documentation.
Warning
When the manual capture feature is activated, your customers are not able to proceed with any payment if unsupported payment methods are selected.
Caution
Odoo doesn’t support the partial capture yet. Be aware that a partial capture from Stripe’s interface is still managed as a full capture by Odoo.
Enable local payment methods¶
Local payment methods are payment methods that are only available for certain merchants and customers countries and currencies.
Odoo supports the following local payment methods:
Bancontact
EPS
giropay
iDEAL
Przelewy24 (P24)
To enable some of these local payment methods with Stripe go to and add the desired payment methods in the Supported Payment Methods field. If the desired payment method is already listed, you don’t have anything to do.
Note
If a payment icon record does not exist in the database and its related local payment method is listed above, it is considered enabled with Stripe.
If a local payment method is not listed, it is not supported and cannot be enabled.
Enable express checkout¶
See also
After ticking the Allow Express Checkout checkbox, Google Pay is enabled out of the box, but Apple Pay requires extra steps: You must register your web domain with Apple. This can be done either automatically from Odoo, or manually from Stripe.
Navigate to your payment provider and make sure that it is enabled.
Go to the Configuration tab and click the Enable Apple Pay button. A notification shows that the web domain was successfully registered with Apple.
Visit the Apple pay web domains page on Stripe, or log into your Stripe dashboard and go to . Then, click Add new domain and insert the web domain of your Odoo database into the pop-up form. Odoo already hosts the verification file of Stripe. Click Add to register your web domain with Apple.
Important
This operation must be repeated whenever your web domain changes.
