Skip to content
Custodian Query

Transfer Holding

Transfer a position internally between custodians/sub-positions.

Request parameters

  • Required: aaid (securities account), market (market), counter_id (instrument code), from_custodian_id (source custodian ID), from_sub_position_no (source sub-position), from_street_quantity (street transfer-out quantity), from_nominee_quantity (nominee transfer-out quantity), from_own_quantity (own transfer-out quantity), to_custodian_id (target custodian ID), to_sub_position_no (target sub-position), to_street_quantity (street transfer-in quantity), to_nominee_quantity (nominee transfer-in quantity), to_own_quantity (own transfer-in quantity), ledger_date (ledger date)
  • See each field description for format, value range, and business meaning.

Business notes

Moves the position from the source custodian/sub-position (from_*) to the target custodian/sub-position (to_*). This changes real positions and only the current ledger date is supported.

Risk warning

This operation changes real positions. Confirm the source and target custodians, sub-positions, and all quantities before calling.

Result

On success the internal transfer is applied; refer to the 200 response for the resulting state and returned data.

POSThttps://b-api.lbkrs.com/clearing/transfer_holding

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_clearing.clearing_move_holding_position

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

Request body application/json

aaidstringrequired

Specifies A/C No.. This field is required.

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.

marketstringrequired

This field is required.

counter_idstringrequired

Counter ID associated with this request. Format is {type}/{market}/{code}, for example, stock ST/HK/700 or ST/US/AAPL, and option OP/US/AAPL270319C320000.

from_custodian_idstringrequired

From Custodian ID associated with this request.

from_sub_position_nostringrequired

Specifies From Sub Position No.. This field is required.

from_street_quantitystringrequired

This field is required.

from_nominee_quantitystringrequired

This field is required.

from_own_quantitystringrequired

This field is required.

to_custodian_idstringrequired

To Custodian ID associated with this request.

to_sub_position_nostringrequired

Specifies To Sub Position No.. This field is required.

to_street_quantitystringrequired

This field is required.

to_nominee_quantitystringrequired

This field is required.

to_own_quantitystringrequired

This field is required.

ledger_datestringrequired

This field is required.

custodian_idstringrequired

Custodian ID of the current holding (equal to from_custodian_id).

audit_frontend_resourceobject

Caller-attached audit context for the transfer operation.

Responses

HTTP 200The request was processed successfully. The response data does not contain additional business fields.
Standard response envelopecodemessagedata
dataobjectdata structure

On success data is an empty object.

No nested fields

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