Skip to main content

Fetch Loan Summary for the Loan Id

GET Loan Summary

This API allows users to retrieve all loan summary information such as "Number Of Installments", "Installment Amount", and "Payable Charges" for the respective Loan Id.

Screenshot 2023-04-20 at 1.45.56 AM.png

URL: {{base_url}}/loan-management/v1/getLoanSummaryForLoan

Run in Postman: GET Loan Summary

Request: 

Request Type: GET
Authorization: Bearer Token
Query Parameter:
Key Data Type Description Validations Default Value Required
loanId Integer Unique identity constraint  N/A - Yes


Response:

Success: 200 OK
Schema
Attribute Type Description Mandatory
response boolean Indicates success of the response Yes
data object Contains various data elements Yes
number_of_installments object Details of installments No
installment_amount object Details of installment amounts No
receivable_charges object Details of receivable charges No
payable_charges object Details of payable charges No
branch_hierarcy object Branch hierarchy information No
error object Error information, if any No
Body 
{
   "response": true,
   "data": {
      "number_of_installments": {
         "paid": 0,
         "dues_as_on_date": 0,
         "net_amount": 0
      },
      "installment_amount": {
         "paid": 0,
         "dues_as_on_date": 0,
         "net_amount": 0
      },
      "receivable_charges": {
         "Processing Fee": {
            "paid": 0,
            "dues_as_on_date": 0,
            "net_amount": 0
         },
         "Total": {
            "paid": 0,
            "dues_as_on_date": 0,
            "net_amount": 0
         }
      },
      "payable_charges": {
         "Excess Amount": {
            "paid": 0,
            "dues_as_on_date": 0,
            "net_amount": 0
         },
         "Total": {
            "paid": 0,
            "dues_as_on_date": 0,
            "net_amount": 0
         }
      },
      "branch_hierarcy": null
   },
   "error": null
}

Internal Server Error: 500

Note: If the API is unable to retrieve data for specific fields against the relevant Loan Id, then this error will occur.

Schema
Attribute

 Type Description Mandatory
response
 String Internal status code that denotes the status of request Yes
data
 Object Response Object for the given inputs No
error Object Data Object Internal error object for the given inputs Yes

code integer Internal error code for API Yes
text String Error message for the API No
detail String Reason / Detail for the cause of error No
Body
Expected messages as per Status API :
Error Code Description
107001 An Exception occurred in saving data 
{
    "response": false,
    "data": null,
    "error": {
        "code": 0,
        "text": "string",
        "detail": "string"
    }
}

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