[IMP] POS: path to configure payment terminals

task-3684488

closes odoo/documentation#7606

X-original-commit: d16864d586
Signed-off-by: Loredana Perazzo (lrpz) <lrpz@odoo.com>
This commit is contained in:
Loredana Perazzo 2024-01-25 11:21:46 +01:00
parent f07ce400b0
commit deecd2ae21
12 changed files with 68 additions and 66 deletions

View File

@ -7,11 +7,13 @@ Payment terminals
Connecting and integrating a payment terminal with your POS system allows you to accept multiple
payment options, including credit and debit cards, making the payment process more efficient.
.. _terminals/configuration:
Configuration
=============
Go to the :doc:`application settings <../configuration>`, scroll down to the :guilabel:`Payment
Terminals` section, and tick your terminal's checkbox.
Go to the :ref:`application settings <configuration/settings>`, scroll down to the
:guilabel:`Payment Terminals` section, and tick your terminal's checkbox.
.. image:: terminals/settings-pt.png
:alt: checkbox in the settings to enable a payment terminal

View File

@ -19,66 +19,65 @@ your terminal following the steps described on your terminal's screen.
- `Adyen Docs - Payment terminal quickstart guides
<https://docs.adyen.com/point-of-sale/user-manuals>`_.
Configure the payment method
----------------------------
First, go to :menuselection:`Point of Sale --> Configuration --> Settings --> Payment Terminals`,
and enable :guilabel:`Adyen`.
Then, go to :menuselection:`Configuration --> Payment Methods` and create a new payment method.
Select :guilabel:`Adyen` in the :guilabel:`Use a Payment Terminal` field.
.. note::
The selected journal **must** be a bank journal for the :guilabel:`Use a payment terminal` field
to appear.
Finally, fill the mandatory fields with an :guilabel:`Adyen API key`, and an :guilabel:`Adyen
Terminal Identifier`.
.. _adyen/api:
Generate an Adyen API key
~~~~~~~~~~~~~~~~~~~~~~~~~
-------------------------
The **Adyen API key** is a key used to authenticate your requests. To generate an API key, go to
your **Adyen account**.
Then, go to :menuselection:`Developers --> API credentials`. Create a new credential or click on an
existing one.
Click on :guilabel:`Generate an API key` and copy-paste that key onto the Odoo mandatory field.
The **Adyen API key** is used to authenticate requests from your Adyen terminal. To generate an API
key, go to your :menuselection:`Adyen account --> Developers --> API credentials`, and **create**
new credentials or select **existing** ones. Click :guilabel:`Generate an API key` and save the key
to paste it into the Odoo :guilabel:`Adyen API key` field at :ref:`the payment method creation
<adyen/method-creation>`.
.. seealso::
- `Adyen Docs - API credentials
<https://docs.adyen.com/development-resources/api-credentials#generate-api-key>`_.
Locate the Adyen terminal identifier
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. _adyen/identifier:
The **Adyen Terminal Identifier** is your terminal's serial number, which is used to identify the
Locate the Adyen terminal identifier
------------------------------------
The **Adyen Terminal Identifier** is the terminal's serial number, which is used to identify the
hardware.
To find this number, go to your **Adyen account**. Then, go to :menuselection:`Point of Sale
--> Terminals`, select the terminal to link, and copy-paste its serial number onto the Odoo
mandatory field.
To find this number, go to your :menuselection:`Adyen account --> Point of Sale --> Terminals`,
select the terminal to link with, and save its serial number to paste it into the Odoo
:guilabel:`Adyen Terminal Identifier` field at :ref:`the payment method creation
<adyen/method-creation>`.
Set the Event URLs
~~~~~~~~~~~~~~~~~~
------------------
For Odoo to know when a payment is made, you must set the terminal **Event URLs**. To do so,
For Odoo to know when a payment is made, you must configure the terminal **Event URLs**. To do so,
#. log in to `Adyen's website <https://www.adyen.com/>`_;
#. go to :menuselection:`Adyen's dashboard --> Point of Sale --> Terminals` and select the connected
#. Log in to `Adyen's website <https://www.adyen.com/>`_;
#. Go to :menuselection:`Adyen's dashboard --> Point of Sale --> Terminals` and select the connected
terminal;
#. from the terminal settings, click :guilabel:`Integrations`;
#. set the :guilabel:`Switch to decrypted mode to edit this setting` field as :guilabel:`Decrypted`;
#. click the **pencil icon** button and enter your server address, followed by
`/pos_adyen/notification` in the :guilabel:`Event URLs` field; and
#. click :guilabel:`Save` at the bottom of the screen to save the changes.
#. From the terminal settings, click :guilabel:`Integrations`;
#. Set the :guilabel:`Switch to decrypted mode to edit this setting` field as :guilabel:`Decrypted`;
#. Click the **pencil icon** button and enter your server address, followed by
`/pos_adyen/notification` in the :guilabel:`Event URLs` field;
#. Click :guilabel:`Save` at the bottom of the screen to save changes.
Add a new payment method
========================
.. _adyen/method-creation:
To add a new **payment method** to a point of sale, go to :menuselection:`Point of Sale -->
Configuration --> Point of Sale`. Then, select the POS and go to :menuselection:`Payments -->
Payment Methods`, and add your new method for Adyen.
Configure the payment method
----------------------------
Enable the payment terminal :ref:`in the application settings <configuration/settings>` and
:doc:`create the related payment method <../../payment_methods>`. Set the journal type as
:guilabel:`Bank` and select :guilabel:`Adyen` in the :guilabel:`Use a Payment Terminal` field.
Finally, fill in the mandatory fields with your :ref:`Adyen API key <adyen/api>`, :ref:`Adyen
Terminal Identifier <adyen/identifier>`, and :guilabel:`Adyen Merchant Account`.
.. image:: adyen/payment-method.png
Once the payment method is created, you can select it in your POS settings. To do so, go to the
:ref:`POS' settings <configuration/settings>`, click :guilabel:`Edit`, and add the payment method
under the :guilabel:`Payments` section.
Pay with a payment terminal
===========================

