Skip to content
Longport WhaleLongport Whale
Data Service Provider

Create / Edit / Delete Custodian Sub-position

Creates, edits, and deletes custodian sub-positions through a single endpoint, distinguished by action_in.

Request parameters

  • Required: action_in (operation type).
  • Optional: id, custodian_id, no (sub-position number), name (sub-position name), position_direction (characteristic), remark, audit_frontend_resource (audit context).
  • See the field definitions for format, value ranges, and business meaning.

Business notes

  • Add (action_in=1): omit id and submit the sub-position's business fields.
  • Edit (action_in=3): pass the target record's id together with the fields to update.
  • Delete (action_in=2): pass only the target record's id and audit_frontend_resource.

Risk warning

This operation changes real custodian sub-position configuration and affects settlement and position aggregation. Confirm the target record and parameters before calling.

Result

On success the add, edit, or delete completes. Refer to the 200 response definition for returned data.

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

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_clearing.clearing_sub_positions

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

Request body application/json

action_instringrequired

Specifies Action In. This field is required.

Allowed values: 1 Add, 2 Delete, 3 Edit

Values
1
Add
2
Delete
3
Edit
idstring

Sub-position record ID that identifies the target of this request. Required when editing or deleting.

custodian_idstring
namestring
remarkstring
position_directionsstring

Position directions; multi-select, comma-joined; options come from a backend data dictionary

tax_ratiostring

Tax ratio; options come from a backend data dictionary

nostring

Responses

HTTP 200The request was processed successfully. The response data does not contain additional business fields.
Standard response envelopecodemessagedata
dataobjectdata structure
idstring
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