Đế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:Đối soát tên chủ tài khoản ▾
Tài liệu/API Tra cứu ngân hàng

Đối soát tên chủ tài khoản

Tra cứu tài khoản và so khớp tên chủ tài khoản với tên dự kiến, trả về độ tin cậy và kết luận khớp / không khớp.

POST/api/v1/owner-checkX-API-Key

Yêu cầu

HeaderBắt buộcMô tả & Chuẩn
X-API-KeyBắt buộcKhóa bí mật API cấp riêng cho tài khoản. Chỉ truyền từ server-to-server.
Content-TypeBắt buộcapplication/json; charset=utf-8
Idempotency-KeyKhuyến nghị caoUUID v4 duy nhất cho mỗi giao dịch (RFC 8470). Chống trừ tiền trùng lặp khi mạng lag.
TrườngBắt buộcMô tả
bankCodeBắt buộcMã ngân hàng (ví dụ MB, VCB). Alias: bank.
accountNumberBắt buộcSố tài khoản. Alias: account.
expectedNameBắt buộcTên cần so khớp. Alias: ownerName, name, accountName.
thresholdTuỳ chọnNgưỡng khớp 0–1. Mặc định 0.85.
cURL
curl -X POST 'https://api.bankgateway.org/api/v1/owner-check' \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: YOUR_API_KEY' \
  -d '{ "bankCode": "MB", "accountNumber": "0783825888", "expectedName": "Nguyen Van A" }'

Phản hồi

Trả về toàn bộ dữ liệu của API Tra cứu số tài khoản, kèm các trường so khớp bên dưới. Phí tính như một lượt tra cứu.

TrườngKiểuMô tả
expectedNamestringTên bạn gửi lên.
isMatchbooleantrue nếu độ tin cậy ≥ threshold.
confidencenumberĐộ tương đồng 0–1.
verificationobjectChi tiết thuật toán so khớp.
HTTPMã lỗiÝ nghĩa
400MISSING_BANK_CODEThiếu mã ngân hàng.
400MISSING_ACCOUNT_NUMBERThiếu số tài khoản.
400MISSING_EXPECTED_NAMEThiếu tên cần so khớp.
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 ↗