Skip to content

Commit b87b0b3

Browse files
committed
[IMP] POS: path to configure payment terminals
task-3684488 closes #7608 X-original-commit: d16864d Signed-off-by: Loredana Perazzo (lrpz) <[email protected]>
1 parent 6a69730 commit b87b0b3

File tree

12 files changed

+69
-67
lines changed

12 files changed

+69
-67
lines changed

content/applications/sales/point_of_sale/payment_methods/terminals.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,13 @@ Payment terminals
77
Connecting and integrating a payment terminal with your POS system allows you to accept multiple
88
payment options, including credit and debit cards, making the payment process more efficient.
99

10+
.. _terminals/configuration:
11+
1012
Configuration
1113
=============
1214

13-
Go to the :doc:`application settings <../configuration>`, scroll down to the :guilabel:`Payment
14-
Terminals` section, and tick your terminal's checkbox.
15+
Go to the :ref:`application settings <configuration/settings>`, scroll down to the
16+
:guilabel:`Payment Terminals` section, and tick your terminal's checkbox.
1517

1618
.. image:: terminals/settings-pt.png
1719
:alt: checkbox in the settings to enable a payment terminal

content/applications/sales/point_of_sale/payment_methods/terminals/adyen.rst

Lines changed: 42 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -19,66 +19,65 @@ your terminal following the steps described on your terminal's screen.
1919
- `Adyen Docs - Payment terminal quickstart guides
2020
<https://docs.adyen.com/point-of-sale/user-manuals>`_.
2121

22-
Configure the payment method
23-
----------------------------
24-
25-
First, go to :menuselection:`Point of Sale --> Configuration --> Settings --> Payment Terminals`,
26-
and enable :guilabel:`Adyen`.
27-
Then, go to :menuselection:`Configuration --> Payment Methods` and create a new payment method.
28-
Select :guilabel:`Adyen` in the :guilabel:`Use a Payment Terminal` field.
29-
30-
.. note::
31-
The selected journal **must** be a bank journal for the :guilabel:`Use a payment terminal` field
32-
to appear.
33-
34-
Finally, fill the mandatory fields with an :guilabel:`Adyen API key`, and an :guilabel:`Adyen
35-
Terminal Identifier`.
22+
.. _adyen/api:
3623

3724
Generate an Adyen API key
38-
~~~~~~~~~~~~~~~~~~~~~~~~~
39-
40-
The **Adyen API key** is a key used to authenticate your requests. To generate an API key, go to
41-
your **Adyen account**.
25+
-------------------------
4226

43-
Then, go to :menuselection:`Developers --> API credentials`. Create a new credential or click on an
44-
existing one.
45-
46-
Click on :guilabel:`Generate an API key` and copy-paste that key onto the Odoo mandatory field.
27+
The **Adyen API key** is used to authenticate requests from your Adyen terminal. To generate an API
28+
key, go to your :menuselection:`Adyen account --> Developers --> API credentials`, and **create**
29+
new credentials or select **existing** ones. Click :guilabel:`Generate an API key` and save the key
30+
to paste it into the Odoo :guilabel:`Adyen API key` field at :ref:`the payment method creation
31+
<adyen/method-creation>`.
4732

4833
.. seealso::
4934
- `Adyen Docs - API credentials
5035
<https://docs.adyen.com/development-resources/api-credentials#generate-api-key>`_.
5136

37+
.. _adyen/identifier:
38+
5239
Locate the Adyen terminal identifier
53-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
40+
------------------------------------
5441

55-
The **Adyen Terminal Identifier** is your terminal's serial number, which is used to identify the
42+
The **Adyen Terminal Identifier** is the terminal's serial number, which is used to identify the
5643
hardware.
5744

