|
| 1 | +===== |
| 2 | +QFPay |
| 3 | +===== |
| 4 | + |
| 5 | +Connecting a **QFPay payment terminal** allows you to offer a fluid payment flow to your customers |
| 6 | +and ease the work of your cashiers. |
| 7 | + |
| 8 | +.. important:: |
| 9 | + - QFPay payment terminals do not require an :doc:`IoT Box </applications/general/iot>`. |
| 10 | + - QFPay terminals can be used only in **Hong-Kong**. |
| 11 | + |
| 12 | +Configuration |
| 13 | +============= |
| 14 | + |
| 15 | +.. _qfpay/account-creation: |
| 16 | + |
| 17 | +Start by creating your QFPay account on `QFPay's website <https://qfpay.global/products/qfpay-pos-api/>`_. |
| 18 | + |
| 19 | +During your application request for the activation of Asynchronous Notifications, you will need to provide your server address, |
| 20 | +followed by `/qfpay/notify`. ie: `https://yourdomain.odoo.com/qfpay/notify` |
| 21 | + |
| 22 | +QFPay will then provide you with a Notification Key that you can add into the Odoo :guilabel:`QFPay Notification Key` field at :ref:`the payment method creation |
| 23 | +<qfpay/method-creation>`. |
| 24 | + |
| 25 | + |
| 26 | +.. _qfpay/terminal-setup: |
| 27 | + |
| 28 | +Set up the QFPay terminal |
| 29 | +------------------------- |
| 30 | + |
| 31 | +To set up your QFPay terminal, you will need to connect the Haojin App to your QFPay account as instructed by QFPay. |
| 32 | + |
| 33 | +It is strongly recomended to setup a fixed IP address for your terminal, indeed Odoo will use this IP address to communicate with the terminal. |
| 34 | +If it changes you will have to update it in the Odoo configuration. |
| 35 | + |
| 36 | +Once your terminal ip address is set you can paste it into the Odoo :guilabel:`QFPay Terminal IP Address` field at :ref:`the payment method creation |
| 37 | +<qfpay/method-creation>`. |
| 38 | + |
| 39 | +Additionally, you have to request a self-signed certificate linked to that IP address from QFPay. |
| 40 | +You will need to import that certificate on the machine running the Odoo POS. |
| 41 | + |
| 42 | + |
| 43 | +.. _qfpay/poskey: |
| 44 | + |
| 45 | +Generate a QFPay POS-KEY |
| 46 | +------------------------ |
| 47 | + |
| 48 | +The **QFPay POS-KEY** is a secret key used to verify the data. |
| 49 | +Steps to generate POS-KEY Login: open Haojin App -> My -> Settings -> Pos Call Up Key -> Reset Key |
| 50 | +Alternatively Login to MMS (merchant portal) with Merchant role, navigate to Setting -> Device Setting -> retrieve the POS key |
| 51 | +Take note of that key and paste it into the Odoo :guilabel:`QFPay POS Key` field at :ref:`the payment method creation |
| 52 | +<qfpay/method-creation>`. |
| 53 | + |
| 54 | +.. seealso:: |
| 55 | + - `QFPay Docs - ECR Integration |
| 56 | + <https://sdk.qfapi.com/docs/in-store/pos-api/ECR/#1-pos-key>`_. |
| 57 | + |
| 58 | +.. _qfpay/method-creation: |
| 59 | + |
| 60 | +Configure the payment method |
| 61 | +---------------------------- |
| 62 | + |
| 63 | +Enable the payment terminal :ref:`in the application settings <configuration/settings>` and |
| 64 | +:doc:`create the related payment method <../../payment_methods>`. Set the journal type as |
| 65 | +:guilabel:`Bank` and select :guilabel:`QFPay` in the :guilabel:`Use a Payment Terminal` field. |
| 66 | + |
| 67 | +Finally, fill in the mandatory fields with your :ref:`QFPay Terminal IP <qfpay/terminal-setup>`, |
| 68 | +:ref:`QFPay POS Key <qfpay/poskey>` and :ref:`QFPay Notification Key <qfpay/account-creation>`, |
| 69 | + |
| 70 | +Once the payment method is created, you can select it in your POS settings. To do so, go to the |
| 71 | +:ref:`POS' settings <configuration/settings>`, click :guilabel:`Edit`, and add the payment method |
| 72 | +under the :guilabel:`Payments` section. |
0 commit comments