Skip to content
Fund

Fund Freeze Ticket

Query fund freeze tickets, used by risk-control operations to freeze/unfreeze a customer's fund holdings and to track approval and execution results.

Request parameters

  • Combine business filters through filters (optional fields are described under the filters section below), and use page, page_size, and orderBy to control pagination and sorting.

Business notes

  • The data source is the fund freeze business within asset lock tickets.

  • Each record identifies the customer id, name, securities account, account type, fund code, freeze quantity (units), freeze status, and validity period, along with freeze remarks and internal remarks.

  • Records also carry approval and execution details: freeze applicant, review status, freeze result, freeze serial number, plus creation and update times.

Returns

On success, returns the list of matching records together with pagination information. See the response definition for the meaning of each column.

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

Authorization

AuthorizationstringheaderRequired

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

Permission

account_balance_lock.fund_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
aaidstring

AAID. Filters results by AAID.

Pass the internal numeric ID of the customer's securities account (aaid), not the securities account number account_no (such as H00000000) or the customer ID member_id. One customer can have multiple aaid values.

freeze_ticket_statusstring

Freeze Approval Status. Filters results by Freeze Approval Status.

Allowed values: WAIT Waiting for Approval, WAIT_APPROVE Under Approval, APPROVED, REJECTED, CLOSE

Values
WAIT
Waiting for Approval
WAIT_APPROVE
Under Approval
APPROVED
Approved
REJECTED
Rejected
CLOSE
Close
account_typestring

Account Type. Filters results by Account Type.

Allowed values: SETTLEMENT

Values
SETTLEMENT
map_statusstring

Freeze Status. Filters results by Freeze Status.

Allowed values: INIT, FREEZED, FREEZE_FAILED Freeze Failed

Values
INIT
Init
FREEZED
Freezed
FREEZE_FAILED
Freeze Failed
pageinteger

Page number to retrieve, starting from 1.

page_sizeinteger

Page Size. Number of records to return per page.

Responses

HTTP 200On success, returns paginated Fund Freeze Ticket 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

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

member_idstring

Member ID. Returned value: Member ID.

member_id_valstring

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

user_namestring

Name. Returned value: Name.

user_name_valstring

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

origin_idstring

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

origin_id_valstring

A/C No (raw value). Raw value of origin_id. The origin_id field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

account_typestring

Account Type. Returned value: Account Type.

statusstring

Freeze Status. Returned value: Freeze Status.

status_valstring

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

counter_idstring

Fund Code. Returned value: Fund Code.

freeze_amountstring

Freeze Qty. Returned value: Freeze Qty.

memostring

Freeze Remarks. Returned value: Freeze Remarks.

inner_memostring

Freeze Internal Remarks. Returned value: Freeze Internal Remarks.

expire_timestring

Expiry Date. Returned value: Expiry Date. The date or time format follows the value returned by the API.

freeze_ticket_creatorstring

Freeze Req Submitted By. Returned value: Freeze Req Submitted By.

freeze_ticket_creator_valstring

Freeze Req Submitted By (raw value). Raw value of freeze_ticket_creator. The freeze_ticket_creator field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

freeze_ticket_statusstring

Freeze Approval Status. Returned value: Freeze Approval Status.

freeze_ticket_status_valstring

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

freeze_resultstring

Freeze Status. Returned value: Freeze Status.

freeze_result_valstring

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

created_atstring

Created At. Returned value: Created At. The date or time format follows the value returned by the API.

updated_atstring

Updated At. Returned value: Updated At. The date or time format follows the value returned by the API.

freeze_nostring

Freeze ID. Returned value: Freeze ID.

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