API danh sách ngân hàng
Api trả về danh sách các ngân hàng mà VietQR hỗ trợ

Công dụng

Api trả về danh sách các ngân hàng mà VietQR hỗ trợ. Và từ đó lấy trích ra mã ngân hàng dùng trong Quick Link

Đặc tả

GET https://api.vietqr.io/v2/banks

Sử dụng

NodeJS
CURL
Cài đặt thư viện
1
npm install vietqr
Copied!
Sử dụng
1
import {VietQR} from 'vietqr';
2
3
let vietQR = new VietQR({
4
clientID: 'client_id_here',
5
apiKey: 'api_key_here',
6
});
7
8
// list banks are supported create QR code by Vietqr
9
vietQR.getBanks().then((banks)=>{
10
console.log(banks);
11
}).catch((err)=>{});
12
Copied!
1
curl https://api.vietqr.io/v2/banks
Copied!

Kết quả trả về

1
{
2
"code": "00",
3
"desc": "Get Bank list successful! Total 52 banks",
4
"data": [{
5
"id": 17,
6
"name": "Ngân hàng TMCP Công thương Việt Nam",
7
"code": "ICB",
8
"bin": "970415",
9
"isTransfer": 1,
10
"short_name": "VietinBank",
11
"logo": "https://api.vietqr.io/img/ICB.3d4d6760.png",
12
"support": 3
13
}, {
14
"id": 43,
15
"name": "Ngân hàng TMCP Ngoại Thương Việt Nam",
16
"code": "VCB",
17
"bin": "970436",
18
"isTransfer": 1,
19
"short_name": "Vietcombank",
20
"logo": "https://api.vietqr.io/img/VCB.237d4924.png",
21
"support": 3
22
},
23
//... and 47 banks
24
]
25
}
Copied!
Mỗi ngân hàng sẽ có các thông số:
Trường
Ý nghĩa
Ví dụ
code
Tên mã ngân hàng
BIDV
name
Tên pháp nhân ngân hàng
Ngân hàng TMCP Đầu tư và Phát triển Việt Nam
bin
Mã ngân hàng, sử dụng mã này trong Quick Link
970418
short_name
Tên thương hiệu ngắn gọn thường được gọi của ngân hàng
MBBank
logo
Đường dẫn tới logo ngân hàng
isTransfer
App ngân hàng đã hỗ trợ chuyển tiền bằng cách quét mã VietQR hay chưa?
1 hoặc 0
support
Mức độ hỗ trợ VietQR của ngân hàng
Từ 0 tới 3
Các giá trị của trường vietqr
  • support = 0 : Ngân hàng chỉ hỗ trợ tạo mã, chưa hỗ trợ quét mã
  • support = 1 : Ngân hàng tuyên bố hỗ trợ tích hợp quét mã VietQR nhưng chưa thực hiện.
  • support = 2 : Ngân hàng đã hỗ trợ quét mã 1 phần trong App, một số tính năng khác ko quét được.
  • support = 3 : Ngân hàng đã hỗ trợ hoàn toàn VietQR trong App
API này trả về danh sách ngân hàng hỗ trợ, danh sách này có thể sẽ thay đổi trong tương lai (thêm / xóa / sửa). Do đó, nếu bạn có ý định cache thì chúng tôi khuyến cáo bạn làm mới danh sách này theo ngày.