Sub Account

Queries the bank sub-accounts opened for customers under the deposit-collection banks, used to manage and audit bank sub-accounts in the deposit and withdrawal channel.

Request parameters

Use filters to combine business conditions (see the filters field notes below), and use page, page_size, and orderBy to control pagination and sorting.

Business notes

The data comes from bank sub-account opening records; each record represents one sub-account opened for a customer under a specific collection bank.

Each record includes the owning customer member_id, the sub-account number sub_account_no and its name, the owning bank lb_bank_account_id, currency, opening state state, opening method, the opening/closing serial numbers, and the opening time opened_at.

It is typically used to verify sub-account opening and status by customer, bank, or opening state, supporting operational maintenance of deposit-collection accounts.

Returns

On success, returns the matched record list with pagination. See the response definition for the meaning of each column.

POSThttps://b-api.lbkrs.com/v1/datasets/atm_bank_sub_accounts

Authorization

AuthorizationstringheaderRequired

Send the Broker ACCESS_TOKEN as Authorization: Bearer <token>.

Permission

lb_hk_sub_account.bank_sub_accounts_query

The Broker ACCESS_TOKEN must be granted the permission above, or the call will be rejected.

Request body application/json

filtersobject

Filters. Combines business filters. Omit a filter field to disable that filter.

Child attributes

member_idstring

Client. Filters results by Client.

member_id is the customer ID. It differs from the securities account number account_no and the internal securities account ID aaid; one customer can have multiple securities accounts.

sub_account_nostring

Sub Account No.. Filters results by Sub Account No..

lb_bank_account_idstring

Bank Name. Filters results by Bank Name.

Values are dynamic. Call GET /v1/datasets/refs/company_bank_account_config to retrieve the current data dictionary, and use the returned entry's key as this parameter's value.

statestring

Activation Status. Filters results by Activation Status.

Allowed values: 0 Opening, 1 Opened, 2 Deleting, 3 Deleted, 4 Closed

Values

0: Opening
1: Opened
2: Deleting
3: Deleted
4: Closed

opened_atobject

Open Time. Filters results by Open Time.

Child attributes

gtestring

Greater Than or Equal. Inclusive lower bound of the filter range.

ltestring

Less Than or Equal. Inclusive upper bound of the filter range.

pageinteger

Page. Page number to retrieve, starting from 1.

page_sizeinteger

Page Size. Number of records to return per page.

orderByarray<object>

Order By. Array of sorting rules. Each item defines a sort field and direction.

Responses

HTTP 200On success, returns paginated Sub Account records together with pagination metadata such as the page number, page size, and total record count.

Standard response envelopecodemessagedata

dataobjectdata structure

listarray<object>required

List. Returned value: List of list.

Child attributes

idstring

Sub Account Id. Returned value: Unique identifier of the current record.

lb_bank_account_idstring

Company Bank Account ID. Returned value: Company Bank Account ID.

lb_bank_account_id_valstring

Company Bank Account ID (raw value). Raw value of lb_bank_account_id. The lb_bank_account_id field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

lb_bank_accountstring

Bank Account. Returned value: Bank Account.

lb_bank_namestring

Bank Account Name. Returned value: Bank Account Name.

member_idstring

Client ID. Returned value: Client ID.

account_channelstring

Account Channel. Returned value: Account Channel.

origin_idstring

A/C No.. Returned value: A/C No..

id_cardstring

Document No.. Returned value: Document No..

open_modestring

Activation Method. Returned value: Activation Method.

open_mode_valstring

Activation Method (raw value). Raw value of open_mode. The open_mode field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

close_modestring

Delete Method. Returned value: Delete Method.

close_mode_valstring

Delete Method (raw value). Raw value of close_mode. The close_mode field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

statestring

Status. Returned value: Status.

state_valstring

Status (raw value). Raw value of state. The state field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

remarkstring

Remark. Returned value: Remark.

currencystring

SubAccount Currency. Returned value: SubAccount Currency.

sub_account_namestring

Sub Account Name. Returned value: Sub Account Name.

sub_account_nostring

Sub Account No.. Returned value: Sub Account No..

open_nostring

Open No. Returned value: Open No.

close_nostring

Account Cancelation Serial No.. Returned value: Account Cancelation Serial No..

opened_atstring

Open Time. Returned value: Open Time. The date or time format follows the value returned by the API.

close_timestring

Account Cancelation Time. Returned value: Account Cancelation Time. The date or time format follows the value returned by the API.

updated_atstring

Update Time. Returned value: Update Time. The date or time format follows the value returned by the API.

totalintegerrequired

Total. Returned value: Total number of matching records, used for pagination.

HTTP 400Bad request. Check the business error code in code and the error details in message.

Standard response envelopecodemessagedata

dataobjectdata structure

No nested fields

HTTP 401The user is not authenticated, or the login session has expired.

Standard response envelopecodemessagedata

dataobjectdata structure

No nested fields

HTTP 403The current account is not authorized to use this feature. Grant the required permission to the account in User Permission.

Standard response envelopecodemessagedata

dataobjectdata structure

No nested fields

HTTP 408The request timed out. Check the business error code in code and the error details in message.

Standard response envelopecodemessagedata

dataobjectdata structure

No nested fields

Request

curl --request POST \
  --url 'https://b-api.lbkrs.com/v1/datasets/atm_bank_sub_accounts' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json'
  --data '{
  "filters": {},
  "page": 1,
  "page_size": 20,
  "orderBy": []
}'

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "id": "182",
        "lb_bank_account_id": "Zhang San",
        "lb_bank_account_id_val": "",
        "lb_bank_account": "",
        "lb_bank_name": "",
        "member_id": "101456715",
        "account_channel": "longport_test",
        "origin_id": "H00000000",
        "id_card": "X0000000",
        "open_mode": "API",
        "open_mode_val": "1",
        "close_mode": "",
        "close_mode_val": "",
        "state": "Opened",
        "state_val": "1",
        "remark": "",
        "currency": "HKD",
        "sub_account_name": "WEI WANG",
        "sub_account_no": "****0000",
        "open_no": "20220609024347101376",
        "close_no": "",
        "opened_at": "1706166920",
        "close_time": "",
        "updated_at": "1706166920"
      }
    ],
    "total": 6
  }
}