Funds Limits

This API returns the user’s current fund and margin details, including available margin, used margin, segment-wise exposure, and other financial limits. It helps determine whether the user has sufficient balance for trading or withdrawals.

Type	API	Details
GET	funds/limits	Get fund limits
POST	payment/upi/update	Place a new UPI fund
GET	payment/upi	Get UPI payment details
GET	atompayment/get/bankdetails	Get bank details

Limits

The API provides a comprehensive breakdown of a user's available trading funds, margin usage, and segment-wise limits. It returns real-time financial metrics such as available margin, pay-in amounts, exposure, SPAN margin, premium blocked, and segment-specific intraday and positional margins (F&O, Currency, Commodity).

Response Structure

{
    "status": "Ok",
    "message": "Success",
    "result": [
        {
            "availableMargin": 0.0,
            "openingBalance": 0.0,
            "marginUsed": 0.0,
            "payin": 0.0,
            "stockPledge": 0.0,
            "holdingSellCredit": 0.0,
            "brokerage": 0.0,
            "exposure": 0.0,
            "span": 0.0,
            "premium": 0.0,
            "payout": 0.0,
            "unclearedCash": 0.0,
            "fnoDay": 0.0,
            "fnoNrml": 0.0,
            "cdsDay": 0.0,
            "cdsNrml": 0.0,
            "mcxDay": 0.0,
            "mcxNrml": 0.0
        }
    ]
}

Response Parameters

Field	Type	Description
availableMargin	Float	Total margin currently available for trading
openingBalance	Float	Opening account balance at the start of the day
marginUsed	Float	Margin already used for trading
payin	Float	Amount of funds added to the account
stockPledge	Float	Margin received from pledged stocks
holdingSellCredit	Float	Credit received from selling holdings
brokerage	Float	Total brokerage charges
exposure	Float	Exposure margin requirement
span	Float	SPAN margin required for open positions
premium	Float	Option premium blocked from available margin
payout	Float	Amount available for withdrawal
unclearedCash	Float	Deposits not yet cleared
fnoDay	Float	Intraday margin used for F\&O segment
fnoNrml	Float	Positional margin used for F\&O segment
cdsDay	Float	Intraday margin used for currency segment
cdsNrml	Float	Positional margin used for currency segment
mcxDay	Float	Intraday margin used for commodity segment
mcxNrml	Float	Positional margin used for commodity segment

Set UPI

Allows the user to register or update their UPI ID for performing transactions such as fund transfers, withdrawals, or linking payment methods. Once submitted, the backend will save the provided UPI ID and return it in the response for confirmation.

Request Structure

{
    "upiId" : "xxxxxx@ymbl"
}

Input Parameter

Field	Type	Description
upiId	String	User's UPI ID to be updated/set

Response Structure

{
    "status": "Ok",
    "message": "Success",
    "result": [
        {
            "upiId": "xxxxx@ymbl"
        }
    ]
}

Response Parameters

Field	Type	Description
status	String	Status of the API response (e.g., "Ok")
message	String	Message describing the result (e.g., "Success")
result	Array	Contains a list of UPI details
upiId	String	User’s updated or registered UPI ID

Get UPI

Allows the user to set or update their UPI ID for future payments or withdrawals. Upon successful update, the API returns the saved UPI ID in the response.

Response Structure

{
    "status": "Ok",
    "message": "Success",
    "result": [
        {
            "upiId": "xxxxxx@ymbl"
        }
    ]
}

Response Parameters

Field	Type	Description
status	String	API response status (e.g., "Ok")
message	String	Response message (e.g., "Success")
result	Array	Array containing the updated UPI ID object
upiId	String	The UPI ID successfully updated or returned

Bank Details

Fetches the user's mapped bank details along with the list of enabled exchanges for trading or payout operations.

Response Structure

{
    "status": "Ok",
    "message": "Success",
    "result": [
        {
            "bankDetails": [
                {
                    "bankName": "abcd",
                    "accNo": "**********0508",
                    "bankType": "Primary",
                    "ifscCode": "xxxx",
                    "bankCode": "NA",
                    "clientName": "xyz"
                }
            ],
            "exchange": [
                "NSE",
                "NFO",
                "CDS",
                "MCX",
                "NSLB",
                "NCOM"
            ]
        }
    ]
}

Response Parameters

Field	Type	Description
availableMargin	Float	Total margin currently available for trading
openingBalance	Float	Opening account balance at the start of the day
marginUsed	Float	Margin already used for trading
payin	Float	Amount of funds added to the account
stockPledge	Float	Margin received from pledged stocks
holdingSellCredit	Float	Credit received from selling holdings
brokerage	Float	Total brokerage charges
exposure	Float	Exposure margin requirement
span	Float	SPAN margin required for open positions
premium	Float	Option premium blocked from available margin
payout	Float	Amount available for withdrawal
unclearedCash	Float	Deposits not yet cleared
fnoDay	Float	Intraday margin used for F\&O segment
fnoNrml	Float	Positional margin used for F\&O segment
cdsDay	Float	Intraday margin used for currency segment
cdsNrml	Float	Positional margin used for currency segment
mcxDay	Float	Intraday margin used for commodity segment
mcxNrml	Float	Positional margin used for commodity segment