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

Loan Summary Response

This method is called be the Lender as a response to Loan Summary Request.

Response Parameters for the Loan Summary 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 consists of status parameters, plus a Summary object, which contains objects for nextRepayment and currentRepayment.       (click to open tables)
ParameterTypeDescription
metadata:wwwwwwnww
    {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
response: {error}ObjectStatus of response. Object contains only one string parameter for "error". If no errors are found, error = "0". For example, if a mandatory attribute is missing, error code should capture that.
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)
loanStatus*StringIf loan is being processed:
loanStatus = "GENERATED"
After loan is processed:
loanStatus = GRANTED / REJECTED / DEFAULTED / COMPLETED / ACTION_REQUIRED
createdDateStringDate when loan was created
startDateStringDate from when loan is active
endDateStringEnd date till when loan is active
summary:   {.., {...}, {...}, ..}*ObjectSummarized details of the loan
   Parameters for the summary object:     (click to open)
nextRepayment:
    {param1, param2,...}
*Object
Strings
Details of next repaymentwww
  Parameters for the nextRepayment object:
      (click to open)
idStringUUID for the payment request (generated by LSP)
descriptionStringA short description of the payment
statusStringPreliminary status for next payment
totalAmountwwwwiiw*StringTotal amount to be paid by borrower for next installment - 2 digit precision
principalStringPrincipal amount to be paid by the borrower for the next payment - 2 digit precision
interestAmountStringInterest amount to be paid by the borrower for the next payment - 2 digit precision
penaltyStringPenalty to be paid by the borrower for the next payment - 2 digit precision
feeStringFees to be paid by the borrower by the borrower for the next payment - 2 digit precision
dateTime-
stamp
Date and time when the next payment transaction is complete (to be populated when payment is done)
installmentNumberStringThe installment number for the next payment
paymentMethodTypetStringPayment method used for the transaction (to be populated when payment is done)
paymentUrlStringURL for the payment page
txnRefNoStringReceipt number of the transactions (to be populated when payment is done)
extensibleDataJSONFor any new data that needs to be added
useSavedPaymentOptionBooleantrue if using the Saved Payment Option
currentRepayment:
    {param1, param2,...}
*Object
Strings
Details of current repaymentw
  Parameters for the currentRepayment object:
      (click to open)
idStringUUID for the payment request (generated by LSP)
descriptionStringA short description of the payment
statusStringStatus of the current payment transaction
totalAmount*StringTotal amount paid by the borrower for the current payment - 2 digit
principalStringPrincipal paid by the borrower for the current payment - 2 digit precision
interestAmountStringInterest amount paid by the borrower for the current payment - 2 digit precision
penaltyStringPenalty paid by the borrower for the current payment - 2 digit precision
feeStringFees paid by the borrower for the current payment - 2 digit precision
dateTime-
stamp
Date and time when the payment transaction is done
installmentNumberStringThe installment number for the current payment
paymentMethodTypenStringPayment method used for the transaction. To be populated when payment is done
paymentUrlStringURL for the payment page
txnRefNoStringReceipt number of the transactions
extensibleDataJSONFor any new data that needs to be added
useSavedPaymentOptionBooleantrue if using the Saved Payment Option
principalPaidwwwwwww*StringPrincipal paid to date
interestPaidStringInterest paid to date
penaltyPaidStringPenalty paid to date
principalPendingStringPrincipal pending
interestPendingStringInterest pending
amountDisbursedStringAmount disbursed to date
amountRepaidStringAmount repaid to date
tenure:
   {duration, unit}
Object
Strings
Tenure details:
duration
String
  Duration of the loan amount.
unit
String
  Time units
  (DAY, MONTH, etc.)
descriptionStringShort description of the loan
* = Required
Language
Click Try It! to start a request and see the response here!