Foreclosure Data

PURPOSE

This method allows the partner to check the status of the loan of the prospect and requirements of financials for foreclosure of the loan. It lists out all dues and charges of the account, required to be paid in order to close the loan.

Request URL

https://apisandbox.iifl.in/fintech/GetForeclosusredata

Request Method: POST

Request format: JSON

Request Header

Content-Type: application/json

Ocp-Apim-Subscription-Key: provided by IIFL

Request Response(200) Response(Failure)

REQUEST BODY

HEADER

Field Name Description Data Type
(max length)		 Mandatory Sample Value
requestCode Request Code of the API called Varchar Yes FCREQ01
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) - PLRQCL01
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
ProspectNumber Prospect Number Varchar(10) SL12345678
CustomerName Name of the customer Varchar(20) dummy_customer
SchemeName Name of the scheme of loan Varchar(15) XXX-BAU
OutstandingPrincipal Principal Outstanding on the loan Double 0.0
DelinquentPrincipal Unpaid principal Double 0.0
DelinquentInterest Unpaid interest Double 0.0
ChequeDefaultCharges Charges related to default of cheque Double 595.00
Penalty Penalty imposed on non-compliance to terms Double 0.0
ExcessAmount Excess amount paid by the client Double 0.0
BPI   Double 0.0
PrePayCharges Charges related to pre-payment of loan Double 0.0
PrePayPenaltyGSTValue GST on penalty value Double 0.0
TotalDues Total due after taking everything into account Double 595.00
PerDayInterest Per day interest  Double 0.0
PerDayPenalInterest Per day interest due to penalty Double 0.0

REQUEST:

{
  "head": {
    "requestCode": "FCREQ01",
    "key": "xxxxxx",
    "appVer": "1.0",
    "osName": "WebAPI",
    "appName": "ALLIANCE",
    "source": "xxxxx"
  },
  "body": {
    "ProspectNo": "SL1922xxx"
  }
}

Response (Success)

{
  "head": {
    "response_code": "FCRESP01",
    "source": "PartnerNameBYj",
    "status": "0",
    "status_description": "Success",
    "success_user_status": "0"
  },
  "body": {
    "ProspectNumber": "SL192xxxx",
    "CustomerName": "dummy_customer",
    "SchemeName": "XXX- BAU",
    "OutstandingPrincipal": "0.00",
    "DelinquentPrincipal": "0.00",
    "DelinquentInterest": "0.00",
    "ChequeDefaultCharges": "595",
    "Penalty": "0.00",
    "ExcessAmount": "0.00",
    "BPI": "0.00",
    "PrePayCharges": "0.00",
    "PrePayPenaltyGSTValue": "0.00",
    "TotalDues": "595.00",
    "PerDayInterest": "0.00",
    "PerDayPenalInterest": "0.00"
  }
}

Response (Failure)

{
  "head": {
    "response_code": "FCRESP01",
    "source": "XXXX",
    "status": "1",
    "status_description": "No data found",
    "success_user_status": "1"
  },
  "body": {
    "Data": null
  }
}