Skip to content

Commit 646e5bc

Browse files
committed
[IMP] payment_providers/stripe: clarifications
task-4378942 closes #15471 X-original-commit: 1552795 Signed-off-by: Audrey Vandromme (auva) <auva@odoo.com>
1 parent 8969947 commit 646e5bc

File tree

1 file changed

+55
-63
lines changed
  • content/applications/finance/payment_providers

1 file changed

+55
-63
lines changed

content/applications/finance/payment_providers/stripe.rst

Lines changed: 55 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,18 @@ businesses to accept **credit cards** and other payment methods.
88
.. seealso::
99
- `List of countries supported by Stripe <https://stripe.com/global>`_
1010
- `List of payment methods supported by Stripe <https://stripe.com/payments/payment-methods>`_
11+
- :doc:`../payment_providers`
12+
- :doc:`Use Stripe as a payment terminal in Point of Sale
13+
<../../sales/point_of_sale/payment_methods/terminals/stripe>`
14+
15+
.. _payment_providers/stripe/create_account:
1116

1217
Create your Stripe account with Odoo
1318
====================================
1419

15-
The method to acquire your credentials depends on your hosting type:
20+
To create a new Stripe account and link it to your Odoo database, make sure the company's
21+
:guilabel:`Email` is configured in the :ref:`company's settings <general/companies/company>`, then
22+
follow the steps below according to your hosting type:
1623

1724
.. tabs::
1825
.. group-tab:: Odoo Online
@@ -32,88 +39,73 @@ The method to acquire your credentials depends on your hosting type:
3239
confirmation email.
3340
#. At the end of the process, click :guilabel:`Agree and submit`; you are then redirected to
3441
the payment provider **Stripe** in Odoo.
35-
#. :ref:`Fill in your credentials <stripe/api_keys>`.
36-
#. :ref:`Generate a webhook <stripe/webhook>`.
42+
#. :ref:`Fill in your credentials <payment_providers/stripe/manual_input>`.
3743
#. Set the :guilabel:`State` field to :guilabel:`Enabled`.
3844

3945
.. tip::
40-
- To use an existing Stripe account, :ref:`activate the Developer mode <developer-mode>` and
41-
:ref:`enable Stripe manually <payment_providers/add_new>`. You can then :ref:`Fill in your
42-
credentials <stripe/api_keys>`, :ref:`generate a webhook <stripe/webhook>`, and enable the
43-
payment provider.
44-
- You can also test Stripe using the :ref:`payment_providers/test-mode`. To do so, first,
45-
`log into your Stripe dashboard <https://dashboard.stripe.com/dashboard>`_ and switch to the
46-
**Test mode**. Then, in Odoo, :ref:`activate the Developer mode <developer-mode>`,
47-
:ref:`navigate to the payment provider Stripe <payment_providers/supported_providers>`,
48-
:ref:`fill in your API credentials <stripe/api_keys>` with the test keys, and set the
49-
:guilabel:`State` field to :guilabel:`Test Mode`.
46+
If you have created an account instead of :ref:`linking an existing one
47+
<payment_providers/stripe/manual_input>`, :ref:`enable the developer mode <developer-mode>`, then
48+
click :guilabel:`Reset your Stripe Account` on the Stripe payment provider form, then
49+
:ref:`fill in your Stripe account's credentials <payment_providers/stripe/manual_input>`.
50+
51+
.. _payment_providers/stripe/manual_input:
5052

51-
.. _stripe/api_keys:
53+
Manual credential input
54+
=======================
5255

53-
Fill in your credentials
54-
------------------------
56+
Manual credential input is needed, for example, when linking an existing Stripe account to your
57+
Odoo database, when using an account :ref:`created on Odoo.sh or On-premise
58+
<payment_providers/stripe/create_account>`, or when :ref:`testing Stripe without affecting live
59+
transactions <payment_providers/test-mode>`.
5560

56-
If your **API credentials** are required to connect with your Stripe account, proceed as follows:
61+
.. _payment_providers/stripe/stripe-configuration:
62+
63+
Stripe configuration
64+
--------------------
5765

5866
#. Go to `the API keys page on Stripe <https://dashboard.stripe.com/account/apikeys>`_, or log into
5967
your Stripe dashboard and go to :menuselection:`Developers --> API Keys`.
6068
#. In the :guilabel:`Standard keys` section, copy the :guilabel:`Publishable key` and the
6169
:guilabel:`Secret key` and save them for later.
62-
#. In Odoo, :ref:`navigate to the payment provider Stripe <payment_providers/supported_providers>`.
63-
#. In the :guilabel:`Credentials` tab, fill in the :guilabel:`Publishable Key` and
64-
:guilabel:`Secret Key` fields with the values you previously saved.
65-
66-
.. _stripe/webhook:
6770

68-
Generate a webhook
71+
Odoo configuration
6972
------------------
7073

