Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bhar4t/upiqr
This project is a TypeScript library that generates NPCI's UPI QR code (BASE64) along with UPI intent link, which can be used for payment through UPI-enabled apps.
https://github.com/bhar4t/upiqr
intent javascript node payment qrcode typescript upi
Last synced: 2 days ago
JSON representation
This project is a TypeScript library that generates NPCI's UPI QR code (BASE64) along with UPI intent link, which can be used for payment through UPI-enabled apps.
- Host: GitHub
- URL: https://github.com/bhar4t/upiqr
- Owner: bhar4t
- License: mit
- Created: 2021-03-09T03:56:33.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2025-01-06T15:08:30.000Z (12 days ago)
- Last Synced: 2025-01-09T08:08:26.115Z (9 days ago)
- Topics: intent, javascript, node, payment, qrcode, typescript, upi
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/upiqr
- Size: 60.5 KB
- Stars: 28
- Watchers: 2
- Forks: 7
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
[![npm package][npm-img]][npm-url]
[![Build Status][build-img]][build-url]
[![Downloads][downloads-img]][downloads-url]
[![Issues][issues-img]][issues-url]
[![Commitizen Friendly][commitizen-img]][commitizen-url]
[![Semantic Release][semantic-release-img]][semantic-release-url]
Generate NPCI's UPI QR code (BASE64) along with UPI intent link, By using it any payment is possible from UPI enabled apps.
## Supports
This package will work on client and server.
```js
import upiqr from "upiqr";
upiqr({
payeeVPA: "bhar4t@upi",
payeeName: "Bharat Sahu"
})
.then(({ qr }) => {
console.log(qr) // data:image/png;base64,eR0lGODP...
})
.catch(console.error)
```
### Fields detail:
| Fields | Description | Required |
|--------------------|---------------------------------------------------|-----------|
| `payeeVPA` | UPI ID of the payee (e.g., `example@upi`). | Yes |
| `payeeName` | Registered name of the payee (e.g., `John Doe`). | Yes |
| `payeeMerchantCode`| Merchant Code from UPI payment account | No |
| `transactionId` | Unique transaction id for merchant's reference | No |
| `transactionRef` | Unique transaction id for merchant's reference | No |
| `transactionNote` | Note for the payment (e.g., `Electricity Bill`). | No |
| `amount` | Amount | No |
| `minimumAmount` | Amount to be paid (e.g., `100.00` or `499`). | No |
| `currency` | Currency of amount (default: `INR`) | No |
| `transactionRefUrl`| URL for the order | No |
In table, fields requirement column is based on static QR, For dynamic QR you need to change more fields along with `payeeVPA` and `payeeName`.
For a complete list of supported fields, refer to the [NPCI UPI Linking Specs][upi-specs-url]
### Customization:
Internally using `qrcode` for QR Generation. And, it accepts [second optional param object][qr-code-options] for cusomizing the QR code.
```js
upiqr(intentFields, {
color: {
dark: '#000000',
light: '#FFFFFF'
}
})
```
[build-img]:https://github.com/bhar4t/upiqr/actions/workflows/main.yml/badge.svg
[build-url]:https://github.com/bhar4t/upiqr/actions/workflows/main.yml
[downloads-img]:https://img.shields.io/npm/dt/upiqr
[downloads-url]:https://www.npmtrends.com/upiqr
[npm-img]:https://img.shields.io/npm/v/upiqr
[npm-url]:https://www.npmjs.com/package/upiqr
[issues-img]:https://img.shields.io/github/issues/bhar4t/upiqr
[issues-url]:https://github.com/bhar4t/upiqr/issues
[codecov-img]:https://codecov.io/gh/bhar4t/upiqr/branch/main/graph/badge.svg
[codecov-url]:https://codecov.io/gh/bhar4t/upiqr
[semantic-release-img]:https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg
[semantic-release-url]:https://github.com/semantic-release/semantic-release
[commitizen-img]:https://img.shields.io/badge/commitizen-friendly-brightgreen.svg
[commitizen-url]:http://commitizen.github.io/cz-cli/
[qr-code-options]:https://www.npmjs.com/package/qrcode#qr-code-options
[upi-specs-url]:https://www.npci.org.in/PDF/npci/upi/circular/2017/Circular18_BankCompliances_to_enbaleUPIMerchantecosystem_0.pdf