58-
To find this number, go to your **Adyen account**. Then, go to :menuselection:`Point of Sale
59-
--> Terminals`, select the terminal to link, and copy-paste its serial number onto the Odoo
60-
mandatory field.
45+
To find this number, go to your :menuselection:`Adyen account --> Point of Sale --> Terminals`,
46+
select the terminal to link with, and save its serial number to paste it into the Odoo
47+
:guilabel:`Adyen Terminal Identifier` field at :ref:`the payment method creation
48+
<adyen/method-creation>`.
6149

6250
Set the Event URLs
63-
~~~~~~~~~~~~~~~~~~
51+
------------------
6452

65-
For Odoo to know when a payment is made, you must set the terminal **Event URLs**. To do so,
53+
For Odoo to know when a payment is made, you must configure the terminal **Event URLs**. To do so,
6654

67-
#. log in to `Adyen's website <https://www.adyen.com/>`_;
68-
#. go to :menuselection:`Adyen's dashboard --> Point of Sale --> Terminals` and select the connected
55+
#. Log in to `Adyen's website <https://www.adyen.com/>`_;
56+
#. Go to :menuselection:`Adyen's dashboard --> Point of Sale --> Terminals` and select the connected
6957
terminal;
70-
#. from the terminal settings, click :guilabel:`Integrations`;
71-
#. set the :guilabel:`Switch to decrypted mode to edit this setting` field as :guilabel:`Decrypted`;
72-
#. click the **pencil icon** button and enter your server address, followed by
73-
`/pos_adyen/notification` in the :guilabel:`Event URLs` field; and
74-
#. click :guilabel:`Save` at the bottom of the screen to save the changes.
75-
76-
Add a new payment method
77-
========================
78-
79-
To add a new **payment method** to a point of sale, go to :menuselection:`Point of Sale -->
80-
Configuration --> Point of Sale`. Then, select the POS and go to :menuselection:`Payments -->
81-
Payment Methods`, and add your new method for Adyen.
58+
#. From the terminal settings, click :guilabel:`Integrations`;
59+
#. Set the :guilabel:`Switch to decrypted mode to edit this setting` field as :guilabel:`Decrypted`;
60+
#. Click the **pencil icon** button and enter your server address, followed by
61+
`/pos_adyen/notification` in the :guilabel:`Event URLs` field;
62+
#. Click :guilabel:`Save` at the bottom of the screen to save changes.
63+
64+
.. _adyen/method-creation:
65+
66+
Configure the payment method
67+
----------------------------
68+
69+
Enable the payment terminal :ref:`in the application settings <configuration/settings>` and
70+
:doc:`create the related payment method <../../payment_methods>`. Set the journal type as
71+
:guilabel:`Bank` and select :guilabel:`Adyen` in the :guilabel:`Use a Payment Terminal` field.
72+
73+
Finally, fill in the mandatory fields with your :ref:`Adyen API key <adyen/api>`, :ref:`Adyen
74+
Terminal Identifier <adyen/identifier>`, and :guilabel:`Adyen Merchant Account`.
75+
76+
.. image:: adyen/payment-method.png
77+
78+
Once the payment method is created, you can select it in your POS settings. To do so, go to the
79+
:ref:`POS' settings <configuration/settings>`, click :guilabel:`Edit`, and add the payment method
80+
under the :guilabel:`Payments` section.
8281

8382
Pay with a payment terminal
8483
===========================
20.5 KB
Loading

content/applications/sales/point_of_sale/payment_methods/terminals/ingenico.rst

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -35,19 +35,16 @@ Box* (you can find it on the form view of your IoT Box). Then, enter
3535
Configure the payment method
3636
----------------------------
3737

38-
First, go in the general settings of the POS app, and activate the
39-
Ingenico setting.
38+
Enable the payment terminal :ref:`in the application settings <configuration/settings>` and
39+
:doc:`create the related payment method <../../payment_methods>`. Set the journal type as
40+
:guilabel:`Bank` and select :guilabel:`Ingenico` in the :guilabel:`Use a Payment Terminal` field.
41+
Then, select your terminal device in the :guilabel:`Payment Terminal Device` field.
4042

