wynsto / fps-hk

A tool to generate the QR code content string used by Faster Payment System in Hong Kong

hk-fps

This project is forked from node-hk-fps

A Nodejs module that help to generate QR code content string of the Hong Kong Faster Payment System. Please refer the blog

added support for mobile number and email address.

Installation

Install with npm

npm install fps-hk

and in your code

var  fps = require('fps-hk')

Usage

'//import module
// fps.reset()
// fps.setMerchantID("0000001"); FPS ID 
// only works on mobile phone number or email address
fps.setMerchantMobileNumber("[phone]"); 
fps.setBankCode("004"); // only works on mobile phone number or email address
// fps.setMerchantEmail("[email protected]");
fps.setBillNumber("0002");
fps.setStoreLabel("0003");
fps.setLoyaltyNumber("0004");
fps.setCustomerLabel("0005");
fps.setTerminalLabel("0006");
fps.setPurposeOfTransaction("0007");
fps.setMobileNumber("12345678");
fps.setTransactionAmount("5000");
fps.setReferenceLabel("ABCD");
const string = fps.generate();
const code = qrimage.image(string, { type: 'png' });
res.setHeader('Content-type', 'image/png');  //sent qr image to client side
code.pipe(res);

//generate qr content string
var  qrContent = fps.generate();

Example

cd ./example
npm install
node index.js

visit http://localhost:8080

License

MIT

Useful Links

Please find the specification of the QR Code used in FPS at: https://fps.hkicl.com.hk/eng/fps/merchants/qr_code.php

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