v1

latestOpenAPI 3.1.02026-07-2663312285.4 KB

Disputes

Internal

Upload File

Upload a file to a dispute as multipart/form-data when the UPLOAD_FILE capability is allowed.

The file part must contain raw binary data (for example PDF or image bytes). Base64-encoded file content is not supported, including when indicated via Content-Transfer-Encoding: base64. Omit Content-Transfer-Encoding or use binary.

Set an appropriate Content-Type on the file part, such as application/pdf or image/png.

post/v1/disputes/{disputeId}/files

Path parameters

disputeIdstring required

Dispute ID starting with 'dispute_' followed by 21 alpha-numeric characters.

Headers

Request-Referencestring

Optional Reference for the request. This is used to identify the request in debugging.

Request-Idempotency-Keystring

Optional Idempotency Key for the request. Sending duplicate requests will result in 409 HTTP status code.

Response

Successfully uploaded the file and linked to a dispute

idstring

The unique file identifier starting with file_.

namestring

Name of the file.

createdAtstring date-time

Date and time when the file was created.

phase'PRE_DISPUTE' | 'DISPUTE' | 'PRE_ARBITRATION' | 'ARBITRATION' required

Phase when the file was added.

sender'MERCHANT' | 'PROVIDER' required

Sender of the file.

status'PENDING' | 'FAILED' | 'AVAILABLE' | 'SYNCED_WITH_PROVIDER'

Status of the file.

_linksLinks

Example response

{
  "id": "file_17574868",
  "name": "some_policy_document.pdf",
  "createdAt": "2025-06-19T12:34:56.789Z",
  "_links": {
    "self": {
      "href": "/v1/disputes/dispute_20240619XYZabcdefghij/files/file_17574868"
    }
  }
}