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

Nguồn HTML: https://www.vietqr.io/api-bank
Bản Markdown này: https://www.vietqr.io/api-bank.md

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

[Xem demo danh sách ngân hàng](/api-bank/demo)

## Đặc tả

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

## Sử dụng

  

### Bash

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

  
  

### NodeJS

Cài đặt thư viện

```bash
npm install vietqr
```

Sử dụng

```javascript


// Từ vietqr 1.2.0 không cần clientID / apiKey
let vietQR = new VietQR();

// Danh sách ngân hàng hỗ trợ VietQR
vietQR.getBanks().then((banks)=>{
    console.log(banks);
}).catch((err)=>{});
```

**Không cần clientID và apiKey**

Từ thư viện `vietqr` bản 1.2.0, không cần `clientID` và `apiKey` nữa, chỉ cần `new VietQR()`. Code cũ có truyền `{ clientID, apiKey }` vẫn chạy bình thường: thư viện bỏ qua key và in một cảnh báo.

Nếu API không phản hồi trong 2 giây hoặc trả lỗi, `getBanks()` trả danh sách ngân hàng có sẵn trong thư viện, cùng định dạng.

  

## Kết quả trả về

```javascript
{
    "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](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](/tra-cuu-stk) | 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                                                                               |

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.

## Cam kết dịch vụ

- **SLA:** 99.99% — Thời gian hoạt động
- **Giới hạn gọi:** Không giới hạn — Không áp rate limit
- **Quy mô:** 50 triệu — Lượt gọi API mỗi ngày