Đến nội dung
BankGateway
Console ↗
Tìm kiếm tài liệu & API
Bắt đầu
Tổng quan dịch vụ

Cổng API Tra cứu số tài khoản Napas 24/7 theo chuẩn OpenBanking quốc tế. Độ trễ cực thấp O(1) Cache, xác thực Zero-Trust và chữ ký số Ed25519.

Bắt đầu
Bắt đầu nhanh (Quickstart)

Hướng dẫn thực hiện cuộc gọi API tra cứu số tài khoản đầu tiên trong vòng 3 phút bằng cURL, Node.js hoặc Python.

Xác thực & Bảo mật
Xác thực API Key

Cơ chế bảo mật Server-to-Server bằng Header X-API-Key, nguyên tắc giữ bí mật và quy trình thu hồi / cấp phát lại khóa.

Xác thực & Bảo mật
Chữ ký số Ed25519

Đảm bảo tính toàn vẹn và chống giả mạo dữ liệu ngân hàng bằng chữ ký mật mã Ed25519 đính kèm trong mỗi phản hồi.

Xác thực & Bảo mật
Chống trùng lặp (Idempotency)

Sử dụng Header Idempotency-Key chuẩn RFC 8470 để đảm bảo không bị trừ tiền hai lần khi mạng chập chờn hoặc retry.

API Tra cứu ngân hàngPOST
Tra cứu tài khoản

Đặc tả kỹ thuật Endpoint POST /api/v1/lookup. Tra cứu thời gian thực tên chủ tài khoản ngân hàng.

API Tra cứu ngân hàngPOST
Tra cứu theo lô & Webhook

Gửi danh sách hàng nghìn STK trong một request, nhận thông báo kết quả bất đồng bộ qua Webhook kèm chữ ký số.

API Tra cứu ngân hàngGET
Danh sách 68 ngân hàng

Danh mục mã ngân hàng (bankCode), mã BIN Napas, tên đầy đủ và tình trạng kết nối thời gian thực.

↑ ↓ Điều hướng↵ ChọnEsc Đóng
Mục lục tài liệu:Quét VietQR từ ảnh ▾
Tài liệu/API Tra cứu ngân hàng

Đọc mã VietQR từ ảnh (upload, base64 hoặc URL), trả về ngân hàng, số tài khoản, số tiền, nội dung; có thể tra cứu tên chủ tài khoản kèm theo.

POST/api/v1/qr-imageX-API-Key

Yêu cầu

Cách gửiTrườngMô tả
multipart/form-datafileTệp ảnh QR. Thêm ?lookup=true để tra cứu tên.
application/jsonimageẢnh dạng base64. Alias: base64, imageData.
application/jsonimageUrlURL ảnh công khai. Alias: url.
application/jsonlookuptrue để tra cứu tên chủ tài khoản (tính phí như tra cứu).
cURL
curl -X POST 'https://api.bankgateway.org/api/v1/qr-image?lookup=true' \
  -H 'X-API-Key: YOUR_API_KEY' \
  -F '[email protected]'

Phản hồi

TrườngMô tả
bankCode, bankBin, bankNameNgân hàng thụ hưởng.
accountNumberSố tài khoản trong mã QR.
accountNameTên chủ tài khoản (chỉ khi lookup=true).
amount, currencySố tiền và đơn vị (QR động).
content / memoNội dung chuyển khoản.
isDynamicQR động hay tĩnh.
crcCheckKết quả kiểm tra CRC.
imageInfoThông tin ảnh đã xử lý.
HTTPMã lỗiÝ nghĩa
400MISSING_IMAGE_FILEKhông có ảnh trong yêu cầu.
400INVALID_VIETQRẢnh không chứa mã VietQR hợp lệ.
503ENDPOINT_MAINTENANCEEndpoint đang bảo trì.
Tài liệu phát hành theo chuẩn OpenBanking 2.0 · Cập nhật v1.0.5 (Chính thức)Góp ý tài liệu & Báo lỗi ↗