Skip to content
Global Rule

Add Fee Event

Create a global fee configuration that defines the corporate-action charging rule for a given market, announcement type, and event type.

Request parameters

  • Required: ann_type (announcement type), event_type, market, fee_code, metric_type, calc_method, ref_value, max_fee, min_fee, currency, target (charged audience), order (charging priority), fraction_type (rounding rule), restrict_type (special charging rule).
  • See each field's documentation for format, value range, and business meaning.

Business notes

The configuration is a global default charging rule applied when computing matching corporate-action fees. ref_value, calc_method, and fraction_type together determine how the fee is calculated and rounded, while max_fee/min_fee cap the fee range.

Risk warning

This operation adds a charging rule that takes effect for real customers and may affect actual fee calculation and deduction. Confirm the market, event type, and all charging parameters before calling.

Result

On success the fee configuration is created; the resulting state and returned data are defined by the 200 response.

POSThttps://b-api.lbkrs.com/corporate_action/add_fee_event

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

ann_typenumberrequired

Specifies Announcement Type. This field is required.

Allowed values: 1 Stock

Values
1
Stock
event_typenumberrequired

Specifies Event Type. This field is required.

Values
1
Callable bull/bear contract recall.
2
Dividend
marketstringrequired

This field is required.

fee_codestringrequired

This field is required.

metric_typenumberrequired

Specifies Metric Type. This field is required.

Allowed values: 1 Registered holding (per lot), 2 Fixed amount charged once, 3 Entitlement amount

Values
1
The registered-holding (per lot) parameter value.
2
Announced fixed amount.
3
The equity-amount parameter value.
calc_methodstringrequired

Specifies Calc Method. This field is required.

Allowed values: 1 Fee = metric parameter x rate, 2 Fee = rate

Values
1
By ratio.
2
Fixed fee.
ref_valuestringrequired

This field is required.

max_feestringrequired

This field is required.

min_feestringrequired

This field is required.

currencystringrequired

Currency code used for this request. This field is required.

targetstringrequired

This field is required.

ordernumberrequired

This field is required. A free-form value (not an enum); provide the actual business value.

fraction_typenumberrequired

This field is required. Values come from a backend data dictionary (maintained dynamically), not a fixed enum; use the options the service actually returns.

restrict_typenumberrequired

This field is required. Values come from a backend data dictionary (maintained dynamically), not a fixed enum; use the options the service actually returns.

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