NextERP/documentation
5
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[IMP] payment_acquirers: add tabs for Stripe

Browse Source 
task-2782290

closes odoo/documentation#1700

X-original-commit: 88752379bb
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Morgane Demesmaeker <edm@odoo.com>
This commit is contained in:
Demesmaeker 2022-03-01 15:23:46 +00:00
parent 51301eb432
commit dd89b2947c
1 changed files with 52 additions and 57 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

73
content/applications/finance/payment_acquirers/stripe.rst
View File

@ -5,22 +5,16 @@ Stripe
`Stripe <https://stripe.com/>`_ is a United States-based online payment solution provider, allowing `Stripe <https://stripe.com/>`_ is a United States-based online payment solution provider, allowing
businesses to accept **credit cards** and other payment methods. businesses to accept **credit cards** and other payment methods.
Configuration Link your Stripe Account with Odoo
============= ==================================
.. seealso:: .. seealso::
- :ref:`payment_acquirers/add_new` - :ref:`payment_acquirers/add_new`
Credentials tab
---------------
The method to acquire your credentials depends on your hosting type: The method to acquire your credentials depends on your hosting type:
- On Odoo Online, please follow the onboarding. .. tabs::
- On Odoo.sh and On-premise, extra steps are required. .. group-tab:: Odoo Online
Odoo Online
~~~~~~~~~~~
#. Go to the **eCommerce** or the **Sales** app and click on the *Activate Stripe* or the *Set #. Go to the **eCommerce** or the **Sales** app and click on the *Activate Stripe* or the *Set
payments* button on the onboarding banner. payments* button on the onboarding banner.
@ -28,26 +22,25 @@ Odoo Online
#. Confirm your email address when Stripe sends you a confirmation email. #. 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 #. 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 acquirer is enabled. information, you are all set and your payment acquirer is enabled.
#. Your can continue to :ref:`stripe/local-payment-methods`.
.. tip:: .. tip::
To connect your Stripe account after the onboarding is already completed, go to To use your own API keys, :ref:`activate the Developer mode <developer-mode>` and
:menuselection:`Accounting --> Configuration --> Payment Acquirers --> Stripe` and click on the :ref:`enable Stripe manually <payment_acquirers/add_new>`. You can then :ref:`Fill in your
*Connect Stripe* button. credentials <stripe/api_keys>`, :ref:`generate a webhook <stripe/webhook>` and enable the
payment acquirer.
.. tip:: .. group-tab:: Odoo.sh or On-premise
To use your own :ref:`API keys <stripe/api_keys>`, :ref:`activate the Developer mode
<developer-mode>` and :ref:`enable Stripe manually <payment_acquirers/add_new>`.
Odoo.sh or On-premise
~~~~~~~~~~~~~~~~~~~~~
#. Go to the **eCommerce** or the **Sales** app and click on the *Activate Stripe* or the *Set #. Go to the **eCommerce** or the **Sales** app and click on the *Activate Stripe* or the *Set
payments* button on the onboarding banner. payments* button on the onboarding banner.
#. Fill in the requested information and submit the form. #. Fill in the requested information and submit the form.
#. Confirm your email address when Stripe sends you a confirmation email. #. Confirm your email address when Stripe sends you a confirmation email.
#. At the end of the process, you are redirected to the payment acquirer **Stripe** on Odoo. #. At the end of the process, you are redirected to the payment acquirer **Stripe** on Odoo.
#. :ref:`Fill in your credentials <stripe/api_keys>` and :ref:`generate a webhook <stripe/webhook>`. #. :ref:`Fill in your credentials <stripe/api_keys>`.
Then, enable the payment acquirer. #. :ref:`Generate a webhook <stripe/webhook>`.
#. Enable the payment acquirer.
#. You are all set and can continue to :ref:`stripe/local-payment-methods`.
.. tip:: .. tip::
To connect your Stripe account after the onboarding is already completed, go to To connect your Stripe account after the onboarding is already completed, go to
@ -60,10 +53,11 @@ Odoo.sh or On-premise
.. _stripe/api_keys: .. _stripe/api_keys:
Publishable and Secret keys Fill in your credentials
~~~~~~~~~~~~~~~~~~~~~~~~~~~ ------------------------
Odoo needs your **API Credentials** to connect with your Stripe account, which comprises: In case your **API Credentials** are required to connect with your Stripe account, these are the
credentials that must be completed:
- :ref:`Publishable Key <stripe/api_keys>`: The key solely used to identify the account with Stripe. - :ref:`Publishable Key <stripe/api_keys>`: The key solely used to identify the account with Stripe.
- :ref:`Secret Key <stripe/api_keys>`: The key to sign the merchant account with Stripe. - :ref:`Secret Key <stripe/api_keys>`: The key to sign the merchant account with Stripe.
@ -76,25 +70,26 @@ To retrieve the publishable and secret keys, follow this `link to your API keys
.. _stripe/webhook: .. _stripe/webhook:
Webhook Signing Secret Generate a webhook
~~~~~~~~~~~~~~~~~~~~~~ ------------------
To retrieve the webhook signing secret, create a webhook either automatically or manually. In case your **Webhook Signing Secret** is required to connect with your Stripe account, you can
create a webhook either automatically or manually.
Create the webhook automatically .. tabs::
******************************** .. tab:: Create the webhook automatically
Make sure your :ref:`Publishable and Secret keys <stripe/api_keys>` are filled in, then click on the Make sure your :ref:`Publishable and Secret keys <stripe/api_keys>` are filled in, then click
*Generate your Webhook* button. on the *Generate your Webhook* button.
Create the webhook manually .. tab:: Create the webhook manually
***************************
Visit the `webhooks page on Stripe <https://dashboard.stripe.com/webhooks>`_, or log into your Visit the `webhooks page on Stripe <https://dashboard.stripe.com/webhooks>`_, or log into your
Stripe dashboard and go to :menuselection:`Developers --> Webhooks`. Then, click on **Add endpoint** Stripe dashboard and go to :menuselection:`Developers --> Webhooks`. Then, click on **Add
in your **Hosted endpoints** and insert the following data into the pop-up form: endpoint** in your **Hosted endpoints** and insert the following data into the pop-up form:
- | In the **Endpoint URL**, enter your Odoo database's URL followed by `/payment/stripe/webhook`. - | In the **Endpoint URL**, enter your Odoo database's URL followed by
| `/payment/stripe/webhook`.
| For example: `https://yourcompany.odoo.com/payment/stripe/webhook` | For example: `https://yourcompany.odoo.com/payment/stripe/webhook`
- At the end of the form, you can **Select events** to listen to. Click on it and, in the - At the end of the form, you can **Select events** to listen to. Click on it and, in the
**Checkout** section, select **checkout.session.completed**. **Checkout** section, select **checkout.session.completed**.
@ -102,13 +97,13 @@ in your **Hosted endpoints** and insert the following data into the pop-up form:
.. note:: .. note::
It is possible to select other events, but they are currently not processed by Odoo. It is possible to select other events, but they are currently not processed by Odoo.
When you click on **Add endpoint**, your Webhook is configured. You can then click on **reveal** to When you click on **Add endpoint**, your Webhook is configured. You can then click on
display your signing secret. **reveal** to display your signing secret.
.. _stripe/local-payment-methods: .. _stripe/local-payment-methods:
Enable local payment methods Enable local payment methods
---------------------------- ============================
Local payment methods are payment methods that are only available for certain merchants and Local payment methods are payment methods that are only available for certain merchants and
customers countries and currencies. customers countries and currencies.