Skip to content
Structured Products

Get Structured Product Details

Returns the basic information, terms, documents, and trading rules of a structured product for the product detail page.

  • When product.status is offline, the product is delisted. Do not offer a purchase entry.
  • When product.complex_product is 1, the product is a complex product. After the pre-order check passes and before the order page opens, the Client must confirm the complex product declaration.
  • For the product elements section, call GET /v1/wms/target/detail with scene=product_details to get the elements configured by the service.

When the Client taps Buy, call GET /v1/wms/orders/check first to run the pre-order check.

GEThttps://api.lbkrs.com/v2/wms/product/detail

Parameters

counter_idstringqueryRequired

Structured product code

idea_idstringquery

Product idea ID from the product list

Responses

HTTP 200The request succeeded. The response body contains the result of the “Get Structured Product Details” operation.
Standard response envelopecodemessagedata
dataobjectdata structure
basicobject

Basic product information

Child attributes
counter_idstring

Structured product code

idea_idstring

Product idea ID

quote_idstring

Quote ID

instrument_namestring

Product name

subject_titlestring

Product display title. Show instrument_name when empty

client_pricestring

Client subscription price as a ratio of the notional, for example 0.99 means 99%

denominationstring

Minimum subscription unit. The subscription amount must be a positive multiple of it

benefit_textstring

Product benefit highlights

payoff_textstring

Payoff explanation

risk_textstring

Risk explanation

productobject

Product terms

Child attributes
product_typestring

Product type, such as FCN or SAN

currencystring

Product currency

statusstring

Product status:

  • online - On sale
  • offline - Delisted
complex_productstring

Whether the product is a complex product:

  • 0 - Not set
  • 1 - Yes
  • 2 - No
coupon_ratestring

Coupon rate

coupon_2_ratestring

Second-stage conditional coupon rate

coupon_2_start_tenorinteger

Period from which the second-stage coupon starts

coupon_frequencystring

Coupon frequency

strike_levelstring

Strike level

ko_levelstring

Knock-out level

ki_levelstring

Knock-in level. Empty or 0 means the product has no knock-in feature

noncall_periodstring

Non-call period

tenor_numstring

Tenor value

tenor_unitstring

Tenor unit

underlyingarray<string>

Underlying security codes

issuer_namestring

Issuer name

issue_datestring

Issue date

settlement_typestring

Settlement method

documentsarray<object>

Product documents

Child attributes
keystring

File link or identifier used to open the file

namestring

File name

update_atstring

File update time

rulesarray<object>

Trading rules

Child attributes
keystring

Rule key. trade_rules is the trading rules

valuestring

Rule content

Whale Docs