chris/node-fps-hk
1
0
Fork 0
mirror of https://github.com/ryanchanplc/node-fps-hk.git synced 2025-04-04 22:30:42 +00:00
Code Issues Packages Projects Releases Wiki Activity

update readme.md and npm version 1.0.0

Browse Source
This commit is contained in:
ryan.chan 2019-11-03 08:02:24 +08:00
parent e42ccf61aa
commit a1b084069a
2 changed files with 38 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

71
README.md
View File

@ -1,51 +1,54 @@
## hk-fps
A Nodejs module that help to generate QR code content string of the Hong Kong Fast Payment System. ## node-hk-fps
A Nodejs module that help to generate QR code content string of the Hong Kong Faster Payment System.
## Installation ## Installation
Install with npm Install with npm
```
npm install node-fps-hk npm install node-fps-hk
```
and in your code and in your code
```javascript
var fps = require('node-fps-hk')
var fps = require('node-fps-hk') ```
## Usage ## Usage
//import module ```javascript
var fps = require('node-fps-hk') //import module
var fps = require('node-fps-hk')
// set custom variables
fps.setMerchantID("0000001"); // set custom variables
fps.setBillNumber("0002"); fps.setMerchantID("0000001");
fps.setStoreLabel("0003"); fps.setBillNumber("0002");
fps.setLoyaltyNumber("0004"); fps.setStoreLabel("0003");
fps.setCustomerLabel("0005"); fps.setLoyaltyNumber("0004");
fps.setTerminalLabel("0006"); fps.setCustomerLabel("0005");
fps.setPurposeOfTransaction("0007"); fps.setTerminalLabel("0006");
fps.setMobileNumber("12345678"); fps.setPurposeOfTransaction("0007");
fps.setTransactionAmount("5000"); fps.setMobileNumber("12345678");
fps.setReferenceLabel("ABCD"); fps.setTransactionAmount("5000");
fps.setReferenceLabel("ABCD");
//generate qr content string
var qrContent = fps.generate();
```
//generate qr content string
var qrContent = fps.generate();
## Example ## Example
```
cd ./example cd ./example
npm install npm install
node index.js node index.js
```
visit `http://localhost:8080` visit `http://localhost:8080`
## License ## License
MIT [MIT](https://github.com/ryanchanplc/node-fps-hk/blob/master/LICENSE)
## Useful Links ## Useful Links
Please find the specification of the QR Code used in FPS : [https://fps.hkicl.com.hk/eng/fps/merchants/qr_code.php](https://fps.hkicl.com.hk/eng/fps/merchants/qr_code.php) Please find the specification of the QR Code used in FPS at:
[https://fps.hkicl.com.hk/eng/fps/merchants/qr_code.php](https://fps.hkicl.com.hk/eng/fps/merchants/qr_code.php)
The QR Code used the **CRC16 CCITT** check sum. Please find more details : [http://www.sunshine2k.de/articles/coding/crc/understanding_crc.html](http://www.sunshine2k.de/articles/coding/crc/understanding_crc.html) The QR Code content string used in FPS contains the **CRC16 CCITT** check sum.
Please find more details at: [http://www.sunshine2k.de/articles/coding/crc/understanding_crc.html](http://www.sunshine2k.de/articles/coding/crc/understanding_crc.html)

2
package.json
View File

@ -1,6 +1,6 @@
{ {
"name": "node-fps-hk", "name": "node-fps-hk",
"version": "0.1.0", "version": "1.0.0",
"description": "A tool to generate the qrcode content string used by Fast Payment System in Hong Kong", "description": "A tool to generate the qrcode content string used by Fast Payment System in Hong Kong",
"main": "index.js", "main": "index.js",
"directories": { "directories": {