• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”

You are viewing an old version of the API
Retrieve dispute evidence BETA

GET /v2/disputes/{dispute_id}/evidence/{evidence_id}

Returns the specific evidence metadata associated with a specific dispute.

You must maintain a copy of the evidence you upload if you want to reference it later. You cannot download the evidence after you upload it.


Permissions
PAYMENTS_READ
Try in API Explorer
Name Description
dispute_id
string

Required

The ID of the dispute that you want to retrieve evidence from.

evidence_id
string

Required

The ID of the evidence to retrieve.

Response Fields

Name Description
errors
Error [ ]

Any errors that occurred during the request.

evidence
DisputeEvidence

Metadata about the dispute evidence file.

Examples

You are viewing an old version of the API
GET /v2/disputes/{dispute_id}/evidence/{evidence_id}
cURL
  • cURL
  • Ruby
  • Python
  • C#
  • Java
  • PHP
  • Node.js
curl https://connect.squareup.com/v2/disputes/bVTprrwk0gygTLZ96VX1oB/evidence/TOomLInj6iWmP3N8qfCXrB \
  -H 'Square-Version: 2021-03-17' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json'
Response JSON
{
  "evidence": {
    "evidence_id": "TOomLInj6iWmP3N8qfCXrB",
    "dispute_id": "bVTprrwk0gygTLZ96VX1oB",
    "evidence_file": {
      "filename": "evidence.tiff",
      "filetype": "image/tiff"
    },
    "evidence_type": "GENERIC_EVIDENCE",
    "uploaded_at": "2018-10-18T16:01:10.000Z"
  }
}

Share Feedback

Thanks for visiting the Square API documentation. What's on your mind?