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

Set Repayment Plan Request

This API is invoked by the LSP to inform the lender system about the details of the repayment plan that will be used by the borrower. The LSP will need to send either the LoanId or the LoanApplicationId as the case might be.

Response Parameters for the Set Repayment Plan 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 must include either  loanId  or loanApplicationId, depending on whether the loan has been granted. An object for plan is also sent, which includes a repayment plan ID and other optional information.       (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 Set Repayment Plan Request (UUID used to tie request and response and for idempotency)
loanApplicationId*StringUnique reference ID (UUID) for the loan application already created by LSP in previous APIs. To be passed only when this API is called before the grant loan request.
loanId*StringUnique reference ID (UUID) of loan whose repayment plan is being set (generated by lender) To be passed only if this API is called after the Grant Loan API request.
plan:  {...,{...},...}*ObjectRepayment plan chosen by the borrower for the loan
  Parameters for the plan object:
      (click to open)
id*StringUnique reference ID (UUID) of the repayment plan selected by the borrower for the specified loan (generated by lender)
titleStringTitle of the repayment plan
shortDescriptionStringShort description for the repayment plan
descriptionStringDetailed description of the payment plan
paymentUrlStringURL of the payment page provided by the lender to show repayment details
automaticBooleanFlag indicating whether payment is automatic or user initiated
payNowAllowedBooleanFlag indicates if the borrower can make an immediate payment with this repayment plan
editPlanAllowedBooleanThis flag indicates if the configurations of the current repayment plan can be changed by the borrower
changeMethodAllowedBooleanThis field indicates if the borrower can choose a different payment method for the plan
scheduleTypeStringType of schedule - can be ONE_TIME, AS_PRESENTED or RECURRING
frequencyStringIn case of a recurring payment, this field indicates how often the payment is disbursed
noOfInstallmentsStringNumber of installments for the chosen repayment plan. Will be 1 for ONE_TIME schedule type
tenure:wwwwwinww
   {duration, unit}
Object
Strings
Tenure associated with the repayment plan. This value will be less than or equal to the tenure in loan terms.
Tenure details:
duration
String
  Duration of the loan amount.
unit
String
  Time units
  (DAY, MONTH, etc.)
principalStringPrincipal - up tp to 2 digits precision
interestAmountStringInterest component for the duration specified in plan - up to 2 digits precision
penaltyStringPenalty component for the duration specified in loan - up to 2 digits precision
startDateStringThe first date on which the borrower chooses to make payment/wishes to get the disbursement credited.
statusStringFlag indicating if the plan is active or inactive
totalAmountStringTotal amount of loan
* = Required
* = Conditional
Language
Click Try It! to start a request and see the response here!