corporate refund announcement details

Returns the tax-refund execution details under a corporate-action announcement, used to trace the amount, state, and revocation status of every individual refund.

Request parameters

Combine business filters through filters (see the filters field reference below), and use page, page_size, and orderBy for pagination and sorting.
Provide ann_id to target the announcement; results are returned in descending order of creation time.
filters is required and must include ann_id.

Business notes

Data comes from tax-refund execution detail records, with one record per refund action.
Each record includes the owning announcement, customer (aaid), securities account, refund charge item, refund and adjustment amounts, execution currency, execution state, the original charged amount, remarks, and whether it is revoked along with the reference to the revoked original detail.
Typically used for auditing and reconciling refund records, or to verify individual refund execution results during customer enquiries or exception investigation.

Returns

On success, returns the matching record list and pagination info. See the response definition for column meanings.

POSThttps://b-api.lbkrs.com/v1/datasets/corp_action_refund_announcement_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

filtersobjectrequired

Filters

Child attributes

ann_idstringrequired

Ann Id. Required.

pageinteger

Page

page_sizeinteger

Page Size

Responses

HTTP 200Paginated list result.

Standard response envelopecodemessagedata

dataobjectdata structure

listarray<object>required

List

Child attributes

idstring

ann_idstring

Ann Id

origin_idstring

Origin Id

refundment_idstring

Refundment Id

aaidstring

Aaid

aaid_valstring

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

stock_fee_detail_idstring

Stock Fee Detail Id

exec_statestring

Exec State

refund_fee_codestring

Refund Fee Code

amountstring

Amount

adjust_amountstring

Adjust Amount

currencystring

Currency

is_revokestring

Is Revoke

revoked_refundment_detail_idstring

Revoked Refundment Detail Id

remarkstring

Remark

created_atstring

Created At

original_charge_amountstring

Original Charge Amount

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

Request

curl --request POST \
  --url 'https://b-api.lbkrs.com/v1/datasets/corp_action_refund_announcement_details' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json'
  --data '{
  "filters": {},
  "page": 1,
  "page_size": 20
}'

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "id": "1000000001",
        "ann_id": "1000000001",
        "origin_id": "1000000001",
        "refundment_id": "1000000001",
        "aaid": "H00000001",
        "aaid_val": "H00000001",
        "stock_fee_detail_id": "1000000001",
        "exec_state": "1",
        "refund_fee_code": "1",
        "amount": "125630.50",
        "adjust_amount": "125630.50",
        "currency": "USD",
        "is_revoke": "1",
        "revoked_refundment_detail_id": "1000000001",
        "remark": "审核通过",
        "created_at": "1789713827",
        "original_charge_amount": "12.50"
      }
    ],
    "total": 1
  }
}

Export

The export endpoint uses the same filters as this Dataset query.

POSThttps://b-api.lbkrs.com/v1/datasets/corp_action_refund_announcement_details/download

lb_hk_corporate.corporate_query

Export options Export records Download result