Skip to content

Commit dd89b29

Browse files
committed
[IMP] payment_acquirers: add tabs for Stripe
task-2782290 closes #1700 X-original-commit: 8875237 Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com> Signed-off-by: Morgane Demesmaeker <edm@odoo.com>
1 parent 51301eb commit dd89b29

File tree

1 file changed

+56
-61
lines changed
  • content/applications/finance/payment_acquirers

1 file changed

+56
-61
lines changed

content/applications/finance/payment_acquirers/stripe.rst

Lines changed: 56 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -5,49 +5,42 @@ Stripe
55
`Stripe <https://stripe.com/>`_ is a United States-based online payment solution provider, allowing
66
businesses to accept **credit cards** and other payment methods.
77

8-
Configuration
9-
=============
8+
Link your Stripe Account with Odoo
9+
==================================
1010

1111
.. seealso::
1212
- :ref:`payment_acquirers/add_new`
1313

14-
Credentials tab
15-
---------------
16-
1714
The method to acquire your credentials depends on your hosting type:
1815

19-
- On Odoo Online, please follow the onboarding.
20-
- On Odoo.sh and On-premise, extra steps are required.
21-
22-
Odoo Online
23-
~~~~~~~~~~~
24-
25-
#. Go to the **eCommerce** or the **Sales** app and click on the *Activate Stripe* or the *Set
26-
payments* button on the onboarding banner.
27-
#. Fill in the requested information and submit the form.
28-
#. Confirm your email address when Stripe sends you a confirmation email.
29-
#. At the end of the process, you are redirected to Odoo. If you submitted all the requested
30-
information, you are all set and your payment acquirer is enabled.
31-
32-
.. tip::
33-
To connect your Stripe account after the onboarding is already completed, go to
34-
:menuselection:`Accounting --> Configuration --> Payment Acquirers --> Stripe` and click on the
35-
*Connect Stripe* button.
36-
37-
.. tip::
38-
To use your own :ref:`API keys <stripe/api_keys>`, :ref:`activate the Developer mode
39-
<developer-mode>` and :ref:`enable Stripe manually <payment_acquirers/add_new>`.
40-
41-
Odoo.sh or On-premise
42-
~~~~~~~~~~~~~~~~~~~~~
43-
44-
#. Go to the **eCommerce** or the **Sales** app and click on the *Activate Stripe* or the *Set
45-
payments* button on the onboarding banner.
46-
#. Fill in the requested information and submit the form.
47-
#. Confirm your email address when Stripe sends you a confirmation email.
48-
#. At the end of the process, you are redirected to the payment acquirer **Stripe** on Odoo.
49-
#. :ref:`Fill in your credentials <stripe/api_keys>` and :ref:`generate a webhook <stripe/webhook>`.
50-
Then, enable the payment acquirer.
16+
.. tabs::
17+
.. group-tab:: Odoo Online
18+
19+
#. Go to the **eCommerce** or the **Sales** app and click on the *Activate Stripe* or the *Set
20+
payments* button on the onboarding banner.
21+
#. Fill in the requested information and submit the form.
22+
#. Confirm your email address when Stripe sends you a confirmation email.
23+
#. At the end of the process, you are redirected to Odoo. If you submitted all the requested
24+
information, you are all set and your payment acquirer is enabled.
25+
#. Your can continue to :ref:`stripe/local-payment-methods`.
26+
27+
.. tip::
28+
To use your own API keys, :ref:`activate the Developer mode <developer-mode>` and
29+
:ref:`enable Stripe manually <payment_acquirers/add_new>`. You can then :ref:`Fill in your
30+
credentials <stripe/api_keys>`, :ref:`generate a webhook <stripe/webhook>` and enable the
31+
payment acquirer.
32+
33+
.. group-tab:: Odoo.sh or On-premise
34+
35+
#. Go to the **eCommerce** or the **Sales** app and click on the *Activate Stripe* or the *Set
36+
payments* button on the onboarding banner.
37+
#. Fill in the requested information and submit the form.
38+
#. Confirm your email address when Stripe sends you a confirmation email.
39+
#. At the end of the process, you are redirected to the payment acquirer **Stripe** on Odoo.
40+
#. :ref:`Fill in your credentials <stripe/api_keys>`.
41+
#. :ref:`Generate a webhook <stripe/webhook>`.
42+
#. Enable the payment acquirer.
43+
#. You are all set and can continue to :ref:`stripe/local-payment-methods`.
5144

