Get Dispute by ID

get

https://api.staging.payrails.io/dispute/disputes/{disputeId}

Retrieve a dispute by its ID. Use the include parameters to expand related objects such as payment details, evidence files, and representment sections in a single request.

Path Params

disputeId

uuid

required

Identifier of the resource in Payrails.

Query Params

includePayment

boolean

Defaults to false

Boolean indicating if the payment should be included in the response.

includeInstrument

boolean

Defaults to false

Boolean indicating if the instrument should be included in the response.

includeHolderReference

boolean

Defaults to false

Boolean indicating if the holder reference should be included in the response.

includeUserEmail

boolean

Defaults to false

Boolean indicating if the assigned user email and username should be included in the response.

includeEvidences

boolean

Defaults to false

Boolean indicating if evidences should be included in the response.

includeRepresentmentPlan

boolean

Defaults to false

Boolean indicating if representment plan entities should be included in the response.

includeRepresentmentSections

boolean

Defaults to false

Boolean indicating if representment sections should be included in the response.

includeEvidenceClassifications

boolean

Defaults to false

Boolean indicating if AI evidence classifications should be included in the response.

Responses

Language

Credentials

Bearer

JWT

Loading…

Response

Choose an example:

application/json

200Dispute found, and all details are included.

400Bad Request.

401Unauthorized.

403Insufficient Scope.

404Not Found.

429Too Many Requests.