Skip to content
Longport WhaleLongport Whale
Corp Action Management

Corporate refund announcement list

Returns a summary list of withholding-tax refunds for US corporate actions, used to centrally manage the collected tax, refund progress, and status of each announcement.

Request parameters

  • Combine business filters through filters (see the filters field reference below), and use page, page_size, and orderBy for pagination and sorting.
  • Supports filtering by announcement code, payable-date range, underlying security, remark, and state; either end of the range may be omitted (an omitted side is unbounded), and omitting a filter matches all.

Business notes

  • Data covers US corporate-action announcements that have reached the relevant stage and carry withholding tax (TAX_FEE), sorted by payable date in descending order.

  • Each record summarizes the announcement code, underlying security, payable date, tax actually collected, final charge and refunded amount, execution currency, operator, and last-updated time, together with the refund state (such as not refunded, refunding, refunded, execution failed, revoked, or under approval).

  • Typically serves as the entry list for the refund workflow, used to track the refund progress of each withholding-tax charge and to initiate subsequent refund actions.

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_list

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
ca_codestring

Announcement NO.

payable_dateobject

Range filter; both bounds are optional (omit a bound to leave that side unbounded).

Child attributes
gtestring

Greater Than or Equal

ltestring

Less Than or Equal

origin_counter_idstring

Origin Counter Id

remarkstring

Remark

statestring

Filters results by Status. Values come from a backend data dictionary.

Values
1
Not refunded
2
In Progess
3
Refunded
5
Revoked
6
In approval
pageinteger

Page

page_sizeinteger

Page Size

Responses

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

List

Child attributes
ca_codestring

Announcement NO.

origin_counter_idstring

Origin Counter Id

payable_datestring

Payable Date

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.

total_tax_feestring

Actual Amount Received

currencystring

Currency

remarkstring

Remark

final_feestring

Final Fee

updated_atstring

Updated At

statestring

Action

state_valstring

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

refund_amountstring

Amount Refunded

operatorstring

Operator

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