Sign in

v1

latestOpenAPI 3.1.02026-07-263644911022.4 KB
Exception

Upload an evidence file to a dispute

Streams an evidence file (pdf, png, jpeg, or csv) to tenant-scoped object storage and records the resulting object key on the dispute as a new evidence item. The comment arrives as a query parameter and the file bytes as the request body. The tenant is resolved from the JWT and the dispute from the path — never from the body. Fails closed (503) when object storage is not configured; rejects oversize bodies (413) and unsupported content types (415).

post/v1/disputes/{disputeId}/evidence/upload

Path parameters

disputeIdstring uuid required

Dispute ID (UUID)

Example:550e8400-e29b-41d4-a716-446655440001

Dispute ID (UUID)

Query parameters

commentstring

Comment describing the uploaded evidence

Example:Bank statement showing correct amount

Comment describing the uploaded evidence

Headers

Content-Typestring

Evidence media type: application/pdf, image/png, image/jpeg, or text/csv

Example:application/pdf

Evidence media type: application/pdf, image/png, image/jpeg, or text/csv

Response

Created

category'BANK_FEE_ERROR' | 'UNRECOGNIZED_CHARGE' | 'DUPLICATE_TRANSACTION' | 'OTHER'

Category of the dispute

createdAtstring

Creation timestamp in RFC3339 format

descriptionstring

Description of the dispute

exceptionIdstring

Exception ID this dispute is for

idstring

Unique identifier for the dispute

openedBystring

User who opened the dispute

reopenReasonstring

Reason for reopening if reopened

resolutionstring

Resolution description when closed

state'DRAFT' | 'OPEN' | 'PENDING_EVIDENCE' | 'WON' | 'LOST'

Current state

updatedAtstring

Last update timestamp in RFC3339 format

Example response

{
  "category": "BANK_FEE_ERROR",
  "createdAt": "2025-01-15T10:30:00.000Z",
  "description": "Transaction amount differs from expected",
  "evidence": [
    {
      "comment": "Bank statement attached",
      "disputeId": "019c96a0-10d2-7193-8841-0d7347efd09a",
      "fileUrl": "https://storage.example.com/evidence/doc123.pdf",
      "id": "019c96a0-0c0d-7915-84b9-e497bfee9916",
      "submittedAt": "2025-01-15T10:30:00.000Z",
      "submittedBy": "user@example.com"
    }
  ],
  "exceptionId": "019c96a0-10d2-7134-ba5f-664142ee7052",
  "id": "019c96a0-10d2-7193-8841-0d7347efd09a",
  "openedBy": "user@example.com",
  "reopenReason": "New evidence discovered",
  "resolution": "Counterparty confirmed error",
  "state": "OPEN",
  "updatedAt": "2025-01-15T10:30:00.000Z"
}