|
1 | | -=========== |
2 | | -Viva Wallet |
3 | | -=========== |
| 1 | +======== |
| 2 | +Viva.com |
| 3 | +======== |
4 | 4 |
|
5 | | -Connecting a **Viva Wallet** :doc:`payment terminal <../terminals>` allows you to offer a fluid |
| 5 | +Connecting a **Viva.com** :doc:`payment terminal <../terminals>` allows you to offer a fluid |
6 | 6 | payment flow to your customers and ease the work of your cashiers. |
7 | 7 |
|
8 | 8 | .. note:: |
9 | | - Viva Wallet lets you turn your phone into a mobile card reader: `Tap On Phone |
10 | | - <https://www.vivawallet.com/gb_en/blog-tap-on-phone-gb>`_. |
| 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>`_. |
11 | 11 |
|
12 | 12 | Configuration |
13 | 13 | ============= |
14 | 14 |
|
15 | | -Start by creating your Viva Wallet account on `Viva Wallet's website <https://www.vivawallet.com>`_. |
| 15 | +Start by creating your Viva.com account on `Viva.com website <https://www.viva.com>`_. |
16 | 16 |
|
17 | | -Locate your Viva Wallet credentials |
18 | | ------------------------------------ |
| 17 | +Locate your Viva.com credentials |
| 18 | +-------------------------------- |
19 | 19 |
|
20 | | -When configuring Viva Wallet in Point of Sale, you need to use specific credentials that are |
21 | | -available in your Viva Wallet account. These credentials include your :ref:`Merchant ID |
22 | | -<viva_wallet/id-key>`, :ref:`API key <viva_wallet/id-key>`, :ref:`POS API credentials |
23 | | -<viva_wallet/pos-api>`, and :ref:`Terminal ID <viva_wallet/identifier>` number. |
| 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 | 24 |
|
25 | | -.. _viva_wallet/id-key: |
| 25 | +.. _pos/viva_com/id-key: |
26 | 26 |
|
27 | 27 | Merchant ID and API key |
28 | 28 | ~~~~~~~~~~~~~~~~~~~~~~~ |
29 | 29 |
|
30 | 30 | Locate your `Merchant ID and API key following the Viva documentation |
31 | | -<https://developer.vivawallet.com/getting-started/find-your-account-credentials/merchant-id-and-api-key/>`_. |
| 31 | +<https://developer.viva.com/getting-started/find-your-account-credentials/merchant-id-and-api-key/>`_. |
32 | 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 <viva_wallet/method-creation>`. |
| 33 | +fields :ref:`when creating the payment method <pos/viva_com/method-creation>`. |
34 | 34 |
|
35 | | -.. image:: viva_wallet/access-cred.png |
| 35 | +.. image:: viva_com/access-cred.png |
36 | 36 | :alt: merchant ID and API key fields |
37 | 37 |
|
38 | 38 | .. note:: |
39 | 39 | These credentials are used for APIs that authenticate with Basic Auth. |
40 | 40 |
|
41 | | -.. _viva_wallet/pos-api: |
| 41 | +.. _pos/viva_com/pos-api: |
42 | 42 |
|
43 | 43 | POS API credentials |
44 | 44 | ~~~~~~~~~~~~~~~~~~~ |
45 | 45 |
|
46 | 46 | Locate and generate your `POS API credentials following the Viva documentation |
47 | | -<https://developer.vivawallet.com/getting-started/find-your-account-credentials/pos-api-credentials/>`_. |
| 47 | +<https://developer.viva.com/getting-started/find-your-account-credentials/pos-apis-credentials/>`_. |
48 | 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 <viva_wallet/method-creation>`. |
| 49 | +fields :ref:`when creating the payment method <pos/viva_com/method-creation>`. |
50 | 50 |
|
51 | 51 | .. warning:: |
52 | 52 | These credentials are only displayed once. Ensure you keep a copy to secure them. |
53 | 53 |
|
54 | | -.. image:: viva_wallet/api-cred.png |
| 54 | +.. image:: viva_com/api-cred.png |
55 | 55 | :alt: Client secret and client ID fields |
56 | 56 |
|
57 | 57 | .. note:: |
58 | 58 | These credentials are used for Android and iOS POS Activation requests, as well as the Cloud |
59 | 59 | Terminal API. |
60 | 60 |
|
61 | | -.. _viva_wallet/identifier: |
| 61 | +.. _pos/viva_com/identifier: |
62 | 62 |
|
63 | 63 | Terminal ID |
64 | 64 | ~~~~~~~~~~~ |
65 | 65 |
|
66 | 66 | Your terminal ID number is used to identify your terminal. To find it: |
67 | 67 |
|
68 | | -#. Go to your Viva Wallet account and select the relevant account. |
| 68 | +#. Go to your Viva.com account and select the relevant account. |
69 | 69 | #. Go to :menuselection:`Sales --> Physical payments --> Card terminals` in the navigation menu. |
70 | 70 |
|
71 | 71 | The terminal ID number is located under the :guilabel:`Terminal ID (TID)` column. Save it to paste |
72 | 72 | it into the :guilabel:`Terminal ID` field :ref:`when creating the payment method |
73 | | -<viva_wallet/method-creation>`. |
| 73 | +<pos/viva_com/method-creation>`. |
74 | 74 |
|
75 | | -.. image:: viva_wallet/terminal-id.png |
| 75 | +.. image:: viva_com/terminal-id.png |
76 | 76 | :alt: Viva terminal ID |
77 | 77 |
|
78 | | -.. _viva_wallet/method-creation: |
| 78 | +.. _pos/viva_com/method-creation: |
79 | 79 |
|
80 | 80 | Configure the payment method |
81 | 81 | ---------------------------- |
82 | 82 |
|
83 | | -#. :doc:`Activate the POS Viva Wallet module <../../../../general/apps_modules>` to enable the |
| 83 | +#. :doc:`Activate the POS Viva.com module <../../../../general/apps_modules>` to enable the |
84 | 84 | payment terminal. |
85 | 85 | #. :doc:`Create the related payment method <../../payment_methods>` by going to |
86 | 86 | :menuselection:`Point of Sale --> Configuration --> Payment Methods` and clicking |
87 | 87 | :guilabel:`New`. |
88 | 88 | #. Set the journal type as :guilabel:`Bank`. |
89 | | -#. Select :guilabel:`Viva Wallet` in the :guilabel:`Use a Payment Terminal` field. |
| 89 | +#. Select :guilabel:`Terminal` in the :guilabel:`Integration` field. |
| 90 | +#. Select :guilabel:`Viva.com` in the :guilabel:`Integrate with` field. |
90 | 91 | #. Fill in the mandatory fields with your: |
91 | 92 |
|
92 | | - - :ref:`Merchant ID and API key <viva_wallet/ID-key>` |
93 | | - - :ref:`Client ID and Client secret <viva_wallet/pos-api>` |
94 | | - - :ref:`Terminal ID <viva_wallet/identifier>` |
| 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>` |
95 | 96 |
|
96 | | -#. Save the form and copy the generated webhook URL from the :guilabel:`Viva Wallet Webhook |
97 | | - Endpoint` field. This URL is necessary :ref:`when configuring the webhook <viva_wallet/webhook>`. |
| 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>`. |
98 | 99 |
|
99 | | -.. image:: viva_wallet/create-method-viva-wallet.png |
| 100 | +.. image:: viva_com/create-method-viva-com.png |
100 | 101 | :alt: payment method creation form |
101 | | - :scale: 75% |
102 | 102 |
|
103 | | -.. _viva_wallet/webhook: |
| 103 | +.. _pos/viva_com/webhook: |
104 | 104 |
|
105 | 105 | Configure the webhook |
106 | 106 | --------------------- |
107 | 107 |
|
108 | | -Webhooks allow you to receive real-time notifications whenever a transaction occurs within your Viva |
109 | | -Wallet account. Set them up for `payment transactions following the Viva documentation |
110 | | -<https://developer.vivawallet.com/webhooks-for-payments/transaction-payment-created/>`_. |
| 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 | 111 |
|
112 | 112 | .. seealso:: |
113 | 113 | `Setting up webhooks <https://developer.viva.com/webhooks-for-payments/#setting-up-webhooks>`_ |
114 | 114 |
|
115 | 115 | Link the payment method to a POS |
116 | 116 | -------------------------------- |
117 | 117 |
|
118 | | -You can select the payment method in your POS settings once the payment method is created. To do so, |
| 118 | +Select the payment method in your POS settings once the payment method is created. To do so, |
119 | 119 | go to the :ref:`POS' settings <configuration/settings>` and add the payment method under the |
120 | 120 | :guilabel:`Payment methods` field of the :guilabel:`Payment` section. |
0 commit comments