diff --git a/content/applications/sales/point_of_sale/payment_methods/terminals.rst b/content/applications/sales/point_of_sale/payment_methods/terminals.rst index 949101d98..877bce080 100644 --- a/content/applications/sales/point_of_sale/payment_methods/terminals.rst +++ b/content/applications/sales/point_of_sale/payment_methods/terminals.rst @@ -25,6 +25,7 @@ Then, follow the corresponding documentation to configure your device: - :doc:`SIX configuration ` - :doc:`Stripe configuration ` - :doc:`Vantiv configuration ` +- :doc:`Viva Wallet configuration ` - :doc:`Worldline configuration ` Once the terminal is configured, you can :doc:`create the corresponding payment method and add it to @@ -38,4 +39,5 @@ the POS <../payment_methods>`. terminals/six terminals/stripe terminals/vantiv + terminals/viva_wallet terminals/worldline diff --git a/content/applications/sales/point_of_sale/payment_methods/terminals/viva_wallet.rst b/content/applications/sales/point_of_sale/payment_methods/terminals/viva_wallet.rst new file mode 100644 index 000000000..b71a3edff --- /dev/null +++ b/content/applications/sales/point_of_sale/payment_methods/terminals/viva_wallet.rst @@ -0,0 +1,134 @@ +=========== +Viva Wallet +=========== + +Connecting a **Viva Wallet** :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 + `_. + +Configuration +============= + +Start by creating your Viva Wallet account on `Viva Wallet's website `_. + +Locate your Viva Wallet 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 +`, :ref:`API key `, :ref:`POS API credentials +`, and :ref:`Terminal ID ` number. + +.. _viva_wallet/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_wallet/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 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 `. + +.. warning:: + These credentials are only displayed once. Ensure you keep a copy to secure them. + +.. image:: viva_wallet/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: + +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 :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_wallet/terminal-id.png + :alt: Viva terminal ID + +.. _viva_wallet/method-creation: + +Configure the payment method +---------------------------- + +#. :doc:`Activate the POS Viva Wallet 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. +#. 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 Wallet Webhook + Endpoint` field. This URL is necessary :ref:`when configuring the webhook `. + +.. image:: viva_wallet/create-method-viva-wallet.png + :alt: payment method creation form + :scale: 75% + +.. _viva_wallet/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 +`_. + +.. seealso:: + `Setting up webhooks `_ + +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, +go to the :ref:`POS' settings ` and add the payment method under the +:guilabel:`Payment methods` field of the :guilabel:`Payment` section. + +Pay with a payment terminal +=========================== + +When processing a payment, select the related 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 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. + - To cancel the payment request, click :guilabel:`cancel`. diff --git a/content/applications/sales/point_of_sale/payment_methods/terminals/viva_wallet/access-cred.png b/content/applications/sales/point_of_sale/payment_methods/terminals/viva_wallet/access-cred.png new file mode 100644 index 000000000..1d15a781a Binary files /dev/null and b/content/applications/sales/point_of_sale/payment_methods/terminals/viva_wallet/access-cred.png differ diff --git a/content/applications/sales/point_of_sale/payment_methods/terminals/viva_wallet/api-cred.png b/content/applications/sales/point_of_sale/payment_methods/terminals/viva_wallet/api-cred.png new file mode 100644 index 000000000..ce6c3b6d9 Binary files /dev/null and b/content/applications/sales/point_of_sale/payment_methods/terminals/viva_wallet/api-cred.png differ diff --git a/content/applications/sales/point_of_sale/payment_methods/terminals/viva_wallet/create-method-viva-wallet.png b/content/applications/sales/point_of_sale/payment_methods/terminals/viva_wallet/create-method-viva-wallet.png new file mode 100644 index 000000000..c4255db4e Binary files /dev/null and b/content/applications/sales/point_of_sale/payment_methods/terminals/viva_wallet/create-method-viva-wallet.png differ diff --git a/content/applications/sales/point_of_sale/payment_methods/terminals/viva_wallet/terminal-id.png b/content/applications/sales/point_of_sale/payment_methods/terminals/viva_wallet/terminal-id.png new file mode 100644 index 000000000..7c60ed03e Binary files /dev/null and b/content/applications/sales/point_of_sale/payment_methods/terminals/viva_wallet/terminal-id.png differ diff --git a/content/applications/sales/point_of_sale/preparation/setting.png b/content/applications/sales/point_of_sale/preparation/setting.png deleted file mode 100644 index 5a8112c42..000000000 Binary files a/content/applications/sales/point_of_sale/preparation/setting.png and /dev/null differ