post https://api.juspay.in/v3/repayment/setRepaymentPlanStatusResponse
This API is used by lenders to inform LSP about the status of a previously initiated set Repayment. The API returns the status of the repayment plan that the borrower has chosen. In case the borrower has chosen e-mandate as the repayment method in payment page URL, the status of the repayment plan becomes ACTIVE only after successful authorization of the e-mandate on the PSP by the borrower.
Response Parameters for the Set Repayment Plan Status Response API: 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 contains the parameter: requestId (UUID for the previous API request), and an object for plan, which contains updated status parameters for the repayment plan. (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 |
| response: {error} | Object | Object contains one parameter, "error:", which indicates if any errors were found in the current request received. If none are found, error = 0. | |
| requestIdwwwwwtwww | * | String | Unique reference ID for the Set Repayment Plan Status Request (UUID used to tie request and response and for idempotency) |
| loanId | * | String | Unique reference ID (UUID) of loan whose repayment plan status has been requested by the LSP (UUID generated by lender) |
| plan: {...,{...},...} | * | Object | Updated details from the lender for the repayment plan that the borrower has chosen for the loan. |
Parameters for the plan object:
(click to open)
| id | * | String | Unique reference ID (UUID) of the repayment plan whose status update has been requested (UUID 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