Đế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:Bảng mã lỗi & HTTP Status ▾
Tài liệu/Vận hành & Xử lý lỗi

Bảng mã lỗi & HTTP Status

Danh mục chi tiết toàn bộ các mã phản hồi HTTP và error.code chuẩn OpenBanking.

Danh mục mã lỗi hoàn chỉnh

HTTP CodeMã lỗi (error.code)Ý nghĩa nghiệp vụCách xử lý
200SUCCESSTra cứu thành công, tìm thấy chủ tài khoảnSử dụng data.accountName và signature
400INVALID_BANK_CODEMã ngân hàng không đúng hoặc không hỗ trợKiểm tra bảng mã bankCode trong danh mục
400INVALID_ACCOUNT_NUMBERSố tài khoản rỗng hoặc không đúng quy cáchKiểm tra định dạng chuỗi số tài khoản
401UNAUTHORIZED_API_KEYKhóa API không hợp lệ hoặc đã bị khóaKiểm tra header X-API-Key trên Dashboard
402PAYMENT_REQUIREDSố dư ví hoặc số lượt trong gói đã cạn kiệtNạp tiền vào ví hoặc gia hạn gói lượt
403IP_NOT_ALLOWEDĐịa chỉ IP của máy chủ không có trong WhitelistThêm IP máy chủ vào Dashboard > API Keys
403QUOTA_EXHAUSTEDHạn mức của riêng API Key này đã hếtTăng hạn mức cho khóa trong trang quản trị
404NOT_FOUNDSố tài khoản không tồn tại tại ngân hàng đíchThông báo cho khách hàng kiểm tra lại STK
409IDEMPOTENCY_PAYLOAD_MISMATCHDùng lại Idempotency-Key nhưng đổi dữ liệuSinh Idempotency-Key mới cho giao dịch mới
429RATE_LIMIT_EXCEEDEDGọi vượt quá số lượt cho phép trong 1 giâyHạ nhịp gọi hoặc chờ theo header Retry-After
503ENDPOINT_MAINTENANCECổng API đang tạm ngưng bảo trì theo lịchTạm hoãn và gọi lại sau thời gian autoReopenAt
502UPSTREAM_FAILURECổng Napas / Ngân hàng đích tạm thời gián đoạnThử lại sau 3-5 giây (Miễn phí 100%)
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 ↗