71-
If your **Webhook Signing Secret** is required to connect with your Stripe account, you can create a
72-
webhook automatically or manually.
74+
#. :ref:`Enable the developer mode <developer-mode>`.
75+
#. :ref:`Navigate to the Stripe payment provider <payment_providers/supported_providers>`.
76+
#. In the :guilabel:`Credentials` tab, fill in the :guilabel:`Publishable Key` and
77+
:guilabel:`Secret Key` fields with the values you :ref:`previously saved
78+
<payment_providers/stripe/stripe-configuration>`.
79+
#. Click :guilabel:`Generate your webhook`.
80+
#. Configure the remaining options as needed.
81+
#. Set the :guilabel:`State` field to :guilabel:`Enabled`.
7382

74-
.. tabs::
75-
.. tab:: Create the webhook automatically
76-
77-
Make sure your :ref:`Publishable and Secret keys <stripe/api_keys>` are filled in, then click
78-
:guilabel:`Generate your webhook`.
79-
80-
.. tab:: Create the webhook manually
81-
82-
#. Go to the `Webhooks page on Stripe <https://dashboard.stripe.com/webhooks>`_, or log into
83-
your Stripe dashboard and go to :menuselection:`Developers --> Webhooks`.
84-
#. In the :guilabel:`Hosted endpoints` section, click :guilabel:`Add endpoint`. Then, in the
85-
:guilabel:`Endpoint URL` field, enter your Odoo database's URL, followed by
86-
`/payment/stripe/webhook`, e.g., `https://yourcompany.odoo.com/payment/stripe/webhook`.
87-
#. Click :guilabel:`Select events` at the bottom of the form, then select the following
88-
events:
89-
90-
- in the :guilabel:`Charge` section: :guilabel:`charge.refunded` and
91-
:guilabel:`charge.refund.updated`;
92-
- in the :guilabel:`Payment intent` section:
93-
:guilabel:`payment_intent.amount_capturable_updated`,
94-
:guilabel:`payment_intent.payment_failed`, :guilabel:`payment_intent.processing`, and
95-
:guilabel:`payment_intent.succeeded`;
96-
- in the :guilabel:`Setup intent` section: :guilabel:`setup_intent.succeeded`.
97-
98-
#. Click :guilabel:`Add events`.
99-
#. Click :guilabel:`Add endpoint`, then click :guilabel:`Reveal` and save your
100-
:guilabel:`Signing secret` for later.
101-
#. In Odoo, :ref:`navigate to the payment provider Stripe
102-
<payment_providers/supported_providers>`.
103-
#. In the :guilabel:`Credentials` tab, fill the :guilabel:`Webhook Signing Secret` field with
104-
the value you previously saved.
105-
106-
.. note::
107-
You can select other events, but they are currently not processed by Odoo.
83+
.. tip::
84+
- You can also test Stripe without affecting live transactions using the :ref:`test mode
85+
<payment_providers/test-mode>` and the :ref:`API keys
86+
<payment_providers/stripe/stripe-configuration>` of your `Stripe account's Test Mode or
87+
a sandbox environment <https://docs.stripe.com/testing-use-cases>`_.
88+
- To link the same Stripe account to :doc:`multiple companies
89+
</applications/general/companies/multi_company>` in a database, :ref:`create an account
90+
<payment_providers/stripe/create_account>` and :ref:`fill in the credentials
91+
<payment_providers/stripe/manual_input>` for one company, then reuse the same credentials and
92+
webhook for the others. To view the webhook, go to the `Webhooks page on Stripe
93+
<https://dashboard.stripe.com/webhooks>`_, or log into your Stripe dashboard and go to
94+
:menuselection:`Developers --> Webhooks`. Click the destination in the list, then click the
95+
:icon:`fa-eye` (:guilabel:`Reveal secret`) icon next to the :guilabel:`Signing secret`
96+
field and copy the value.
10897

10998
Enable Apple Pay
11099
================
111100

112-
To allow customers to use the Apple Pay button to pay their eCommerce orders, go to the
101+
To allow customers to use the Apple Pay button to pay for their eCommerce orders, :ref:`navigate to
102+
the Stripe payment provider <payment_providers/supported_providers>`, then go to the
113103
:guilabel:`Configuration` tab, enable :guilabel:`Allow Express Checkout`, and click
114104
:guilabel:`Enable Apple Pay`.
115105

116106
.. seealso::
117-
- :ref:`Express checkout and Google Pay <payment_providers/express_checkout>`
118-
- :doc:`../payment_providers`
119-
- :doc:`Use Stripe as a payment terminal in Point of Sale <../../sales/point_of_sale/payment_methods/terminals/stripe>`
107+
:ref:`Express checkout and Google Pay <payment_providers/express_checkout>`
108+
109+
.. tip::
110+
Stripe allows to :ref:`manually capture <payment_providers/manual_capture>` and :ref:`refund
111+
<payment_providers/refunds>` payments either from Odoo or directly from the Stripe dashboard.

0 commit comments

Comments
 (0)