FUNDS VIEW SUMMARY API

This API is used to fetch detailed funds summary information for a user, including deposits, collateral, trading limits, utilization, P&L, and available funds.

🔑 Header Parameters

Header	Type	Description	Example
Content-Type	string	Specifies the media type of the request payload	application/json
Authorization	string	Dealer authentication token	Bearer {{access_token}}
x-api-key	string	API key used to authorize the request	{{x-api-key}}

📑 Request Body Parameters

Field	Type	Required	Description	Example
userId	string	Yes	Client ID to fetch funds data. Leave empty for dealer-level	"VISHAL1"
groupId	string	Yes	Group ID of the user	"GRP01"
periodicityName	string	Yes	Periodicity name	"T+1 Balance"
productType	integer	Yes	Product type identifier	1

🟢 Success Response - 200 OK

Content-Type: application/json

Field	Type	Description	Example
status	boolean	Status of API call	true
result	object[]	Array containing status and funds summary	Refer below

📦 Result Object Structure

✅ Status Array

Field	Type	Description	Example
Status	string	Status of request execution	"SUCCESS"
ErrorMsg	string	Error message if any	""

💰 Funds Summary Array

Field	Type	Description	Example
Product	string	Product ID	"EQFO"
Deposit	string	Total deposit amount	"100000"
Funds Transferred Today	string	Funds transferred today	"5000"
Collateral	string	Collateral value	"25000"
Credit for Sale	string	Credit available from sell	"10000"
Option CFS	string	Option Credit for Sale	"2000"
Total Trading Power Limit	string	Total trading limit	"150000"
Limit Utilization	string	Utilized limit	"75000"
Booked P&L	string	Realized profit/loss	"5000"
MTM P&L	string	Mark-to-market profit/loss	"2000"
Total Utilization	string	Total utilized funds	"77000"
Net Available Funds	string	Available funds for trading	"73000"
For Allocation/Withdrawal	string	Amount available for withdrawal	"50000"
Exposure Margin	string	Margin blocked for exposure	"10000"
Cash Deposit	string	Cash deposit amount	"80000"
Adhoc Deposit	integer	Additional deposit amount	5000