Skip to main content

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​

ParameterTypeRequiredDescriptionExample
tenantidstringYesUnique id provided for the tenant by SIPL"tenant001"

🔍 Query Parameters​

ParameterTypeRequiredDescriptionExample
userIdstringYesUser ID (UCC)"{{user_id}}"

🔑 Header Parameters​

HeaderTypeDescriptionExample
AuthorizationstringAccess token for authenticated requests{{access_token}}
Content-TypestringRequest payload formatapplication/json
x-api-keystringAPI key used to authorize request{{x-api-key}}

📑 Request Body Parameters​

FieldTypeRequiredDescriptionExample
userIdstringYesUser ID"CLIENT001"
groupIdstringYesGroup ID"GRP01"
periodicityNamestringNoPeriodicity Name"All Exchange Combined"
productTypeintegerYesProduct Type ID1

🟢 Success Response - 200 OK​

Content-Type: application/json

FieldTypeDescriptionExample
statusbooleanStatus of API calltrue
resultarraySee structure belowRefer below

📦 result[0] — Status Object​

FieldTypeDescriptionExample
StatusstringInline status indicator"Success"
ErrorMsgstringError message""

📦 result[1] — Fund Summary Object​

FieldTypeDescriptionExample
ProductstringProduct ID"1"
DepositstringTotal deposit balance"99999999999.99"
Funds Transferred TodaystringFunds transferred today"0.00"
CollateralstringCollateral value"0.00"
Credit for SalestringCredit received from sale transactions"0.00"
Option CFSstringOption Credit for Sale value"0.00"
Total Trading Power LimitstringTotal trading power available"99999999999.99"
Limit UtilizationstringUtilized trading limit (may be negative)"-41640.61"
Booked P&LstringRealized profit and loss"0.00"
MTM P&LstringMark-to-Market profit and loss (may be negative)"-153.95"
Total UtilizationstringTotal utilized amount (may be negative)"-41794.56"
Net Available FundsstringNet available trading funds"99999958205.43"
For Allocation/WithdrawalstringAmount available for allocation or withdrawal"99999958205.43"
Exposure MarginstringExposure margin blocked"0.00"
Cash DepositstringCash deposit amount"99999999999.99"
Adhoc DepositintegerAdhoc deposit amount0
NotionalDepositintegerNotional deposit amount0

📝 Notes​

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