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

Get Disbursement Plans Response

This API is invoked by the lender to inform the LSP about the list of disbursement plans available for the loan

Response Parameters for the Get Disbursement Plans Response API: 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 an array for  plans, which provides details of all disbursement plans available for the loan.       (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
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.
requestIdwwwwwtwww*StringUnique reference ID for the Get Disbursement Plans Request (UUID used to tie request and response and for idempotency)
plans:  [{...},{...},...]*Array of
objects
Each object contains details of a disbursement plan available for the specified loan.
  Parameters for each object in the plans array:
      (click to open)
id*StringUnique reference ID (UUID) of an available disbursement plan (UUID generated by lender),
titleStringTitle of the disbursement plan
shortDescriptionStringShort description for the disbursement plan
descriptionStringDetailed description of the disbursement plan
urlStringURL of the payment page provided by the lender to show disbursement plans
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 (balance of loan yet to be paid) - 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
Note: This request should include the loanId parameter, which is a reference for the loan whose disbursement plan details are being sent.
Language
Click Try It! to start a request and see the response here!