5245
.. tip::
5346
To connect your Stripe account after the onboarding is already completed, go to
@@ -60,10 +53,11 @@ Odoo.sh or On-premise
6053

6154
.. _stripe/api_keys:
6255

63-
Publishable and Secret keys
64-
~~~~~~~~~~~~~~~~~~~~~~~~~~~
56+
Fill in your credentials
57+
------------------------
6558

66-
Odoo needs your **API Credentials** to connect with your Stripe account, which comprises:
59+
In case your **API Credentials** are required to connect with your Stripe account, these are the
60+
credentials that must be completed:
6761

6862
- :ref:`Publishable Key <stripe/api_keys>`: The key solely used to identify the account with Stripe.
6963
- :ref:`Secret Key <stripe/api_keys>`: The key to sign the merchant account with Stripe.
@@ -76,39 +70,40 @@ To retrieve the publishable and secret keys, follow this `link to your API keys
7670

7771
.. _stripe/webhook:
7872

79-
Webhook Signing Secret
80-
~~~~~~~~~~~~~~~~~~~~~~
73+
Generate a webhook
74+
------------------
8175

82-
To retrieve the webhook signing secret, create a webhook either automatically or manually.
76+
In case your **Webhook Signing Secret** is required to connect with your Stripe account, you can
77+
create a webhook either automatically or manually.
8378

84-
Create the webhook automatically
85-
********************************
79+
.. tabs::
80+
.. tab:: Create the webhook automatically
8681

87-
Make sure your :ref:`Publishable and Secret keys <stripe/api_keys>` are filled in, then click on the
88-
*Generate your Webhook* button.
82+
Make sure your :ref:`Publishable and Secret keys <stripe/api_keys>` are filled in, then click
83+
on the *Generate your Webhook* button.
8984

90-
Create the webhook manually
91-
***************************
85+
.. tab:: Create the webhook manually
9286

93-
Visit the `webhooks page on Stripe <https://dashboard.stripe.com/webhooks>`_, or log into your
94-
Stripe dashboard and go to :menuselection:`Developers --> Webhooks`. Then, click on **Add endpoint**
95-
in your **Hosted endpoints** and insert the following data into the pop-up form:
87+
Visit the `webhooks page on Stripe <https://dashboard.stripe.com/webhooks>`_, or log into your
88+
Stripe dashboard and go to :menuselection:`Developers --> Webhooks`. Then, click on **Add
89+
endpoint** in your **Hosted endpoints** and insert the following data into the pop-up form:
9690

97-
- | In the **Endpoint URL**, enter your Odoo database's URL followed by `/payment/stripe/webhook`.
98-
| For example: `https://yourcompany.odoo.com/payment/stripe/webhook`
99-
- At the end of the form, you can **Select events** to listen to. Click on it and, in the
100-
**Checkout** section, select **checkout.session.completed**.
91+
- | In the **Endpoint URL**, enter your Odoo database's URL followed by
92+
| `/payment/stripe/webhook`.
93+
| For example: `https://yourcompany.odoo.com/payment/stripe/webhook`
94+
- At the end of the form, you can **Select events** to listen to. Click on it and, in the
95+
**Checkout** section, select **checkout.session.completed**.
10196

102-
.. note::
103-
It is possible to select other events, but they are currently not processed by Odoo.
97+
.. note::
98+
It is possible to select other events, but they are currently not processed by Odoo.
10499

105-
When you click on **Add endpoint**, your Webhook is configured. You can then click on **reveal** to
106-
display your signing secret.
100+
When you click on **Add endpoint**, your Webhook is configured. You can then click on
101+
**reveal** to display your signing secret.
107102

108103
.. _stripe/local-payment-methods:
109104

110105
Enable local payment methods
111-
----------------------------
106+
============================
112107

113108
Local payment methods are payment methods that are only available for certain merchants and
114109
customers countries and currencies.

0 commit comments

Comments
 (0)