v1

latestOpenAPI 3.1.02026-07-131991131.4 KB
Disputes

Provide evidence for a dispute

Provide evidence (text and/or attachments) for a dispute. Used by the merchant to submit proof in response to an evidence request.

post/api/v1/disputes/{disputeId}/provide-evidence

Path parameters

dispute_idstring uuid required
Example:dispute id, uuid format

ID of the dispute.

Request body

contentstring required

Text content of the evidence being provided.

attachment_idsstring[]

Array of attachment IDs to include as evidence. IDs can be received via upload attachment endpoint.

Example request

{
  "content": "I am providing a photo of the damaged product that was received",
  "attachment_ids": [
    "attachment id, uuid format"
  ]
}

Response

Success. Evidence was submitted for the dispute.

idstring uuid required

Evidence ID.

dispute_idstring uuid required

Dispute ID.

contentstring required

Evidence content.

created_bystring required

Who created the evidence.

created_atstring date-time required

Creation timestamp in UTC, ISO 8601 datetime format.

attachment_idsstring[]

Array of attachment IDs.

Example response

{
  "id": "evidence id, uuid format",
  "dispute_id": "dispute id, uuid format",
  "content": "I am providing a photo of the damaged product that was received",
  "created_by": "merchant",
  "created_at": "2024-01-15T10:30:00Z",
  "attachment_ids": [
    "attachment id, uuid format"
  ]
}