List disputes BETA
Returns a list of disputes associated with a particular account.
Query Parameters
| Name | Description |
|---|---|
cursor
|
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
|
The dispute states to filter the result.
If not specified, the endpoint
returns all open disputes (dispute status is not
|
location_id
|
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 |
Response Fields
| Name | Description |
|---|---|
errors
|
Information on errors encountered during the request. |
disputes
|
The list of Disputes. |
cursor
|
The pagination cursor to be used in a subsequent request. If unset, this is the final response. For more information, see Paginating. |
Examples
- cURL
- Ruby
- Python
- C#
- Java
- PHP
curl https://connect.squareup.com/v2/disputes \
-H 'Square-Version: 2020-06-25' \
-H 'Authorization: Bearer ACCESS_TOKEN' \
-H 'Content-Type: application/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"
}