41-
.. image:: ingenico/payment_terminal_03.png
42-
:align: center
43-
44-
Go back in :menuselection:`Point of Sale --> Configuration --> Point of Sale`,
45-
go in the payments section and access your payment methods. Create a new
46-
payment method for Ingenico, select the payment terminal option Ingenico, and
47-
select your payment terminal device.
43+
.. image:: ingenico/payment-method.png
4844

49-
.. image:: ingenico/payment_terminal_04.png
50-
:align: center
45+
Once the payment method is created, you can select it in your POS settings. To do so, go to the
46+
:ref:`POS' settings <configuration/settings>`, click :guilabel:`Edit`, and add the payment method
47+
under the :guilabel:`Payments` section.
5148

5249
Pay with a payment terminal
5350
===========================
18.5 KB
Loading
Binary file not shown.
Binary file not shown.

content/applications/sales/point_of_sale/payment_methods/terminals/six.rst

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -52,15 +52,18 @@ homepage under the :guilabel:`Payments` section to confirm the connection.
5252
Configure the payment method
5353
----------------------------
5454

55-
From your database, go to :menuselection:`Point of Sale --> Configuration --> Payment Methods` to
56-
create a new payment method specifically for Six. Click :guilabel:`New`, enter a :guilabel:`Name`,
57-
set the :guilabel:`Journal` field as :guilabel:`Bank`, the :guilabel:`Use a Payment Terminal` field
58-
as :guilabel:`SIX IOT`, and select the corresponding device in the :guilabel:`Payment Terminal
59-
Device` field.
55+
Enable the payment terminal :ref:`in the application settings <configuration/settings>` and
56+
:doc:`create the related payment method <../../payment_methods>`. Set the journal type as
57+
:guilabel:`Bank` and select :guilabel:`SIX IOT` in the :guilabel:`Use a Payment Terminal` field.
58+
Then, select your terminal device in the :guilabel:`Payment Terminal Device` field.
6059

6160
.. image:: six/new-payment-method.png
6261
:alt: Creating a new payment method for the SIX payment terminal
6362

63+
Once the payment method is created, you can select it in your POS settings. To do so, go to the
64+
:ref:`POS' settings <configuration/settings>`, click :guilabel:`Edit`, and add the payment method
65+
under the :guilabel:`Payments` section.
66+
6467
Pay with a payment terminal
6568
===========================
6669

content/applications/sales/point_of_sale/payment_methods/terminals/worldline.rst

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -62,15 +62,16 @@ the terminal automatically restarts.
6262
Configure the payment method
6363
----------------------------
6464

65-
From the Point of Sale application, go to :menuselection:`Configuration --> Settings --> Payment
66-
terminals` and activate the *Worldline* payment terminal.
65+
Enable the payment terminal :ref:`in the application settings <configuration/settings>` and
66+
:doc:`create the related payment method <../../payment_methods>`. Set the journal type as
67+
:guilabel:`Bank` and select :guilabel:`Worldline` in the :guilabel:`Use a Payment Terminal` field.
68+
Then, select your terminal device in the :guilabel:`Payment Terminal Device` field.
6769

6870
.. image:: worldline/worldline-payment-terminals.png
69-
:align: center
7071

71-
Then, go to :menuselection:`Configuration --> Payment methods` and create a new payment method for
72-
*Worldline*. Select the payment terminal *Worldline* and your payment terminal device on your
73-
*Payment Method form*.
72+
Once the payment method is created, you can select it in your POS settings. To do so, go to the
73+
:ref:`POS' settings <configuration/settings>`, click :guilabel:`Edit`, and add the payment method
74+
under the :guilabel:`Payments` section.
7475

7576
.. _worldline/yomani-info:
7677

Binary file not shown.

0 commit comments

Comments
 (0)