[IMP] payment_acquirers/stripe: split authorization and capture

Add documentation about the manual capture for Stripe

task-2781377

closes odoo/documentation#1642

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
This commit is contained in:
Valentin Chevalier 2022-02-28 15:35:00 +00:00
parent e6d9a9dac2
commit c57decd8b0
2 changed files with 33 additions and 7 deletions

View File

@ -86,7 +86,7 @@ Online payment acquirers
| :doc:`SIPS | Redirection to the | | | | | :doc:`SIPS | Redirection to the | | | |
| <payment_acquirers/sips>` | acquirer website | | | | | <payment_acquirers/sips>` | acquirer website | | | |
+-------------------------------+----------------------+------------+-----------------+-----------+ +-------------------------------+----------------------+------------+-----------------+-----------+
| :doc:`Stripe | Redirection to the | |V| | | | | :doc:`Stripe | Redirection to the | |V| | |V| | |
| <payment_acquirers/stripe>` | acquirer website | | | | | <payment_acquirers/stripe>` | acquirer website | | | |
+-------------------------------+----------------------+------------+-----------------+-----------+ +-------------------------------+----------------------+------------+-----------------+-----------+

View File

@ -27,7 +27,7 @@ The method to acquire your credentials depends on your hosting type:
.. tip:: .. tip::
To use your own API keys, :ref:`activate the Developer mode <developer-mode>` and To use your own API keys, :ref:`activate the Developer mode <developer-mode>` and
:ref:`enable Stripe manually <payment_acquirers/add_new>`. You can then :ref:`Fill in your :ref:`enable Stripe manually <payment_acquirers/add_new>`. You can then :ref:`Fill in your
credentials <stripe/api_keys>`, :ref:`generate a webhook <stripe/webhook>` and enable the credentials <stripe/api-keys>`, :ref:`generate a webhook <stripe/webhook>` and enable the
payment acquirer. payment acquirer.
.. group-tab:: Odoo.sh or On-premise .. group-tab:: Odoo.sh or On-premise
@ -37,7 +37,7 @@ The method to acquire your credentials depends on your hosting type:
#. 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>`. #. :ref:`Fill in your credentials <stripe/api-keys>`.
#. :ref:`Generate a webhook <stripe/webhook>`. #. :ref:`Generate a webhook <stripe/webhook>`.
#. Enable the payment acquirer. #. Enable the payment acquirer.
#. You are all set and can continue to :ref:`stripe/local-payment-methods`. #. You are all set and can continue to :ref:`stripe/local-payment-methods`.
@ -51,7 +51,7 @@ The method to acquire your credentials depends on your hosting type:
If you are testing Stripe (in **test mode**), change the **State** to *Test Mode*. We recommend 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. doing this on a test Odoo database rather than on your main database.
.. _stripe/api_keys: .. _stripe/api-keys:
Fill in your credentials Fill in your credentials
------------------------ ------------------------
@ -59,8 +59,8 @@ Fill in your credentials
In case your **API Credentials** are required to connect with your Stripe account, these are the In case your **API Credentials** are required to connect with your Stripe account, these are the
credentials that must be completed: 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.
- :ref:`Webhook Signing Secret <stripe/webhook>`: When you enable your webhook on your 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. account, this signing secret must be set to authenticate the messages sent from Stripe to Odoo.
@ -79,7 +79,7 @@ create a webhook either automatically or manually.
.. tabs:: .. tabs::
.. tab:: Manage the webhook automatically .. tab:: Manage the webhook automatically
Make sure your :ref:`Publishable and Secret keys <stripe/api_keys>` are filled in, then click Make sure your :ref:`Publishable and Secret keys <stripe/api-keys>` are filled in, then click
on the :guilabel:`Generate your Webhook` button. on the :guilabel:`Generate your Webhook` button.
.. tip:: .. tip::
@ -113,6 +113,32 @@ create a webhook either automatically or manually.
To update an existing webhook, click on it. Then, click on the three dots at the right side To update an existing webhook, click on it. Then, click on the three dots at the right side
of the **Webhook URL** and on :guilabel:`Update details`. of the **Webhook URL** and on :guilabel:`Update details`.
Configuration tab
-----------------
.. _stripe/manual-capture:
Place a hold on a card
~~~~~~~~~~~~~~~~~~~~~~
Stripe allows you to **capture an amount manually** instead of having an immediate capture. This
feature earmarks an amount on the customer's account for a determined period of time that depends on
the payment method used.
To set it up, enable the :guilabel:`Capture Amount Manually` option on Odoo, as explained in the
:ref:`payment acquirers documentation <payment_acquirers/capture_amount>`.
.. warning::
When the manual capture feature is activated, your customers are not able to proceed with any
payment if unsupported payment methods are selected.
.. caution::
Odoo doesn't support the partial capture yet. Be aware that a partial capture from Stripe's
interface is still managed as a full capture by Odoo.
.. seealso::
- :doc:`../payment_acquirers`
.. _stripe/local-payment-methods: .. _stripe/local-payment-methods:
Enable local payment methods Enable local payment methods