v1

latestOpenAPI 3.0.32026-07-24190128.9 KB

Credit limit simulation

Determine the loan amount that can be drawn against user's mutual fund and stock holdings.

post/backend/{gatewayname}/v1/creditlimit/simulation

Path parameters

gatewaynamestring required

Query parameters

aggregateFundsboolean

Optional. When true, the distribution is aggregated by ISIN + dpId and the summary section is returned.

Headers

x-gateway-secretstring required

Required | apiSecret shared for authentication

x-gateway-authtokenstring required

Required | JWT created with payload {"iss":"<your_gateway_name>"}, and signed with the shared secret

Request body

referrerstring

Optional. Defaults to your partner name.

panstring

Optional. User's PAN.

agenumber

Optional. Validated against the lender's allowed age range when provided.

isNriboolean

Optional. Use isNri (isNRI is deprecated). NRI users are rejected with not_eligible_wrt_nri_status (4407).

namestring

Optional. User's name.

lenderstring

Optional. Omit to get the best offer across all eligible lenders.

Example request

{
  "brokerHoldings": [
    {
      "broker": "kite"
    }
  ]
}

Response

200

codeinteger

messagestring

Example response

{
  "data": {
    "distribution": [
      {
        "assetType": "STOCKS",
        "securityCode": "INF200KA1FS1",
        "securityName": "SBI Nifty 50 ETF",
        "sid": "SBFP",
        "isETF": true,
        "riskCategory": 1,
        "category": "EQUITY",
        "inputQuantity": 100,
        "allowableQty": 91,
        "selectedQuantity": 91,
        "price": 270.4,
        "marketValue": 24606.4,
        "totalMarketValue": 27040,
        "inputLTV": 50,
        "actualLTV": 45,
        "bufferLTV": 5,
        "drawingPower": 11072,
        "isDemat": true,
        "dpId": "1208160075231086",
        "isEligible": true
      }
    ],
    "flags": {
      "isDematEnabled": true
    },
    "summary": {
      "category": {
        "stocks": {
          "marketValue": 236628,
          "ltv": 45,
          "drawingPower": 48166,
          "marketValueEligible": 107038,
          "marketValueInEligible": 129590
        },
        "etfs": {
          "marketValue": 35208,
          "ltv": 42,
          "drawingPower": 14747,
          "marketValueEligible": 35208
        }
      },
      "maxDrawingAmount": 62913,
      "maxMarketValueForEligible": 142246,
      "maxMarketValueForInEligible": 129590
    },
    "lender": "bajaj_finserv",
    "loanAmountThreshold": {
      "minAmount": 25000,
      "maxAmount": 20000000
    },
    "interestRate": 10.5
  },
  "message": "SUCCESS"
}