Skip to content

Latest commit

 

History

History
51 lines (42 loc) · 3.56 KB

dispute.md

File metadata and controls

51 lines (42 loc) · 3.56 KB

Dispute

Represents a dispute a cardholder initiated with their bank.

Structure

Dispute

Fields

Name Type Tags Description
disputeId string | undefined Optional The unique ID for this Dispute, generated by Square.
Constraints: Minimum Length: 1, Maximum Length: 40
id string | undefined Optional The unique ID for this Dispute, generated by Square.
Constraints: Minimum Length: 1, Maximum Length: 40
amountMoney Money | undefined 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 | undefined Optional The list of possible reasons why a cardholder might initiate a
dispute with their bank.
state string | undefined Optional The list of possible dispute states.
dueAt string | undefined Optional The deadline by which the seller must respond to the dispute, in RFC 3339 format.
Constraints: Minimum Length: 1, Maximum Length: 40
disputedPayment DisputedPayment | undefined Optional The payment the cardholder disputed.
evidenceIds string[] | undefined Optional The IDs of the evidence associated with the dispute.
cardBrand string | undefined Optional Indicates a card's brand, such as VISA or MASTERCARD.
createdAt string | undefined Optional The timestamp when the dispute was created, in RFC 3339 format.
Constraints: Minimum Length: 1, Maximum Length: 40
updatedAt string | undefined Optional The timestamp when the dispute was last updated, in RFC 3339 format.
Constraints: Minimum Length: 1, Maximum Length: 40
brandDisputeId string | undefined Optional The ID of the dispute in the card brand system, generated by the card brand.
Constraints: Minimum Length: 1, Maximum Length: 40
reportedDate string | undefined Optional The timestamp when the dispute was reported, in RFC 3339 format.
Constraints: Minimum Length: 1, Maximum Length: 40
reportedAt string | undefined Optional The timestamp when the dispute was reported, in RFC 3339 format.
Constraints: Minimum Length: 1, Maximum Length: 40
version number | undefined Optional The current version of the Dispute.
locationId string | undefined Optional The ID of the location where the dispute originated.
Constraints: Minimum Length: 1, Maximum Length: 40

Example (as JSON)

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