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

Raise Dispute Request

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)
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 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)
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
requestIdwwwwwtwww*StringUnique reference ID for the Raise Dispute Request (UUID used to tie request and response and for idempotency).
loanId*StringUnique reference ID (UUID) of the loan for which a dispute has been raised by the borrower (UUID generated by lender).
dispute:
   {param1, param2,...}
*ObjectDetails of the loan issue faced by the borrower.
  Parameters for the dispute object:
      (click to open)
id*StringUnique reference ID (UUID) of the dispute (generated by lender).
descriptionStringA short description of the loan issue faced by the borrower.
urlStringURL of a payment page provided by the lender to show dispute details.
statusStringCurrent status of the dispute.
lenderIdStringUnique reference ID (UUID) of the lender (generated by lender).
extensibleDatawwwwJSONFor any new data that needs to be added.
* = Required
Language
Click Try It! to start a request and see the response here!