Skip to main content

PRODUCT-WISE BALANCE API

This API provides the product-wise fund balance details for a user.
Balances are grouped based on products such as "COMMCOMB", "EQ+FO+CDS+MCX+OTS", "NSE EQUITIES", etc.

🔍 Query Parameters

ParameterTypeRequiredDescriptionExample
client_idstringNoClient ID to fetch product-wise balance for an end userclient_id=VISHAL1

🔑 Header Parameters

HeaderTypeDescriptionExample
Content-TypestringSpecifies the media type of the request payloadapplication/json
AuthorizationstringDealer authentication tokenBearer {{access_token}}
x-api-keystringAPI key used to authorize the request{{x-api-key}}

🟢 Success Response - 200 OK

Content-Type: application/json

FieldTypeDescriptionExample
statusstringStatus of API call"success"
codestringResponse code to user request"s-101"
messagestringSuccess message"Product-wise balance fetched successfully"
dataobject[]Array of product-wise balance objectsRefer below

📦 Product Balance Object Fields

FieldTypeDescriptionExample
sProductIdstringUnique product identifier"EQFO"
sProductNamestringName of the product"EQ+FO+CDS+MCX+OTS"
sActivestringStatus of the product"Y"
bDefaultProdintegerIndicates if this is the default product (1 = Yes, 0 = No)1
nBankMappingintegerBank mapping status1
balanceAmountstringTotal balance amount for the product"150000"
periodicitiesarrayList of associated periodicity IDs[30847, 30848]