Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/hdrajs/bank-qr

Thư viện hỗ trợ encode/decode mã QR của VietQR (QR Ngân hàng, QR Đa năng Momo/ZaloPay) & VNPayQR
https://github.com/hdrajs/bank-qr

qr-code qrcode scan vietqr vnpay vnpay-api vnpayment

Last synced: 4 days ago
JSON representation

Thư viện hỗ trợ encode/decode mã QR của VietQR (QR Ngân hàng, QR Đa năng Momo/ZaloPay) & VNPayQR

Host: GitHub
URL: https://github.com/hdrajs/bank-qr
Owner: hdrajs
Created: 2024-06-17T08:09:39.000Z (7 months ago)
Default Branch: main
Last Pushed: 2024-07-08T09:53:23.000Z (7 months ago)
Last Synced: 2024-12-21T13:48:08.454Z (about 1 month ago)
Topics: qr-code, qrcode, scan, vietqr, vnpay, vnpay-api, vnpayment
Language: TypeScript
Homepage: https://www.npmjs.com/package/bank-qr
Size: 63.5 KB
Stars: 0
Watchers: 0
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

        # Vietnam QR Pay

Thư viện hỗ trợ encode/decode mã QR của VietQR (QR Ngân hàng, QR Đa năng Momo/ZaloPay) & VNPayQR

## Install

```bash

yarn add bank-qr

```

## Encode - Tạo mã QR

### VietQR Tĩnh

```javascript

import { QRPay, BanksObject } from 'bank-qr';

const qrPay = QRPay.initVietQR({

  bankBin: BanksObject.acb.bin,

  bankNumber: '123456789', // Số tài khoản

})

const content = qrPay.build()

console.log(content)

 

```

### VietQR Động

```javascript

import { QRPay, BanksObject } from 'bank-qr';

const qrPay = QRPay.initVietQR({

  bankBin: BanksObject.acb.bin,

  bankNumber: '123456789', // Số tài khoản

  amount: '10000', // Số tiền

  purpose: 'Chuyen tien', // Nội dung chuyển tiền

})

const content = qrPay.build()

console.log(content)

```

### QR Đa năng của MoMo và ZaloPay

Hiệ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.

Mỗ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.

Bạ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.

#### MoMo

```javascript

import { QRPay, BanksObject } from 'bank-qr';

// Số tài khoản trong ví MoMo

const accountNumber = '99MM24011M0000000'

const momoQR = QRPay.initVietQR({

  bankBin: BanksObject.banviet.bin,

  bankNumber: accountNumber,

  // amount: '10000', // Số tiền (không bắt buộc)

  // purpose: 'Chuyen tien', // Nội dung (không bắt buộc)

})

// Trong mã QR của MoMo có chứa thêm 1 mã tham chiếu tương ứng với STK

momoQR.additionalData.reference = 'MOMOW2W' + accountNumber.slice(10)

// 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

momoQR.setUnreservedField('80', '046')

const content = momoQR.build()

```

#### ZaloPay

> 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.

```javascript

import { QRPay, BanksObject } from 'bank-qr';

// Số tài khoản trong ví ZaloPay

const accountNumber = '99ZP24009M00000000'

  

const zaloPayQR = QRPay.initVietQR({

  bankBin: BanksObject.banviet.bin,

  bankNumber: accountNumber,

  // amount: '10000', // Số tiền (không bắt buộc)

  // purpose: 'Chuyen tien', // Nội dung (không bắt buộc)

})

const content = zaloPayQR.build()

```

### VNPay 

```javascript

const qrPay = QRPay.initVNPayQR({

  merchantId: '0102154778',

  merchantName: 'TUGIACOMPANY',

  store: 'TU GIA COMPUTER',

  terminal: 'TUGIACO1',

})

const content = qrPay.build()

console.log(content)

```

## Decode mã QR

### VietQR

