[IMP] accounting: Adyen's backend changes for the webhook creation

Adyen's backend had slightly changed and the previous doc version was outdated (URL and HMAC key fields)

task - 2810213

closes odoo/documentation#2356

X-original-commit: da87312821
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
This commit is contained in:
Tom Aarab (toaa) 2022-06-17 08:05:53 +00:00
parent 51dd489f62
commit 84b6213eec
10 changed files with 29 additions and 20 deletions

View File

@ -2,14 +2,14 @@
Adyen Adyen
===== =====
`Adyen <https://www.adyen.com/>`_ is a Dutch-based company that offers several online payment `Adyen <https://www.adyen.com/>`_ is a Dutch company that offers several online payment
possibilities. possibilities.
Configuration Configuration
============= =============
.. seealso:: .. seealso::
- :ref:`payment_acquirers/add_new` :ref:`payment_acquirers/add_new`
Credentials tab Credentials tab
--------------- ---------------
@ -27,8 +27,10 @@ You can copy your credentials from your Adyen account, and paste them in the rel
the **Credentials** tab. the **Credentials** tab.
.. important:: .. important::
If you are trying Adyen as a test, with a *test account*, change the **State** to *Test Mode*. We If you are trying Adyen as a test, with an Adyen *test account*, head to
recommend doing this on a test Odoo database, rather than on your main database. :menuselection:`Accounting --> Configuration --> Payment Acquirers`. There, click on
:guilabel:`Adyen`, enable :guilabel:`Test Mode` and enter your credentials in the
:guilabel:`Credentials` tab.
.. _adyen/api_and_client_keys: .. _adyen/api_and_client_keys:
@ -39,11 +41,13 @@ In order to retrieve the API Key and the Client Key, log into your Adyen account
:menuselection:`Developers --> API Credentials`. :menuselection:`Developers --> API Credentials`.
- If you already have an API user, open it. - If you already have an API user, open it.
- If you don't have an API user yet, click on **Create new credential**. - If you don't have an API user yet, click on **Create new credential**.
Go to :menuselection:`Authentication` and get or generate your **API Key** and **Client Key**. Be Go to :menuselection:`Server settings --> Authentification` and copy or generate your **API Key**.
careful to copy your API key as you'll not be allowed to get it later without generating a new one. Be careful to copy your API key as you'll not be allowed to get it later without generating a new
one.
This is also the place where you'll :ref:`allow payments to be made from your website Now, head to :menuselection:`Client settings --> Authentification` and cody or generate your
<adyen/allowed_origins>`. **Client Key**. This is also the place where you can :ref:`allow payments to be made from your
website <adyen/allowed_origins>`.
.. _adyen/hmac_key: .. _adyen/hmac_key:
@ -54,19 +58,23 @@ In order to retrieve the HMAC Key, you'll need to configure a `Standard Notifica
this, log into your Adyen account then go to :menuselection:`Developers --> Webhooks --> Add webhook this, log into your Adyen account then go to :menuselection:`Developers --> Webhooks --> Add webhook
--> Add Standard notification`. --> Add Standard notification`.
.. image:: adyen/adyen_add_webhook.png .. image:: adyen/adyen-add-webhook.png
:align: center :align: center
:alt: Configure a webhook. :alt: Configure a webhook.
There, in :menuselection:`Transport --> URL`, enter your server address followed by There, in :menuselection:`General --> Server configuration --> URL`, enter your server address
`/payment/adyen/notification`. followed by `/payment/adyen/notification`.
.. image:: adyen/adyen_webhook_url.png .. image:: adyen/adyen-webhook-url.png
:align: center :align: center
:alt: Enter the notification URL. :alt: Enter the notification URL.
Then continue in :menuselection:`Additional Settings --> HMAC Key --> Generate new HMAC key`. Be Then enter :menuselection:`Security --> HMAC Key --> Generate`. Be careful to copy the key as you
careful to copy it as you'll not be allowed to get it later without generating a new one. will not be allowed to do it later without generating a new one.
.. image:: adyen/adyen-hmac-key.png
:align: center
:alt: Generate a HMAC key and save it.
You have to save the webhook to finalize its creation. You have to save the webhook to finalize its creation.
@ -76,10 +84,11 @@ URLs
~~~~ ~~~~
To retrieve the URLs, log into your Adyen account, go to :menuselection:`Developers --> API URLs`. To retrieve the URLs, log into your Adyen account, go to :menuselection:`Developers --> API URLs`.
Pick one of the URLs listed next to **Recurring** as your **Recurring API URL** and one of the URLs Select one of the URLs listed next to :guilabel:`Classic Recurring API` as your
listed next to **Checkout API** as your **Checkout API URL**. :guilabel:`Recurring API URL` and one listed next to :guilabel:`Checkout API` as your
:guilabel:`Checkout API URL`.
.. image:: adyen/adyen_api_urls.png .. image:: adyen/adyen-api-urls.png
:align: center :align: center
:alt: Get the links for the different API. :alt: Get the links for the different API.
@ -92,10 +101,10 @@ Allow payments from a specific origin
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
To allow payment originated from your website, follow the steps in :ref:`adyen/api_and_client_keys` To allow payment originated from your website, follow the steps in :ref:`adyen/api_and_client_keys`
to navigate to your API user and go to :menuselection:`Allowed Origins`, then add the URLs from to navigate to your API user and go to :menuselection:`Add allowed origins`, then add the URLs from
where payments will be made (the URLs of the servers hosting your Odoo instances). where payments will be made (the URLs of the servers hosting your Odoo instances).
.. image:: adyen/adyen_allowed_origins.png .. image:: adyen/adyen-allowed-origins.png
:align: center :align: center
:alt: Allows payments originated from a specific domain. :alt: Allows payments originated from a specific domain.
@ -126,4 +135,4 @@ Then, open your Adyen Merchant Account, go to :menuselection:`Account --> Settin
**revoke** it. **revoke** it.
.. seealso:: .. seealso::
- :doc:`../payment_acquirers` :doc:`../payment_acquirers`

Binary file not shown.

After

Width:  |  Height:  |  Size: 7.7 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 7.0 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 29 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 8.2 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 13 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 3.6 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 15 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 4.0 KiB