Skip to content
Longport WhaleLongport Whale
Corp Action Management

Corporate Action - Refund By Sub-position View

Initiates tax refunds grouped by the selected sub-position view during the refund flow. Each group specifies a refund amount and the sub-position accounts it covers.

Request parameters

  • Required: ann_id (corporate-action advance-notice ID), view_id (sub-position view ID), groups (refund groups).
  • Optional: audit_frontend_resource (caller-provided audit context).
  • Each groups item must give group_id, amount (refund amount), and sub_position_scope (the sub-position accounts the group covers).
  • view_id comes from the list of sub-position views available for the refund scenario.

Risk warning

This operation initiates real tax refunds and involves fund movement. Confirm the view, groups, and refund amounts before calling.

Result

On success the refunds are initiated; the outcome is in data. Interpret it together with the business code.

POSThttps://b-api.lbkrs.com/corporate_action/refund_by_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.

Request body application/json

ann_idstringrequired

Corporate-action announcement ID identifying the corporate action to refund.

view_idstringrequired

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

groupsarray<object>required

Refund group list. Each item corresponds to a group under the selected view, giving its refund amount and the sub-position accounts it covers.

Child attributes
group_idstringrequired

Group ID.

group_namestring

Group name, a caller-provided display name for the group. Optional; omission does not affect refund processing.

amountstringrequired

Refund amount for the group, passed as a numeric string.

sub_position_scopearray<string>required

Sub-position accounts covered by the group, as a list of sub-position account identifiers (counterpart_account).

audit_frontend_resourceobject

Caller-provided audit context recording information such as the securities and announcement codes involved in this operation. No audit information is attached when omitted.

Responses

HTTP 200The request was processed successfully. The business result is in data; its exact fields follow the actual API response.
Standard response envelopecodemessagedata
dataobjectdata structure

Result of initiating the refund; the exact fields follow the actual API response.

No nested fields

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