Đến nội dung
BankGatewayBankGateway
Console ↗
↑ ↓ Điều hướng↵ ChọnEsc Đóng
Mục lục tài liệu:Thư viện SDK & Code mẫu ▾
Tài liệu›SDK & Tài nguyên›Thư viện SDK & Code mẫu
Phiên bản:v1.0.5 (Chính thức)

Bộ thư viện SDK chính thức (@bankgateway/sdk, pip) và mã nguồn mẫu tích hợp đa ngôn ngữ.

01. Gói SDK chính thức (Khuyến nghị)

Ngôn ngữ / Nền tảngGói PackageLệnh cài đặt
Node.js / TypeScript@bankgateway/sdknpm i @bankgateway/sdk
Python (>= 3.8)bankgatewaypip install bankgateway
PHP / Composerbankgateway/sdkcomposer require bankgateway/sdk (Sắp có)
quick-sdk.ts
// Node.js / TypeScript với @bankgateway/sdk
import { BankGateway } from "@bankgateway/sdk";

const client = new BankGateway({
  apiKey: process.env.BANKGATEWAY_API_KEY!,
});

const result = await client.lookup({
  bankCode: "MB",
  accountNumber: "0783825888",
});

if (result.success) {
  console.log("Tìm thấy:", result.data.accountName, result.data.latencyMs + "ms");
}
quick_sdk.py
# Python với bankgateway
from bankgateway import BankGateway
import os

client = BankGateway(api_key=os.environ["BANKGATEWAY_API_KEY"])

res = client.lookup(bank_code="MB", account_number="0783825888")
if res.get("success"):
    print("Tìm thấy:", res["data"]["accountName"])

02. Tích hợp Thư viện chuẩn Native (Zero-Dependency)

Nếu không muốn cài thêm package ngoài, bạn có thể gọi REST trực tiếp bằng thư viện có sẵn của ngôn ngữ:

# Gọi trực tiếp từ máy chủ backend (Server-to-Server).
# Bảo mật: Không bao giờ nhúng API Key vào client/web frontend.

curl -X POST 'https://api.bankgateway.pro/api/v1/lookup' \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: YOUR_API_KEY' \
  -H 'Idempotency-Key: op_$(date +%s)_$RANDOM' \
  -d '{
    "bankCode": "MB",
    "accountNumber": "0783825888"
  }'

03. Đặc tả Type Definition (TypeScript)

TypeScript
export interface OpenBankingLookupRequest {
  bankCode: string;
  accountNumber: string;
}

export interface OpenBankingLookupSuccessResponse {
  success: true;
  data: {
    requestId: string;
    bankCode: string;
    bankName: string;
    accountNumber: string;
    accountName: string;
    cached: boolean;
    source: "L1_CACHE" | "L2_DATABASE" | "LIVE_UPSTREAM";
    verifiedAt: string;
    feeChargedVnd: number;
    chargeMethod: "PAY_AS_YOU_GO" | "SUBSCRIPTION_PASS" | "LIFETIME_VAULT";
    quotaRemaining: {
      subscriptionQuota: number;
      vaultQuota: number;
      walletBalanceVnd: number;
    };
    latencyMs: number;
    signature: string;
    message: string;
  };
}

export interface OpenBankingLookupErrorResponse {
  success: false;
  error: {
    code: string;
    message: string;
    requestId?: string;
    feeChargedVnd?: number;
    autoReopenAt?: string;
  };
}
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 ↗