Skip to content
Longport WhaleLongport Whale
Sub Account

Sub Account

Queries Sub Account data. Combine business filters in filters, and use page, page_size, and orderBy to control pagination and sorting.

Response

On success, the API returns the matching records and pagination metadata. See each filter field for its purpose, allowed values, and dynamic value source.

GEThttps://b-api.longbridge.xyz/v1/datasets/atm_bank_sub_accounts

This Dataset query is read-only. Use GET by default. If the encoded query parameters are too large, send the same parameters as a JSON body with POST to the same path.

Authorization

Authorizationstringheaderlb_hk_sub_account.bank_sub_accounts_queryRequired

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

Query parameters

filtersobject

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

Child attributes
member_idstring

Client. Filters results by Client.

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

01234

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

Whale Docs