Tra cứu

API 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.

POSThttps://api.vietqr.io/v2/lookup

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

Demo

Mô phỏng · dùng dữ liệu mẫu trong tài liệu

# Request
POST https://api.vietqr.io/v2/lookup
x-client-id: <CLIENT_ID>
x-api-key: <API_KEY>
Content-Type: application/json

{
  "bin": 970415,
  "accountNumber": "113366668888"
}

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

Xem video demo

Video demo: chọn ngân hàng, nhập số tài khoản, tên tài khoản hiện ra

Tham số

Header

x-client-idbắt buộcheader

Client Id để chứng thực. Truy cập https://my.vietqr.io để lấy Client Id

x-api-keybắt buộcheader

API key để chứng thực. Truy cập https://my.vietqr.io để lấy API Key

Body

binbắt buộcinteger

Mã BIN ngân hàng

Ví dụ: 970415

accountNumberbắ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

Response

Bấm vào từng dòng để xem dữ liệu trả về.

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

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

20042Account number invalidSố tài khoản không hợp lệ

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

20041Bank not supportNgân hàng không hỗ trợ

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

20043Somthing went wrongLỗi không xác định

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

20045All provider busyTất cả các API Provider đều đang bận.

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

20010Missing paramMissing param BIN/accountNumber

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

20022Invalid BINMã đị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 api.vietqr.io/v2/banks

{
  "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"
}

20021Invalid account numberSố 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ự

{
  "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ự"
}

429–Too Many RequestGọi API vượt quá Limit Rate