FUND VIEW SUMMARY

This API returns a consolidated Funds View Summary for a user, including available funds, deposits, collateral, margins, utilization, profits/losses, and withdrawal eligibility.

🔗 Path Parameters

Parameter	Type	Required	Description	Example
tenantid	string	Yes	Unique id provided for the tenant by SIPL	"tenant001"

🔍 Query Parameters

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

🔑 Header Parameters

Header	Type	Description	Example
Authorization	string	Access token for authenticated requests	{{access_token}}
Content-Type	string	Request payload format	application/json
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	Yes	Group ID	"GRP01"
periodicityName	string	No	Periodicity Name	"All Exchange Combined"
productType	integer	Yes	Product Type ID	1

🟢 Success Response - 200 OK

Content-Type: application/json

Field	Type	Description	Example
status	boolean	Status of API call	true
result	array	See structure below	Refer below

📦 result[0] — Status Object

Field	Type	Description	Example
Status	string	Inline status indicator	"Success"
ErrorMsg	string	Error message	""

📦 result[1] — Fund Summary Object

Field	Type	Description	Example
Product	string	Product ID	"1"
Deposit	string	Total deposit balance	"99999999999.99"
Funds Transferred Today	string	Funds transferred today	"0.00"
Collateral	string	Collateral value	"0.00"
Credit for Sale	string	Credit received from sale transactions	"0.00"
Option CFS	string	Option Credit for Sale value	"0.00"
Total Trading Power Limit	string	Total trading power available	"99999999999.99"
Limit Utilization	string	Utilized trading limit (may be negative)	"-41640.61"
Booked P&L	string	Realized profit and loss	"0.00"
MTM P&L	string	Mark-to-Market profit and loss (may be negative)	"-153.95"
Total Utilization	string	Total utilized amount (may be negative)	"-41794.56"
Net Available Funds	string	Net available trading funds	"99999958205.43"
For Allocation/Withdrawal	string	Amount available for allocation or withdrawal	"99999958205.43"
Exposure Margin	string	Exposure margin blocked	"0.00"
Cash Deposit	string	Cash deposit amount	"99999999999.99"
Adhoc Deposit	integer	Adhoc deposit amount	0
NotionalDeposit	integer	Notional deposit amount	0

📝 Notes

• Provides a consolidated snapshot of the user's funds and margin position.