{"id":22612085,"url":"https://github.com/bhar4t/upiqr","last_synced_at":"2025-04-13T04:08:06.845Z","repository":{"id":57387221,"uuid":"345876598","full_name":"bhar4t/upiqr","owner":"bhar4t","description":"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.","archived":false,"fork":false,"pushed_at":"2025-01-06T15:08:30.000Z","size":62,"stargazers_count":28,"open_issues_count":0,"forks_count":8,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-13T04:07:55.347Z","etag":null,"topics":["intent","javascript","node","payment","qrcode","typescript","upi"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/upiqr","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bhar4t.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["bhar4t"],"patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"lfx_crowdfunding":null,"polar":null,"buy_me_a_coffee":null,"thanks_dev":null,"custom":null}},"created_at":"2021-03-09T03:56:33.000Z","updated_at":"2025-01-06T15:08:33.000Z","dependencies_parsed_at":"2025-01-02T06:40:16.435Z","dependency_job_id":"7967d956-fcdc-4752-ba7f-7f08c85f7373","html_url":"https://github.com/bhar4t/upiqr","commit_stats":{"total_commits":84,"total_committers":2,"mean_commits":42.0,"dds":"0.011904761904761862","last_synced_commit":"27c3eaa4dbd5f308c961331fb123eae8bbc33670"},"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bhar4t%2Fupiqr","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bhar4t%2Fupiqr/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bhar4t%2Fupiqr/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bhar4t%2Fupiqr/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bhar4t","download_url":"https://codeload.github.com/bhar4t/upiqr/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248661705,"owners_count":21141450,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["intent","javascript","node","payment","qrcode","typescript","upi"],"created_at":"2024-12-08T17:09:44.117Z","updated_at":"2025-04-13T04:08:06.817Z","avatar_url":"https://github.com/bhar4t.png","language":"TypeScript","funding_links":["https://github.com/sponsors/bhar4t"],"categories":[],"sub_categories":[],"readme":"[![npm package][npm-img]][npm-url]\n[![Build Status][build-img]][build-url]\n[![Downloads][downloads-img]][downloads-url]\n[![Issues][issues-img]][issues-url]\n[![Commitizen Friendly][commitizen-img]][commitizen-url]\n[![Semantic Release][semantic-release-img]][semantic-release-url]\n\nGenerate NPCI's UPI QR code (BASE64) along with UPI intent link, By using it any payment is possible from UPI enabled apps.\n\n## Supports\n\n\u003cdiv id=\"header\" align=\"center\"\u003e\n  \u003cimg src=\"https://raw.githubusercontent.com/bhar4t/bhar4t/master/public/img/upis.png\" width=\"300\"/\u003e\n\u003c/div\u003e\n\n\u003cbr/\u003e\n\nThis package will work on client and server.\n\n```js\n\n  import upiqr from \"upiqr\";\n\n  upiqr({\n    payeeVPA: \"bhar4t@upi\",\n    payeeName: \"Bharat Sahu\"\n  })\n  .then(({ qr }) =\u003e {\n    console.log(qr)      // data:image/png;base64,eR0lGODP...\n  })\n  .catch(console.error)\n\n```\n\n### Fields detail:\n\n| Fields             | Description                                       | Required  |\n|--------------------|---------------------------------------------------|-----------|\n| `payeeVPA`         | UPI ID of the payee (e.g., `example@upi`).        | Yes       |\n| `payeeName`        | Registered name of the payee (e.g., `John Doe`).  | Yes       |\n| `payeeMerchantCode`| Merchant Code from UPI payment account            | No        |\n| `transactionId`    | Unique transaction id for merchant's reference    | No        |\n| `transactionRef`   | Unique transaction id for merchant's reference    | No        |\n| `transactionNote`  | Note for the payment (e.g., `Electricity Bill`).  | No        |\n| `amount`           | Amount                                            | No        |\n| `minimumAmount`    | Amount to be paid (e.g., `100.00` or `499`).      | No        |\n| `currency`         | Currency of amount (default: `INR`)               | No        |\n| `transactionRefUrl`| URL for the order                                 | No        |\n\n\nIn table, fields requirement column is based on static QR, For dynamic QR you need to change more fields along with `payeeVPA` and `payeeName`.\n\nFor a complete list of supported fields, refer to the [NPCI UPI Linking Specs][upi-specs-url]\n\n### Customization:\n\nInternally using `qrcode` for QR Generation. And, it accepts [second optional param object][qr-code-options] for cusomizing the QR code.\n\n```js\n  upiqr(intentFields, {\n    color: {\n      dark: '#000000',\n      light: '#FFFFFF'\n    }\n  })\n\n```\n\n\u003c!--- [![Code Coverage][codecov-img]][codecov-url] ---\u003e\n\n[build-img]:https://github.com/bhar4t/upiqr/actions/workflows/main.yml/badge.svg\n[build-url]:https://github.com/bhar4t/upiqr/actions/workflows/main.yml\n[downloads-img]:https://img.shields.io/npm/dt/upiqr\n[downloads-url]:https://www.npmtrends.com/upiqr\n[npm-img]:https://img.shields.io/npm/v/upiqr\n[npm-url]:https://www.npmjs.com/package/upiqr\n[issues-img]:https://img.shields.io/github/issues/bhar4t/upiqr\n[issues-url]:https://github.com/bhar4t/upiqr/issues\n[codecov-img]:https://codecov.io/gh/bhar4t/upiqr/branch/main/graph/badge.svg\n[codecov-url]:https://codecov.io/gh/bhar4t/upiqr\n[semantic-release-img]:https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg\n[semantic-release-url]:https://github.com/semantic-release/semantic-release\n[commitizen-img]:https://img.shields.io/badge/commitizen-friendly-brightgreen.svg\n[commitizen-url]:http://commitizen.github.io/cz-cli/\n[qr-code-options]:https://www.npmjs.com/package/qrcode#qr-code-options\n[upi-specs-url]:https://www.npci.org.in/PDF/npci/upi/circular/2017/Circular18_BankCompliances_to_enbaleUPIMerchantecosystem_0.pdf\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbhar4t%2Fupiqr","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbhar4t%2Fupiqr","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbhar4t%2Fupiqr/lists"}