Skip to content

Commit a9fd287

Browse files
committed
[IMP] pos/viva: Update Viva.com doc
task-4745855 closes #14092 X-original-commit: d66af2e Signed-off-by: Audrey Vandromme (auva) <auva@odoo.com> Signed-off-by: Emmanuel Minga (EMMI) <emmi@odoo.com>
1 parent 13776c0 commit a9fd287

File tree

5 files changed

+68
-108
lines changed

5 files changed

+68
-108
lines changed

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

Lines changed: 68 additions & 108 deletions
Original file line numberDiff line numberDiff line change
@@ -2,119 +2,79 @@
22
Viva.com
33
========
44

5-
Connecting a **Viva.com** :doc:`payment terminal <../terminals>` allows you to offer a fluid
6-
payment flow to your customers and ease the work of your cashiers.
5+
**Viva.com** is a payment service that offers payment solutions through the **viva.com Terminal**
6+
app for :doc:`physical <../terminals>` and virtual terminals.
77

88
.. note::
9-
Viva.com lets you turn your phone into a mobile card reader: `Tap On Phone
10-
<https://www.viva.com/en-gb/blog/tap-on-phone-turn-your-phone-into-a-mobile-card-reader>`_.
9+
- Viva.com payment terminals do not require an :doc:`IoT Box </applications/general/iot>` to
10+
operate.
11+
- `Many European countries <https://developer.viva.com/about-viva/>`_ support the use of Viva.com
12+
payment terminals.
13+
- The viva.com Terminal app turns a smartphone with an NFC chip into a `payment terminal
14+
<https://www.viva.com/en-gb/blog/tap-on-phone-turn-your-phone-into-a-mobile-card-reader>`_.
1115

12-
Configuration
13-
=============
16+
.. important::
17+
Odoo only supports the Euro currency with viva.com.
1418

15-
Start by creating your Viva.com account on `Viva.com website <https://www.viva.com>`_.
16-
17-
Locate your Viva.com credentials
18-
--------------------------------
19-
20-
When configuring Viva.com in Point of Sale, you need to use specific credentials that are available
21-
in your Viva.com account. These credentials include your :ref:`Merchant ID <pos/viva_com/id-key>`,
22-
:ref:`API key <pos/viva_com/id-key>`, :ref:`POS API credentials <pos/viva_com/pos-api>`, and
23-
:ref:`Terminal ID <pos/viva_com/identifier>` number.
24-
25-
.. _pos/viva_com/id-key:
26-
27-
Merchant ID and API key
28-
~~~~~~~~~~~~~~~~~~~~~~~
29-
30-
Locate your `Merchant ID and API key following the Viva documentation
31-
<https://developer.viva.com/getting-started/find-your-account-credentials/merchant-id-and-api-key/>`_.
32-
Then, save the keys and paste them into the Odoo :guilabel:`Merchant ID` and :guilabel:`API Key`
33-
fields :ref:`when creating the payment method <pos/viva_com/method-creation>`.
34-
35-
.. image:: viva_com/access-cred.png
36-
:alt: merchant ID and API key fields
37-
38-
.. note::
39-
These credentials are used for APIs that authenticate with Basic Auth.
40-
41-
.. _pos/viva_com/pos-api:
42-
43-
POS API credentials
44-
~~~~~~~~~~~~~~~~~~~
45-
46-
Locate and generate your `POS API credentials following the Viva documentation
47-
<https://developer.viva.com/getting-started/find-your-account-credentials/pos-apis-credentials/>`_.
48-
Then, save the keys and paste them in the Odoo :guilabel:`Client secret` and :guilabel:`Client ID`
49-
fields :ref:`when creating the payment method <pos/viva_com/method-creation>`.
19+
.. seealso::
20+
- `List of supported terminals <https://www.vivawallet.com/shop/terminals/terminals-4>`_
21+
- `List of supported payment methods <https://developer.viva.com/payment-methods/>`_
22+
23+
.. _viva/configuration:
24+
25+
Viva.com configuration
26+
======================
27+
28+
To configure a viva.com terminal, go to the `Viva.com website <https://www.viva.com>`_, create an
29+
account, and then follow these steps:
30+
31+
#. On the viva.com dashboard, go to :menuselection:`Settings --> API Access --> General`.
32+
#. Copy the `Merchant ID and API key
33+
<https://developer.viva.com/getting-started/find-your-account-credentials/merchant-id-and-api-key/>`_.
34+
#. Copy the `Client ID and the generated Client secret (POS API credentials)
35+
<https://developer.viva.com/getting-started/find-your-account-credentials/pos-apis-credentials/>`_.
36+
#. Download the viva.com Terminal app on a device, then generate and copy the `activation code
37+
<https://euhelp.viva.com/en/articles/5316775-how-do-i-activate-the-viva-com-terminal>`_.
38+
#. On the viva.com dashboard, go to :menuselection:`Sales --> Sales Transactions --> Physical
39+
Payments --> Card Terminals`.
40+
#. Create a new `card terminal and paste the activation code
41+
<https://euhelp.viva.com/en/articles/5316775-how-do-i-activate-the-viva-com-terminal>`_.
42+
#. Copy the :guilabel:`Terminal ID` generated by the terminal activation.
5043

