Dispute

February 26, 2020 ยท View on GitHub

Description

Represents a dispute a cardholder initiated with their bank.

Properties

NameGetterSetterTypeDescriptionNotes
dispute_idgetDisputeId()setDisputeId($value)stringUnique ID for this `Dispute`, generated by Square.[optional]
amount_moneygetAmountMoney()setAmountMoney($value)\SquareConnect\Model\MoneyThe disputed amount. The amount can be less than the entire transaction amount. For example, a cardholder purchased multiple items, however initiated dispute only for some of the items.[optional]
reasongetReason()setReason($value)stringThe dispute reason why cardholder initiated dispute with their bank. See DisputeReason for possible values[optional]
stategetState()setState($value)stringThe current state of this dispute. See DisputeState for possible values[optional]
due_atgetDueAt()setDueAt($value)stringThe time when the next action is due, in RFC 3339 format.[optional]
disputed_paymentgetDisputedPayment()setDisputedPayment($value)\SquareConnect\Model\DisputedPaymentThe payment challenged in this dispute.[optional]
evidence_idsgetEvidenceIds()setEvidenceIds($value)string[]The IDs of the evidence associated with the dispute.[optional]
card_brandgetCardBrand()setCardBrand($value)stringThe card brand used in the disputed payment. See CardBrand for possible values[optional]
created_atgetCreatedAt()setCreatedAt($value)stringTimestamp when the dispute was created, in RFC 3339 format.[optional]
updated_atgetUpdatedAt()setUpdatedAt($value)stringTimestamp when dispute was last updated, in RFC 3339 format.[optional]
brand_dispute_idgetBrandDisputeId()setBrandDisputeId($value)stringID of the dispute in the card brand system, generated by the card brand.[optional]
reported_dategetReportedDate()setReportedDate($value)stringTimestamp when the dispute was reported, in RFC 3339 format.[optional]
versiongetVersion()setVersion($value)intThe current version of the `Dispute`.[optional]
location_idgetLocationId()setLocationId($value)stringThe ID of location where dispute originated.[optional]

Note: All properties are protected and only accessed via getters and setters.

[Back to Model list] [Back to API list] [Back to README]