Channel Custodial Account

Query the virtual-asset custody wallet accounts opened for clients at upstream channels, used to maintain and verify channel custody accounts.

Request parameters

Combine business filters through filters (see the filter fields below for available keys), and use page, page_size, and orderBy to control pagination and sorting.

Business notes

Records are the custody wallet accounts opened for clients at upstream channels (such as HashKey).

Each record carries the id, securities account, client id and client name, channel (upstream broker), channel custody wallet id, channel account, plus creator / updater and creation and update times.

The status marks whether the custody account is enabled / in use, useful for confirming a client's custody account setup on the channel side.

Typically used to look up a client's channel custody account by id, securities account, or creation / update time.

Returns

On success, returns the list of matching records with pagination info. See the response definition for column meanings.

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

Authorization

AuthorizationstringheaderRequired

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

Permission

atm.va_channel_custodial_account_inquiry

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

idstring

ID. Filters results by ID.

account_nostring

A/C No.. Filters results by A/C No..

account_no is the securities account number (such as L6VQEU00121996). It differs from the customer ID member_id and the internal securities account ID aaid.

created_atobject

Created At. Filters results by Created At.

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.

updated_atobject

Updated At. Filters results by Updated At.

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 Channel Custodial 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: Records matching the query conditions.

Child attributes

idstring

ID. Returned value: Unique identifier of the current record.

upstream_brokerstring

Channel. Returned value: Channel.

channel_wallet_idstring

Wallet ID. Returned value: Wallet ID.

member_idstring

Client ID. Returned value: Client ID.

account_nostring

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

created_atstring

Created Time. Returned value: Created 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.

updaterstring

Updater. Returned value: Updater.

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/va_broker_wallets' \
  --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": "11122",
        "upstream_broker": "HASHKEY",
        "channel_wallet_id": "199075602649264324",
        "member_id": "101456715",
        "account_no": "H00000000",
        "created_at": "1773821416",
        "updated_at": "1781172043",
        "updater": "user@example.com"
      }
    ],
    "total": 22
  }
}