[MOV] pos: restructuration of pos toctree

task-3284514 + update of access pos settings + + update menu button + cash register Task-3256407 closes #4212 closes odoo/documentation#4242 X-original-commit: f851ea0e0a Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com> Co-authored-by: Jonathan Castillo <jcs@odoo.com> Co-authored-by: Loredana Perazzo <lrpz@odoo.com>
2023-04-21 14:37:11 +00:00
parent 6d25f69513
commit 27647fcb38
119 changed files with 417 additions and 384 deletions
@@ -0,0 +1,15 @@
+:nosearch:
+
+=================
+Payment terminals
+=================
+
+.. toctree::
+   :titlesonly:
+
+   terminals/adyen
+   terminals/ingenico
+   terminals/six
+   terminals/stripe
+   terminals/vantiv
+   terminals/worldline
@@ -0,0 +1,91 @@
+=====
+Adyen
+=====
+
+Connecting an **Adyen payment terminal** allows you to offer a fluid payment flow to your customers
+and ease the work of your cashiers.
+
+Configuration
+=============
+
+Start by creating your Adyen account on `Adyen's website <https://www.adyen.com/>`_. Then, board
+your terminal following the steps described on your terminal's screen.
+
+.. seealso::
+   - `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`.
+
+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.
+
+.. seealso::
+   - `Adyen Docs - API credentials
+     <https://docs.adyen.com/development-resources/api-credentials#generate-api-key>`_.
+
+Locate the Adyen terminal identifier
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The **Adyen Terminal Identifier** is your 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.
+
+Set the Event URLs
+~~~~~~~~~~~~~~~~~~
+
+For Odoo to know when a payment is made, you must set 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
+   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.
+
+Add a new payment method
+========================
+
+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.
+
+Pay with a payment terminal
+===========================
+
+When processing a payment, select :guilabel:`Adyen` as the payment method. Check the amount and
+click on :guilabel:`Send`. Once the payment is successful, the status changes to :guilabel:`Payment
+Successful`.
+
+.. note::
+   - | In case of connexion issues between Odoo and the payment terminal, force the payment by
+       clicking on :guilabel:`Force Done`, which allows you to validate the order.
+     | This option is only available after receiving an error message informing you that the
+       connection failed.
+   - To cancel the payment request, click on :guilabel:`cancel`.
@@ -0,0 +1,80 @@
+========
+Ingenico
+========
+
+Connecting a payment terminal allows you to offer a fluid payment flow to your customers and ease
+the work of your cashiers.
+
+Please note that Ingenico is currently only available for customers in the
+Benelux.
+
+Configuration
+=============
+
+Connect an IoT Box
+------------------
+
+Connecting an Ingenico Payment Terminal to Odoo is a feature that
+requires an IoT Box. For more information on how to connect an IoT Box
+to your database, please refer to the :doc:`IoT documentation </applications/productivity/iot/config/connect>`.
+
+Configure the Lane/5000 for Ingenico BENELUX
+--------------------------------------------
+
+Click on the F button of the terminal, then go in the
+:menuselection:`PoS Menu --> Settings` and enter the settings password.
+
+Now, click on connection change and TCP/IP. Type the IP of your *IoT
+Box* (you can find it on the form view of your IoT Box). Then, enter
+9000 as port. The terminal will restart. Once it is done, go on your
+*IoT Box* form in Odoo and verify that the terminal has been found.
+
+.. image:: ingenico/payment_terminal_02.png
+   :align: center
+
+Configure the payment method
+----------------------------
+
+First, go in the general settings of the POS app, and activate the
+Ingenico setting.
+
+.. image:: ingenico/payment_terminal_03.png
+   :align: center
+
+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
+
+Pay with a payment terminal
+===========================
+
+In your *PoS interface*, when processing a payment, select a *Payment
+Method* using a payment terminal. Check that the amount in the tendered
+column is the one that has to be sent to the payment terminal and click
+on *Send*. When the payment is successful, the status will change to
+*Payment Successful*.
+
+.. image:: ingenico/payment_terminal_05.png
+   :align: center
+
+If you want to cancel the payment request, click on cancel. You can
+still retry to send the payment request.
+
+If there is any issue with the payment terminal, you can still force the
+payment using the *Force Done*. This will allow you to validate the
+order in Odoo even if the connection between the terminal and Odoo has
+issues.
+
+.. note::
+   This option will only be available if you received an error message
+   telling you the connection failed.
+
+Once your payment is processed, on the payment record, you’ll find the
+type of card that has been used and the transaction ID.
+
+.. image:: ingenico/payment_terminal_06.png
+   :align: center
@@ -0,0 +1,57 @@
+===
+SIX
+===
+
+Connecting a SIX payment terminal allows you to offer a fluid payment flow to your customers and
+ease the work of your cashiers.
+
+.. warning::
+   - Starting in July 2022, it will **not** be possible anymore to connect and use a Six payment
+     terminal in PoS.
+   - Even though Worldline has recently acquired SIX Payment Services and both companies use Yomani
+     payment terminals, the firmware they run is different. Terminals received from Worldline are
+     therefore not compatible with this integration.
+
+Configuration
+=============
+
+Configure the Payment Method
+----------------------------
+
+First, make sure that the :guilabel:`POS Six` module is installed. For this, go to
+:guilabel:`Apps`, remove the :guilabel:`Apps` filter, and search for *POS Six*.
+
+.. image:: six/pos-six-module.png
+   :align: center
+   :alt: The POS Six module.
+
+Back in :menuselection:`Point of Sale --> Configuration --> Payment Methods`, click
+:guilabel:`Create` to create a new payment method for SIX, select the payment terminal option
+:guilabel:`SIX`, and enter the payment terminal IP address.
+
+.. image:: six/new-payment-method.png
+   :align: center
+   :alt: Create a new payment method for the SIX payment terminal.
+
+Pay with a Payment Terminal
+===========================
+
+In the :abbr:`PoS (Point of Sale)` interface, at the moment of the payment, select a payment method
+using a payment terminal. Verify that the amount in the tendered column is the one that has to be
+sent to the payment terminal and click on :guilabel:`Send`. To cancel the payment request, click on
+:guilabel:`Cancel`.
+
+.. image:: six/pos-send-payment.png
+   :align: center
+   :alt: The PoS interface.
+
+When the payment is done, the status will change to :guilabel:`Payment Successful`. If needed,
+reverse the last transaction by clicking on :guilabel:`Reverse`.
+
+.. image:: six/pos-reverse-payment.png
+   :align: center
+   :alt: The Reverse button on the PoS interface.
+
+If there is any issue with the payment terminal, you can still force the payment using the
+:guilabel:`Force Done` button. This will allow you to validate the order in Odoo even if there are
+connection issues between the payment terminal and Odoo.
@@ -0,0 +1,117 @@
+======
+Stripe
+======
+
+Connecting a payment terminal allows you to offer a fluid payment flow to your customers and ease
+the work of your cashiers.
+
+.. seealso::
+   - :doc:`Use Stripe as payment provider. <../../../../finance/payment_providers/stripe>`
+
+Configuration
+=============
+
+Configure the payment method
+----------------------------
+
+Activate **Stripe** in the settings by going to :menuselection:`Point of Sale --> Configuration -->
+Settings --> Payment Terminals` and enabling :guilabel:`Stripe`.
+
+Then, create the payment method:
+
+- Go to :menuselection:`Point of Sale --> Configuration --> Payment Methods`, click
+  :guilabel:`Create`, and complete the :guilabel:`Method` field with your payment method's name;
+- Set the :guilabel:`Journal` field as :guilabel:`Bank` and the :guilabel:`Use a Payment Terminal`
+  field as :guilabel:`Stripe`;
+- Enter your payment terminal serial number in the :guilabel:`Stripe Serial Number` field;
+- Click :guilabel:`Don't forget to complete Stripe connect before using this payment method.`
+
+.. image:: stripe/create-method-stripe.png
+   :align: center
+   :alt: payment method creation form
+
+.. note::
+   - Click :guilabel:`Identify Customer` to allow this payment method **exclusively** for identified
+     customers. For any unidentified customers to be able to pay with Stripe, leave the
+     :guilabel:`Identify Customer` field unchecked.
+   - The :guilabel:`Outstanding Account` and the :guilabel:`Intermediary Account` can stay empty to
+     use the default accounts.
+   - Find your payment terminal serial number under the device or on `Stripe's dashboard
+     <https://dashboard.stripe.com>`_.
+
+Connect Stripe to Odoo
+----------------------
+
+Click :guilabel:`Connect Stripe`. Doing so redirects you automatically to a configuration page.
+Fill in all the information to create your Stripe account and link it with Odoo. Once the forms are
+completed, the API keys (:guilabel:`Publishable Key` and :guilabel:`Secret Key`) can be retrieved on
+**Stripe's** website. To do so, click :guilabel:`Get your Secret and Publishable keys`,
+click the keys to copy them, and paste them into the corresponding fields in Odoo. Your terminal is
+ready to be configured in a POS.
+
+.. image:: stripe/stripe-connect.png
+   :align: center
+   :alt: stripe connection form
+
+.. note::
+   - When you use **Stripe** exclusively in Point of Sale, you only need the **Secret Key** to use
+     your terminal.
+   - When you use Stripe as **payment provider**, the :guilabel:`State` can stay set as
+     :guilabel:`Disabled`.
+   - For databases hosted **On-Premise**, the :guilabel:`Connect Stripe` button does not work. To
+     retrieve the API keys manually, log in to your `Stripe dashboard
+     <https://dashboard.stripe.com>`_, type `API` in the search bar, and click
+     :guilabel:`Developers > API`.
+
+Configure the payment terminal
+------------------------------
+
+Swipe right on your payment terminal, click :guilabel:`Settings`, enter the admin PIN code, validate
+and select your network.
+
+.. note::
+   - The device must be connected to a secured WI-FI network.
+   - Your Odoo database and payment terminal must share the same network.
+   - You must enter the admin PIN code to access your payment terminal settings. By default, this
+     code is `07139`.
+
+Link the payment method to a POS
+--------------------------------
+
+To add a **payment method** to your point of sale, go to :menuselection:`Point of Sale -->
+Configuration --> Settings`. Select the POS, scroll down to the :guilabel:`Payments` section, and
+add your payment method for **Stripe** in the :guilabel:`Payment Methods` field.
+
+Pay with a payment terminal
+===========================
+
+When processing a payment, select :guilabel:`Stripe` as the payment method. Check the amount and
+click :guilabel:`Send`. Once the payment is successful, the status changes to :guilabel:`Payment
+Successful`. To cancel the payment request, click :guilabel:`cancel`.
+
+.. note::
+   - | In case of connection issues between Odoo and the payment terminal, force the payment by
+       clicking on :guilabel:`Force Done`, which allows you to validate the order.
+     | This option is only available after receiving an error message informing you that the
+       connection failed.
+   - The terminal must have at least 10% battery level to use it.
+   - The device does not work for payments under €0.50.
+
+Troubleshooting
+===============
+
+Payment terminal unavailable in your Stripe account
+---------------------------------------------------
+
+If the payment terminal is unavailable in your Stripe account, you must add it manually:
+
+#. Log into your `Stripe's dashboard <https://dashboard.stripe.com>`_ and go to
+   :menuselection:`Stripe dashboard --> Payments --> Readers --> Locations`;
+#. Add a location by clicking the :guilabel:`+ New` button or selecting an already created location;
+#. Click the :guilabel:`+ New` button in the :guilabel:`Readers` box and fill in the required
+   information.
+
+.. note::
+   You must provide a **registration code**. To retrieve that code, swipe right on your device,
+   enter the admin PIN code (by default: `07319`), validate, and click :guilabel:`Generate a
+   registration code`.
@@ -0,0 +1,46 @@
+======
+Vantiv
+======
+
+Connecting a Vantiv payment terminal allows you to offer a fluid payment flow to your customers and
+ease the work of your cashiers.
+
+.. note::
+   Please note MercuryPay only operates with US and Canadian banks, making
+   this procedure only suitable for North American businesses.
+
+Configuration
+=============
+
+Configure the Payment Method
+----------------------------
+
+First, go in the general settings of the POS app, and activate the
+Vantiv setting.
+
+.. image:: vantiv/vantiv_01.png
+    :align: center
+
+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 Vantiv, select the payment terminal option Vantiv, and create
+new Vantiv credentials.
+
+.. image:: vantiv/vantiv_02.png
+    :align: center
+
+To create new Vantiv credentials, fill in your merchant ID and password,
+then save. Make sure the credentials you just created are selected, then
+save the payment method.
+
+.. image:: vantiv/vantiv_03.png
+    :align: center
+
+Pay with a Payment Terminal
+===========================
+
+In your PoS interface, at the moment of the payment, select your Vantiv
+payment method and… that’s all.
+
+.. image:: vantiv/vantiv_04.png
+    :align: center
@@ -0,0 +1,101 @@
+=========
+Worldline
+=========
+
+Connecting a payment terminal allows you to offer a fluid payment flow to your customers and ease
+the work of your cashiers.
+
+.. note::
+   Please note that Worldline is currently only available in the Benelux.
+
+Configuration
+=============
+
+Connect an IoT Box
+------------------
+
+Connecting a Worldline Payment Terminal to Odoo is a feature that requires an IoT Box. For more
+information on how to connect one to your database, please refer to the
+:doc:`IoT documentation </applications/productivity/iot/config/connect>`.
+
+Configure the protocol
+----------------------
+
+From your terminal, click on :menuselection:`"." --> 3 --> stop --> 3 --> 0 --> 9`. Enter the
+technician password **"1235789"** and click on :menuselection:`OK --> 4 --> 2`. Then, click on
+:menuselection:`Change --> CTEP (as Protocole ECR) --> OK`. Click on **OK** thrice on the subsequent
+screens (*CTEP ticket ECR*, *ECR ticket width*, and *Character set*). Finally, press **Stop** three
+times; the terminal automatically restarts.
+
+Set the IP address
+------------------
+
+From your terminal, click on :menuselection:`"." --> 3 --> stop --> 3 --> 0 --> 9`. Enter the
+technician password **"1235789"** and click on :menuselection:`OK --> 4 --> 9`. Then, click on
+:menuselection:`Change --> TCP/IP` (*TCP physical configuration* screen) :menuselection:`--> OK -->
+OK` (*TCP Configuration client* screen).
+
+Finally, set up the hostname and port number.
+
+Hostname
+~~~~~~~~
+
+| To set up the hostname, enter your IoT box's IP address' sequence numbers and press **OK** at each
+  "." until you reach the colon symbol.
+| Then, press **OK** twice.
+
+.. example::
+   | Here's an IP address sequence: `10.30.19.4:8069`.
+   | On the *Hostname screen*, type :menuselection:`10 --> OK --> 30 --> OK --> 19 --> OK --> 4
+     --> OK --> OK`.
+
+.. note::
+   Your IoT box's IP address is available in your IoT Box application's database.
+
+Port number
+~~~~~~~~~~~
+
+On the *Port number* screen, enter **9001** (or **9050** for Windows) and click on
+:menuselection:`OK` (*ECR protocol SSL no*) :menuselection:`--> OK`. Click on **Stop** three times;
+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.
+
+.. 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*.
+
+.. _worldline/yomani-info:
+
+.. tip::
+   - Technician password: `1235789`
+   - To reach Wordline's technical assistance, call `02 727 61 11` and choose "merchant". Your call
+     is automatically transferred to the desired service.
+   - Configure the cashier terminal if you have both a customer and a cashier terminal.
+   - To avoid blocking the terminal, check the initial configuration beforehand.
+   - Set a fixed IP to your IoT Box’s router to prevent losing the connexion.
+
+Pay with a payment terminal
+===========================
+
+When processing a payment, select *Worldline* as payment method. Check the amount and click on
+*Send*. Once the payment is successful, the status changes to *Payment Successful*.
+
+Once your payment is processed, the type of card used and the transaction ID appear on the payment
+record.
+
+.. image:: worldline/worldline-payment.png
+   :align: center
+
+.. note::
+   * In case of connexion issues between Odoo and the payment terminal, force the payment by
+     clicking on *Force Done*, which allows you to validate the order. This option is only available
+     after receiving an error message informing you that the connection failed.
+   * To cancel the payment request, click on **cancel**.