dispute.md

Dispute

Represents a dispute a cardholder initiated with their bank.

Structure

Dispute

Fields

Name	Type	Tags	Description
DisputeId	string	Optional	Unique ID for this Dispute, generated by Square.
AmountMoney	Models.Money	Optional	Represents an amount of money. Money fields can be signed or unsigned. Fields that do not explicitly define whether they are signed or unsigned are considered unsigned and can only hold positive amounts. For signed fields, the sign of the value indicates the purpose of the money transfer. See Working with Monetary Amounts for more information.
Reason	string	Optional	List of possible reasons why a cardholder might initiate a dispute with their bank.
State	string	Optional	List of possible dispute states.
DueAt	string	Optional	The time when the next action is due, in RFC 3339 format.
DisputedPayment	Models.DisputedPayment	Optional	The payment the cardholder disputed.
EvidenceIds	IList<string>	Optional	The IDs of the evidence associated with the dispute.
CardBrand	string	Optional	Indicates a card's brand, such as VISA or MASTERCARD.
CreatedAt	string	Optional	Timestamp when the dispute was created, in RFC 3339 format.
UpdatedAt	string	Optional	Timestamp when dispute was last updated, in RFC 3339 format.
BrandDisputeId	string	Optional	ID of the dispute in the card brand system, generated by the card brand.
ReportedDate	string	Optional	Timestamp when the dispute was reported, in RFC 3339 format.
Version	int?	Optional	The current version of the Dispute.
LocationId	string	Optional	The ID of location where dispute originated.

Example (as JSON)

{
  "dispute_id": null,
  "amount_money": null,
  "reason": null,
  "state": null,
  "due_at": null,
  "disputed_payment": null,
  "evidence_ids": null,
  "card_brand": null,
  "created_at": null,
  "updated_at": null,
  "brand_dispute_id": null,
  "reported_date": null,
  "version": null,
  "location_id": null
}