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

[ADD] general/payment_acquirers: add doc on Stripe Webhook Setup

Browse Source 
and ease the way to get the api keys

task-2574512

closes odoo/documentation#1335

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
This commit is contained in:
Demesmaeker 2021-11-25 11:30:46 +00:00
parent 57e1e31433
commit 92ad3e8658
1 changed files with 37 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
content/applications/general/payment_acquirers/stripe.rst
View File

@ -14,23 +14,50 @@ Configuration
Credentials tab Credentials tab
--------------- ---------------
Odoo needs your **API Credentials** to connect with your Stripe account, which comprise: Odoo needs your **API Credentials** to connect with your Stripe account, which comprises:
- Publishable Key: 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.
- Secret Key: The key to sign the merchant account with Stripe. - :ref:`Secret Key <stripe/api_keys>`: The key to sign the merchant account with Stripe.
- Webhook Signing Secret: If a webhook is enabled on your Stripe account - :ref:`Webhook Signing Secret <stripe/webhook>`: When you enable your webhook on your Stripe
(:menuselection:`Developers --> webhooks`), this signing secret must be set to authenticate the account, this signing secret must be set to authenticate the messages sent from Stripe to Odoo.
messages sent from Stripe to Odoo.
To retrieve the publishable and secret keys, log into your Stripe dashboard and go to
:menuselection:`Developers --> API Keys --> Standard Keys`
.. important:: .. important::
If you are trying Stripe as a test, in the **test mode**, change the **State** to *Test If you are trying Stripe as a test, in the **test mode**, change the **State** to *Test
Mode*. We recommend doing this on a test Odoo database, rather than on your main database. Mode*. We recommend doing this on a test Odoo database, rather than on your main database.
.. _stripe/api_keys:
Publishable and Secret keys
~~~~~~~~~~~~~~~~~~~~~~~~~~~
To retrieve the publishable and secret keys, follow this `link to your API keys
<https://dashboard.stripe.com/account/apikeys>`_, or log into your Stripe dashboard and go to
:menuselection:`Developers --> API Keys --> Standard Keys`.
.. _stripe/webhook:
Webhook Signing Secret
~~~~~~~~~~~~~~~~~~~~~~
To retrieve the webhook signing secret, you first need to create a webhook.
To do so, follow this `link to your webhooks <https://dashboard.stripe.com/webhooks>`_, or log into
your Stripe dashboard and go to :menuselection:`Developers --> Webhooks`. Then, click on **Add
endpoint** in your **Hosted endpoints**. A form opens, where you'll need to add the following data:
- | In the **Endpoint URL**, enter your Odoo database's URL followed by ``/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
**Checkout** section, select **checkout.session.completed**.
.. note::
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
display your signing secret.
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.