5144
.. warning::
52-
These credentials are only displayed once. Ensure you keep a copy to secure them.
53-
54-
.. image:: viva_com/api-cred.png
55-
:alt: Client secret and client ID fields
45+
The POS API credentials are only displayed once. Make sure to keep a copy to secure them.
5646

5747
.. note::
58-
These credentials are used for Android and iOS POS Activation requests, as well as the Cloud
59-
Terminal API.
60-
61-
.. _pos/viva_com/identifier:
62-
63-
Terminal ID
64-
~~~~~~~~~~~
65-
66-
Your terminal ID number is used to identify your terminal. To find it:
67-
68-
#. Go to your Viva.com account and select the relevant account.
69-
#. Go to :menuselection:`Sales --> Physical payments --> Card terminals` in the navigation menu.
70-
71-
The terminal ID number is located under the :guilabel:`Terminal ID (TID)` column. Save it to paste
72-
it into the :guilabel:`Terminal ID` field :ref:`when creating the payment method
73-
<pos/viva_com/method-creation>`.
74-
75-
.. image:: viva_com/terminal-id.png
76-
:alt: Viva terminal ID
77-
78-
.. _pos/viva_com/method-creation:
79-
80-
Configure the payment method
81-
----------------------------
82-
83-
#. :doc:`Activate the POS Viva.com module <../../../../general/apps_modules>` to enable the
84-
payment terminal.
85-
#. :doc:`Create the related payment method <../../payment_methods>` by going to
86-
:menuselection:`Point of Sale --> Configuration --> Payment Methods` and clicking
87-
:guilabel:`New`.
88-
#. Set the journal type as :guilabel:`Bank`.
89-
#. Select :guilabel:`Terminal` in the :guilabel:`Integration` field.
90-
#. Select :guilabel:`Viva.com` in the :guilabel:`Integrate with` field.
91-
#. Fill in the mandatory fields with your:
92-
93-
- :ref:`Merchant ID and API key <pos/viva_com/ID-key>`
94-
- :ref:`Client ID and Client secret <pos/viva_com/pos-api>`
95-
- :ref:`Terminal ID <pos/viva_com/identifier>`
96-
97-
#. Save the form and copy the generated webhook URL from the :guilabel:`Viva.com Webhook
98-
Endpoint` field. This URL is necessary :ref:`when configuring the webhook <pos/viva_com/webhook>`.
99-
100-
.. image:: viva_com/create-method-viva-com.png
101-
:alt: payment method creation form
102-
103-
.. _pos/viva_com/webhook:
104-
105-
Configure the webhook
106-
---------------------
107-
108-
Webhooks allow you to receive real-time notifications whenever a transaction occurs within your
109-
Viva.com account. Set them up for `payment transactions following the Viva.com documentation
110-
<https://developer.viva.com/webhooks-for-payments/transaction-payment-created/>`_.
111-
112-
.. seealso::
113-
`Setting up webhooks <https://developer.viva.com/webhooks-for-payments/#setting-up-webhooks>`_
114-
115-
Link the payment method to a POS
116-
--------------------------------
117-
118-
Select the payment method in your POS settings once the payment method is created. To do so,
119-
go to the :ref:`POS' settings <configuration/settings>` and add the payment method under the
120-
:guilabel:`Payment methods` field of the :guilabel:`Payment` section.
48+
- The POS API credentials are for APIs that use Basic Authentication, including those for Android
49+
and iOS POS activation and the `Cloud Terminal API
50+
<https://developer.viva.com/apis-for-point-of-sale/card-terminals-devices/rest-api/>`_.
51+
52+
Odoo POS configuration
53+
======================
54+
55+
To connect the viva.com terminal with Odoo Point of Sale, follow these steps:
56+
57+
#. Go to :menuselection:`Point of Sale --> Configuration --> Settings`, scroll down to the
58+
:guilabel:`Payment Terminals` section, enable the :guilabel:`Viva.com` terminal, and click
59+
:guilabel:`Save`.
60+
#. Go to :menuselection:`Point of Sale --> Configuration --> Payment Methods` and :doc:`create a
61+
payment method <../../payment_methods>`.
62+
#. Set the :guilabel:`Journal` field to :guilabel:`Bank`.
63+
#. Select the desired point of sale in the :guilabel:`Point of Sale` field.
64+
#. Set the :guilabel:`Integration` field to :guilabel:`Terminal`.
65+
#. Set the :guilabel:`Integrate with` field to :guilabel:`Viva.com`.
66+
#. Paste the copied information from :ref:`viva.com <viva/configuration>` into the corresponding
67+
fields:
68+
69+
- :guilabel:`Merchant ID`
70+
- :guilabel:`API Key`
71+
- :guilabel:`Client ID`
72+
- :guilabel:`Client secret`
73+
- :guilabel:`Terminal ID`
74+
75+
#. Save the form and copy the generated webhook URL from the :guilabel:`Viva Com Webhook
76+
Endpoint` field.
77+
#. Go to the :ref:`viva.com <viva/configuration>` account and paste the webhook URL into the
78+
`corresponding field
79+
<https://developer.viva.com/webhooks-for-payments/transaction-payment-created/>`_.
80+
#. Click :guilabel:`Save`.

0 commit comments

Comments
 (0)