v1

latestOpenAPI 3.0.22026-08-061303782.1 MB

Disputes

Update Dispute Evidence

Update tags on Dispute Evidence.

put/disputes/{dispute_id}/evidence/{evidence_id}

Request body

tagsTags nullable

Include up to 50 key: value pairs to annotate requests with custom metadata.

Maximum character length for individual keys is 40.
Maximum character length for individual values is 500. (For example, order_number: 25, item_type: produce, department: sales)

Response

A single Dispute

idstring

The ID of the resource.

created_atstring date-time

Timestamp of when the object was created.

updated_atstring date-time

Timestamp of when the object was last updated.

applicationstring

ID of the Application the resource was created under.

disputestring

The ID of the Dispute associated with the evidence.

state'PENDING' | 'SUCCEEDED' | 'CANCELED' | 'FAILED'

The result after uploading evidence.

PENDING: The evidence file has not yet been submitted to the processor. No user action is required.
SUCCEEDED: The evidence file has been successfully sent to the processor. No further user action is required.
CANCELED: The evidence file upload was not completed due to user action.
FAILED: The evidence file could not be processed. Check failure_code for the specific reason and failure_message for a user-safe description of the issue.

failure_code'MALWARE_DETECTED' | 'GENERIC_FAILURE' | 'FILE_SIZE_LIMIT_EXCEEDED' | 'TOTAL_COMBINED_FILE_SIZE_LIMIT_EXCEEDED' | 'TOTAL_PAGE_COUNT_LIMIT_EXCEEDED' nullable

The reason the evidence file failed processing. Populated when state is FAILED; null otherwise.

MALWARE_DETECTED: The file was flagged for suspicious content and cannot be accepted.
GENERIC_FAILURE: An unexpected error occurred. Contact support for details.
FILE_SIZE_LIMIT_EXCEEDED: The file exceeds the maximum allowed file size.
TOTAL_COMBINED_FILE_SIZE_LIMIT_EXCEEDED: The total size of all uploaded evidence exceeds the maximum combined file size limit.
TOTAL_PAGE_COUNT_LIMIT_EXCEEDED: The total number of pages across all uploaded evidence exceeds the maximum allowed page count.

failure_messagestring nullable

A human-readable message explaining why the evidence file failed processing. Populated when state is FAILED; null otherwise. Safe to surface directly in a UI.

identitystring

The ID of the seller's Identity resource. This is the Identity resource that was used to create the seller's Merchant.

merchantstring

The ID of the seller's Merchant resource. This is the Merchant account the Dispute was filed against.

content_typestring

The MIME type of the uploaded evidence file (e.g. application/pdf, image/jpeg).

extensionstring

The file extension, a suffix at the end of a file_name (letters following last period).

file_namestring

The name of the uploaded evidence file.

tagsTags nullable

Include up to 50 key: value pairs to annotate requests with custom metadata.

Maximum character length for individual keys is 40.
Maximum character length for individual values is 500. (For example, order_number: 25, item_type: produce, department: sales)

Example response

{
  "identity": "IDpYDM7J9n57q849o9E9yNrG",
  "merchant": "MUucec6fHeaWo3VHYoSkUySM",
  "content_type": "application/pdf",
  "extension": "pdf",
  "file_name": "evidence.pdf"
}