Skip to content
IPO Cards

Get Usable IPO Cards

Called when the card selection panel opens on the IPO subscription or reservation page. Returns the cards the client holds for the given card types, currency, business types, and security, including unusable cards (invisible is true). The Broker App shows only cards in the subscription currency and selects the best card automatically: cards with priority set to true first, then IPO financing interest cards by discount rate in descending order and other cards by expiry time in ascending order. A card designated for another IPO security cannot be used. Pass the card_id of the selected card when submitting the subscription or reservation. Query IPO fee cards with Get IPO Fee Card instead.

POSThttps://api.lbkrs.com/v2/rewards/usable_card_list

Request body application/json

card_typesarray<string>required

Card types to query: ipo quota reservation coupon (for reservations), ipo_interest IPO financing interest card

subscription_idstring

Reservation project ID. Pass it for reservations

currencystring

Subscription currency

bz_typesarray<integer>

Business types; use bz_types from the subscription method or reservation info: 1 financed IPO subscription, 2 cash IPO subscription

counter_idstring

IPO security ID

Responses

HTTP 200The request succeeded. The response body contains the result of the “Get Usable IPO Cards” operation.
Standard response envelopecodemessagedata
dataobjectdata structure
listarray<object>

Cards

Child attributes
card_idstring

Card ID. Pass it when submitting a subscription or reservation

card_typestring

Card type: ipo quota reservation coupon, ipo_interest IPO financing interest card, ipo_commission IPO fee card

titlestring

Card title

title_secstring

Card subtitle

currencystring

Card currency. Only cards in the subscription currency can be selected

amountstring

Card face value

start_timestring

Start of the validity period as a Unix timestamp in seconds. 0 means no limit

end_timestring

Expiry time as a Unix timestamp in seconds. 0 means no limit

invisibleboolean

When true, the card cannot be used in the current scenario and is shown as unavailable

priorityboolean

Whether the card is recommended first. Automatic card selection picks it first

ipo_interestobject

IPO financing interest card attributes

Child attributes
discount_ratestring

Interest discount rate. Automatic selection sorts cards by this value in descending order

ipo_commissionobject

IPO fee card attributes

Child attributes
counter_idstring

Designated IPO security ID. Empty means no restriction

financing_limitstring

Financing amount threshold. The card cannot be used unless the financing amount exceeds it

bz_typesarray<integer>

Applicable IPO subscription types: 1 financed IPO subscription, 2 cash IPO subscription

Whale Docs