🏦 API danh sách ngân hàng

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

Bash

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

NodeJS

Cài đặt thư viện

    npm install vietqr

Sử dụng

    import {VietQR} from 'vietqr';

    let vietQR = new VietQR({
        clientID: 'client_id_here',
        apiKey: 'api_key_here',
    });

    // list banks are supported create QR code by Vietqr
    vietQR.getBanks().then((banks)=>{
        console.log(banks);
    }).catch((err)=>{});

Kết quả trả về

{
    "code": "00",
    "desc": "Get Bank list successful! Total 55 banks",
    "data": [{
        "id": 1,
        "name": "Ngân hàng TMCP An Bình",
        "code": "ABB",
        "bin": "970425",
        "shortName": "ABBANK",
        "logo": "https://api.vietqr.io/img/ABB.png",
        "transferSupported": 1,
        "lookupSupported": 1
    }, {
        "id": 2,
        "name": "Ngân hàng TMCP Á Châu",
        "code": "ACB",
        "bin": "970416",
        "shortName": "ACB",
        "logo": "https://api.vietqr.io/img/ACB.png",
        "transferSupported": 1,
        "lookupSupported": 1
    }
    //và 53 bank khác
}

Mỗi ngân hàng sẽ có các thông số:

id	ID	1
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
shortName	Tên ngắn gọn thường gọi	BIDV
code	Tên mã ngân hàng	BIDV
bin	Mã ngân hàng, sử dụng mã này trong Quick Link	970418
logo	Đường dẫn tới logo ngân hàng	https://api.vietqr.io/img/ICB.3d4d6760.png
transferSupported	App của Bank hỗ trợ chuyển tiền bằng cách quét mã VietQR	0 hoặc 1
lookupSupported	Số tài khoản của Bank có thể tra cứu bằng API tra cứu số tài khoản	0 hoặc 1
short_name	Tương tự shortName (sẽ bỏ field này ở v3)	MBBank
isTransfer	Tương tự transferSupported (sẽ bỏ field này ở v3)	0 hoặc 1
support	Mức độ hỗ trợ VietQR của ngân hàng (sẽ bỏ field này ở v3)	Từ 0 tới 3

thông tin

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.