Tài khoản ngân hàng

Các tài khoản ngân hàng đã liên kết để nhận báo có. Liên kết và hủy liên kết làm trong app vì cần mã OTP của ngân hàng; API chỉ đọc. Dùng id làm bankAccountId khi tạo yêu cầu thanh toán.

Đối tượng bank_account

Các trường

  • idstring
    ID tài khoản ngân hàng, tiền tố ba_. Dùng làm bankAccountId khi tạo yêu cầu thanh toán.
  • objectstring
    Luôn là "bank_account".
  • livemodeboolean
    false với tài khoản ngân hàng thử của sandbox.
  • bankobject
    bin (mã BIN NAPAS), code (mã viết tắt, vd. MBB), name.
  • accountTypeenum
    personal-account (cá nhân), business-household-account (hộ kinh doanh) hoặc business-account (doanh nghiệp).
  • accountNumberstring
    Số tài khoản.
  • accountNamestring
    Tên chủ tài khoản, in hoa không dấu.
  • receivingNumberstring | null
    Tài khoản nhận báo có: virtual account (tài khoản định danh) hoặc chính số tài khoản.
  • notifyRealAccountboolean
    true nếu nhận báo có ở số tài khoản gốc thay vì virtual account; khi đó receivingNumber là số tài khoản gốc.
  • statusstring
    active (đang liên kết) hoặc removed (đã hủy liên kết, sự kiện bank_account.removed).
  • pendingStepstring | null
    Bước xác nhận còn dang dở; null khi đã liên kết xong.
  • linkedAtstring | null
    Thời điểm liên kết xong.
  • createdAtstring
    Thời điểm bắt đầu liên kết.
Đối tượng bank_account
{
  "id": "ba_8Hn2PqR5sT7vW9xY3zA4bC6d",
  "object": "bank_account",
  "livemode": true,
  "bank": {
    "bin": "970422",
    "code": "MBB",
    "name": "MB Bank"
  },
  "accountType": "personal-account",
  "accountNumber": "0123456789",
  "accountName": "NGUYEN VAN AN",
  "receivingNumber": "0123456789",
  "notifyRealAccount": false,
  "status": "active",
  "pendingStep": null,
  "linkedAt": "2026-11-04T09:02:13.000Z",
  "createdAt": "2026-11-04T09:00:41.000Z"
}

Liệt kê tài khoản

GET/v1/bank-accounts

Trả các tài khoản đang liên kết (status là active), liên kết gần nhất trước. Không phân trang.

GET /v1/bank-accounts
curl https://app.bankopenapi.com/api/v1/bank-accounts \
  -H "Authorization: Bearer $BANKOPENAPI_API_KEY"
Response 200
{
  "object": "list",
  "data": [
    {
      "id": "ba_8Hn2PqR5sT7vW9xY3zA4bC6d",
      "object": "bank_account",
      "livemode": true,
      "bank": {
        "bin": "970422",
        "code": "MBB",
        "name": "MB Bank"
      },
      "accountType": "personal-account",
      "accountNumber": "0123456789",
      "accountName": "NGUYEN VAN AN",
      "receivingNumber": "0123456789",
      "notifyRealAccount": false,
      "status": "active",
      "pendingStep": null,
      "linkedAt": "2026-11-04T09:02:13.000Z",
      "createdAt": "2026-11-04T09:00:41.000Z"
    }
  ]
}

Xem một tài khoản

GET/v1/bank-accounts/:id

Trả đối tượng bank_account theo ID (tiền tố ba_), kể cả tài khoản đã hủy liên kết.

Lỗi

  • 404 NOT_FOUND
    Không có tài khoản với ID này trong tài khoản của bạn.
GET /v1/bank-accounts/:id
curl https://app.bankopenapi.com/api/v1/bank-accounts/ba_8Hn2PqR5sT7vW9xY3zA4bC6d \
  -H "Authorization: Bearer $BANKOPENAPI_API_KEY"
Response 200
{
  "id": "ba_8Hn2PqR5sT7vW9xY3zA4bC6d",
  "object": "bank_account",
  "livemode": true,
  "bank": {
    "bin": "970422",
    "code": "MBB",
    "name": "MB Bank"
  },
  "accountType": "personal-account",
  "accountNumber": "0123456789",
  "accountName": "NGUYEN VAN AN",
  "receivingNumber": "0123456789",
  "notifyRealAccount": false,
  "status": "active",
  "pendingStep": null,
  "linkedAt": "2026-11-04T09:02:13.000Z",
  "createdAt": "2026-11-04T09:00:41.000Z"
}
Response 404
{
  "error": {
    "code": "NOT_FOUND",
    "message": "Không tìm thấy tài khoản ngân hàng."
  }
}

Bắt đầu với BankOpenAPI

Đăng ký tài khoản, liên kết tài khoản ngân hàng và nhận webhook báo có đầu tiên. Cần tư vấn thì nhắn chúng tôi.