Skip to main content

Fetch Loan Summary for the Loan Id

Screenshot 2023-04-20 at 1.45.56 AM.png

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

RequestRun in Postman: GET Loan Summary

Request: 

Request Type: GET
Authorization: Bearer Token
Query Parameter
Query Parameter:
identity
Key Data Type DescriptionValidationsDefault ValueRequired
loanId*loanId Integer
Unique
constraint 
* required Param

Response: 200


{
   "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": {
         "Storage Charge": {
            "paid": 0,
            "dues_as_on_date": 0,
            "net_amount": 0
         },
         "Stamp Duty": {
            "paid": 0,
            "dues_as_on_date": 0,
            "net_amount": 0
         },
         "Total": {
            "paid": 0,
            "dues_as_on_date": 0,
            "net_amount": 0
         }
      },
      "payable_charges": {
         "Processing Fees (Payable to customer)": {
            "paid": 0,
            "dues_as_on_date": 0,
            "net_amount": 0
         },
         "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
}


N/A - Yes

 

Response:

Success: 200 OK
Schema
Attribute
TypeDescriptionMandatory
response
Boolean

data


Object
number_of_installments


Object
paid

Integer

dues_as_on_date

Double

net_amount

Double

installment_amount


Object
paid

Double

dues_as_on_date

Double

net_amount

Double

receivable_charges


Object


<Charge_Name>
Object
paid
Double

dues_as_on_date
Double

net_amount
Double

Total

Object
paid
Double

dues_as_on_date
Double

net_amount
Double

payable_charges


Object


<Charge_Name>
Object
paid
Double

dues_as_on_date
Double

net_amount
Double

Total

Object
paid
Double

dues_as_on_date
Double

net_amount
Double

branch_hierarcy




errorStringInternal error object for the given inputsNo
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

TypeDescriptionMandatory
response
StringInternal status code that denotes the status of requestYes
data
ObjectResponse Object for the given inputsNo
errorObject DataObjectInternal error object for the given inputsYes

codeintegerInternal error code for APIYes
textStringError message for the APINo
detailStringReason / Detail for the cause of errorNo
Body
Expected messages as per Status API :
Error CodeDescription
107001An 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