VIETQR

• Support draw QR code from data bank ( accountName, amount, memo,....) with many templates
• Support create link URL from QR code

Table of Contents

• Features
• Choose what you need
• Try It!
• Demo preview
• Installation
• Example
• Vietqr API
• License

Features

• Support draw QR code from data bank ( accountName, amount, memo,....) with many templates
• Support create link URL from QR code

Choose what you need

Project	Support
VietQR	- Running with DOM on CLIENT-SIDE: Browser(IE6+, Chrome, Firefox, Safari, Opera, Mobile Safari, Android, Windows Mobile, etc.), Electron, NW.js, etc. - Running without DOM on SERVER-SIDE: Save image to file(PNG/JPEG/Base64) or get data url text. NodeJS, Electron, NW.js, etc. - A QRCode generator for React Native: Generate QRCode image or get base64 data url text.

Try It!

Try It!

Demo preview

Installation

• Download install

  https://github.com/vietqr/vietqr-node

• Npm install

  1npm install vietqr

Example

1import {VietQR} from 'vietqr';
2
3
4let vietQR = new VietQR({
5    clientID: 'de8a0804-a76d-41e5-8ad6-31503ce7d5f4',
6    apiKey: '17c29f09-4ea2-4417-b9c2-7f020d35de42',
7});
8
9// list banks are supported create QR code by Vietqr
10vietQR.getBanks().then((banks)=>{console.log(banks)})
11.catch((err)=>{});
12
13// list templates are supported by Vietqr
14vietQR.getTemplate().then((data)=>{console.log(data)})
15.catch((err)=>{});
16
17
18// create QR code from data
19vietQR.genQRCodeBase64({
20    bank: '970415',
21    accountName: 'QUY VAC XIN PHONG CHONG COVID',
22    accountNumber: '113366668888',
23    amount: '79000',
24    memo: 'Ung Ho Quy Vac Xin',
25    template: 'compact'
26}).then((data)=>{console.log(data)})
27.catch((err)=>{});
28

VietQR API

Option	Description
bank	Get the bin field corresponding to the data returned in the banks API (VietQR.getTemplate() or API Bank)
accountName	Bank account name
accountNumber	Bank account number
amount	Amount of money
memo	Money transfer content
template	Type of template returned to the user
clientID	api_key is provided when registering an account at http://my.vietqr.io/
apiKey	client_key is provided when registering an account at http://my.vietqr.io/

getTemplate()

1vietQR.getTemplate().then((data)=>{console.log(data)})
2.catch((err)=>{});

Response successfully

1 {
2  code: '00',
3  desc: 'success',
4  data: [
5    {
6      name: 'QR Only',
7      template: 'qr_only',
8      demo: 'https://api.vietqr.io/Vietinbank/113366668888/790000/Gop%20Quy/qr_only.jpg?accountName=Quy%20Vacxin%20Covid'
9    },
10    {
11      name: 'Compact',
12      template: 'compact',
13      demo: 'https://api.vietqr.io/Vietinbank/113366668888/790000/Gop%20Quy/compact.jpg?accountName=Quy%20Vacxin%20Covid'
14    },
15    {
16      name: 'Compact 2',
17      template: 'compact2',
18      demo: 'https://api.vietqr.io/Vietinbank/113366668888/790000/Gop%20Quy/compact2.jpg?accountName=Quy%20Vacxin%20Covid'
19    }
20  ]
21}

getBanks()

1vietQR.getBanks().then((data)=>{console.log(data)})
2.catch((err)=>{});

Response successfully

1{
2  code: '00',
3  desc: 'Get Bank list successful! Total 52 banks',
4  data: [
5    {
6      id: 17,
7      name: 'Ngân hàng TMCP Công thương Việt Nam',
8      code: 'ICB',
9      bin: '970415',
10      isTransfer: 1,
11      short_name: 'VietinBank',
12      logo: 'https://api.vietqr.io/img/ICB.3d4d6760.png',
13      support: 3
14    },
15    ....
16  ]
17}

genQuickLink()

1let link = vietQR.genQuickLink({
2        bank: '970415',
3        accountName: 'QUY VAC XIN PHONG CHONG COVID',
4        accountNumber: '113366668888',
5        amount: '79000',
6        memo: 'Ung Ho Quy Vac Xin',
7        template: 'compact', 
8        media: '.jpg' 
9    });
10console.log(link);

genQRCodeBase64()

1vietQR.genQRCodeBase64({
2    bank: '970415',
3    accountName: 'QUY VAC XIN PHONG CHONG COVID',
4    accountNumber: '113366668888',
5    amount: '79000',
6    memo: 'Ung Ho Quy Vac Xin',
7    template : 'qr_only'
8}).then((data)=>{console.log(data)})
9.catch((err)=>{});

Response successfully

1{
2    "code": "00",
3    "desc": "Gen VietQR successful!",
4    "data": {
5        "acqId": "970415",
6        "accountName": "QUY VAC XIN PHONG CHONG COVID",
7        "qrDataURL": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAOwAAADeCAYAAAA..."
8    }
9}

License

MIT License