post https://api.juspay.in/v3/loan/dispute/raiseDisputeRequest
This API is invoked by the LSP to create a dispute in the lender system for an issue that is faced by the borrower.
Response Parameters for the Raise Dispute Request API: w 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 parameters: requestId (UUID for the API request) and loanId (UUID for the loan for which a dispute is to be raised). A dispute object is included to provide details of the loan issue raised by the borrower. (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 Raise Dispute Request (UUID used to tie request and response and for idempotency). |
| loanId | * | String | Unique reference ID (UUID) of the loan for which a dispute has been raised by the borrower (UUID generated by lender). |
| dispute: {param1, param2,...} | * | Object | Details of the loan issue faced by the borrower. |
Parameters for the dispute object:
(click to open)
| id | * | String | Unique reference ID (UUID) of the dispute (generated by lender). |
| description | String | A short description of the loan issue faced by the borrower. | |
| url | String | URL of a payment page provided by the lender to show dispute details. | |
| status | String | Current status of the dispute. | |
| lenderId | String | Unique reference ID (UUID) of the lender (generated by lender). | |
| extensibleDatawwww | JSON | For any new data that needs to be added. |
* = Required