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

Dispute Status Response / Webhook

This API is invoked by the lender to inform the LSP regarding the status of the dispute.

Response Parameters for the Dispute Status Response 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 parameter:  requestId  (UUID for the previous API request) and a dispute object, which provides updated details on the dispute, such as a status indication and a URL for progress updates.     (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
response: {error}ObjectObject contains one parameter, "error:", which indicates if any errors were found in the current request received. If none are found, error = 0.
requestIdwwwwwtwww*StringUnique reference ID for the Dispute Status Request (UUID used to tie request and response and for idempotency).
dispute:
   {param1, param2,...}
*ObjectUpdated details of the dispute issue raised 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 provided by the lender to show updates on dispute progress.
status*StringCurrent status of the dispute.
lenderIdStringUnique reference ID (UUID) of the lender.
extensibleDatawwwwJSONFor any new data that needs to be added.
* = Required
Language
Click Try It! to start a request and see the response here!