Skip to main content

Place/Modify IPO Order

This API allows users to modify an IPO (Initial Public Offering) order by providing a set of required parameters. The modification process includes sending certain details like the transaction number, reference number, and IPO details.

🔑Header Parameters

HeaderTypeDescriptionExample
AuthorizationstringBearer access tokenaccess-token
Content-typestringSpecifies the type of the content being sentapplication/json
x-api-keystringUnique API key provided for accessx-api-key

📦Request Body Schema

ParameterTypeDescriptionExample/ENUM
UserIDstringUnique Client Code (UCC) assigned to the user"UCC123456"
GroupIDstringIdentifier for the group under which the user fallsgroup9776
UCCClientIDstringUnique Client ID associated with the userclient123
UCCGroupIDstringThe unique group ID associated with the clientgroup345
BidmodestringBidmode of the IPO order. It indicates how the order will be placed"N"
IPOCodestringA unique code for the IPO being modifiedIPO1234
SeriesstringThe series for which the bid is being made (can be used to classify different IPO types)."EQ"
AppCategoryCodestringCategory code of the application, which might categorize users for specific rules or limits."Retail"
DPIdstringThe depository Participant ID that represents the central depository accountDP98765
BenficiaryIDstringThe ID of the beneficiary receiving the IPO allocationBen12345
PaymentModestringMethod of payment for the IPO order"UPI"
UpiIdstringThe UPI Id used for payment , if applicableuser@upi
BankIDstringThe unique identifier of the user's bankBank12345
BankAccountNostringThe bank account number for payment processing.00586788966
TransactionNostringThe unique transaction number of the original IPO order. This is used for identifying the order to modify.TXN12345678
ReferenceNostringThe reference number associated with the original IPO orderREF9875654
Bidsarray of objectDetails of bid entriesSee details below

📘Bids Object Info Fields

FieldTypeDescriptionExample/ENUM
ActivityTypestringSpecifies the Type of activity for the bid"N"
CutOffbooleanIndicates if the bid should be placed as a cutoff bid."true"
PriceintegerThe price at which the bid is placed.400
BidNointegerThe Bid number of the IPO order1
QtyintegerThe quantity of shares being bid for this order100

🟢Success Response - 200 Ok

post/transactional/v1/ipo/orders