Đế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:Quản lý Batch Job (Poll / Hủy / Retry) ▾
Tài liệu/API Tra cứu ngân hàng

Quản lý Batch Job (Poll / Hủy / Retry)

Kiểm tra tiến độ job tra cứu hàng loạt, hủy job đang chờ hoặc gửi lại Webhook nếu máy chủ của bạn tạm gián đoạn.

GET/api/v1/lookup/batch/:jobIdX-API-Key

Các endpoint quản lý Job

Thao tácEndpointMô tả
Xem tiến độ & kết quảGET /api/v1/lookup/batch/:jobIdTrả về trạng thái PENDING/PROCESSING/COMPLETED và danh sách results.
Hủy Batch JobPOST /api/v1/lookup/batch/:jobId/cancelDừng các phần tử chưa xử lý và kích hoạt sự kiện batch.cancelled.
Gửi lại WebhookPOST /api/v1/lookup/batch/:jobId/retry-webhookĐẩy lại payload HMAC-SHA256 tới webhookUrl đã đăng ký.
cURL
# Kiểm tra trạng thái job
curl -X GET 'https://api.bankgateway.org/api/v1/lookup/batch/BATCH_1793352313937_acd1c46c' \
  -H 'X-API-Key: YOUR_API_KEY'

# Gửi lại webhook nếu endpoint bị timeout
curl -X POST 'https://api.bankgateway.org/api/v1/lookup/batch/BATCH_1793352313937_acd1c46c/retry-webhook' \
  -H 'X-API-Key: YOUR_API_KEY'
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 ↗