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

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

POST /v2/disputes/{dispute_id}/evidence_text

Uploads text to use as evidence for a dispute challenge.


Permissions
PAYMENTS_WRITE
Guide
Challenge a dispute
Try in API Explorer
Name Description
dispute_id
string

Required

The ID of the dispute you want to upload evidence for.

Name Description
idempotency_key
string

Required

Unique ID. For more information, see Idempotency.

Max Length 45 Min Length 1
evidence_type
string

The type of evidence you are uploading.

evidence_text
string

Required

The evidence string.

Max Length 500 Min Length 1

Response Fields

Name Description
errors
Error [ ]

Any errors that occurred during the request.

evidence
DisputeEvidence

The newly uploaded dispute evidence metadata.

Examples

You are viewing an old version of the API
POST /v2/disputes/{dispute_id}/evidence_text
cURL
  • cURL
  • Ruby
  • Python
  • C#
  • Java
  • PHP
  • Node.js
curl https://connect.squareup.com/v2/disputes/bVTprrwk0gygTLZ96VX1oB/evidence_text \
  -X POST \
  -H 'Square-Version: 2020-11-18' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "evidence_type": "TRACKING_NUMBER",
    "evidence_text": "1Z8888888888888888",
    "idempotency_key": "ed3ee3933d946f1514d505d173c82648"
  }'
Response JSON
{
  "evidence": {
    "evidence_id": "TOomLInj6iWmP3N8qfCXrB",
    "dispute_id": "bVTprrwk0gygTLZ96VX1oB",
    "evidence_text": "1Z8888888888888888",
    "uploaded_at": "2018-10-18T16:01:10.000Z"
  }
}

Share Feedback

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