Skip to content

[IMP] pos/viva: Update Viva.com doc #13848

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: 18.0
Choose a base branch
from
Open

[IMP] pos/viva: Update Viva.com doc #13848

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
61 changes: 33 additions & 28 deletions content/applications/sales/point_of_sale/payment_methods/terminals/viva_com.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,34 +2,40 @@
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.
Connecting a **Viva.com** :doc:`payment terminal <../terminals>` gives customers a fluid payment
flow and eases cashiers' work.
Comment on lines +5 to +6
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we link to the Viva.com website? (like we do for payment providers) And I think I would replace this sentence as it sounds too marketing-y and does add much value IMO.

Also, I see there are many different Viva.com payment terminals (and an app for the Tap to Pay option), are all of them supported/covered in this documentation? Are there configuration differences? Should we mention these options (briefly) here (and mention they need/don't need specific configurations)? What do you think?


.. important::
- Viva.com payment terminals do not require an :doc:`IoT Box </applications/general/iot>` to
operate.
- Many European countries support the use of Viva.com payment terminals. Check the `availability
of the Viva Terminal app in Europe <https://developer.viva.com/about-viva/>`_.
Comment on lines +11 to +12
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Many European countries support the use of Viva.com payment terminals. Check the `availability
of the Viva Terminal app in Europe <https://developer.viva.com/about-viva/>`_.
- `Many European countries <https://developer.viva.com/about-viva/>`_ support the use of Viva.com payment terminals.


.. note::
Viva.com lets you turn your phone into a mobile card reader: `Tap On Phone
Viva.com turns phones into card readers with `tapping options
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Viva.com turns phones into card readers with `tapping options
Viva.com allows you to `turn your phone into a mobile card terminal

(borrowed this from viva.com's website; i think its more accurate. And FYI, I think this feature is more commonly called "Tap to Pay")

<https://www.viva.com/en-gb/blog/tap-on-phone-turn-your-phone-into-a-mobile-card-reader>`_.

Configuration
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since this is the only h2 on this doc page, I suggest removing it entirely.

That being said, I think it'd be easier to split the configuration section of this doc into 1) all viva.com configurations (use "save for later when necessary) and 2) all Odoo PoS configurations instead of going back and forth between viva.com and Odoo all the time for the different configurations.

See the payment providers doc (e.g;, Xendit or Razorpay) for an example of what I mean (I would not use the same headings but something more like "Viva.com configuration" and "Odoo PoS configuration" or something similar.

I also strongly suggest testing the account creation part on viva.com (I haven't checked yet, my apologies if you have already!)

(We can of course discuss this 😉 )

=============

Start by creating your Viva.com account on `Viva.com website <https://www.viva.com>`_.
Start by creating a Viva.com account on the `Viva.com website <https://www.viva.com>`_.

Locate your Viva.com credentials
--------------------------------
Viva.com account 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 <pos/viva_com/id-key>`,
:ref:`API key <pos/viva_com/id-key>`, :ref:`POS API credentials <pos/viva_com/pos-api>`, and
When configuring Viva.com in Odoo Point of Sale, use the specific credentials available in the
created Viva.com account. These credentials include a :ref:`Merchant ID <pos/viva_com/id-key>`,
:ref:`API key <pos/viva_com/id-key>`, :ref:`POS API credentials <pos/viva_com/pos-api>`, and a
:ref:`Terminal ID <pos/viva_com/identifier>` number.

.. _pos/viva_com/id-key:

Merchant ID and API key
~~~~~~~~~~~~~~~~~~~~~~~

Locate your `Merchant ID and API key following the Viva documentation
<https://developer.viva.com/getting-started/find-your-account-credentials/merchant-id-and-api-key/>`_.
Then, save the keys and paste them into the Odoo :guilabel:`Merchant ID` and :guilabel:`API Key`
Locate the `Merchant ID and API key
<https://developer.viva.com/getting-started/find-your-account-credentials/merchant-id-and-api-key/>`_,
then save the keys and paste them into the Odoo :guilabel:`Merchant ID` and :guilabel:`API Key`
fields :ref:`when creating the payment method <pos/viva_com/method-creation>`.

.. image:: viva_com/access-cred.png
Expand All @@ -43,13 +49,13 @@ fields :ref:`when creating the payment method <pos/viva_com/method-creation>`.
POS API credentials
~~~~~~~~~~~~~~~~~~~

Locate and generate your `POS API credentials following the Viva documentation
<https://developer.viva.com/getting-started/find-your-account-credentials/pos-apis-credentials/>`_.
Then, save the keys and paste them in the Odoo :guilabel:`Client secret` and :guilabel:`Client ID`
Locate and generate the `POS API credentials
<https://developer.viva.com/getting-started/find-your-account-credentials/pos-apis-credentials/>`_,
then save the keys and paste them in the Odoo :guilabel:`Client secret` and :guilabel:`Client ID`
fields :ref:`when creating the payment method <pos/viva_com/method-creation>`.

.. warning::
These credentials are only displayed once. Ensure you keep a copy to secure them.
These credentials are only displayed once. Make sure to keep a copy to secure them.

.. image:: viva_com/api-cred.png
:alt: Client secret and client ID fields
Expand All @@ -63,21 +69,20 @@ fields :ref:`when creating the payment method <pos/viva_com/method-creation>`.
Terminal ID
~~~~~~~~~~~

Your terminal ID number is used to identify your terminal. To find it:
The terminal ID number identifies the terminal. Follow these steps 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
<pos/viva_com/method-creation>`.
#. Save the terminal ID number under the :guilabel:`Terminal ID (TID)` column.
#. Paste the terminal ID number into the :guilabel:`Terminal ID` field :ref:`when creating the
payment method <pos/viva_com/method-creation>`.

.. image:: viva_com/terminal-id.png
:alt: Viva terminal ID

.. _pos/viva_com/method-creation:

Configure the payment method
Payment method configuration
----------------------------

#. :doc:`Activate the POS Viva.com module <../../../../general/apps_modules>` to enable the
Expand All @@ -102,19 +107,19 @@ Configure the payment method

.. _pos/viva_com/webhook:

Configure the webhook
Webhook configuration
---------------------

Webhooks allow you to receive real-time notifications whenever a transaction occurs within your
Webhooks enable the reception of real-time notifications whenever a transaction occurs within your
Viva.com account. Set them up for `payment transactions following the Viva.com documentation
<https://developer.viva.com/webhooks-for-payments/transaction-payment-created/>`_.

.. seealso::
`Setting up webhooks <https://developer.viva.com/webhooks-for-payments/#setting-up-webhooks>`_

Link the payment method to a POS
--------------------------------
POS and Payment method link
---------------------------

Select the payment method in your POS settings once the payment method is created. To do so,
go to the :ref:`POS' settings <configuration/settings>` and add the payment method under the
To select a payment method after the :ref:`configuration <pos/viva_com/method-creation>`, go to the
:ref:`POS settings <configuration/settings>` and add the payment method under the
:guilabel:`Payment methods` field of the :guilabel:`Payment` section.