post https://api.juspay.in/v3/disbursement/setDisbursementPlanResponse
This API is invoked by the lender to inform the LSP about the current status of the chosen Disbursement Plan
Response Parameters for the Set Disbursement Plan Response 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 contains the parameter: requestId (UUID for the set plan request), and an object for plan, which contains details on the disbursement plan to be set. (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 Disbursement Plan Request (UUID used to tie request and response and for idempotency) |
| plan: {...,{...},...} | * | Object | Details of the disbursement plan to be set by the borrower for the specified loan. |
Parameters for the plan object:
(click to open)
| id | * | String | Unique reference ID (UUID) of the disbursement plan to be set by the borrower for the specified loan (UUID generated by lender) |
| title | String | Title of the disbursement plan | |
| shortDescription | String | Short description for the disbursement plan | |
| description | String | Detailed description of the disbursement plan | |
| url | String | URL of the payment page provided by the lender to show disbursement plans | |
| automatic | Boolean | Flag indicating whether disbursement is automatic or user initiated | |
| payNowAllowed | Boolean | Flag indicates if the lender can make an immediate payment with this disbursement plan | |
| editPlanAllowed | Boolean | This flag indicates if the configurations of the current disbursement plan can be changed by the borrower | |
| changeMethodAllowed | Boolean | This field indicates if the borrower can choose a different disbursement 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 disbursement plan. Will be 1 for ONE_TIME schedule type | |
| tenure:wwwwwinww {duration, unit} | Object Strings | Tenure associated with the disbursement 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 (balance yet to be paid) - up 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 |
* = RequiredNote: This request should also include either the "loanId" or the "loanApplicationId" parameter, which was the reference ID in the previous request for the loan whose disbursement plan is to be set.