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

Confirm Repayment

This API is used by lenders to inform LSP about the status of a repayment handled directly by the lender (Triggered on Lender side - Payment on the branch or auto E-Mandate repayment)

Response Parameters for the Confirm Repayment API: w w w w w (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 request) and loanId  (UUID of the loan whose repayment status is to be sent to the LSP). A  payment object is also included, which provides the status report of the repayment.       (click to open tables)
ParameterTypeDescription
metadata:wwtwwwww
   {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
requestIdwwwwwtwww*StringUnique reference ID (UUID) for the Confirm Repayment API.
loanId*StringUnique reference ID (UUID) of the loan whose repayment status is to be sent to the LSP (generated by lender).
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.
payment:  {...,{...}}*ObjectIn cases where the repayment is handled directly by the lender, the triggering of updated payment details (current status) to LSP is initiated by the lender.
  Parameters for the payment object:
      (click to open)
id*StringUnique reference ID (UUID) of the payment (generated by lender)
descriptionStringA short description for the payment
dateDate-
time
Date and time (ISO representation) of the payment transaction. To be populated when the transaction is done.
principalStringPrincipal paid by the borrower for the current payment - 2 digits precision
interestAmountStringInterest amount paid by the borrower for the current payment - 2 digit precision
feeStringFees paid by the borrower for the current payment - 2 digits precision
penaltyStringPenalty paid by the borrower for the current payment - 2 digits precision
totalAmountStringTotal amount paid by borrower for the current payment - 2 digit precision
installmentNumberStringThe installment number for the current payment
statusStringStatus of the current payment transaction
useSavedPaymentOptionBooleantrue if using the Saved Payment Option
paymentMethodTypeStringPayment method used for the transaction. To be populated when payment is done
paymentUrlStringURL of the payment page
txnRefNoStringReceipt number of the transactions
extensibleDataJSONFor any new data that needs to be added
* = Required
Language
Click Try It! to start a request and see the response here!