Skip to content
Dividend Election

Calculate dividend election split

For a shares-and-cash split, calculates the registered shares allocated to the scrip option and the cash option, plus the estimated shares and cash receivable, based on the number of shares the Client wants to receive. Use it when the Client adjusts and confirms the share quantity on the dividend election details page. It only calculates and does not submit the election.

Get ann_id and origin_quantity from the event, stock_surplus_value and exchange_price from scrip_event, and cash_surplus_value from the default cash option. divided_stock_quantity must be a positive integer below scrip_event.stock_payable; at or above that limit, switch to all shares instead of calling this operation. Use cash_choices_quantity and stock_choices_quantity from the result in details of POST /v1/app/be/choose. On failure, show message to the Client.

POSThttps://api.lbkrs.com/v1/app/be/calc

Request body application/json

ann_idintegerrequired

Event ID from ann_id of the event

origin_quantitystringrequired

Registered shares from origin_quantity of the event

divided_stock_quantitystringrequired

Number of shares the Client wants to receive. A positive integer below scrip_event.stock_payable

exchange_pricestringrequired

Conversion price from scrip_event.exchange_price

stock_surplus_valuestringrequired

Scrip option dividend per share from scrip_event.surplus_value

cash_surplus_valuestringrequired

Cash option dividend per share from surplus_value of the default cash option

Responses

HTTP 200The request succeeded. The response body contains the result of the “Calculate dividend election split” operation.
Standard response envelopecodemessagedata
dataobjectdata structure
stock_choices_quantitystring

Registered shares allocated to the scrip option

cash_choices_quantitystring

Registered shares allocated to the cash option

divided_stock_quantitystring

Estimated shares receivable

divided_cash_amountstring

Estimated cash receivable in the default cash option's currency, as a decimal string

Whale Docs