Skip to content
Corp Action Management

corporate fee details v2

Queries the fee detail records of a corporate action, used to verify how an individual charge is composed.

Request parameters

  • Combine business filter conditions through filters (see the filters field descriptions below for the available fields), and use page, page_size, and orderBy to control pagination and sorting.

Business notes

Returns the related fee details by announcement ann_id and allocation aaid.

Each record carries the fee ID, currency, charged amount, fee item, and remark.

Use it to verify the individual fees incurred during a corporate-action payout.

Returns

On success, returns the list of matching records with pagination. See the response schema for the meaning of each returned column.

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

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

filtersobject

Filters

Child attributes
ann_idstring

Ann Id

aaidstring

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.

pageinteger

Page

page_sizeinteger

Page Size

Responses

HTTP 200Paginated list result.
Standard response envelopecodemessagedata
dataobjectdata structure
listarray<object>required

List

Child attributes
idstring

Id

currencystring

Currency

calc_amountstring

Calc Amount

fee_codestring

Fee Code

fee_code_valstring

Raw value behind field fee_code: fee_code returns the human-readable display value resolved via a dictionary/join mapping, while this field returns the underlying code/ID before that mapping.

remarkstring

Remark

totalintegerrequired

Total

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