Đế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:Kiểm tra số dư ví ▾
Tài liệu/Ví & Tài khoản

Truy vấn số dư ví khả dụng, hạn mức gói lượt và đối soát lịch sử giao dịch sổ cái.

GET/api/v1/wallet/balanceX-API-Key

Kiểm tra số dư hiện tại

cURL
curl -X GET 'https://api.bankgateway.org/api/v1/wallet/balance' \
  -H 'X-API-Key: YOUR_API_KEY'
JSON
{
  "success": true,
  "data": {
    "tenantId": "TNT_98218FA",
    "currency": "VND",
    "balanceVnd": 1500000,
    "availableVnd": 1500000,
    "reservedVnd": 0,
    "subscriptionQuota": 49850,
    "subscriptionExpiresAt": "2026-11-17T00:00:00.000Z",
    "vaultQuota": 0
  }
}

Sao kê sổ cái (Ledger Statement)

cURL
curl -X GET 'https://api.bankgateway.org/api/v1/wallet/statement?limit=20' \
  -H 'X-API-Key: YOUR_API_KEY'

Trả về danh sách các bút toán biến động số dư minh bạch 100%, ghi rõ mã requestId tra cứu và số tiền quyết toán.

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 ↗