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

Trigger Repayment Request

This API is invoked by the LSP to inform the lender to trigger repayment.

Response Parameters for the Trigger Repayment Request API: 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 for the loan whose repayment is to be triggered). A payment object is optionally included to provide details of the payment.     (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 for the Trigger Repayment Request (UUID used to tie request and response and for idempotency)
loanId*StringUnique reference ID (UUID) of the loan whose repayment is to be triggered (UUID generated by lender).
payment:  {...,{...}}ObjectPayment details (optional)
  Parameters for the payment object:
      (click to open)
id*StringUnique reference ID (UUID) of the payment request (generated by LSP - new ID to be provided by lender)
descriptionStringA short description for the payment
dateDate-
time
Date and time (ISO representation) when the payment 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 (provided by lender)
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!