[REF] sales: rename Viva Wallet to Viva.com
task-4673212
As requested by Viva.com teams, we adapted the documentation to conform to their rebranding.
closes odoo/documentation#13288
Task: 4673212
X-original-commit: b75365646b
Signed-off-by: Loredana Perazzo (lrpz) <lrpz@odoo.com>
@@ -27,7 +27,7 @@ Then, follow the corresponding documentation to configure your device:
|
||||
- :doc:`SIX configuration <terminals/six>`
|
||||
- :doc:`Stripe configuration <terminals/stripe>`
|
||||
- :doc:`Tyro configuration <terminals/tyro>`
|
||||
- :doc:`Viva Wallet configuration <terminals/viva_wallet>`
|
||||
- :doc:`Viva.com configuration <terminals/viva_com>`
|
||||
- :doc:`Worldline configuration <terminals/worldline>`
|
||||
|
||||
Once the terminal is configured, you can :doc:`create the corresponding payment method and add it to
|
||||
@@ -57,5 +57,5 @@ Successful`.
|
||||
terminals/six
|
||||
terminals/stripe
|
||||
terminals/tyro
|
||||
terminals/viva_wallet
|
||||
terminals/viva_com
|
||||
terminals/worldline
|
||||
|
||||
@@ -1,113 +1,113 @@
|
||||
===========
|
||||
Viva Wallet
|
||||
===========
|
||||
========
|
||||
Viva.com
|
||||
========
|
||||
|
||||
Connecting a **Viva Wallet** :doc:`payment terminal <../terminals>` allows you to offer a fluid
|
||||
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.
|
||||
|
||||
.. note::
|
||||
Viva Wallet lets you turn your phone into a mobile card reader: `Tap On Phone
|
||||
<https://www.vivawallet.com/gb_en/blog-tap-on-phone-gb>`_.
|
||||
Viva.com lets you turn your phone into a mobile card reader: `Tap On Phone
|
||||
<https://www.viva.com/en-gb/blog/tap-on-phone-turn-your-phone-into-a-mobile-card-reader>`_.
|
||||
|
||||
Configuration
|
||||
=============
|
||||
|
||||
Start by creating your Viva Wallet account on `Viva Wallet's website <https://www.vivawallet.com>`_.
|
||||
Start by creating your Viva.com account on `Viva.com website <https://www.viva.com>`_.
|
||||
|
||||
Locate your Viva Wallet credentials
|
||||
-----------------------------------
|
||||
Locate your Viva.com credentials
|
||||
--------------------------------
|
||||
|
||||
When configuring Viva Wallet in Point of Sale, you need to use specific credentials that are
|
||||
available in your Viva Wallet account. These credentials include your :ref:`Merchant ID
|
||||
<viva_wallet/id-key>`, :ref:`API key <viva_wallet/id-key>`, :ref:`POS API credentials
|
||||
<viva_wallet/pos-api>`, and :ref:`Terminal ID <viva_wallet/identifier>` number.
|
||||
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
|
||||
:ref:`Terminal ID <pos/viva_com/identifier>` number.
|
||||
|
||||
.. _viva_wallet/id-key:
|
||||
.. _pos/viva_com/id-key:
|
||||
|
||||
Merchant ID and API key
|
||||
~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Locate your `Merchant ID and API key following the Viva documentation
|
||||
<https://developer.vivawallet.com/getting-started/find-your-account-credentials/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 <viva_wallet/method-creation>`.
|
||||
fields :ref:`when creating the payment method <pos/viva_com/method-creation>`.
|
||||
|
||||
.. image:: viva_wallet/access-cred.png
|
||||
.. 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.
|
||||
|
||||
.. _viva_wallet/pos-api:
|
||||
.. _pos/viva_com/pos-api:
|
||||
|
||||
POS API credentials
|
||||
~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Locate and generate your `POS API credentials following the Viva documentation
|
||||
<https://developer.vivawallet.com/getting-started/find-your-account-credentials/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 <viva_wallet/method-creation>`.
|
||||
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.
|
||||
|
||||
.. image:: viva_wallet/api-cred.png
|
||||
.. image:: viva_com/api-cred.png
|
||||
:alt: Client secret and client ID fields
|
||||
|
||||
.. note::
|
||||
These credentials are used for Android and iOS POS Activation requests, as well as the Cloud
|
||||
Terminal API.
|
||||
|
||||
.. _viva_wallet/identifier:
|
||||
.. _pos/viva_com/identifier:
|
||||
|
||||
Terminal ID
|
||||
~~~~~~~~~~~
|
||||
|
||||
Your terminal ID number is used to identify your terminal. To find it:
|
||||
|
||||
#. Go to your Viva Wallet account and select the relevant account.
|
||||
#. 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
|
||||
<viva_wallet/method-creation>`.
|
||||
<pos/viva_com/method-creation>`.
|
||||
|
||||
.. image:: viva_wallet/terminal-id.png
|
||||
.. image:: viva_com/terminal-id.png
|
||||
:alt: Viva terminal ID
|
||||
|
||||
.. _viva_wallet/method-creation:
|
||||
.. _pos/viva_com/method-creation:
|
||||
|
||||
Configure the payment method
|
||||
----------------------------
|
||||
|
||||
#. :doc:`Activate the POS Viva Wallet module <../../../../general/apps_modules>` to enable the
|
||||
#. :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:`Viva Wallet` in the :guilabel:`Use a Payment Terminal` field.
|
||||
#. 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 <viva_wallet/ID-key>`
|
||||
- :ref:`Client ID and Client secret <viva_wallet/pos-api>`
|
||||
- :ref:`Terminal ID <viva_wallet/identifier>`
|
||||
- :ref:`Merchant ID and API key <pos/viva_com/ID-key>`
|
||||
- :ref:`Client ID and Client secret <pos/viva_com/pos-api>`
|
||||
- :ref:`Terminal ID <pos/viva_com/identifier>`
|
||||
|
||||
#. Save the form and copy the generated webhook URL from the :guilabel:`Viva Wallet Webhook
|
||||
Endpoint` field. This URL is necessary :ref:`when configuring the webhook <viva_wallet/webhook>`.
|
||||
#. 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 <pos/viva_com/webhook>`.
|
||||
|
||||
.. image:: viva_wallet/create-method-viva-wallet.png
|
||||
.. image:: viva_com/create-method-viva-com.png
|
||||
:alt: payment method creation form
|
||||
:scale: 75%
|
||||
|
||||
.. _viva_wallet/webhook:
|
||||
.. _pos/viva_com/webhook:
|
||||
|
||||
Configure the webhook
|
||||
---------------------
|
||||
|
||||
Webhooks allow you to receive real-time notifications whenever a transaction occurs within your Viva
|
||||
Wallet account. Set them up for `payment transactions following the Viva documentation
|
||||
<https://developer.vivawallet.com/webhooks-for-payments/transaction-payment-created/>`_.
|
||||
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
|
||||
<https://developer.viva.com/webhooks-for-payments/transaction-payment-created/>`_.
|
||||
|
||||
.. seealso::
|
||||
`Setting up webhooks <https://developer.viva.com/webhooks-for-payments/#setting-up-webhooks>`_
|
||||
@@ -115,6 +115,6 @@ Wallet account. Set them up for `payment transactions following the Viva documen
|
||||
Link the payment method to a POS
|
||||
--------------------------------
|
||||
|
||||
You can select the payment method in your POS settings once the payment method is created. To do so,
|
||||
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
|
||||
:guilabel:`Payment methods` field of the :guilabel:`Payment` section.
|
||||
|
Before Width: | Height: | Size: 12 KiB After Width: | Height: | Size: 12 KiB |
|
Before Width: | Height: | Size: 18 KiB After Width: | Height: | Size: 18 KiB |
|
After Width: | Height: | Size: 14 KiB |
|
Before Width: | Height: | Size: 14 KiB After Width: | Height: | Size: 14 KiB |
|
Before Width: | Height: | Size: 18 KiB |
@@ -8,6 +8,7 @@ applications/finance/accounting/payments/checks.rst applications/finance/account
|
||||
# applications/point of sale
|
||||
|
||||
content/applications/sales/point_of_sale/payment_methods/terminals/vantiv.rst content/applications/sales/point_of_sale/payment_methods/terminals.rst
|
||||
content/applications/sales/point_of_sale/payment_methods/terminals/viva_wallet.rst content/applications/sales/point_of_sale/payment_methods/viva_com.rst # terminals/viva_wallet.rst --> terminals/viva_com.rst
|
||||
|
||||
# applications/inventory_and_mrp
|
||||
|
||||
|
||||