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: 

Query Params:

{
    "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

{
    "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

{
    "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.

{
    "code": 401,
    "message": "auth fail, you can retry!"
}