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

Loan Statement Response

This method is called by the Lender to return the loan account statement back to the LSP

Response Parameters for the Loan Statement Response 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 includes an array for accountStatement, where each object in the array contains details of a transaction within a specified time period (if any).       (click to open tables)
ParameterTypeDescription
metadata:wwtwwww
   {param1, param2,...}
*Object
Strings
Metadata specific to each API response
  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
response: {error}ObjectObject contains one parameter, "error:", which indicates if any errors were found in the current request received. If none are found, error = 0.
requestIdwwwwtwww*StringUnique reference ID for the Loan Statement Request (UUID used to tie request and response and for idempotency)
loanId*StringUnique reference ID (UUID) of the loan for which a statement is being requested (generated by lender)
accountStatement:
      [{...},{...},...]
*Array of
objects
Details of each transaction carried out on the Loan Account within the specified time period. If no time period is specified, the entire account statement is returned
  Parameters for each object in the accountStatement array:
      (click to open)
datetStringDate when the transaction was carried out
Format: "dd-mm-yyyy"
narrationStringNarration as it appears in the bank statement
txnRefNoStringReference number for the transaction
amountStringTransaction Amount - up to 2 digits precision
typeStringDEPOSIT for repayment transactions and WITHDRAWAL for disbursement transactions
closingBalancewwwStringClosing balance in the account after the transaction
urlStringFor any new data that needs to be passed as a link
extensibleDataJSONFor any new data that needs to be added
* = Required
Language
Authentication
Basic
base64
:
Click Try It! to start a request and see the response here!