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

Trigger Repayment Response

This API is invoked by the lender to the LSP giving the lender payment page url from where the borrower can make the payment. Lender also generates an ID for the payment which becomes the reference for LSP to check the status of repayment.

Response Parameters for the Trigger Repayment Resonse 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 parameter:  requestId  (UUID for the previous API request) and a payment object, which provides new payment details, such as status indication, payment URL, and a new ID for 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)
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:  {...,{...}}*ObjectUpdated payment details
  Parameters for the payment object:
      (click to open)
id*StringNew unique reference ID (UUID) of the payment (originally generated by LSP, but updated 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
status*StringStatus 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
paymentUrl*StringURL of the payment page
txnRefNoStringReceipt number of the transactions
extensibleDataJSONFor any new data that needs to be added
* = Required
Note: This request should also include the  loanId parameter, which is a reference for the loan whose repayment was to be triggered.
Language
Click Try It! to start a request and see the response here!