Repayment Schedule
PURPOSE
This method allows the partner to check the repayment schedule of the loan and is easy to use with inputs about the prospect number of the client. On successful execution, the API returns the status along with EMI, Outstanding Principal, Interest, Principal, Loan Amount and Loan Status. However, if there is some discrepancy API returns null in place of the data.
Request URL
https://apisandbox.iifl.in/fintech/RepayScheduleRequest Method: POST
Request format: JSON
Request Header
Content-Type: application/json
Ocp-Apim-Subscription-Key: provided by IIFL
REQUEST BODY
HEADER
Field Name | Description | Data Type (max length) |
Mandatory | Sample Value |
---|---|---|---|---|
requestCode | Request Code of the API called | Varchar | Yes | PLRQCL01 |
appVer | Developer App Version | Varchar | Yes | 1.0 |
key | UserKey generated at the time of registration | Varchar | Yes | ABpyyGUh1nsbesSlup3VKURkI4tQDe8y |
osName | Channel of order | Varchar | Yes | WebAPI, Android, iOS |
appName | App Name provided at the time of registration | Varchar | Yes | ALLIANCE |
source | Source provided at the time of registration | Varchar | Yes | 321 |
BODY
Field Name | Description | Data Type (max length) |
Mandatory | Sample Value |
---|---|---|---|---|
ProspectNo | Prospect Number provided while prospect creation | Varchar (10) | Yes | 78946123 |
RESPONSE BODY
HEAD
Field Name | Description | Data Type (max length) |
List of Values | Sample Value |
---|---|---|---|---|
responseCode | This is the response code of API | Varchar(20) | - | FTRSRS01 |
status | This is the response code of API | Varchar(10) | 0 - Success 1 - Fail |
0 |
Source | This is the Partner’s name | Varchar(20) | - | Partner_Name |
statusDescription | Description of the response status | Varchar(50) | - | - |
success_user_status | Status of the user for a partner | Varchar(10) | 0 - Success 1 - Fail |
0 |
BODY
Field Name | Description | Data Type (max length) |
Sample Value |
---|---|---|---|
prospectno | Prospect Number | Varchar(10) | SL12345678 |
Data | List of Repayment Schedule | Array |
Data
Field Name | Description | Type | Values |
---|---|---|---|
SrNo. | Serial Number of the Repayment | Int | 1 |
Dt | Date of Payment (YYYYMMDD) | Int | 20210530 |
Loanamount | Loan Amount Remaining | Double | 195845.35 |
EMI | EMI amount | Int | 14253 |
Interest | Amount of interest paid from the EMI | Double | 7958.75 |
Principal | Amount of principal paid from the EMI | Double | 6294.25 |
Outstanding_Principal | Principal outstanding after adjusting EMI principal paymen | Double | 189551.10 |
Status | Status of the payment | Varchar | PEN - Pending DEP - Deposit CLR - Clear BNC - Bounce MOR - Moratorium CLS - Closed |
REQUEST:
{
"head": {
"requestCode": "FTRQRS01",
"key": "abcdefghi12345678jklmno",
"appVer": "1.0",
"osName": "WebAPI",
"appName": "ALLIANCE",
"source": "PartnerName"
},
"body": {
"ProspectNo": "SL1066351"
}
}
Response (Success)
{
"head": {
"response_code": "FTRSRS01",
"source": "PartnerName",
"status": "0",
"status_description": "success",
"success_user_status": "0"
},
"body": {
"ProspectNo": "SL1066351",
"Data": [
{
"SrNo": 1,
"Dt": "20180303",
"Loanamount": 200000,
"EMI": 14658,
"Interest": 2416.67,
"Principal": 12241.33,
"Outstanding_Principal": 187758.672,
"Status": "PEN"
},
{
"SrNo": 2,
"Dt": "20180403",
"Loanamount": 187758.672,
"EMI": 14658,
"Interest": 2268.75,
"Principal": 12389.25,
"Outstanding_Principal": 175369.422,
"Status": "PEN"
},
{
"SrNo": 3,
"Dt": "20180503",
"Loanamount": 175369.422,
"EMI": 14658,
"Interest": 2119.05,
"Principal": 12538.95,
"Outstanding_Principal": 162830.453,
"Status": "PEN"
}
]
}
}
Response (Failure)
{
"head": {
"response_code": "FTRSRS01",
"source": "PartnerName",
"status": "0",
"status_description": "success",
"success_user_status": "0"
},
"body": {
"ProspectNo": "SL1066351",
"Data": null
}
}