Skip to main content

Charge Service: Compute Charges

POST Compute Charges


This API endpoint enables users to compute charges associated with specific loan schemes and configurations. By submitting a POST request with relevant parameters such as scheme, charge code, loan details, and location, users can receive detailed information about applicable charges. The computation takes into account factors like loan amount, number of properties, and geographical location. Optional fields for computed_on_value and slab_value allow inclusion of additional computation parameters if available, and they can be omitted if not needed. The response provides comprehensive details about the computed charge, including its description, amount, charge code, stage, and tax-related information, empowering users with essential insights for financial planning and decision-making processes.

Attribute Priority: Attributes scheme and charge code need to be added and configured using the admin panel.

URL: {{base_url}}/charges/v1/computeCharge

Run in Postman: Receipt Cancellation Request

Request: 

Request Type: POST
Authorization: Bearer Token

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
Attribute Data Type Description Mandatory
sanctioned_amount Double The amount of money officially approved for the loan. No
principal_outstanding Double The remaining principal amount of the loan that has not been paid off. No
part_prepayment_amount Double The amount of money paid towards the loan as a partial prepayment. No
gross_prepayment_amount Double The total amount of money paid towards the loan as prepayment. No
total_overdue Double The total amount of money that is past due and has not been paid on time. No
rate_of_interest Double The percentage rate at which interest is charged on the loan. No
balance_principal Double The remaining principal balance of the loan. No
disbursal_amount Double The amount of money disbursed for the loan. No
requested_amount Double The amount of money requested for the loan. No
instrument_amount Double The total amount of money received as a financial instrument. No
outstanding_installment_amount Double The remaining amount of money that needs to be paid for the loan in installments. No
receipt_amount Double The total amount of money received as a receipt. No
slab_value Object Optional: Offers further parameters for computation, such as loan or draw-down amount, receipt amount, etc. No

Attribute: slab_value
Attribute Data Type Description Mandatory
loan_or_draw_down_amount Double The amount of money disbursed or drawn down for the loan. No
receipt_amount Double The total amount of money received as a receipt. No
balance_principal Double The remaining principal balance of the loan. No
principal_outstanding Double The remaining principal amount of the loan that has not been paid off. No
balance_tenure Double The remaining tenure or duration of the loan. No
billed_tenure Double The tenure or duration of the loan that has been billed. No
gross_prepayment_amount Double The total amount of money paid towards the loan as prepayment. No
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
  • description
  • computedOn
  • computedAmount
  • chargeRate
  • chargeType
  • isActive
  • isTaxApplicable
  • computedOnAmount
  • amountBased
  • rateBased
  • effectiveChargeRate
  • taxableAmount
  • taxAmount
  • chargeCode
  • chargeAmount
  • chargeStage
  • computationType
  • excludeCalculation
error
 Object Error Response Object (null) Yes
Body 
{
    "response": true,
    "data": {
        "description": "Stamp Duty",
        "computedOn": null,
        "computedAmount": 0.0,
        "chargeRate": 0.0,
        "chargeType": null,
        "isActive": null,
        "isTaxApplicable": false,
        "computedOnAmount": null,
        "amountBased": null,
        "rateBased": null,
        "effectiveChargeRate": null,
        "taxableAmount": 0.0,
        "taxAmount": 0.0,
        "chargeCode": "stamp_duty",
        "chargeAmount": 0.0,
        "chargeStage": "postdisbursal",
        "computationType": null,
        "excludeCalculation": false
    },
    "error": null
}
Internal Server Error: 200
Schema
Error Response Code and Messages
S. No Code Message Description
1. 101756 Cannot cancel receipt. Charges is already allocated Appears When receipt charges are already allocated for the respective receipt.
2.
1015000
 Receipt Cancellation Date should be Business Date 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



Data : Fail Response Attribute
unique_transaction_number
 null
Yes

error

 Object
Error : Fail Response Attribute
code Please Refer Error Response Code and Messages
text
Yes
Body 
{
    "response": false,
    "data": {
        "unique_transaction_number": null
    },
    "error": {
        "code": 1015000,
        "text": "Receipt Cancellation Date should be Business Date"
    }
}

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!"
}

Back to top