You are viewing an old version of the API
Retrieve dispute

Beta

Returns details of a specific dispute.

Required permissions PAYMENTS_READ

Path Parameters

Name Description
dispute_id
string

Required

The ID of the dispute you want more details about.

Response Fields

Name Description
errors
Error [ ]

Information on errors encountered during the request.

dispute
Dispute

Details about the requested Dispute.

Examples

You are viewing an old version of the API
GET /v2/disputes/{dispute_id}
cURL
  • cURL
  • Ruby
  • Python
  • C#
  • Java
curl https://connect.squareup.com/v2/disputes/{dispute_id} \
  -H 'Square-Version: 2020-03-25' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json'
Response JSON
{
  "dispute": {
    "dispute_id": "XDgyFu7yo1E2S5lQGGpYn",
    "amount_money": {
      "amount": 2000,
      "currency": "USD"
    },
    "reason": "NO_KNOWLEDGE",
    "state": "LOST",
    "due_at": "2018-11-01T00:00:00.000Z",
    "disputed_payments": [
      {
        "payment_id": "6Ee10wvqhfipStz297mtUhBXvaB"
      }
    ],
    "card_brand": "visa",
    "created_at": "2018-10-18T15:59:13.613Z",
    "updated_at": "2018-10-18T15:59:13.613Z",
    "brand_dispute_id": "100000282394"
  }
}

Share Feedback

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