Skip to content
Longport WhaleLongport Whale
Customer Rule

Save Client Fee

Create or edit a client-specific fee rule for a securities account, overriding that client's charging parameters for a particular fee item.

Request parameters

  • Required: aaid (securities account), fee_code, ref_value_ratio (reference ratio), min_value_ratio (minimum ratio).
  • Optional: id (rule ID), audit_frontend_resource (audit context).
  • See each field's documentation for format, value range, and business meaning.

Business notes

When id is provided the request edits an existing rule; otherwise it creates one. The rule applies to the client and fee item identified by aaid and fee_code; ref_value_ratio and min_value_ratio determine that client's charging ratio.

Risk warning

This operation creates or modifies a charging rule that is live for a real client and may affect actual fee calculation and deduction. Confirm the securities account, fee code, and ratio parameters before calling.

Result

On success the client fee rule is created or updated; the resulting state and returned data are defined by the 200 response.

POSThttps://b-api.lbkrs.com/v1/client_fee/save

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_corporate.corporate_query

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

Request body application/json

idstring

Rule ID associated with this request.

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.

fee_codestringrequired

This field is required.

ref_value_ratiostringrequired

This field is required.

min_value_ratiostringrequired

This field is required.

audit_frontend_resourceobject

Provides audit context for this operation.

Responses

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

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