# 💼 API tra cứu Số Tài Khoản

Nguồn HTML: https://www.vietqr.io/tra-cuu-stk
Bản Markdown này: https://www.vietqr.io/tra-cuu-stk.md

## Demo
![](/img/lookup_account_number_demo.gif)

Chúng tôi đang thực hiện việc migrate vào bộ [API Pay Out](https://cas.so/product/pay-out) của CAS, nhằm tuân thủ các quy định và lộ trình triển khai giao diện lập trình ứng dụng mở trong ngành Ngân hàng.
Bộ API Cas Pay Out sẽ bao gồm API tra cứu STK & API Chuyển tiền, trực tiếp từ tài khoản doanh nghiệp không qua trung gian.

### POST /lookup

`https://api.vietqr.io/v2/lookup`

Tra cứu số tài khoản

API dùng để kiểm tra một số tài khoản ngân hàng có hợp lệ hay không. 
Nếu Số tài khoản này là hợp lệ, API sẽ trả về Tên Tài Khoản.

#### Tham số

| Trường | Bắt buộc | Loại | Mô tả | Ví dụ |
| --- | --- | --- | --- | --- |
| x-client-id | Có | header | Client Id để chứng thực. Truy cập https://my.vietqr.io để lấy Client Id |  |
| x-api-key | Có | header | API key để chứng thực. Truy cập https://my.vietqr.io để lấy API Key |  |

#### Body

| Trường | Bắt buộc | Loại | Mô tả | Ví dụ |
| --- | --- | --- | --- | --- |
| bin | Có | integer | Mã BIN ngân hàng | 970415 |
| accountNumber | Có | string | 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ự | 113366668888 |

#### Response 200

Số tài khoản hợp lệ

Success — Success - Thành công

```json
{
  "code": "00",
  "desc": "Success - Thành công",
  "data": {
    "accountName": "QUY VAC XIN PHONG COVID 19"
  }
}
```

Account number invalid — Account number Invalid - Số tài khoản không hợp lệ

```json
{
  "code": "42",
  "desc": "Account number Invalid - Số tài khoản không hợp lệ"
}
```

Bank not support — Bank not support - Ngân hàng không hỗ trợ

```json
{
  "code": "41",
  "desc": "Bank not support - Ngân hàng không hỗ trợ"
}
```

Somthing went wrong — Oops, Something went wrong - Lỗi không xác định

```json
{
  "code": "43",
  "desc": "Oops, Something went wrong - Lỗi không xác định"
}
```

All provider busy — All provider busy - Tất cả các API Provider đều đang bận.

```json
{
  "code": "45",
  "desc": "All provider busy - Tất cả các API Provider đều đang bận."
}
```

Missing param — Missing param BIN/accountNumber

```json
{
  "code": "10",
  "desc": "Missing param"
}
```

Invalid BIN — Invalid acqId - 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. Xem BIN tại https://api.vietqr.io/v2/banks

```json
{
  "code": "22",
  "desc": "Invalid acqId - 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. Xem BIN tại https://api.vietqr.io/v2/banks"
}
```

Invalid account number — Invalid accountNo - số tài khoản thụ hưởng nhập số hoặc chữ(alias, nickname), tối thiểu 4 ký tự, tối đa 25 kí tự

```json
{
  "code": "21",
  "desc": "Invalid accountNo - số tài khoản thụ hưởng nhập số hoặc chữ(alias, nickname), tối thiểu 4 ký tự, tối đa 25 kí tự"
}
```

#### Response 429

Too Many Request - Gọi API vượt quá Limit Rate

## Demo tương tác

[Tra cứu số tài khoản](https://www.vietqr.io/tra-cuu-stk#demo). Demo dùng dữ liệu mẫu trong tài liệu, không gọi API tra cứu thật.