How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Square Disputes API

The Disputes API from Square — 8 operation(s) for disputes.

Square Disputes API is one of 45 APIs that Square publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Disputes. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and an AsyncAPI specification.

This API exposes 9 operations across 8 paths, and defines 24 schemas. It is described by OpenAPI 3.2.0, at version 2.0.

Requests are made against a single base URL, https://connect.squareup.com.

9 operations 8 paths 24 schemas 1 DELETE4 GET4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0
Server
https://connect.squareup.com
Authentication
OAuth 2.0, API Key
License
Terms of Service
Resource Areas
1

Authentication & Security 2

Square Disputes API declares 2 security schemes for authenticating requests. It supports OAuth 2.0 (oauth2) using the authorizationCode flow, exposing 57 scopes. An API key is passed in the header as Authorization (oauth2ClientSecret).

Paths & Operations 9

Across 8 paths, the API surfaces 9 operations — 1 DELETE, 4 GET, 4 POST. Each is listed below with its method, path, parameters, and response codes.

Disputes 9
GET
/v2/disputes
Square List Disputes
ListDisputes 3 params → 200
GET
/v2/disputes/{dispute_id}
Square Retrieve Dispute
RetrieveDispute 1 param → 200
POST
/v2/disputes/{dispute_id}/accept
Square Accept Dispute
AcceptDispute 1 param → 200
GET
/v2/disputes/{dispute_id}/evidence
Square List Dispute Evidence
ListDisputeEvidence 2 params → 200
POST
/v2/disputes/{dispute_id}/evidence-files
Square Create Dispute Evidence File
CreateDisputeEvidenceFile 1 param body → 200
POST
/v2/disputes/{dispute_id}/evidence-text
Square Create Dispute Evidence Text
CreateDisputeEvidenceText 1 param body → 200
DELETE
/v2/disputes/{dispute_id}/evidence/{evidence_id}
Square Delete Dispute Evidence
DeleteDisputeEvidence 2 params → 200
GET
/v2/disputes/{dispute_id}/evidence/{evidence_id}
Square Retrieve Dispute Evidence
RetrieveDisputeEvidence 2 params → 200
POST
/v2/disputes/{dispute_id}/submit-evidence
Square Submit Evidence
SubmitEvidence 1 param → 200

Schemas 24

The contract defines 24 schemas that model the data the API accepts and returns. The most detailed are Dispute (16 properties), DisputeEvidence (7 properties), Error (4 properties), CreateDisputeEvidenceTextRequest (3 properties). Each schema is shown below with its type and property counts.

Currency
string
Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://wikipedia.org/wiki/ISO4217).
DisputeEvidence
object
7 properties
DisputeEvidenceType
string
The type of the dispute evidence.
CardBrand
string
Indicates a card's brand, such as VISA or MASTERCARD.
AcceptDisputeResponse
object
Defines the fields in an AcceptDispute response.
2 properties
DisputedPayment
object
The payment the cardholder disputed.
1 property
CreateDisputeEvidenceTextRequest
object
Defines the parameters for a CreateDisputeEvidenceText request.
3 properties 2 required
ListDisputesResponse
object
Defines fields in a ListDisputes response.
3 properties
DisputeEvidenceFile
object
A file to be uploaded as dispute evidence.
2 properties
Money
object
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…
2 properties
CreateDisputeEvidenceTextResponse
object
Defines the fields in a CreateDisputeEvidenceText response.
2 properties
SubmitEvidenceResponse
object
Defines the fields in a SubmitEvidence response.
2 properties
ListDisputeEvidenceResponse
object
Defines the fields in a ListDisputeEvidence response.
3 properties
RetrieveDisputeResponse
object
Defines fields in a RetrieveDispute response.
2 properties
CreateDisputeEvidenceFileResponse
object
Defines the fields in a CreateDisputeEvidenceFile response.
2 properties
Dispute
object
Represents a [dispute](https://developer.squareup.com/docs/disputes-api/overview) a cardholder initiated with their bank.
16 properties
Error
object
Represents an error encountered during a request to the Connect API. See [Handling errors](https://developer.squareup.com/docs/build-basics/handling-errors) fo…
4 properties 2 required
DisputeReason
string
The list of possible reasons why a cardholder might initiate a dispute with their bank.
ErrorCode
string
Indicates the specific error that occurred during a request to a Square API.
CreateDisputeEvidenceFileRequest
object
Defines the parameters for a CreateDisputeEvidenceFile request.
3 properties 1 required
RetrieveDisputeEvidenceResponse
object
Defines the fields in a RetrieveDisputeEvidence response.
2 properties
DeleteDisputeEvidenceResponse
object
Defines the fields in a DeleteDisputeEvidence response.
1 property
ErrorCategory
string
Indicates which high-level category of error has occurred during a request to the Connect API.
DisputeState
string
The list of possible dispute states.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

square-disputes-api-openapi.yml Raw ↑

Other APIs Square publishes across the network.

Square Reporting API
Square Channels API
Square Transfer Orders API
Square ApplePay API
Square BankAccounts API
Square BookingCustomAttributes API
Square Bookings API
Square Cards API
Square CashDrawers API
Square Catalog API
Square Checkout API
Square CustomerCustomAttributes API
Where this information came from

This is an independent, third-party profile of Square Disputes API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.