API lấy danh sách Tài khoản

GET /bank-accounts — lấy danh sách mọi tài khoản ngân hàng đã liên kết qua SePay Bank Hub với phân trang và lọc theo công ty, ngân hàng, trạng thái.

||

API Endpoint

GET
https://bankhub-api.sepay.vn/v1/bank-account

Query Parameters

pageinteger

Số trang cần lấy

Mặc định: 1
per_pageinteger

Số item mỗi trang

Mặc định: 20
company_xidstring

Lọc theo Company XID

bank_idstring

Lọc theo mã ngân hàng

qstring

Từ khóa tìm kiếm

Lưu ý
  • API này yêu cầu Bearer Token trong header Authorization
  • Kết quả được sắp xếp theo thời gian tạo mới nhất
  • Sử dụng company_xid để lọc tài khoản theo công ty cụ thể
  • Phân trang với page và limit (mặc định 20 items/trang, tối đa 100)

Xử lý lỗi

401Unauthorized

Access token không hợp lệ hoặc đã hết hạn

API Response

Response 200 - Thành công
{
  "data": [
    {
      "xid": "string",
      "company_xid": "string",
      "brand_name": "string",
      "account_holder_name": "string",
      "account_number": "string",
      "accumulated": "string",
      "account_type": "individual",
      "bank_api_connected": "string",
      "active": "string",
      "last_transaction": "string",
      "created_at": "string",
      "updated_at": "string"
    }
  ],
  "meta": {
    "per_page": 0,
    "total": 0,
    "has_more": true,
    "current_page": 0,
    "page_count": 0
  }
}
dataarray<object>

Danh sách tài khoản ngân hàng

metaobject

Thông tin phân trang

Code mẫu

>
>
>
curl --request GET \
  --url 'https://bankhub-api.sepay.vn/v1/bank-account?page=SOME_INTEGER_VALUE&per_page=SOME_INTEGER_VALUE&company_xid=SOME_STRING_VALUE&bank_id=SOME_STRING_VALUE&q=SOME_STRING_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Ví dụ sử dụng

JSLấy trang đầu tiên với 10 tài khoản
1
2
curl --location 'https://bankhub-api.sepay.vn/v1/bank-account?limit=10&page=1' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN'
JSLọc theo công ty
1
2
curl --location 'https://bankhub-api.sepay.vn/v1/bank-account?company_xid=cmp_abc123xyz' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN'
JSPhân trang - Lấy trang 2
1
2
curl --location 'https://bankhub-api.sepay.vn/v1/bank-account?page=2' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN'
Lưu ý về Performance
  • Nên sử dụng limit phù hợp để tối ưu hiệu suất (tối đa 100)
  • Với số lượng tài khoản lớn, nên phân trang thay vì lấy tất cả
  • Sử dụng company_xid để lọc theo công ty giúp giảm tải dữ liệu
Trước
—
Tiếp theo
—