Bucket Report

PURPOSE

This method allows the partner to check the status of the financials of the loan of the prospect and is easy to use with inputs about the prospect number of the client. On successful execution, the API returns the financial data of the loan along with all information pertaining to the edge cases of non-payment and other charges as accrued on the loan account.

Request URL

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

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 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 Bucket report for the prospect Array Data Array (if success) Null (if failure)

Data

Field Name Type Description Values
CuId Varchar Customer ID of the prospect 12345678
Customer Name Varchar Name of the customer Mrs ABC SINGH
Product Name Varchar Type of Loan Supply Chain
Supply Chain Varchar Code of the scheme 14253
Scheme Name Varchar Name of the scheme dummy EMI
Subscheme Varchar Code of the sub-scheme 62
Location Varchar Location of the loan MUMBAI
CaseLocation Varchar Location of the branch ANDHERI
AppliedLoanAmount Double Loan Amount applied 50000
FinalApprovedAmount Double Loan Amount Approved 45000
FirstDisbursalDate Varchar Date of disbursal 17 Jan, 2021
EMI Double EMI that has to be paid 1425
PreEMI Double Broken interest till next cycle date 0
Cycle Int Number of payments 3
AuthorizationDate Varchar Date of Authorization of Loan 14 Jan, 2021
FirstEMIDate Varchar Date of first EMI 1 Mar, 2021
PrincipalOutstanding Double Outstanding Principal 4500
ActualPOS Double Actual Principal Outstanding 4500
ReceivedFund Double Funds received from client 0
BucketAmount Double Total Due Amount 0
BCCAmount Double Bounce Charge (if EMI is bounced) 0
PenalDueAmount Double Penal interest due after failure to pay bounce charges 0
DPD Int Days passed due last payment 0
BPIAmount Int Broken Period Interest (for daily accrual) 0
TypeOfClosure Varchar Closure Type Foreclosure, Normal, Settlement, Write-off, Death
ClosureReason Varchar Reason for Closure Cash
ClosureRemarks Varchar Reason for Closure Free text
ExcessFund Double Excess fund disbursed 0

REQUEST:

{
  "head": {
    "requestCode": "FTRQBD01",
    "key": "abcdefghi12345678jklmno",
    "appVer": "1.0",
    "osName": "WebAPI",
    "appName": "ALLIANCE",
    "source": "PartnerName"
  },
  "body": {
    "ProspectNo": "SL1066351"
  }
}

Response (Success)

{
    "head": {
    "response_code": "FTRSBD01",
    "source": "PartnerName",
    "status": "0",
    "status_description": "success",
    "success_user_status": "0"
       },
    "body":  {
        "Data": [ {        
    "ProspectNumber" : "SL1000000" ,
    "CuId" : "1010101" ,
    "CustomerName" : "Miss. Dummy" ,
    "ProductName" : "Supply Chain" ,
    "SchemeCode" : "85033" ,
    "SchemeName" : "dummy EMI" ,
    "SubScheme" : "" ,
    "Location" : "MUMBAI" ,
    "CaseLocation" : "" ,
    "AppliedLoanAmount" : "200000.0000" ,
    "FinalApprovedAmount" : "200000.0000" ,
    "FirstDisbursalDate" : "01 Jan 2000" ,
    "EMI" : "14658.0000" ,
    "PreEMI" : "0.0000" ,
    "Cycle" : "3" ,
    "AuthorizationDate" : "01 Jan 2000" ,
    "FirstEMIDate" : "01 Mar 2000" ,
    "PrincipalOutstanding" : "200000.0000" ,
    "ActualPOS" : "200000.0000" ,
    "ReceivedFund" : "0.0000" ,
    "ExcessFund" : "0.0000" ,
    "BucketAmount" : "0.0000" ,
    "BCCAmount" : "0.0000" ,
    "PenalDueAmount" : "0.0000" ,
    "DPD" : "0" ,
    "BPIAmount" : "" ,
    "TypeOfClosure" : "" ,
    "ClosureReason" : "" ,
    "ClosureRemarks" : ""
            }   ]      
    }

Response (Failure)

{
  "head": {
    "response_code": "FTRSRS01",
    "source": "PartnerName",
    "status": "0",
    "status_description": "success",
    "success_user_status": "0"
  },
  "body": {
    "ProspectNo": "SL1066351",
    "Data": null
  }
}