Đế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:Chữ ký số Ed25519 ▾
Tài liệu/Xác thực & Bảo mật

Khung bảo mật cấp ngân hàng: Chữ ký số Ed25519 chống giả mạo, xác thực Zero-Trust, IP Whitelisting và Kill-Switch bảo trì.

Headers yêu cầu trong mỗi Request

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.
HTTP Headers
X-API-Key: bg_live_8f3a9e2d1c4b7a6f...
Content-Type: application/json
Idempotency-Key: 9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d

Quy tắc quản lý vòng đời khóa

  1. 01
    Tách biệt khóa theo môi trường

    Tạo khóa riêng cho môi trường Staging/Dev và khóa riêng cho Production để kiểm soát hạn mức độc lập.

  2. 02
    Cấu hình IP máy chủ

    Chỉ định danh sách IP tĩnh của cụm máy chủ Backend được phép sử dụng khóa.

  3. 03
    Luân chuyển khóa định kỳ

    BankGateway hỗ trợ tạo khóa mới trước, cập nhật vào hệ thống rồi mới thu hồi khóa cũ mà không gây gián đoạn dịch vụ.

  4. 04
    Thu hồi khẩn cấp

    Nếu nghi ngờ lộ khóa, nhấn nút "Thu Hồi" trong Dashboard để vô hiệu hóa ngay tức thì.

Bảng mã lỗi xác thực

Mã HTTPMã lỗi (error.code)Nguyên nhân & Khắc phục
401MISSING_CREDENTIALSChưa gửi header X-API-Key trong HTTP Request.
401UNAUTHORIZED_API_KEYKhóa API không hợp lệ hoặc đã bị thu hồi trong hệ thống.
403IP_NOT_ALLOWEDĐịa chỉ IP máy chủ gọi API không nằm trong danh sách IP Whitelist.
403QUOTA_EXHAUSTEDHạn mức requests được cấp cho API Key này đã hết.
403ENDPOINT_BLOCKEDKhóa API này đang bị khóa quyền truy cập vào endpoint được gọi.
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 ↗