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

You are viewing an old version of the API
List disputes BETA

GET /v2/disputes

Returns a list of disputes associated with a particular account.

Name Description
cursor
string

A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. For more information, see Paginating.

states
string

The dispute states to filter the result. If not specified, the endpoint returns all open disputes (dispute status is not INQUIRY_CLOSED, WON, or LOST).

location_id
string

The ID of the location for which to return a list of disputes. If not specified, the endpoint returns all open disputes (dispute status is not INQUIRY_CLOSED, WON, or LOST) associated with all locations.

Response Fields

Name Description
errors
Error [ ]

Information on errors encountered during the request.

disputes
Dispute [ ]

The list of Disputes.

cursor
string

The pagination cursor to be used in a subsequent request. If unset, this is the final response. For more information, see Paginating.

Examples

You are viewing an old version of the API
GET /v2/disputes
cURL
  • cURL
  • Ruby
  • Python
  • C#
  • Java
  • PHP
  • Node.js
curl https://connect.squareup.com/v2/disputes \
  -H 'Square-Version: 2020-11-18' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json'
Response JSON
{
  "disputes": [
    {
      "dispute_id": "OnY1AZwhSi775rbNIK4gv",
      "amount_money": {
        "amount": 1000,
        "currency": "USD"
      },
      "reason": "NO_KNOWLEDGE",
      "state": "EVIDENCE_REQUIRED",
      "due_at": "2018-10-11T00:00:00.000Z",
      "disputed_payments": [
        {
          "payment_id": "APgIq6RX2jM6DKDhMHiC6QEkuaB"
        }
      ],
      "card_brand": "visa",
      "created_at": "2018-10-12T02:20:25.577Z",
      "updated_at": "2018-10-12T02:20:25.577Z",
      "brand_dispute_id": "100000809947"
    }
  ],
  "cursor": "G1aSTRm48CLjJsg6Sg3hQN1b1OMaoVuG"
}

Share Feedback

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