Disputes
Query the disputes associated with a Square account.
Table Specific Information
Select
The add-in uses the Square API to filter the results by the following columns and operators while the rest of the filter is executed client-side within the add-in.
- Id supports the following operator: =.
- LocationId supports the following operator: =.
- State supports the following operator: =.
Retrieve all disputes:
SELECT * FROM Disputes
Retrieve a specific dispute:
SELECT * FROM Disputes WHERE Id = 'dispute_id_here'
Retrieve disputes requiring evidence:
SELECT * FROM Disputes WHERE State = 'EVIDENCE_REQUIRED'
Retrieve disputes for a specific location:
SELECT * FROM Disputes WHERE LocationId = '92BYHNBR6W77E'
Columns
| Name | Type | Description |
| Id [KEY] | String | The unique ID for this Dispute, generated by Square. |
| LocationId | String | The ID of the location where the dispute originated. |
| State | String | The current state of this dispute.
The allowed values are INQUIRY_EVIDENCE_REQUIRED, INQUIRY_PROCESSING, INQUIRY_CLOSED, EVIDENCE_REQUIRED, PROCESSING, WON, LOST, ACCEPTED. |
| Reason | String | The reason why the cardholder initiated the dispute.
The allowed values are AMOUNT_DIFFERS, CANCELLED, DUPLICATE, NO_KNOWLEDGE, NOT_AS_DESCRIBED, NOT_RECEIVED, PAID_BY_OTHER_MEANS, CUSTOMER_REQUESTS_CREDIT, EMV_LIABILITY_SHIFT. |
| DisputedPaymentPaymentId | String | Square-generated unique ID of the payment being disputed. |
| AmountDisputedMoneyAmount | Int64 | The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents. Monetary amounts can be positive or negative. |
| AmountDisputedMoneyCurrency | String | The type of currency, in ISO 4217 format. For example, the currency code for US dollars is USD. |
| CardBrand | String | The card brand used in the disputed payment.
The allowed values are OTHER_BRAND, VISA, MASTERCARD, AMERICAN_EXPRESS, DISCOVER, DISCOVER_DINERS, JCB, CHINA_UNIONPAY, SQUARE_GIFT_CARD, SQUARE_CAPITAL_CARD, INTERAC, EFTPOS, FELICA, EBT. |
| DueAt | Datetime | The deadline by which the seller must respond to the dispute, in RFC 3339 format. |
| ReportedAt | Datetime | The timestamp when the dispute was reported, in RFC 3339 format. |
| BrandDisputeId | String | The ID of the dispute in the card brand system, generated by the card brand. |
| Version | Integer | The current version of the Dispute. |
| CreatedAt | Datetime | The timestamp when the dispute was created, in RFC 3339 format. |
| UpdatedAt | Datetime | The timestamp when the dispute was last updated, in RFC 3339 format. |