Skip to content
Structured Product Trading

Get Structured Product Order Page Data

Call it when the order page opens. It returns the account's available funds and financing information in the product currency, product elements, selectable price types, and documents. This operation is read-only.

Validate the subscription amount quantity on the order page as follows:

  • It must be a positive multiple of product_details.denomination and cannot be 0.
  • Amount payable = quantity × product_details.client_price.
  • When cash_info.support_financing is 1, the amount payable cannot exceed cash_info.buy_on_margin. Otherwise it cannot exceed cash_info.withdraw.
  • When financing is supported and the amount payable exceeds cash_info.withdraw, the excess is financed. Set pay_mode to 1 when submitting, and you can call POST /v1/wms/orders/get_finance_info to estimate the interest.

When product_details.order_price_types is not empty, the Client must choose a price type for each underlying. With multiple underlyings, call POST /v1/wms/orders/additional-price-types to get the price types that remain selectable.

GEThttps://api.lbkrs.com/v1/wms/orders/data_info

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 Order Page Data” operation.
Standard response envelopecodemessagedata
dataobjectdata structure
cash_infoobject

Account funds and financing information

Child attributes
currencystring

Funds currency

withdrawstring

Available cash. The payable limit without financing

buy_on_marginstring

Amount purchasable with financing, including available cash. The payable limit when financing is supported

cash_amountstring

Cash amount

support_financingstring

Whether financed subscription is supported. 1 means supported; other values mean not supported

ratestring

Financing rate as a decimal, for example 0.065 means 6.5%

debit_intereststring

Financing interest

product_detailsobject

Product elements shown on the order page

Child attributes
instrument_namestring

Product name

product_typestring

Product type

currencystring

Product currency for display

currency_codestring

Product currency code. Pass it as currency to POST /v1/wms/orders/get_finance_info

client_pricestring

Client subscription price as a ratio of the notional, for example 0.99 means 99%. Pass it unchanged when submitting the order

denominationstring

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

coupon_ratestring

Coupon rate

strike_levelstring

Strike level

ko_levelstring

Knock-out level

tenor_numstring

Tenor value

tenor_unitstring

Tenor unit

support_financingstring

Whether the product supports financed subscription. 1 means supported

order_price_typesarray<object>

Selectable order price types. Empty means no selection is needed

Child attributes
price_typestring

Price type machine value. Pass it as order_price_types[].price_type when submitting an order, for example Limit or Market

titlestring

Price type name

sub_titlestring

Price type subtitle

descstring

Price type explanation

underlying_infoarray<object>

Underlyings

Child attributes
underlying_counter_idstring

Underlying security code

namestring

Underlying name

file_infoarray<object>

Product documents to read before ordering

Child attributes
keystring

File link or identifier used to open the file

namestring

File name

update_atstring

File update time

Whale Docs