Skip to content
Dividend Election

Submit dividend election

Submits the election for the specified event. Use it for Confirm on the dividend election details page. The election cannot be changed after submission, so the Broker App should show the chosen option and estimated proceeds and ask the Client to confirm before calling.

For all cash, pass the cash_event[].event_id of the chosen currency in event_id. For all shares, pass scrip_event.event_id. For shares and cash, pass 0 in event_id and, in details, pass the event_id of the default cash option and the scrip option with cash_choices_quantity and stock_choices_quantity returned by POST /v1/app/be/calc.

On success, data is null and you can show the result page, using the event's payable_at as the expected payment date. Actual proceeds and payment date are subject to the actual distribution. On failure, show message to the Client.

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

Request body application/json

ann_idstringrequired

Event ID: the event's ann_id as a string

event_idstringrequired

Chosen option ID. Pass 0 for a shares-and-cash split

detailsarray<object>

Required for a shares-and-cash split, with one item for the cash option and one for the scrip option. Omit it otherwise

Child attributes
event_idstringrequired

Option ID

choices_quantitystringrequired

Registered shares allocated to this option, from the calculation result

Responses

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

Always null

No nested fields

Whale Docs