Skip to content
Rights Issues and Tender Offers

Get Subscription Order Details

Gets the details of a rights issue or tender offer subscription by order ID. Used on the subscription details page to show the applied quantity, distributed quantity, fee, and key dates. Get order_id from the event list or subscription history.

The Broker App decides which actions to offer from the response. Before the end of the day of end_time, and when state is not REVOKED, UNDISTRIBUT, or DISTRIBUTED, the Client can cancel through POST /v1/portfolio/corpaction/subscribe/reovke. When state is REVOKED and the closing date has not passed, the Client can recalculate the fee with choices_quantity and subscribe again. The server makes the final decision. Specify the target account in the x-target-aaid request header.

POSThttps://api.lbkrs.com/v1/portfolio/corpaction/subscribe/detail

Parameters

x-target-aaidstringheaderRequired

The aaid of the target account. The operation returns or processes subscription data for this account.

Request body application/json

order_idintegerrequired

Subscription order ID from order_id of the list or history, converted to a number

Responses

HTTP 200The request succeeded. The response body contains the result of the “Get Subscription Order Details” operation.
Standard response envelopecodemessagedata
dataobjectdata structure
order_infoobject

A rights issue or tender offer subscription order

Child attributes
ann_idstring

Corporate action event ID. Convert it to a number when calculating fees or subscribing.

counter_codestring

Security code

counter_namestring

Security name

currencystring

Currency of the subscription price and fees

typestring

Subscription corporate action type:

  • RIGHTSISSUE - Rights issue
  • TAKEOVER - Tender offer
Values
RIGHTSISSUE
TAKEOVER
statestring

Subscription status:

  • UNSELECT - Pending
  • PROCESSING - Processing
  • UNDISTRIBUT - Pending distribution
  • DISTRIBUTED - Distributed
  • REVOKED - Cancelled
Values
UNSELECT
PROCESSING
UNDISTRIBUT
DISTRIBUTED
REVOKED
choices_quantitystring

Applied quantity, in shares

distribute_quantitystring

Distributed quantity, in shares. Populated when state is DISTRIBUTED.

fee_amountstring

Total fee. See currency for the currency.

is_excessboolean

Whether this is an excess rights application. Applies only to rights issues.

record_datestring

Record date, as a Unix timestamp in seconds, in string form

start_timestring

Subscription start time, as a Unix timestamp in seconds, in string form

end_timestring

Subscription closing time, as a Unix timestamp in seconds, in string form

distribute_datestring

Estimated distribution date, as a Unix timestamp in seconds, in string form

Whale Docs