API tạo mã QR
Chuyển sang thư viện vietqr
Thư viện vietqr (bản 1.2.0 trở lên) tạo mã QR offline, ngay trên hệ thống của bạn, không gọi API và không cần clientID / apiKey.
npm install vietqr
Dự án đang dùng vietqr bản cũ chỉ cần nâng cấp, không phải sửa code: genQRCodeBase64() vẫn trả về đúng định dạng như trước.
let vietQR = new VietQR();
// Ảnh QR (PNG, JPG hoặc SVG) và chuỗi QR, tạo offline
vietQR.genQRCodeBase64({
bank: '970415',
accountName: 'QUY VAC XIN PHONG CHONG COVID',
accountNumber: '113366668888',
amount: '79000',
memo: 'Ung Ho Quy Vac Xin',
media: 'png' // 'png' | 'jpg' | 'svg'
}).then((res)=>{
console.log(res.data.data.qrCode); // chuỗi QR
console.log(res.data.data.qrDataURL); // data:image/png;base64,...
}).catch((err)=>{});
Hàm generateQR nhận đúng body và trả đúng response JSON như POST /v2/generate, tiện để thay thế trực tiếp:
const { generateQR } = require('vietqr');
const res = await generateQR({
accountNo: '113366668888',
accountName: 'QUY VAC XIN PHONG CHONG COVID',
acqId: '970415',
amount: 79000,
addInfo: 'Ung Ho Quy Vac Xin'
});
// { code: '00', desc: 'Gen VietQR successful!', data: { acqId, accountName, qrCode, qrDataURL } }
| Cần gì | Dùng |
|---|---|
| Chuỗi QR (text) | genQRText(), hoặc genQRCodeBase64({ template: 'text' }) |
| Ảnh QR PNG / JPG / SVG | genQRCodeBase64({ media }) |
Ảnh QR theo mẫu (compact, compact2, print, ...) | genQuickLink({ template }), ảnh do Quick Link tạo |
Đặc tả API cũ
Đặc tả dưới đây giữ lại để tham khảo cho các tích hợp đang chạy.
https://api.vietqr.io/v2/generateTạo mã QR (đã ngừng hỗ trợ)
API này đã ngừng hỗ trợ và ngừng hoạt động từ 01/01/2027. Dùng thư viện vietqr (npm install vietqr) để tạo mã QR offline.
Tham số
| Trường | Mô tả |
|---|---|
x-client-id bắt buộcheader | Client Id để chứng thực. Truy cập [My VietQR](https://my.vietqr.io) để lấy Client Id |
x-api-key bắt buộcheader | API key để chứng thực. Truy cập [My VietQR](https://my.vietqr.io) để lấy API Key |
Body
| Trường | Mô tả |
|---|---|
accountNo bắt buộcstring | Số tài khoản ngân hàng thụ hưởng. Chỉ nhập số, tối thiểu 6 ký tự, tối đa 19 kí tự Ví dụ: 113366668888 |
accountNamestring | Tên tài khoản ngân hàng. Nhập tiếng Việt không dấu, viết hoa, tối thiểu 5 ký tự, tối đa 50 kí tự, không chứa các ký tự đặc biệt. Ví dụ: QUY VAC XIN PHONG CHONG COVID |
acqId bắt buộcinteger | Mã định danh ngân hàng (thường gọi là BIN) 6 chữ số, quy đinh bởi ngân hàng nước Ví dụ: 970415 |
amountinteger | Số tiền chuyển. Chỉ nhập số, tối đa 13 kí tự Ví dụ: 79000 |
addInfostring | Nội dung chuyển tiền. Nhập tiếng Việt không dấu, tối đa 25 ký tự. Không chứa các ký tự đặc biệt Ví dụ: Ung Ho Quy Vac Xin |
formatstring | Định dạng VietQR trả về Ví dụ: text |
templatestring | Mẫu VietQR trả về Ví dụ: compact |
Response 200
Trạng thái thành công
Success — Thành công
{
"code": "00",
"desc": "Gen VietQR successful!",
"data": {
"acpId": 970415,
"accountName": "QUY VAC XIN PHONG CHONG COVID 19",
"qrCode": "00020101021238560010A0000007270126000697041501121133666688880208QRIBFTTA53037045405790005802VN62220818Ung Ho Quy Vac Xin63043ACF",
"qrDataURL": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAeAAAAHgCAYAAAB91L6VAAAAAk…"
}
}Thiếu tham số — Thiếu tham số
{
"code": "01",
"desc": "Thiếu tham số"
}Thiếu tham số Mã tài khoản — Thiếu tham số Mã tài khoản
{
"code": "11",
"desc": "Thiếu tham số Mã tài khoản"
}Thiếu tham số Mã ngân hàng — Thiếu tham số Mã ngân hàng
{
"code": "12",
"desc": "Thiếu tham số Mã ngân hàng"
}Thiếu tham số Tên tài khoản — Thiếu tham số Tên tài khoản
{
"code": "13",
"desc": "Thiếu tham số Tên tài khoản"
}Mã tài khoản không hợp lệ — Mã tài khoản không hợp lệ
{
"code": "21",
"desc": "Mã tài khoản không hợp lệ"
}Mã ngân hàng không hợp lệ — Mã ngân hàng không hợp lệ
{
"code": "22",
"desc": "Mã ngân hàng không hợp lệ"
}Tên tài khoản không hợp lệ — Tên tài khoản không hợp lệ
{
"code": "23",
"desc": "Tên tài khoản không hợp lệ"
}Số tiền không hợp lệ — Số tiền không hợp lệ
{
"code": "24",
"desc": "Số tiền không hợp lệ"
}Nội dung chuyển tiền không hợp lệ — Nội dung chuyển tiền không hợp lệ
{
"code": "25",
"desc": "Nội dung chuyển tiền không hợp lệ"
}