Closure Request
PURPOSE
This method will help partner convey that the prospect has been foreclosed successfully. The partner needs to send one of the following reasons along with the foreclosure request on behalf of the client.
Request Method: POST
Request format: JSON
Request Header
Content-Type: application/json
Ocp-Apim-Subscription-Key: provided by IIFL
ClosureReasons |
---|
Sale Of Collateral |
Service Issue |
FCRB |
RBO |
Curing/RBO |
RE-AGE |
Fully Matured |
Top UP |
Own Sources |
Buy Out / Balance Transfer |
Buy Out |
Free Lookup Closure |
Normal Foreclosure |
Request Withdrawn |
Risk Closure |
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 |
ClosureReason | Reason for closure | Varchar (20) | Yes | Service Issue |
ClosureRemarks | Remarks to be provided along with closure | Varchar(500) | Yes | |
ApproverId | PartnerID who has approved foreclosure | Varchar(10) | Yes | 1478523 |
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) | - | FCREQ01 |
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 |
---|---|---|---|
status | Status of the response | Varchar(1) | 0 - Success 1 - Fail |
Message | Message to be displayed along with the status | Varchar(500) | Closure Request Processed successfully |
REQUEST:
{
"head": {
"requestCode": "FCREQ01",
"key": "f12cd83f550241a1180ce6757f779468",
"appVer": "1.0",
"osName": "WebAPI",
"appName": "ALLIANCE",
"source": "PartnerName"
},
"body": {
"ProspectNo": "SLxxxxxx",
"ClosureReason": "TEST",
"ClosureRemarks": "testok",
"ApproverId": "BJ_1924119"
}
}
Response (Success)
{
"head": {
"response_code": "FCRESP01",
"source": "PartnerName",
"status": "0",
"status_description": "Success",
"success_user_status": "0"
},
"body": {
"Message": "Closure Request Processed successfully.",
"Status": "0"
}
}
Response (Failure)
{
"head": {
"response_code": "FCRESP01",
"source": "PartnerName",
"status": "0",
"status_description": "Success",
"success_user_status": "0"
},
"body": {
"Message": "Invalid closure reason,Kindly use closure reason master",
"Status": "1"
}
}