```javascript

import { QRPay } from 'bank-qr';

const qrContent = '00020101021238530010A0000007270123000697041601091234567890208QRIBFTTA5303704540410005802VN62150811Chuyen tien6304BBB8'

const qrPay = new QRPay(qrContent);

console.log(qrPay.isValid) // true

console.log(qrPay.provider.name) // VIETQR

console.log(qrPay.consumer.bankBin) // 970416

console.log(qrPay.consumer.bankNumber) // 123456789

console.log(qrPay.amount) // 1000

console.log(qrPay.additionalData.purpose) // Chuyen tien

```

### VNPay

```javascript

import { QRPay } from 'bank-qr';

const qrContent = '00020101021126280010A0000007750110010531314453037045408210900005802VN5910CELLPHONES62600312CPSHN ONLINE0517021908061613127850705ONLHN0810CellphoneS63047685'

const qrPay = new QRPay(qrContent);

console.log(qrPay.isValid) // true

console.log(qrPay.provider.name) // VNPAY

console.log(qrPay.merchant.merchantId) // 0105313144

console.log(qrPay.amount) // 21090000

console.log(qrPay.additionalData.store) // CPSHN ONLINE

console.log(qrPay.additionalData.terminal) // ONLHN

console.log(qrPay.additionalData.purpose) // CellphoneS

console.log(qrPay.additionalData.reference) // 02190806161312785

```

## `QRPay` class

```javascript

import { QRPay } from 'bank-qr';

```

| Name | Type | Description |

| --- | --- | --- |

| `isValid` | `boolean` | Kiểm tra tính hợp lệ của mã QR |

| `initMethod` | `string` | Phương thức khởi tạo (`11` - QR Tĩnh, `12` - QR động) |

| `provider` | `Provider` | Thông tin nhà cung cấp |

| `merchant` | `Merchant` | Thông tin merchant |

| `consumer` | `Consumer` | Thông tin người thanh toán |

| `amount` | `string` | Số tiền giao dịch |

| `currency` | `string` | Mã tiền tệ (VNĐ: 704) |

| `nation` | `string` | Mã quốc gia |

| `additionalData` | `AdditionalData` | Thông tin bổ sung |

| `crc` | `string` | Mã kiểm tra |

| `build()` | `method` | Tạo lại mã QR mới |

### `Provider` class

Thông tin đơn vị cung cấp mã QR (VietQR, VNPay)

| Name | Type | Description |

| --- | --- | --- |

| `guid` | `string` | Mã định danh toàn cầu |

| `name` | `string` | Tên nhà cung cấp |

### `Merchant` class

Thông tin merchant (Đơn vị chấp nhận thanh toán)

| Name | Type | Description |

| --- | --- | --- |

| `id` | `string` | Mã định danh đơn vị CNTT |

| `name` | `string` | Tên đơn vị CNTT |

### `Consumer` class

Thông tin người thanh toán

| Name | Type | Description |

| --- | --- | --- |

| `bankBin` | `string` | Mã ngân hàng |

| `bankNumber` | `string` | Số tài khoản |

### `AdditionalData` class

Thông tin bổ sung

| Name | Type | Description |

| --- | --- | --- |

| `billNumber` | `string` | Số hóa đơn |

| `mobileNumber` | `string` | Số điện thoại di động |

| `store` | `string` | Tên cửa hàng |

| `loyaltyNumber` | `string` | Mã khách hàng thân thiết |

| `reference` | `string` | Mã Tham chiếu |

| `customerLabel` | `string` | Mã khách hàng |

| `terminal` | `string` | Tên điểm bản |

| `purpose` | `string` | Nội dung giao dịch |

###  `build()` method

Trả về nội dung mã QR mới

```javascript

import { QRPay } from 'bank-qr';

const qrContent = '00020101021238530010A0000007270123000697041601091234567890208QRIBFTTA5303704540410005802VN62150811Chuyen tien6304BBB8'

const qrPay = new QRPay(qrContent);

// qrPay.amount === "10000"

// qrPay.additionalData.purpose === "Chuyen tien"

qrPay.amount = '999999';

qrPay.additionalData.purpose = 'Cam on nhe';

const newQRContent = qrPay.build();

```