Binary file not shown.

After

Width:  |  Height:  |  Size: 20 KiB

View File

@ -35,19 +35,16 @@ Box* (you can find it on the form view of your IoT Box). Then, enter
Configure the payment method
----------------------------
First, go in the general settings of the POS app, and activate the
Ingenico setting.
Enable the payment terminal :ref:`in the application settings <configuration/settings>` and
:doc:`create the related payment method <../../payment_methods>`. Set the journal type as
:guilabel:`Bank` and select :guilabel:`Ingenico` in the :guilabel:`Use a Payment Terminal` field.
Then, select your terminal device in the :guilabel:`Payment Terminal Device` field.
.. image:: ingenico/payment_terminal_03.png
:align: center
.. image:: ingenico/payment-method.png
Go back in :menuselection:`Point of Sale --> Configuration --> Point of Sale`,
go in the payments section and access your payment methods. Create a new
payment method for Ingenico, select the payment terminal option Ingenico, and
select your payment terminal device.
.. image:: ingenico/payment_terminal_04.png
:align: center
Once the payment method is created, you can select it in your POS settings. To do so, go to the
:ref:`POS' settings <configuration/settings>`, click :guilabel:`Edit`, and add the payment method
under the :guilabel:`Payments` section.
Pay with a payment terminal
===========================

Binary file not shown.

After

Width:  |  Height:  |  Size: 18 KiB

View File

@ -52,15 +52,18 @@ homepage under the :guilabel:`Payments` section to confirm the connection.
Configure the payment method
----------------------------
From your database, go to :menuselection:`Point of Sale --> Configuration --> Payment Methods` to
create a new payment method specifically for Six. Click :guilabel:`New`, enter a :guilabel:`Name`,
set the :guilabel:`Journal` field as :guilabel:`Bank`, the :guilabel:`Use a Payment Terminal` field
as :guilabel:`SIX IOT`, and select the corresponding device in the :guilabel:`Payment Terminal
Device` field.
Enable the payment terminal :ref:`in the application settings <configuration/settings>` and
:doc:`create the related payment method <../../payment_methods>`. Set the journal type as
:guilabel:`Bank` and select :guilabel:`SIX IOT` in the :guilabel:`Use a Payment Terminal` field.
Then, select your terminal device in the :guilabel:`Payment Terminal Device` field.
.. image:: six/new-payment-method.png
:alt: Creating a new payment method for the SIX payment terminal
Once the payment method is created, you can select it in your POS settings. To do so, go to the
:ref:`POS' settings <configuration/settings>`, click :guilabel:`Edit`, and add the payment method
under the :guilabel:`Payments` section.
Pay with a payment terminal
===========================

View File

@ -62,15 +62,16 @@ the terminal automatically restarts.
Configure the payment method
----------------------------
From the Point of Sale application, go to :menuselection:`Configuration --> Settings --> Payment
terminals` and activate the *Worldline* payment terminal.
Enable the payment terminal :ref:`in the application settings <configuration/settings>` and
:doc:`create the related payment method <../../payment_methods>`. Set the journal type as
:guilabel:`Bank` and select :guilabel:`Worldline` in the :guilabel:`Use a Payment Terminal` field.
Then, select your terminal device in the :guilabel:`Payment Terminal Device` field.
.. image:: worldline/worldline-payment-terminals.png
:align: center
Then, go to :menuselection:`Configuration --> Payment methods` and create a new payment method for
*Worldline*. Select the payment terminal *Worldline* and your payment terminal device on your
*Payment Method form*.
Once the payment method is created, you can select it in your POS settings. To do so, go to the
:ref:`POS' settings <configuration/settings>`, click :guilabel:`Edit`, and add the payment method
under the :guilabel:`Payments` section.
.. _worldline/yomani-info:

Binary file not shown.

Before

Width:  |  Height:  |  Size: 30 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 30 KiB

After

Width:  |  Height:  |  Size: 18 KiB