Hey! These docs are for version 3.2, which is no longer officially supported. Click here for the latest version, 1.0!

Loan Summary Request

This API is invoked by the LSP to get the summary of the loan as of the current date.

Response Parameters for the Loan Summary Request API:               (click to view)
ParameterTypeDescription
ack:wwwwwwww
  {error, traceId, timestamp}
ObjectJSON object for acknowlegement
    Parameters for the ack object:
ParameterTypeDescription
errorStringErrors in the current request received. If no errors are found, error = 0.
traceIdStringIdentification for tracing
timestampTime-
stamp
YYYY-MM-DDThh:mm:ssZ+/-hh:mm
(eg 1997-07-16T19:20:30+05:30)
Z +/- hh:mm = time zone designator (Z) followed by time zone difference from GMT in hours and minutes. THIS IS OPTIONAL. If not provided, it is assumed to be IST (+5.30)
The request for this API contains the parameters:  requestId  (UUID for the API) and  loanId  (UUID of loan for which summary is requested)         (click to open tables)
ParameterTypeDescription
metadata:wwwwwwtnww
    {param1, param2,...}
*Object
Strings
Metadata specific to each API request
  Parameters for the metadata object:     click to open)
FieldTypeDescription
versionStringOCEN Version
timestampTime-
stamp
YYYY-MM-DDThh:mm:ssZ+/-hh:mm
(eg 1997-07-16T19:20:30+05:30)
Z +/- hh:mm = time zone designator (Z) followed by time zone difference from GMT in hours and minutes. THIS IS OPTIONAL. If not provided, it is assumed to be IST (+5.30)
traceIdStringIdentification for tracing
orgIdStringOrigin ID
requestId wwwwwwwnwwwwwww*StringUnique reference ID for the Loan Summary Request (UUID used to tie request and response and for idempotency)
loanId:*StringUnique reference ID (UUID) of the loan whose status is being enquired (generated by lender)
* = Required
Language
Click Try It! to start a request and see the response here!