{"id":21229671,"url":"https://github.com/hdrajs/bank-qr","last_synced_at":"2025-07-13T08:39:15.986Z","repository":{"id":247253419,"uuid":"816188228","full_name":"hdrajs/bank-qr","owner":"hdrajs","description":"Thư viện hỗ trợ encode/decode mã QR của VietQR (QR Ngân hàng, QR Đa năng Momo/ZaloPay) \u0026 VNPayQR","archived":false,"fork":false,"pushed_at":"2024-07-08T09:53:23.000Z","size":65,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-02-26T03:35:39.813Z","etag":null,"topics":["qr-code","qrcode","scan","vietqr","vnpay","vnpay-api","vnpayment"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/bank-qr","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hdrajs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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}},"created_at":"2024-06-17T08:09:39.000Z","updated_at":"2024-07-08T09:38:33.000Z","dependencies_parsed_at":null,"dependency_job_id":"cae46b7c-cd0d-46ac-9cb8-4d582a65f29c","html_url":"https://github.com/hdrajs/bank-qr","commit_stats":null,"previous_names":["hoanledev/bank-qr"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hdrajs%2Fbank-qr","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hdrajs%2Fbank-qr/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hdrajs%2Fbank-qr/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hdrajs%2Fbank-qr/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hdrajs","download_url":"https://codeload.github.com/hdrajs/bank-qr/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243672484,"owners_count":20328768,"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":["qr-code","qrcode","scan","vietqr","vnpay","vnpay-api","vnpayment"],"created_at":"2024-11-20T23:28:58.009Z","updated_at":"2025-03-15T02:14:56.704Z","avatar_url":"https://github.com/hdrajs.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Vietnam QR Pay\n\nThư viện hỗ trợ encode/decode mã QR của VietQR (QR Ngân hàng, QR Đa năng Momo/ZaloPay) \u0026 VNPayQR\n\n\n## Install\n\n```bash\nyarn add bank-qr\n```\n\n\n## Encode - Tạo mã QR\n\n### VietQR Tĩnh\n```javascript\n\nimport { QRPay, BanksObject } from 'bank-qr';\n\nconst qrPay = QRPay.initVietQR({\n  bankBin: BanksObject.acb.bin,\n  bankNumber: '123456789', // Số tài khoản\n})\nconst content = qrPay.build()\n\nconsole.log(content)\n \n```\n\n### VietQR Động\n\n```javascript\nimport { QRPay, BanksObject } from 'bank-qr';\n\nconst qrPay = QRPay.initVietQR({\n  bankBin: BanksObject.acb.bin,\n  bankNumber: '123456789', // Số tài khoản\n  amount: '10000', // Số tiền\n  purpose: 'Chuyen tien', // Nội dung chuyển tiền\n})\nconst content = qrPay.build()\n\nconsole.log(content)\n\n```\n\n### QR Đa năng của MoMo và ZaloPay\n\nHiện tại, QR Đa năng của MoMo và ZaloPay đang thông qua Ngân hàng Bản Việt (BVBank) để nhận tiền.\n\nMỗi tài khoản MoMo/ZaloPay sẽ được gán một STK tương ứng tại BVBank. Tiền chuyển đến STK này sẽ được chuyển tiếp đến ví MoMo/ZaloPay.\n\nBạn có thể lấy STK này tại trang chi tiết của QR Nhận tiền trong ứng dụng MoMo/ZaloPay.\n\n#### MoMo\n\n```javascript\nimport { QRPay, BanksObject } from 'bank-qr';\n\n// Số tài khoản trong ví MoMo\nconst accountNumber = '99MM24011M0000000'\n\nconst momoQR = QRPay.initVietQR({\n  bankBin: BanksObject.banviet.bin,\n  bankNumber: accountNumber,\n  // amount: '10000', // Số tiền (không bắt buộc)\n  // purpose: 'Chuyen tien', // Nội dung (không bắt buộc)\n})\n\n// Trong mã QR của MoMo có chứa thêm 1 mã tham chiếu tương ứng với STK\nmomoQR.additionalData.reference = 'MOMOW2W' + accountNumber.slice(10)\n\n// Mã QR của MoMo có thêm 1 trường ID 80 với giá trị là 3 số cuối của SỐ ĐIỆN THOẠI của tài khoản nhận tiền\nmomoQR.setUnreservedField('80', '046')\n\nconst content = momoQR.build()\n\n\n```\n\n#### ZaloPay\n\n\u003e Trong mã QR của ZaloPay có chứa một số thông tin bổ sung ở trường ID 26. Tuy nhiên chưa rõ chức năng của các thông tin này (có thể là dùng để định danh từng mã QR đc tạo trên hệ thống của ZaloPay). Trong ví dụ dưới sẽ bỏ qua các thông tin này.\n\n```javascript\nimport { QRPay, BanksObject } from 'bank-qr';\n\n// Số tài khoản trong ví ZaloPay\nconst accountNumber = '99ZP24009M00000000'\n  \nconst zaloPayQR = QRPay.initVietQR({\n  bankBin: BanksObject.banviet.bin,\n  bankNumber: accountNumber,\n  // amount: '10000', // Số tiền (không bắt buộc)\n  // purpose: 'Chuyen tien', // Nội dung (không bắt buộc)\n})\n\nconst content = zaloPayQR.build()\n```\n\n\n\n### VNPay \n\n```javascript\nconst qrPay = QRPay.initVNPayQR({\n  merchantId: '0102154778',\n  merchantName: 'TUGIACOMPANY',\n  store: 'TU GIA COMPUTER',\n  terminal: 'TUGIACO1',\n})\nconst content = qrPay.build()\nconsole.log(content)\n\n```\n\n\n## Decode mã QR\n\n### VietQR\n```javascript\nimport { QRPay } from 'bank-qr';\n\nconst qrContent = '00020101021238530010A0000007270123000697041601091234567890208QRIBFTTA5303704540410005802VN62150811Chuyen tien6304BBB8'\nconst qrPay = new QRPay(qrContent);\nconsole.log(qrPay.isValid) // true\nconsole.log(qrPay.provider.name) // VIETQR\nconsole.log(qrPay.consumer.bankBin) // 970416\nconsole.log(qrPay.consumer.bankNumber) // 123456789\nconsole.log(qrPay.amount) // 1000\nconsole.log(qrPay.additionalData.purpose) // Chuyen tien\n\n```\n\n### VNPay\n```javascript\nimport { QRPay } from 'bank-qr';\n\nconst qrContent = '00020101021126280010A0000007750110010531314453037045408210900005802VN5910CELLPHONES62600312CPSHN ONLINE0517021908061613127850705ONLHN0810CellphoneS63047685'\nconst qrPay = new QRPay(qrContent);\nconsole.log(qrPay.isValid) // true\nconsole.log(qrPay.provider.name) // VNPAY\nconsole.log(qrPay.merchant.merchantId) // 0105313144\nconsole.log(qrPay.amount) // 21090000\nconsole.log(qrPay.additionalData.store) // CPSHN ONLINE\nconsole.log(qrPay.additionalData.terminal) // ONLHN\nconsole.log(qrPay.additionalData.purpose) // CellphoneS\nconsole.log(qrPay.additionalData.reference) // 02190806161312785\n\n```\n\n\n## `QRPay` class\n\n\n```javascript\nimport { QRPay } from 'bank-qr';\n```\n\n| Name | Type | Description |\n| --- | --- | --- |\n| `isValid` | `boolean` | Kiểm tra tính hợp lệ của mã QR |\n| `initMethod` | `string` | Phương thức khởi tạo (`11` - QR Tĩnh, `12` - QR động) |\n| `provider` | `Provider` | Thông tin nhà cung cấp |\n| `merchant` | `Merchant` | Thông tin merchant |\n| `consumer` | `Consumer` | Thông tin người thanh toán |\n| `amount` | `string` | Số tiền giao dịch |\n| `currency` | `string` | Mã tiền tệ (VNĐ: 704) |\n| `nation` | `string` | Mã quốc gia |\n| `additionalData` | `AdditionalData` | Thông tin bổ sung |\n| `crc` | `string` | Mã kiểm tra |\n| `build()` | `method` | Tạo lại mã QR mới |\n\n### `Provider` class\n\nThông tin đơn vị cung cấp mã QR (VietQR, VNPay)\n\n\n| Name | Type | Description |\n| --- | --- | --- |\n| `guid` | `string` | Mã định danh toàn cầu |\n| `name` | `string` | Tên nhà cung cấp |\n\n### `Merchant` class\n\nThông tin merchant (Đơn vị chấp nhận thanh toán)\n\n| Name | Type | Description |\n| --- | --- | --- |\n| `id` | `string` | Mã định danh đơn vị CNTT |\n| `name` | `string` | Tên đơn vị CNTT |\n\n### `Consumer` class\n\nThông tin người thanh toán\n\n| Name | Type | Description |\n| --- | --- | --- |\n| `bankBin` | `string` | Mã ngân hàng |\n| `bankNumber` | `string` | Số tài khoản |\n\n### `AdditionalData` class\n\nThông tin bổ sung\n\n| Name | Type | Description |\n| --- | --- | --- |\n| `billNumber` | `string` | Số hóa đơn |\n| `mobileNumber` | `string` | Số điện thoại di động |\n| `store` | `string` | Tên cửa hàng |\n| `loyaltyNumber` | `string` | Mã khách hàng thân thiết |\n| `reference` | `string` | Mã Tham chiếu |\n| `customerLabel` | `string` | Mã khách hàng |\n| `terminal` | `string` | Tên điểm bản |\n| `purpose` | `string` | Nội dung giao dịch |\n\n###  `build()` method\n\nTrả về nội dung mã QR mới\n\n```javascript\nimport { QRPay } from 'bank-qr';\n\n\nconst qrContent = '00020101021238530010A0000007270123000697041601091234567890208QRIBFTTA5303704540410005802VN62150811Chuyen tien6304BBB8'\nconst qrPay = new QRPay(qrContent);\n\n// qrPay.amount === \"10000\"\n// qrPay.additionalData.purpose === \"Chuyen tien\"\n\nqrPay.amount = '999999';\nqrPay.additionalData.purpose = 'Cam on nhe';\n\nconst newQRContent = qrPay.build();\n\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhdrajs%2Fbank-qr","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhdrajs%2Fbank-qr","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhdrajs%2Fbank-qr/lists"}