• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”

Object Index

You are viewing an old version of the API
Dispute

Represents a dispute a cardholder initiated with their bank.

Properties

Name Description
dispute_id
string

Deprecated

The unique ID for this Dispute, generated by Square.

Min Length 1 Max Length 40
id
string

The unique ID for this Dispute, generated by Square.

Min Length 1 Max Length 40
amount_money
Money

The 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.

reason
string

The dispute reason why the cardholder initiated the dispute with their bank.

state
string

The current state of this dispute.

due_at
string

The time when the next action is due, in RFC 3339 format.

Min Length 1 Max Length 40
disputed_payment
DisputedPayment

The payment challenged in this dispute.

evidence_ids
string [ ]

Deprecated

The IDs of the evidence associated with the dispute.

card_brand
string

The card brand used in the disputed payment.

created_at
string

Read only The timestamp when the dispute was created, in RFC 3339 format.

Examples for January 25th, 2020 6:25:34pm Pacific Standard Time:

UTC: 2020-01-26T02:25:34Z

Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00

Min Length 1 Max Length 40
updated_at
string

Read only The timestamp when the dispute was last updated, in RFC 3339 format.

Examples for January 25th, 2020 6:25:34pm Pacific Standard Time:

UTC: 2020-01-26T02:25:34Z

Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00

Min Length 1 Max Length 40
brand_dispute_id
string

The ID of the dispute in the card brand system, generated by the card brand.

Min Length 1 Max Length 40
reported_date
string

Deprecated

The timestamp when the dispute was reported, in RFC 3339 format.

Examples for January 25th, 2020 6:25:34pm Pacific Standard Time:

UTC: 2020-01-26T02:25:34Z

Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00

Min Length 1 Max Length 40
reported_at
string

The timestamp when the dispute was reported, in RFC 3339 format.

Examples for January 25th, 2020 6:25:34pm Pacific Standard Time:

UTC: 2020-01-26T02:25:34Z

Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00

Min Length 1 Max Length 40
version
integer (32-bit)

The current version of the Dispute.

location_id
string

The ID of the location where the dispute originated.

Min Length 1 Max Length 40

Share feedback

Thanks for visiting the Square API documentation. What's on your mind?