Tra cứu số tài khoản — qua ảnh QR (VietQR)
Hướng dẫn sử dụng API tra cứu thông tin ngân hàng thông qua ảnh QR của VietQR.
Lựa chọn
Trong trường hợp bạn chỉ cần kiểm tra qua nội dung QR, hãy dùng Tra cứu qua nội dung QR ngay.
Endpoint
POST
https://api.banklookup.net/qr-imageHeader (Bắt buộc)
Các giá trị bắt buộc ở Header khi thực hiện Request.
| Header | Required | Data type | Description |
|---|---|---|---|
| x-api-key | Bắt buộc | string | Mã API |
| x-api-secret | Bắt buộc | string | Mã Secret API |
Body (multipart/form-data) (Bắt buộc)
Chỉ hỗ trợ file, không hỗ trợ base64.
| Payload | Required | Data type | Description |
|---|---|---|---|
| file | Bắt buộc | file (png/jpg/jpeg) | File ảnh: tối đa 2MB. Phải là QR được tạo từ VietQR . |
Mẫu code tham khảo
curl --location 'https://api.banklookup.net/qr-image' \
--header 'x-api-key: <api_key>' \
--header 'x-api-secret: <api_secret>' \
--form 'file=@/path/to/your/file.png'Ngôn ngữ:curl
Responses
| HTTP code | Content-type | Response |
|---|---|---|
200 | json | Success |
422 | json | Not found / Hoặc lỗi đọc mã QR |
429 | json | Too many requests |
402 | json | Payment Required | Out of Credit |
200: Success response
{
"code": 200,
"success": true,
"data": {
"bank": "<Mã ngân hàng>",
"ownerName": "<Tên tài khoản>",
"account": "<Số tài khoản>",
},
"msg": "Success"
}Ngôn ngữ:json
Câu hỏi thường gặp
Credit chỉ trừ khi đã truy xuất được mã QR của VietQR nhưng không tìm thấy chủ thể - còn lại các lỗi liên quan đến hình ảnh/ nội dung QR thì sẽ không bị trừ.