PERIODICITY WISE BALANCE

This API returns the periodicity-wise fund balances of the user. These balances are categorized into different fund types such as cash deposits, adhoc deposits, miscellaneous deposits, overdraft limits, and other ledger components.

🔍 Query Parameters

Parameter	Type	Required	Description	Example
userId	string	Yes	User ID (UCC)	"{{user_id}}"
periodicity	integer	No	Periodicity ID. Available from Margin Info API where type is returned as list.	30847

🔑 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}}

🟢 Success Response - 200 OK

Content-Type: application/json

Field	Type	Description	Example
status	string	Status of API call	"success"
code	string	Response code	"s-101"
message	string	Success message	"Balance information fetched successfully"
data	array	List of periodicity-wise balance details	Refer Data Object Fields

📦 Data Object Fields

Field	Type	Description	Example
id	string	Periodicity identifier	"30847"
name	string	Periodicity name	"Daily"
data	array	Balance breakup details	Refer Balance Fields

📘 Balance Fields

Field	Type	Description	Example
sSign	string	Sign indicator for amount	"+", "-"
sDescription	string	Balance description	"Cash Deposit"
nTrading	integer	Trading balance amount	50000
nIPO	integer	IPO balance amount	10000
nMF	integer	Mutual Fund balance amount	5000
nTotal	integer	Total balance amount	65000
sIndicator	string	Balance category indicator	"CR", "DR"

📝 Notes

• Provides a detailed breakup of funds available under different balance categories.
• Balances may include:
  • Cash Deposits
  • Adhoc Deposits
  • Miscellaneous Deposits
  • Overdraft Limits
  • Other Ledger Components
• periodicity is optional:
  • If provided, returns balance details for the specified periodicity.
  • If omitted, the default periodicity balance is returned.
• Periodicity IDs can be obtained from the Margin Info API.