Skip to content
Longport WhaleLongport Whale
Corp Action Management

Corporate Action - Refund Detail By Sub-position View

Returns the per-group refundable summary for a corporate action under a given sub-position view, so refund amounts can be filled in group by group.

Request parameters

  • Required: ann_id (corporate-action advance-notice ID), view_id (sub-position view ID).
  • See the field descriptions for the format, allowed values, and business meaning of each field.

Returns

On success returns the group list under the view in data.groups; each group includes the refundable fee, already-refunded amount, currency, and the sub-position accounts it covers.

GEThttps://b-api.lbkrs.com/corporate_action/refund_detail/by_sub_position_view

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.

Parameters

ann_idstringRequired

Corporate-action announcement ID.

view_idstringRequired

Sub-position view ID. Use a view identifier returned by the sub-position view list (tax refund) endpoint.

Responses

HTTP 200The request was processed successfully. The business result is in data.groups.
Standard response envelopecodemessagedata
dataobjectdata structure
groupsarray<object>

Refund groups under the sub-position view.

Child attributes
group_idstring

Group ID.

group_namestring

Group name.

total_tax_feestring

Total refundable fee for the group (display value).

total_refundedstring

Total already-refunded amount for the group (display value).

currencystring

Currency.

sub_positionsarray<object>

Sub-position accounts within the group.

Child attributes
counterpart_accountstring

Sub-position account.

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