Skip to content

Latest commit

 

History

History
45 lines (36 loc) · 3.67 KB

dispute.md

File metadata and controls

45 lines (36 loc) · 3.67 KB
Raw

Dispute

Represents a dispute a cardholder initiated with their bank.

Structure

Dispute

Fields

Name Type Tags Description Getter
DisputeId String Optional The unique ID for this Dispute, generated by Square.
Constraints: Minimum Length: 1, Maximum Length: 40		 String getDisputeId()
Id String Optional The unique ID for this Dispute, generated by Square.
Constraints: Minimum Length: 1, Maximum Length: 40		 String getId()
AmountMoney 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.		 Money getAmountMoney()
Reason String Optional The list of possible reasons why a cardholder might initiate a
dispute with their bank.		 String getReason()
State String Optional The list of possible dispute states. String getState()
DueAt String Optional The deadline by which the seller must respond to the dispute, in RFC 3339 format.
Constraints: Minimum Length: 1, Maximum Length: 40		 String getDueAt()
DisputedPayment DisputedPayment Optional The payment the cardholder disputed. DisputedPayment getDisputedPayment()
EvidenceIds List<String> Optional The IDs of the evidence associated with the dispute. List getEvidenceIds()
CardBrand String Optional Indicates a card's brand, such as VISA or MASTERCARD. String getCardBrand()
CreatedAt String Optional The timestamp when the dispute was created, in RFC 3339 format.
Constraints: Minimum Length: 1, Maximum Length: 40		 String getCreatedAt()
UpdatedAt String Optional The timestamp when the dispute was last updated, in RFC 3339 format.
Constraints: Minimum Length: 1, Maximum Length: 40		 String getUpdatedAt()
BrandDisputeId String Optional The ID of the dispute in the card brand system, generated by the card brand.
Constraints: Minimum Length: 1, Maximum Length: 40		 String getBrandDisputeId()
ReportedDate String Optional The timestamp when the dispute was reported, in RFC 3339 format.
Constraints: Minimum Length: 1, Maximum Length: 40		 String getReportedDate()
ReportedAt String Optional The timestamp when the dispute was reported, in RFC 3339 format.
Constraints: Minimum Length: 1, Maximum Length: 40		 String getReportedAt()
Version Integer Optional The current version of the Dispute. Integer getVersion()
LocationId String Optional The ID of the location where the dispute originated.
Constraints: Minimum Length: 1, Maximum Length: 40		 String getLocationId()

Example (as JSON)

{
  "dispute_id": "dispute_id2",
  "id": "id0",
  "amount_money": {
    "amount": 186,
    "currency": "TZS"
  },
  "reason": "NOT_AS_DESCRIBED",
  "state": "LOST"
}