PLACE/MODIFY IPO ORDER

This API is used to place a new IPO bid or modify an existing IPO bid.

To modify an IPO application, pass the TransactionNo and ReferenceNo received during the original IPO order placement.

🔍 Query Parameters

Parameter	Type	Required	Description	Example
userId	string	Yes	User ID (UCC)	"{{user_id}}"

🔑 Header Parameters

Header	Type	Description	Example
Content-Type	string	Request payload format	application/json
Authorization	string	Access token for authenticated requests	{{access_token}}
x-api-key	string	API key used to authorize request	{{x-api-key}}

📑 Request Body Parameters

Field	Type	Required	Description	Example
UserID	string	Yes	User ID	"CLIENT001"
GroupID	string	No	Group ID	"GRP01"
UCCClientID	string	Yes	UCC Client ID	"CLIENT001"
UCCGroupID	string	No	UCC Group ID	"UGRP01"
BidMode	string	Yes	Bid mode	"ONLINE"
IPOCode	string	Yes	IPO code	"NMULTSB1"
Series	string	Yes	IPO series	"EQ"
AppCategoryCode	string	Yes	Application category code	"RET"
DPId	string	Yes	Depository Participant ID	"IN300XXX"
BeneficiaryId	string	Yes	Beneficiary account ID	"1234567890"
PaymentMode	string	Yes	Payment mode	"UPI", "ASBA"
UpiId	string	No	UPI ID	"user@upi"
BankId	string	No	Bank ID	"BANK001"
BankAccountNo	string	No	Bank account number	"XXXXXXXX1234"
TransactionNo	string	No*	Transaction number received during order placement	"TXN123456"
ReferenceNo	string	No*	Reference number received during order placement	"REF123456"
Bids	array	Yes	List of IPO bids	Refer Bid Object Fields

Note: TransactionNo and ReferenceNo are mandatory when modifying an existing IPO order.

📦 Bid Object Fields

Field	Type	Required	Description	Example
ActivityType	string	Yes	Bid activity type	"NEW", "MODIFY"
Cutoff	boolean	Yes	Apply at Cut-Off price	true
Price	integer	Yes	Bid price	120
BidNo	integer	Yes	Bid number	1
Qty	integer	Yes	Bid quantity	125

🟢 Success Response - 200 OK

Content-Type: application/json

Field	Type	Description
status	string	Status of API call
code	string	s-101
message	string	Success message
data	object	IPO application response details

📝 Notes

• Supports both IPO Order Placement and IPO Order Modification.
• For new applications:
  • Do not send TransactionNo and ReferenceNo.
• For modifications:
  • Pass TransactionNo and ReferenceNo obtained from the original IPO application.
• Used in:
  • IPO subscription workflows
  • IPO application modification flows
  • Retail and HNI bidding journeys