a83d44239a
Changing the name of model payment.acquirer to payment.provider and everything that it touches. It is technically incorrect to use the term "acquirer" for systems that only provide a service of payment. After this commit the model payment.acquirer and everything related to it will be renamed to payment.provider. Task - 2842088 closes odoo/documentation#1981 Related: odoo/upgrade#3542 Related: odoo/odoo#90899 Related: odoo/enterprise#27131 Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
139 lines
4.9 KiB
ReStructuredText
139 lines
4.9 KiB
ReStructuredText
=====
|
|
Adyen
|
|
=====
|
|
|
|
`Adyen <https://www.adyen.com/>`_ is a Dutch company that offers several online payment
|
|
possibilities.
|
|
|
|
Configuration
|
|
=============
|
|
|
|
.. seealso::
|
|
:ref:`payment_providers/add_new`
|
|
|
|
Credentials tab
|
|
---------------
|
|
|
|
Odoo needs your **API Credentials** to connect with your Adyen account, which comprise:
|
|
|
|
- **Merchant Account**: The code of the merchant account to use with Adyen.
|
|
- :ref:`API Key <adyen/api_and_client_keys>`: The API key of the webservice user.
|
|
- :ref:`Client Key <adyen/api_and_client_keys>`: The client key of the webservice user.
|
|
- :ref:`HMAC Key <adyen/hmac_key>`: The HMAC key of the webhook.
|
|
- :ref:`Checkout API URL <adyen/urls>`: The base URL for the Checkout API endpoints.
|
|
- :ref:`Recurring API URL <adyen/urls>`: The base URL for the Recurring API endpoints.
|
|
|
|
You can copy your credentials from your Adyen account, and paste them in the related fields under
|
|
the **Credentials** tab.
|
|
|
|
.. important::
|
|
If you are trying Adyen as a test, with an Adyen *test account*, head to
|
|
:menuselection:`Accounting --> Configuration --> Payment Providers`. There, click on
|
|
:guilabel:`Adyen`, enable :guilabel:`Test Mode` and enter your credentials in the
|
|
:guilabel:`Credentials` tab.
|
|
|
|
.. _adyen/api_and_client_keys:
|
|
|
|
API Key and Client Key
|
|
~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
In order to retrieve the API Key and the Client Key, log into your Adyen account, go to
|
|
:menuselection:`Developers --> API Credentials`.
|
|
- If you already have an API user, open it.
|
|
- If you don't have an API user yet, click on **Create new credential**.
|
|
Go to :menuselection:`Server settings --> Authentification` and copy or generate your **API Key**.
|
|
Be careful to copy your API key as you'll not be allowed to get it later without generating a new
|
|
one.
|
|
|
|
Now, head to :menuselection:`Client settings --> Authentification` and cody or generate your
|
|
**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:
|
|
|
|
HMAC key
|
|
~~~~~~~~
|
|
|
|
In order to retrieve the HMAC Key, you'll need to configure a `Standard Notification` webhook. For
|
|
this, log into your Adyen account then go to :menuselection:`Developers --> Webhooks --> Add webhook
|
|
--> Add Standard notification`.
|
|
|
|
.. image:: adyen/adyen-add-webhook.png
|
|
:align: center
|
|
:alt: Configure a webhook.
|
|
|
|
There, in :menuselection:`General --> Server configuration --> URL`, enter your server address
|
|
followed by `/payment/adyen/notification`.
|
|
|
|
.. image:: adyen/adyen-webhook-url.png
|
|
:align: center
|
|
:alt: Enter the notification URL.
|
|
|
|
Then enter :menuselection:`Security --> HMAC Key --> Generate`. Be careful to copy the key as you
|
|
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.
|
|
|
|
.. _adyen/urls:
|
|
|
|
URLs
|
|
~~~~
|
|
|
|
To retrieve the URLs, log into your Adyen account, go to :menuselection:`Developers --> API URLs`.
|
|
Select one of the URLs listed next to :guilabel:`Classic Recurring API` as your
|
|
:guilabel:`Recurring API URL` and one listed next to :guilabel:`Checkout API` as your
|
|
:guilabel:`Checkout API URL`.
|
|
|
|
.. image:: adyen/adyen-api-urls.png
|
|
:align: center
|
|
:alt: Get the links for the different API.
|
|
|
|
Adyen Account
|
|
-------------
|
|
|
|
.. _adyen/allowed_origins:
|
|
|
|
Allow payments from a specific origin
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
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:`Add allowed origins`, then add the URLs from
|
|
where payments will be made (the URLs of the servers hosting your Odoo instances).
|
|
|
|
.. image:: adyen/adyen-allowed-origins.png
|
|
:align: center
|
|
:alt: Allows payments originated from a specific domain.
|
|
|
|
Place a hold on a card
|
|
----------------------
|
|
|
|
Adyen allows you to capture an amount manually instead of having an immediate capture.
|
|
|
|
To set it up, enable the **Capture Amount Manually** option on Odoo, as explained in the
|
|
:ref:`payment providers documentation <payment_providers/features/manual_capture>`.
|
|
|
|
Then, open your Adyen Merchant Account, go to :menuselection:`Account --> Settings`, and set the
|
|
**Capture Delay** to **manual**.
|
|
|
|
.. image:: adyen/adyen_capture_delay.png
|
|
:align: center
|
|
:alt: Capture Delay settings in Adyen
|
|
|
|
.. caution::
|
|
- If you configure Odoo to capture amounts manually, make sure to set the **Capture Delay** to
|
|
**manual** on Adyen. Otherwise, the transaction will be blocked in the authorized state in
|
|
Odoo.
|
|
- Odoo doesn't support the partial capture yet. Be aware that if you make a partial capture from
|
|
Adyen's interface, Odoo will manage it as if it was a full capture.
|
|
|
|
.. note::
|
|
After **7 days**, if the transaction hasn't been captured yet, the customer has the right to
|
|
**revoke** it.
|
|
|
|
.. seealso::
|
|
:doc:`../payment_providers`
|