Bank Account List API

API to retrieve the list of all bank accounts linked via Bank Hub. Supports pagination and filtering by company.

API Endpoint

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

Query Parameters

pageinteger

Page number to retrieve

Default: 1
per_pageinteger

Number of items per page

Default: 20
company_xidstring

Filter by Company XID

bank_idstring

Filter by bank code

qstring

Search keyword

Note
  • This API requires a Bearer Token in the Authorization header
  • Results are sorted by newest creation time by default
  • Use company_xid to filter accounts by a specific company
  • Pagination with page and limit (default 20 items/page, max 100)

Error Handling

401Unauthorized

The access token is invalid or has expired

API Response

Response 200 - Success
{
  "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>

List of bank accounts

metaobject

Pagination information

Code Examples

1
2
3
curl --request GET \
  --url 'https://bankhub-api-sandbox.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'

Usage Examples

JSGet the first page with 10 accounts
1
2
curl --location 'https://bankhub-api-sandbox.sepay.vn/v1/bank-account?limit=10&page=1' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN'
JSFilter by company
1
2
curl --location 'https://bankhub-api-sandbox.sepay.vn/v1/bank-account?company_xid=cmp_abc123xyz' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN'
JSPagination - Get page 2
1
2
curl --location 'https://bankhub-api-sandbox.sepay.vn/v1/bank-account?page=2' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN'
Performance Notes
  • Use an appropriate limit value to optimize performance (max 100)
  • With a large number of accounts, paginate instead of requesting all at once
  • Use company_xid to filter by company to reduce payload size
Previous page
—
Next page
—