post https://api.juspay.in/v3/repayment/setRepaymentPlanRequest
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)
| Parameter | Type | Description |
|---|---|---|
| ack:wwwwwwww {error, traceId, timestamp} | Object | JSON object for acknowlegement |
Parameters for the
ack object: | Parameter | Type | Description |
|---|---|---|
| error | String | Errors in the current request received. If no errors are found, error = 0. |
| traceId | String | Identification for tracing |
| timestamp | Time- 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)
| Parameter | Type | Description | |
|---|---|---|---|
| metadata:wwtwwwww {param1, param2,...} | * | Object Strings | Metadata specific to each API response |
Parameters for the metadata object: click to open)
| Field | Type | Description | |
|---|---|---|---|
| version | String | OCEN Version | |
| timestamp | Time- 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) | |
| traceId | String | Identification for tracing | |
| orgId | String | Origin ID |
| requestIdwwwwwtwww | * | String | Unique reference ID for the Set Repayment Plan Request (UUID used to tie request and response and for idempotency) |
| loanApplicationId | * | String | Unique 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 | * | String | Unique 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: {...,{...},...} | * | Object | Repayment plan chosen by the borrower for the loan |
Parameters for the plan object:
(click to open)
| id | * | String | Unique reference ID (UUID) of the repayment plan selected by the borrower for the specified loan (generated by lender) |
| title | String | Title of the repayment plan | |
| shortDescription | String | Short description for the repayment plan | |
| description | String | Detailed description of the payment plan | |
| paymentUrl | String | URL of the payment page provided by the lender to show repayment details | |
| automatic | Boolean | Flag indicating whether payment is automatic or user initiated | |
| payNowAllowed | Boolean | Flag indicates if the borrower can make an immediate payment with this repayment plan | |
| editPlanAllowed | Boolean | This flag indicates if the configurations of the current repayment plan can be changed by the borrower | |
| changeMethodAllowed | Boolean | This field indicates if the borrower can choose a different payment method for the plan | |
| scheduleType | String | Type of schedule - can be ONE_TIME, AS_PRESENTED or RECURRING | |
| frequency | String | In case of a recurring payment, this field indicates how often the payment is disbursed | |
| noOfInstallments | String | Number 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 unit String (DAY, MONTH, etc.) | |
| principal | String | Principal - up tp to 2 digits precision | |
| interestAmount | String | Interest component for the duration specified in plan - up to 2 digits precision | |
| penalty | String | Penalty component for the duration specified in loan - up to 2 digits precision | |
| startDate | String | The first date on which the borrower chooses to make payment/wishes to get the disbursement credited. | |
| status | String | Flag indicating if the plan is active or inactive | |
| totalAmount | String | Total amount of loan |
* = Required * = Conditional