diff --git a/content/applications/sales/point_of_sale/payment_methods/terminals/viva_com.rst b/content/applications/sales/point_of_sale/payment_methods/terminals/viva_com.rst index cdb29092a1..0f754a4b41 100644 --- a/content/applications/sales/point_of_sale/payment_methods/terminals/viva_com.rst +++ b/content/applications/sales/point_of_sale/payment_methods/terminals/viva_com.rst @@ -2,119 +2,81 @@ Viva.com ======== -Connecting a **Viva.com** :doc:`payment terminal <../terminals>` allows you to offer a fluid -payment flow to your customers and ease the work of your cashiers. +**Viva.com** is a payment service that offers payment solutions through the **viva.com Terminal** +app for :doc:`physical <../terminals>` and virtual terminals. .. note:: - Viva.com lets you turn your phone into a mobile card reader: `Tap On Phone - `_. + - Viva.com payment terminals do not require an :doc:`IoT Box ` to + operate. + - `Many European countries `_ support the use of Viva.com + payment terminals. + - The viva.com Terminal app turns a smartphone with an NFC chip into a `payment terminal + `_. -Configuration -============= +.. important:: + Odoo only supports the Euro currency with viva.com. -Start by creating your Viva.com account on `Viva.com website `_. - -Locate your Viva.com credentials --------------------------------- - -When configuring Viva.com in Point of Sale, you need to use specific credentials that are available -in your Viva.com account. These credentials include your :ref:`Merchant ID `, -:ref:`API key `, :ref:`POS API credentials `, and -:ref:`Terminal ID ` number. - -.. _pos/viva_com/id-key: - -Merchant ID and API key -~~~~~~~~~~~~~~~~~~~~~~~ - -Locate your `Merchant ID and API key following the Viva documentation -`_. -Then, save the keys and paste them into the Odoo :guilabel:`Merchant ID` and :guilabel:`API Key` -fields :ref:`when creating the payment method `. - -.. image:: viva_com/access-cred.png - :alt: merchant ID and API key fields - -.. note:: - These credentials are used for APIs that authenticate with Basic Auth. - -.. _pos/viva_com/pos-api: - -POS API credentials -~~~~~~~~~~~~~~~~~~~ - -Locate and generate your `POS API credentials following the Viva documentation -`_. -Then, save the keys and paste them in the Odoo :guilabel:`Client secret` and :guilabel:`Client ID` -fields :ref:`when creating the payment method `. +.. seealso:: + - `List of supported terminals `_ + - `List of supported payment methods `_ + +.. _viva/configuration: + +Viva.com configuration +====================== + +To configure a viva.com terminal, go to the `Viva.com website `_, create an +account, and then follow these steps: + +#. On the viva.com dashboard, go to :menuselection:`Settings --> API Access --> General`. +#. Copy the `Merchant ID and API key + `_. +#. Copy the `Client ID and the generated Client secret (POS API credentials) + `_. +#. Download the viva.com Terminal app on a device, then generate and copy the `activation code + `_. +#. On the viva.com dashboard, go to :menuselection:`Sales --> Sales Transactions --> Physical + Payments --> Card Terminals`. +#. Create a new `card terminal and paste the activation code + `_. +#. Copy the :guilabel:`Terminal ID` generated by the terminal activation. .. warning:: - These credentials are only displayed once. Ensure you keep a copy to secure them. - -.. image:: viva_com/api-cred.png - :alt: Client secret and client ID fields + The POS API credentials are only displayed once. Make sure to keep a copy to secure them. .. note:: - These credentials are used for Android and iOS POS Activation requests, as well as the Cloud - Terminal API. - -.. _pos/viva_com/identifier: - -Terminal ID -~~~~~~~~~~~ - -Your terminal ID number is used to identify your terminal. To find it: - -#. Go to your Viva.com account and select the relevant account. -#. Go to :menuselection:`Sales --> Physical payments --> Card terminals` in the navigation menu. - -The terminal ID number is located under the :guilabel:`Terminal ID (TID)` column. Save it to paste -it into the :guilabel:`Terminal ID` field :ref:`when creating the payment method -`. - -.. image:: viva_com/terminal-id.png - :alt: Viva terminal ID - -.. _pos/viva_com/method-creation: - -Configure the payment method ----------------------------- - -#. :doc:`Activate the POS Viva.com module <../../../../general/apps_modules>` to enable the - payment terminal. -#. :doc:`Create the related payment method <../../payment_methods>` by going to - :menuselection:`Point of Sale --> Configuration --> Payment Methods` and clicking - :guilabel:`New`. -#. Set the journal type as :guilabel:`Bank`. -#. Select :guilabel:`Terminal` in the :guilabel:`Integration` field. -#. Select :guilabel:`Viva.com` in the :guilabel:`Integrate with` field. -#. Fill in the mandatory fields with your: - - - :ref:`Merchant ID and API key ` - - :ref:`Client ID and Client secret ` - - :ref:`Terminal ID ` - -#. Save the form and copy the generated webhook URL from the :guilabel:`Viva.com Webhook - Endpoint` field. This URL is necessary :ref:`when configuring the webhook `. - -.. image:: viva_com/create-method-viva-com.png - :alt: payment method creation form - -.. _pos/viva_com/webhook: - -Configure the webhook ---------------------- - -Webhooks allow you to receive real-time notifications whenever a transaction occurs within your -Viva.com account. Set them up for `payment transactions following the Viva.com documentation -`_. - -.. seealso:: - `Setting up webhooks `_ - -Link the payment method to a POS --------------------------------- - -Select the payment method in your POS settings once the payment method is created. To do so, -go to the :ref:`POS' settings ` and add the payment method under the -:guilabel:`Payment methods` field of the :guilabel:`Payment` section. + - The POS API credentials are for APIs that use Basic Authentication, including those for Android + and iOS POS activation and the `Cloud Terminal API + `_. + +Odoo POS configuration +====================== + +To connect the viva.com terminal with Odoo Point of Sale, follow these steps: + +#. Go to :menuselection:`Point of Sale --> Configuration --> Settings`, scroll down to the + :guilabel:`Payment Terminals` section, enable the :guilabel:`Viva Wallet` terminal, and click + :guilabel:`Save`. +#. Go to :menuselection:`Point of Sale --> Configuration --> Payment Methods` and :doc:`create a + payment method <../../payment_methods>`. +#. Set the :guilabel:`Journal` field to :guilabel:`Bank`. +#. Set the :guilabel:`Integration` field to :guilabel:`Terminal`. +#. Set the :guilabel:`Integrate with` field to :guilabel:`Viva Wallet`. +#. Paste the copied information from :ref:`viva.com ` into the corresponding + fields: + + - :guilabel:`Merchant ID` + - :guilabel:`API Key` + - :guilabel:`Client ID` + - :guilabel:`Client secret` + - :guilabel:`Terminal ID` + +#. Save the form and copy the generated webhook URL from the :guilabel:`Viva Wallet Webhook + Endpoint` field. +#. Go to the :ref:`viva.com ` account and paste the webhook URL into the + `corresponding field + `_. +#. In Odoo, access the :ref:`relevant point of sale settings `, scroll down + to the :guilabel:`Payment` section, and add the created payment method in the :guilabel:`Payment + Methods` field. +#. Click :guilabel:`Save`. diff --git a/content/applications/sales/point_of_sale/payment_methods/terminals/viva_com/access-cred.png b/content/applications/sales/point_of_sale/payment_methods/terminals/viva_com/access-cred.png deleted file mode 100644 index 1d15a781a2..0000000000 Binary files a/content/applications/sales/point_of_sale/payment_methods/terminals/viva_com/access-cred.png and /dev/null differ diff --git a/content/applications/sales/point_of_sale/payment_methods/terminals/viva_com/api-cred.png b/content/applications/sales/point_of_sale/payment_methods/terminals/viva_com/api-cred.png deleted file mode 100644 index ce6c3b6d95..0000000000 Binary files a/content/applications/sales/point_of_sale/payment_methods/terminals/viva_com/api-cred.png and /dev/null differ diff --git a/content/applications/sales/point_of_sale/payment_methods/terminals/viva_com/create-method-viva-com.png b/content/applications/sales/point_of_sale/payment_methods/terminals/viva_com/create-method-viva-com.png deleted file mode 100644 index 5ef054c65a..0000000000 Binary files a/content/applications/sales/point_of_sale/payment_methods/terminals/viva_com/create-method-viva-com.png and /dev/null differ diff --git a/content/applications/sales/point_of_sale/payment_methods/terminals/viva_com/terminal-id.png b/content/applications/sales/point_of_sale/payment_methods/terminals/viva_com/terminal-id.png deleted file mode 100644 index 7c60ed03e0..0000000000 Binary files a/content/applications/sales/point_of_sale/payment_methods/terminals/viva_com/terminal-id.png and /dev/null differ