Part A) Setup API Server in POS
The API Server acts as the middleware between BC POS (with LS Central extension installed) and QF Card terminal communication purpose. The API Server encrypts the transaction request from POS then send encrypted message to QF Card Terminal. After the transaction, the card terminal returns result to POS through API Server.
Pre-requisite, skip this part if NodeJS v12.8.0 installed on the computer already.
- NodeJS v12.8.0 (download from https://nodejs.org/dist/v12.18.0/node-v12.18.0-x64.msi)
- Double click to install with all default option
- Run "node" in command prompt to verify NodeJS is whether installed or not
1) Download QF_Pay_Integration.zip the cloud storage at http://cloud.bizspoketech.com:8088/index.php/f/233083
Check api.exe
2) Folder Setup
- Create a folder called "QF_API" under C Drive (ie. C:\)
- Create a folder called log under C:\QF_API
(* Subject to latest UAT Successful version)
Move the downloaded files to C:\QF_API, the structure would same as below screenshot. *Replace all files for update
3) Search "Environment Variables" → Advance → Environment Variable / 編輯系統環境變數 → 進階 → 環境變數
Add the C:\QF_API to PATH User Variable in Environment Variables.
4) Verification of Step 5: Open Command Prompt, run as administrator, input "echo %PATH%"
5) Install Service step:
1) Open Command Prompt (Run as Administrator)
2) Input Below Command:
- CD C:\QF_API
- nssm install “Bizspoke API Server”
3) NSSM Service Installer window pops up
4) Path: the file path of api.exe. Then click "install service"
5) To verify, search (Press Win + S) to open "Service" with administrator. Then check "Bizspoke API Server" Service whether available or not.
6) Start the service
7) Check the log at log folder, visit localhost:3000 at browser. If the webpage loaded successfully → OK
Part B) In the new Testing Sandbox/ Production
1) In "POS Hardware Profile Card", create a new H/W profile or modify existing profile.
enter the following fields:
| Role | Sub Role | ID | Hardware Station Host | IP Address | Port Number | Terminal ID | Store ID | Remark | Terminal IP | Terminal Port | Terminal Timeout (ms) | QF POS Key | QF POS IV |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| EFT1 | localhost:8082 | 103.253.10.170 | 3000 | 242KCASB9814 | 1000031263 | 10.168.0.165 | 9001 | 60000 | ●●●●●●●●●● | qfpay202306_hjsh |
*** DO NOT change the red text value, field "ID", "Terminal Port", "QF POS IV"
1) "IP Address" is the public IP
2) "Port Number" is the exposed port at firewall, please fill "3000" (Make sure the port 3000 opened at firewall)
Login https://sh-hk.qfapi.com/#/ (from the QFPay Platform) → 設置 → 設備設置
3) "Terminal ID" = 設備編號
4) "Store ID" = 門店ID
5) "QF POS Key" = POS 密錀
6) "Terminal IP" = QFPay Terminal IP, you may find it in the QFPay device setting → Network & Internet → Wi-Fi setting → Click the Wifi Name → Advanced → IP Address
Make sure the IP address for QF Card Terminal is a static IP. Otherwise, the card terminal IP may be changed when reconnecting to Wi-Fi. Causing timeout connection error on POS.
You can reserve the IP by binding the MAC address and IP in the router setup. The router will assign a dedicated IP address for the card terminal. Detail setup on router may be different.
To obtain the QF Card Terminal's MAC address:
1) Scroll down from the top bar, then click the gear icon to Settings
2) Go to "Network & Internet"
3) Tap the Wi-Fi currently connected
4) Tap "Advanced" then scroll down to check the MAC address
7) Terminal Port = 9001
8) "QF POS IV" = qfpay202306_hjsh
Defined in https://sdk.qfapi.com/docs/in-store/pos-api/ECR/#1-pos-key
9) "Terminal Timeout (ms)", recommend set it at least 30000ms (equivalent to 30sec)
------------------------------
Part C) Tender Type and Numpad setup
1, Go to Store, open the tender list belongs that store.
(1) Check for the payment which link to qfpay
(2) Undertender allowed so as to achieve partial payment
(3) Check the box for amount return (void transaction)
**Please be noted that this does NOT applied to Octopus. Please do NOT check for Octopus.
(4) Allow keyboard to be used. Please check this box.
Go to "POS Terminal" Card, check the box "User Numpad"
Part D) Change the Tender, field = Function to "Card".
* Pls make sure the retail user (the account logged-in, i.e. BIZSUPPORT) with [Store No.] = MK. If not, you may need to create store tender types for another store manually on BC. (Or you can change it directly in the attached excel file, Sheet "Tender Type" > column "Store No.")
Create a new package in "Configuration Package" with the 5 tables ID in below screenshot.
Then click "Import from Excel" on top action bar. Import the file ECRSetupQF.confpack.xlsx.
------------------------------
(updated file ECRSetupQF.v17_03_2025_18_00_49.confpack.xlsx)
Support Show QR Code/Scan customer's phone QR code mode in Alipay & WeChat Pay sale mode)
