Disputes

Download an evidence file by ID

Download an evidence file from a given ID.

get/dispute/disputes/{disputeId}/evidences/{evidenceId}

Request

Base URL
https://api.staging.payrails.io
Auth
HTTP bearer
TypeScript
https://skmtc.dev/payrails/apis/payrails-api-reference/docs/dispute/disputes/:disputeId/evidences/:evidenceId/get.ts
A function with typed inputs. Its response is checked against the schema.

disputeIdstring uuid required

Identifier of the resource in Payrails.

evidenceIdstring uuid required

Identifier of the resource in Payrails.

Evidence found, and all details are included.

idstring uuid required

Unique identifier of the Dispute in Payrails.

createdAtstring date-time required

Date and time when the Dispute was created in Payrails.

updatedAtstring date-time required

Date and time when the Dispute was last updated in Payrails.

displayTitlestring

Display title of the evidence, usually the file name.

status'Active' | 'Inactive' | 'Unknown'

Status of the dispute evidence.

provenance'Merchant' | 'Payrails' | 'Unknown'

Provenance of the dispute evidence.

contentTypestring

MIME type of the evidence content.

contentLengthinteger

Size of the evidence content in bytes.

payloadobject

Inline JSON payload for inline-context evidences. Present only for evidences created from inlineContexts; omitted for file-backed evidence.

workspaceIdstring uuid

Workspace ID that the Dispute belongs to.

labelsstring[]

Labels assigned to this evidence for the dispute, used to categorise the document during representment.

No recorded changes to this operation across all 1 revision of this API.