https://github.com/chewhx/paynowqr

Singapore Paynow QR generator written in TypeScript
https://github.com/chewhx/paynowqr

donations finance payments paynow qrcode singapore-paynow singapore-qrcode typescript

Last synced: 27 days ago
JSON representation

Singapore Paynow QR generator written in TypeScript

• Host: GitHub
• URL: https://github.com/chewhx/paynowqr
• Owner: chewhx
• License: mit
• Created: 2022-06-16T12:44:58.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-06-20T02:31:13.000Z (over 2 years ago)
• Last Synced: 2024-04-24T18:23:53.308Z (9 months ago)
• Topics: donations, finance, payments, paynow, qrcode, singapore-paynow, singapore-qrcode, typescript
• Language: TypeScript
• Homepage:
• Size: 393 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# @chewhx/paynowqr

**Rewritten with Typescript so the package comes with types**

Singapore Paynow QR generator for node.js and javascript. Works on both browser and nodejs.

If you have any questions please open an issue or drop me an email at [email protected]

All credits and efforts to the original contributors.

Project bootstraped with [tsdx](https://tsdx.io/)

## Installation

```bash

$ npm i @chewhx/paynowqr

```

## Usage

```javascript

import PaynowQR from '@chewhx/paynowqr';

//Create a PaynowQR object

let qrcode = new PaynowQR({

  uen: '201403121W', //Required: UEN of company

  amount: 500, //Specify amount of money to pay.

  editable: true, //Whether or not to allow editing of payment amount. Defaults to false if amount is specified

  expiry: '20201231', //Set an expiry date for the Paynow QR code (YYYYMMDD). If omitted, defaults to 5 years from current time.

  refNumber: 'TQINV-10001', //Reference number for Paynow Transaction. Useful if you need to track payments for recouncilation.

  company: 'ACME Pte Ltd.', //Company name to embed in the QR code. Optional.

});

//Outputs the qrcode to a UTF-8 string format, which can be passed to a QR code generation script to generate the paynow QR

let QRstring = qrcode.output();

```

## Links

- 🐙 [GitHub](https://github.com/chewhx)

- 🖥️ [Website](https://www.chewhx.com)

## Credits

Source code from from: https://github.com/ThunderQuoteTeam/PaynowQR

Original code referenced from:

https://gist.github.com/chengkiang/7e1c4899768245570cc49c7d23bc394c

See also:

https://github.com/jtaych/PayNow-QR-Javascript

https://github.com/mindmedia/paynow.py

Developed by ThunderQuote (https://www.thunderquote.com)

Was looking around for various ways to implement dynamic SGQR codes for payment over Javascript, however couldn't find any that worked with UEN based payments.

Feel free to report any issues and feature requests!