Charge Service: PreDisbursal Charge Details
POST PreDisbursal Charge Details
This API retrieves pre-disbursal charge details for a specific loan scheme. Users provide scheme information along with loan details such as the number of properties, loan amount, and state through a POST request. Optional fields for computed_on_value and slab_value are available for additional computation parameters if required. The response includes detailed information about applicable charges, including descriptions, computed amounts, tax applicability, and charge codes.
Attribute Priority: Attributes scheme and charge code need to be added and configured using the admin panel.
URL: {{base_url}}/charges/v1/getPreDisbursalChargeDetails
Run in Postman: PreDisbursal Charge Details
Request:
Query Params:
Schema
Attribute | Data Type | Description | Mandatory | ||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
scheme | String | The unique identifier for the loan scheme. | Yes | ||||||||||||||||||||||||||||||||||||||||||||||||||||
charge_code | String | The code identifying the specific charge associated with the scheme. | Yes | ||||||||||||||||||||||||||||||||||||||||||||||||||||
input | Object | Contains details relevant to the loan, including the number of properties, loan amount, and state. | Yes | ||||||||||||||||||||||||||||||||||||||||||||||||||||
computed_on_value | Object | Optional: Provides additional parameters for computation, including sanctioned amount, principal outstanding, etc. | No | ||||||||||||||||||||||||||||||||||||||||||||||||||||
Attribute: computed_on_value
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||
slab_value | Object | Optional: Offers further parameters for computation, such as loan or draw-down amount, receipt amount, etc. | No | ||||||||||||||||||||||||||||||||||||||||||||||||||||
Attribute: slab_value
|
Body
{
"scheme": "TW100046",
"charge_code" : "unsecured_pl",
"input": {
"no_of_properties": "11",
"loan_amount": "350000",
"state": "karnataka"
},
//Optional
"computed_on_value": {
"sanctioned_amount": 0.0,
"principal_outstanding": 0.0,
"part_prepayment_amount": 0.0,
"gross_prepayment_amount": 0.0,
"total_overdue": 0.0,
"rate_of_interest": 0.0,
"balance_principal": 0.0,
"disbursal_amount": 0.0,
"requested_amount": 0.0,
"instrument_amount": 0.0,
"outstanding_installment_amount": 0.0,
"receipt_amount": 0.0
},
//Optional
"slab_value": {
"loan_or_draw_down_amount": 0.0,
"receipt_amount": 0.0,
"balance_principal": 0.0,
"principal_outstanding": 0.0,
"balance_tenure": 0.0,
"billed_tenure": 0.0,
"gross_prepayment_amount": 0.0
}
}
Response:
Success: 200 OK
Schema
Attribute |
Type | Description |
Mandatory | |||
response |
Boolean | true | Yes | |||
data |
Object | Success Response Object |
Yes | |||
Success Response Attribute |
||||||
error
|
Object | Error Response Object (null) | Yes |
Body
{
"response": true,
"data": [
{
"description": "Charge",
"computedOn": null,
"computedAmount": 94.0,
"chargeRate": 0.0,
"chargeType": "amount_based",
"isActive": null,
"isTaxApplicable": true,
"computedOnAmount": null,
"amountBased": null,
"rateBased": null,
"effectiveChargeRate": null,
"taxableAmount": 80.0,
"taxAmount": 14.4,
"chargeCode": "charge001",
"chargeAmount": 94.0,
"chargeStage": "predisbursal",
"computationType": null,
"excludeCalculation": false
},
{
"description": "test",
"computedOn": null,
"computedAmount": 5900.0,
"chargeRate": 0.0,
"chargeType": "amount_based",
"isActive": null,
"isTaxApplicable": true,
"computedOnAmount": null,
"amountBased": null,
"rateBased": null,
"effectiveChargeRate": null,
"taxableAmount": 5000.0,
"taxAmount": 900.0,
"chargeCode": "test_charge",
"chargeAmount": 5900.0,
"chargeStage": "predisbursal",
"computationType": null,
"excludeCalculation": false
}
],
"error": null
}
Internal Server Error: 200
Schema
Error Response Code and Messages
S. No | Code | Message | Description |
1. |
1017000
|
An Exception occurred in fetching data.
|
This occurs when an attribute can be null, empty, or not available for configuration in the masters. |
2. |
1015000
|
Charge Code is not present on request | Appears when receipt cancellation ('receipt_cancellation_date') is not initiated in the current business date. |
Attribute |
Type | Description |
Mandatory | ||||||
response |
Boolean | true | Yes | ||||||
data |
Object | Fail Response Object |
Yes | ||||||
error |
Object | Error : Fail Response Attribute
|
Yes |
Body
{
"response": false,
"data": null,
"error": {
"code": 1017000,
"text": "An Exception occurred in fetching data",
"detail": null,
"validation": null
}
}
Unauthorized: 401
Note: If the API is not authorized with the Token or if the authorization token has expired, this error is going to show up.
Body
{
"code": 401,
"message": "auth fail, you can retry!"
}
No Comments