[IMP] payment_providers/stripe: improve structure and add Enable Apple Pay button
task-3697828
closes odoo/documentation#7682
X-original-commit: 1bc080ed36
Signed-off-by: Audrey Vandromme (auva) <auva@odoo.com>
This commit is contained in:
“Audrey
parent
48bfcc6d93
commit
d4d62b6967
@ -2,101 +2,114 @@
|
||||
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.
|
||||
|
||||
Link your Stripe Account with Odoo
|
||||
==================================
|
||||
|
||||
.. seealso::
|
||||
- :ref:`payment_providers/add_new`
|
||||
Create your Stripe account with Odoo
|
||||
====================================
|
||||
|
||||
The method to acquire your credentials depends on your hosting type:
|
||||
|
||||
.. tabs::
|
||||
.. group-tab:: Odoo Online
|
||||
|
||||
#. Go to the **eCommerce** or the **Sales** app and click on 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.
|
||||
|
||||
.. tip::
|
||||
To use your own API keys, :ref:`activate the Developer mode <developer-mode>` and
|
||||
:ref:`enable Stripe manually <payment_providers/add_new>`. You can then :ref:`Fill in your
|
||||
credentials <stripe/api_keys>`, :ref:`generate a webhook <stripe/webhook>` and enable the
|
||||
payment provider.
|
||||
#. :ref:`Navigate to the payment provider Stripe <payment_providers/supported_providers>` and
|
||||
click :guilabel:`Connect Stripe`.
|
||||
#. Go through the setup process and confirm your email address when Stripe sends you a
|
||||
confirmation email.
|
||||
#. At the end of the process, click :guilabel:`Agree and submit`. If all requested information
|
||||
has been submitted, you are then redirected to Odoo, and your payment provider is enabled.
|
||||
|
||||
.. group-tab:: Odoo.sh or On-premise
|
||||
|
||||
#. Go to the **eCommerce** or the **Sales** app and click on 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** on Odoo.
|
||||
#. :ref:`Navigate to the payment provider Stripe <payment_providers/supported_providers>` and
|
||||
click :guilabel:`Connect Stripe`.
|
||||
#. Go through the setup process and confirm your email address when Stripe sends you a
|
||||
confirmation email.
|
||||
#. At the end of the process, click :guilabel:`Agree and submit`; you are then redirected to
|
||||
the payment provider **Stripe** in Odoo.
|
||||
#. :ref:`Fill in your credentials <stripe/api_keys>`.
|
||||
#. :ref:`Generate a webhook <stripe/webhook>`.
|
||||
#. Enable the payment provider.
|
||||
#. Set the :guilabel:`State` field to :guilabel:`Enabled`.
|
||||
|
||||
.. tip::
|
||||
To connect your Stripe account after the onboarding is already completed, go to
|
||||
:menuselection:`Accounting --> Configuration --> Payment Providers --> Stripe` and click on 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.
|
||||
- To use an existing Stripe account, :ref:`activate the Developer mode <developer-mode>` and
|
||||
:ref:`enable Stripe manually <payment_providers/add_new>`. You can then :ref:`Fill in your
|
||||
credentials <stripe/api_keys>`, :ref:`generate a webhook <stripe/webhook>`, and enable the
|
||||
payment provider.
|
||||
- You can also test Stripe using the :ref:`payment_providers/test-mode`. To do so, first,
|
||||
`log into your Stripe dashboard <https://dashboard.stripe.com/dashboard>`_ and switch to the
|
||||
**Test mode**. Then, in Odoo, :ref:`activate the Developer mode <developer-mode>`,
|
||||
:ref:`navigate to the payment provider Stripe <payment_providers/supported_providers>`,
|
||||
:ref:`fill in your API credentials <stripe/api_keys>` with the test keys, and set the
|
||||
:guilabel:`State` field to :guilabel:`Test Mode`.
|
||||
|
||||
.. _stripe/api_keys:
|
||||
|
||||
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:
|
||||
If your **API credentials** are required to connect with your Stripe account, proceed as follows:
|
||||
|
||||
- :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:`Webhook Signing Secret <stripe/webhook>`: 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
|
||||
<https://dashboard.stripe.com/account/apikeys>`_, or log into your Stripe dashboard and go to
|
||||
:menuselection:`Developers --> API Keys --> Standard Keys`.
|
||||
#. Go to `the API keys page on Stripe <https://dashboard.stripe.com/account/apikeys>`_, or log into
|
||||
your Stripe dashboard and go to :menuselection:`Developers --> API Keys`.
|
||||
#. In the :guilabel:`Standard keys` section, copy the :guilabel:`Publishable key` and the
|
||||
:guilabel:`Secret key` and save them for later.
|
||||
#. In Odoo, :ref:`navigate to the payment provider Stripe <payment_providers/supported_providers>`.
|
||||
#. In the :guilabel:`Credentials` tab, fill in the :guilabel:`Publishable Key` and
|
||||
:guilabel:`Secret Key` fields with the values you previously saved.
|
||||
|
||||
.. _stripe/webhook:
|
||||
|
||||
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.
|
||||
If your **Webhook Signing Secret** is required to connect with your Stripe account, you can create a
|
||||
webhook automatically or manually.
|
||||
|
||||
.. tabs::
|
||||
.. tab:: Create the webhook automatically
|
||||
|
||||
Make sure your :ref:`Publishable and Secret keys <stripe/api_keys>` are filled in, then click
|
||||
on the *Generate your Webhook* button.
|
||||
:guilabel:`Generate your webhook`.
|
||||
|
||||
.. tab:: Create the webhook manually
|
||||
|
||||
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** in your **Hosted endpoints** and insert the following data into the pop-up form:
|
||||
#. Go to the `Webhooks page on Stripe <https://dashboard.stripe.com/webhooks>`_, or log into
|
||||
your Stripe dashboard and go to :menuselection:`Developers --> Webhooks`.
|
||||
#. In the :guilabel:`Hosted endpoints` section, click :guilabel:`Add endpoint`. Then, in the
|
||||
:guilabel:`Endpoint URL` field, enter your Odoo database's URL, followed by
|
||||
`/payment/stripe/webhook`, e.g., `https://yourcompany.odoo.com/payment/stripe/webhook`.
|
||||
#. Click :guilabel:`Select events` at the bottom of the form, then select the following
|
||||
events:
|
||||
|
||||
- | 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**.
|
||||
- in the :guilabel:`Charge` section: :guilabel:`charge.refunded` and
|
||||
:guilabel:`charge.refund.updated`;
|
||||
- in the :guilabel:`Payment intent` section:
|
||||
:guilabel:`payment_intent.amount_capturable_updated`,
|
||||
:guilabel:`payment_intent.payment_failed`, :guilabel:`payment_intent.processing`, and
|
||||
:guilabel:`payment_intent.succeeded`;
|
||||
- in the :guilabel:`Setup intent` section: :guilabel:`setup_intent.succeeded`.
|
||||
|
||||
.. note::
|
||||
It is possible to select other events, but they are currently not processed by Odoo.
|
||||
#. Click :guilabel:`Add events`.
|
||||
#. Click :guilabel:`Add endpoint`, then click :guilabel:`Reveal` and save your
|
||||
:guilabel:`Signing secret` for later.
|
||||
#. In Odoo, :ref:`navigate to the payment provider Stripe
|
||||
<payment_providers/supported_providers>`.
|
||||
#. In the :guilabel:`Credentials` tab, fill the :guilabel:`Webhook Signing Secret` field with
|
||||
the value you previously saved.
|
||||
|
||||
When you click on **Add endpoint**, your Webhook is configured. You can then click on
|
||||
**reveal** to display your signing secret.
|
||||
.. note::
|
||||
You can select other events, but they are currently not processed by Odoo.
|
||||
|
||||
Enable Apple Pay
|
||||
================
|
||||
|
||||
To allow customers to use the Apple Pay button to pay their eCommerce orders, go to the
|
||||
:guilabel:`Configuration` tab, enable :guilabel:`Allow Express Checkout`, and click
|
||||
:guilabel:`Enable Apple Pay`.
|
||||
|
||||
.. seealso::
|
||||
- :ref:`Express checkout and Google Pay <payment_providers/express_checkout>`
|
||||
- :doc:`../payment_providers`
|
||||
- :doc:`Use Stripe as a payment terminal in Point of Sale <../../sales/point_of_sale/payment_methods/terminals/stripe>`
|
||||
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 11 KiB |
Loading…
Reference in New Issue
Block a user