Skip to content
Structured Product Records

List Structured Product Lifecycle Events

Returns lifecycle events of the structured products held by the current account: coupon, knock-in observation, knock-out observation, and maturity. Each event includes dates, coupon rate, knock-in or knock-out level, settlement method, and status. Without counter_id, it returns events for all positions, for the lifecycle calendar (usually pass start_date and end_date by month and group by event_base_date_locale). With counter_id, it serves the lifecycle section of a single position detail.

Show a maturity event in status 1 (Not triggered) as pending maturity. A non-empty settlement_type means the settlement method has been determined.

GEThttps://api.lbkrs.com/v1/wms/lifecycle/list

Parameters

counter_idstringquery

Structured product code

event_typestringquery

Event type. Omit to return all types

CouponKnock InKnock OutMaturity

statusintegerquery

Event status, with the same values as status in the response. Omit to return all statuses

123567

start_datestringquery

Start of the event base date range, in YYYY-MM-DD

end_datestringquery

End of the event base date range, in YYYY-MM-DD

Responses

HTTP 200The request succeeded. The response body contains the result of the “List Structured Product Lifecycle Events” operation.
Standard response envelopecodemessagedata
dataobjectdata structure
lifecycle_infoarray<object>

Lifecycle events

Child attributes
counter_idstring

Structured product code

namestring

Product name

event_typestring

Event type:

  • Coupon - Coupon date
  • Knock In - Knock-in observation date
  • Knock Out - Knock-out observation date
  • Maturity - Maturity date
event_type_localesstring

Localized event type text

statusinteger

Event status:

  • 1 - Not triggered
  • 2 - Coupon paid
  • 3 - Knocked in
  • 5 - Knocked out
  • 6 - Coupon pending credit
  • 7 - Matured
ratestring

Coupon rate as a percentage number, for example 1.2 means 1.2%. Used by coupon events

amountstring

Event amount

ki_levelstring

Knock-in level. Used by knock-in events

ki_pricestring

Knock-in price

ko_levelstring

Knock-out level. Used by knock-out events

ko_pricestring

Knock-out price

underlying_counter_idstring

Code of the underlying that triggered the event

underlying_codestring

Display code of the underlying that triggered the event (knock-in or knock-out underlying)

settlement_typestring

Maturity settlement method. Empty when not yet determined:

  • physical_delivery - Physical delivery
  • cash_delivery - Cash delivery
event_base_datestring

Event base date. Date range filters apply to this date

event_base_date_localestring

Display text of the event base date (YYYY-MM-DD)

trade_date_localestring

Display text of the confirmation or observation date

period_end_dateinteger

Period end date as a Unix timestamp in seconds. Used for grouping when event_base_date_locale is missing

settlement_dateinteger

Upstream settlement date as a Unix timestamp in seconds

settlement_date_localestring

Display text of the upstream settlement date

estimated_credit_datestring

Estimated credit date

estimated_credit_date_localestring

Display text of the estimated credit date

Whale Docs