Đế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:Xác thực API Key ▾
Tài liệu/Xác thực & Bảo mật

Hướng dẫn sử dụng khóa bí mật X-API-Key, cấu hình an toàn và quản lý vòng đời khóa.

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 Whitelist cho Production

    Chỉ định rõ địa chỉ IP tĩnh của máy chủ backend. Không bao giờ để trống trên môi trường thực tế.

  3. 03
    Thu hồi và đổi khóa định kỳ

    Nếu nghi ngờ lộ khóa, bạn có thể tạo khóa mới và xóa khóa cũ ngay trên Dashboard chỉ trong 1 cú nhấp chuột.

Thao tác nhanh

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 ↗