Square Disputes API

openapi: 3.2.0
info:
  version: '2.0'
  title: Square ApplePay Disputes API
  description: 'Supercharge Square for sellers of every size. Our entire connected commerce platform  from elegant hardware to a rich suite of Square APIs  is yours to build with. Whether youre developing an app or composing a bespoke solution, this is the place to make it happen. '
  termsOfService: https://connect.squareup.com/tos
  contact:
    name: Square Developer Platform
    email: developers@squareup.com
    url: https://squareup.com/developers
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  externalDocs:
    description: 'Read the official documentation here:'
    url: https://docs.connect.squareup.com/
  x-server-configuration:
    default-environment: production
    default-server: default
    environments:
    - name: production
      servers:
      - name: default
        url: https://connect.squareup.com
    - name: sandbox
      servers:
      - name: default
        url: https://connect.squareupsandbox.com
    - name: custom
      servers:
      - name: default
        url: '{custom_url}'
    parameters:
    - name: custom_url
      description: Sets the base URL requests are made to. Defaults to `https://connect.squareup.com`
      type: string
      example: https://connect.squareup.com
  x-square-generic-error-codes:
  - ACCESS_TOKEN_EXPIRED
  - ACCESS_TOKEN_REVOKED
  - API_VERSION_INCOMPATIBLE
  - APPLICATION_DISABLED
  - ARRAY_EMPTY
  - ARRAY_LENGTH_TOO_LONG
  - ARRAY_LENGTH_TOO_SHORT
  - BAD_CERTIFICATE
  - BAD_GATEWAY
  - BAD_REQUEST
  - CONFLICT
  - CONFLICTING_PARAMETERS
  - CURRENCY_MISMATCH
  - EXPECTED_ARRAY
  - EXPECTED_BASE64_ENCODED_BYTE_ARRAY
  - EXPECTED_BOOLEAN
  - EXPECTED_FLOAT
  - EXPECTED_INTEGER
  - EXPECTED_JSON_BODY
  - EXPECTED_MAP
  - EXPECTED_OBJECT
  - EXPECTED_STRING
  - FORBIDDEN
  - GATEWAY_TIMEOUT
  - GONE
  - IDEMPOTENCY_KEY_REUSED
  - INCORRECT_TYPE
  - INSUFFICIENT_SCOPES
  - INTERNAL_SERVER_ERROR
  - INVALID_ARRAY_VALUE
  - INVALID_CONTENT_TYPE
  - INVALID_CURSOR
  - INVALID_ENUM_VALUE
  - INVALID_FORM_VALUE
  - INVALID_SORT_ORDER
  - INVALID_SQUARE_VERSION_FORMAT
  - INVALID_TIME
  - INVALID_TIME_RANGE
  - INVALID_VALUE
  - LOCATION_MISMATCH
  - MAP_KEY_LENGTH_TOO_LONG
  - MAP_KEY_LENGTH_TOO_SHORT
  - MERCHANT_SUBSCRIPTION_NOT_FOUND
  - METHOD_NOT_ALLOWED
  - MISSING_REQUIRED_PARAMETER
  - NOT_ACCEPTABLE
  - NOT_FOUND
  - NOT_IMPLEMENTED
  - NO_FIELDS_SET
  - RATE_LIMITED
  - REQUEST_ENTITY_TOO_LARGE
  - REQUEST_TIMEOUT
  - SANDBOX_NOT_SUPPORTED
  - SERVICE_UNAVAILABLE
  - TOO_MANY_MAP_ENTRIES
  - UNAUTHORIZED
  - UNEXPECTED_VALUE
  - UNKNOWN_BODY_PARAMETER
  - UNKNOWN_QUERY_PARAMETER
  - UNPROCESSABLE_ENTITY
  - UNSUPPORTED_MEDIA_TYPE
  - V1_ACCESS_TOKEN
  - V1_APPLICATION
  - VALUE_EMPTY
  - VALUE_REGEX_MISMATCH
  - VALUE_TOO_HIGH
  - VALUE_TOO_LONG
  - VALUE_TOO_LOW
  - VALUE_TOO_SHORT
servers:
- url: https://connect.squareup.com
  variables: {}
tags:
- name: Disputes
paths:
  /v2/disputes:
    get:
      tags:
      - Disputes
      summary: Square List Disputes
      operationId: ListDisputes
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      description: Returns a list of disputes associated with a particular account.
      x-release-status: PUBLIC
      security:
      - oauth2:
        - DISPUTES_READ
      parameters:
      - name: cursor
        description: 'A pagination cursor returned by a previous call to this endpoint.

          Provide this cursor to retrieve the next set of results for the original query.

          For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).'
        schema:
          type: string
        in: query
        required: false
      - name: states
        description: The dispute states used to filter the result. If not specified, the endpoint returns all disputes.
        schema:
          $ref: '#/components/schemas/DisputeState'
        in: query
        required: false
      - name: location_id
        description: 'The ID of the location for which to return a list of disputes.

          If not specified, the endpoint returns disputes associated with all locations.'
        schema:
          type: string
        in: query
        required: false
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListDisputesResponse'
  /v2/disputes/{dispute_id}:
    get:
      tags:
      - Disputes
      summary: Square Retrieve Dispute
      operationId: RetrieveDispute
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      description: Returns details about a specific dispute.
      x-release-status: PUBLIC
      security:
      - oauth2:
        - DISPUTES_READ
      parameters:
      - name: dispute_id
        description: The ID of the dispute you want more details about.
        schema:
          type: string
        in: path
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetrieveDisputeResponse'
  /v2/disputes/{dispute_id}/accept:
    post:
      tags:
      - Disputes
      summary: Square Accept Dispute
      operationId: AcceptDispute
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      description: 'Accepts the loss on a dispute. Square returns the disputed amount to the cardholder and

        updates the dispute state to ACCEPTED.


        Square debits the disputed amount from the seller’s Square account. If the Square account

        does not have sufficient funds, Square debits the associated bank account.'
      x-release-status: PUBLIC
      security:
      - oauth2:
        - DISPUTES_WRITE
      parameters:
      - name: dispute_id
        description: The ID of the dispute you want to accept.
        schema:
          type: string
        in: path
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AcceptDisputeResponse'
  /v2/disputes/{dispute_id}/evidence:
    get:
      tags:
      - Disputes
      summary: Square List Dispute Evidence
      operationId: ListDisputeEvidence
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      description: Returns a list of evidence associated with a dispute.
      x-release-status: PUBLIC
      security:
      - oauth2:
        - DISPUTES_READ
      parameters:
      - name: dispute_id
        description: The ID of the dispute.
        schema:
          type: string
        in: path
        required: true
      - name: cursor
        description: 'A pagination cursor returned by a previous call to this endpoint.

          Provide this cursor to retrieve the next set of results for the original query.

          For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).'
        schema:
          type: string
        in: query
        required: false
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListDisputeEvidenceResponse'
  /v2/disputes/{dispute_id}/evidence-files:
    post:
      tags:
      - Disputes
      summary: Square Create Dispute Evidence File
      operationId: CreateDisputeEvidenceFile
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      description: 'Uploads a file to use as evidence in a dispute challenge. The endpoint accepts HTTP

        multipart/form-data file uploads in HEIC, HEIF, JPEG, PDF, PNG, and TIFF formats.'
      x-release-status: PUBLIC
      security:
      - oauth2:
        - DISPUTES_WRITE
      parameters:
      - name: dispute_id
        description: The ID of the dispute for which you want to upload evidence.
        schema:
          type: string
        in: path
        required: true
      requestBody:
        required: true
        description: 'An object containing the fields to POST for the request.


          See the corresponding object definition for field details.'
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                request:
                  $ref: '#/components/schemas/CreateDisputeEvidenceFileRequest'
                image_file:
                  type: string
                  format: binary
            encoding:
              image_file:
                contentType: image/jpeg
              request:
                contentType: application/json; charset=utf-8
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateDisputeEvidenceFileResponse'
  /v2/disputes/{dispute_id}/evidence-text:
    post:
      tags:
      - Disputes
      summary: Square Create Dispute Evidence Text
      operationId: CreateDisputeEvidenceText
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      description: Uploads text to use as evidence for a dispute challenge.
      x-release-status: PUBLIC
      security:
      - oauth2:
        - DISPUTES_WRITE
      parameters:
      - name: dispute_id
        description: The ID of the dispute for which you want to upload evidence.
        schema:
          type: string
        in: path
        required: true
      requestBody:
        required: true
        description: 'An object containing the fields to POST for the request.


          See the corresponding object definition for field details.'
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateDisputeEvidenceTextRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateDisputeEvidenceTextResponse'
  /v2/disputes/{dispute_id}/evidence/{evidence_id}:
    delete:
      tags:
      - Disputes
      summary: Square Delete Dispute Evidence
      operationId: DeleteDisputeEvidence
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      description: 'Removes specified evidence from a dispute.

        Square does not send the bank any evidence that is removed.'
      x-release-status: PUBLIC
      security:
      - oauth2:
        - DISPUTES_WRITE
      parameters:
      - name: dispute_id
        description: The ID of the dispute from which you want to remove evidence.
        schema:
          type: string
        in: path
        required: true
      - name: evidence_id
        description: The ID of the evidence you want to remove.
        schema:
          type: string
        in: path
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteDisputeEvidenceResponse'
    get:
      tags:
      - Disputes
      summary: Square Retrieve Dispute Evidence
      operationId: RetrieveDisputeEvidence
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      description: 'Returns the metadata for the evidence specified in the request URL path.


        You must maintain a copy of any evidence uploaded if you want to reference it later. Evidence cannot be downloaded after you upload it.'
      x-release-status: PUBLIC
      security:
      - oauth2:
        - DISPUTES_READ
      parameters:
      - name: dispute_id
        description: The ID of the dispute from which you want to retrieve evidence metadata.
        schema:
          type: string
        in: path
        required: true
      - name: evidence_id
        description: The ID of the evidence to retrieve.
        schema:
          type: string
        in: path
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetrieveDisputeEvidenceResponse'
  /v2/disputes/{dispute_id}/submit-evidence:
    post:
      tags:
      - Disputes
      summary: Square Submit Evidence
      operationId: SubmitEvidence
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      description: 'Submits evidence to the cardholder''s bank.


        The evidence submitted by this endpoint includes evidence uploaded

        using the [CreateDisputeEvidenceFile](api-endpoint:Disputes-CreateDisputeEvidenceFile) and

        [CreateDisputeEvidenceText](api-endpoint:Disputes-CreateDisputeEvidenceText) endpoints and

        evidence automatically provided by Square, when available. Evidence cannot be removed from

        a dispute after submission.'
      x-release-status: PUBLIC
      security:
      - oauth2:
        - DISPUTES_WRITE
      parameters:
      - name: dispute_id
        description: The ID of the dispute for which you want to submit evidence.
        schema:
          type: string
        in: path
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubmitEvidenceResponse'
components:
  schemas:
    Currency:
      type: string
      enum:
      - UNKNOWN_CURRENCY
      - AED
      - AFN
      - ALL
      - AMD
      - ANG
      - AOA
      - ARS
      - AUD
      - AWG
      - AZN
      - BAM
      - BBD
      - BDT
      - BGN
      - BHD
      - BIF
      - BMD
      - BND
      - BOB
      - BOV
      - BRL
      - BSD
      - BTN
      - BWP
      - BYR
      - BZD
      - CAD
      - CDF
      - CHE
      - CHF
      - CHW
      - CLF
      - CLP
      - CNY
      - COP
      - COU
      - CRC
      - CUC
      - CUP
      - CVE
      - CZK
      - DJF
      - DKK
      - DOP
      - DZD
      - EGP
      - ERN
      - ETB
      - EUR
      - FJD
      - FKP
      - GBP
      - GEL
      - GHS
      - GIP
      - GMD
      - GNF
      - GTQ
      - GYD
      - HKD
      - HNL
      - HRK
      - HTG
      - HUF
      - IDR
      - ILS
      - INR
      - IQD
      - IRR
      - ISK
      - JMD
      - JOD
      - JPY
      - KES
      - KGS
      - KHR
      - KMF
      - KPW
      - KRW
      - KWD
      - KYD
      - KZT
      - LAK
      - LBP
      - LKR
      - LRD
      - LSL
      - LTL
      - LVL
      - LYD
      - MAD
      - MDL
      - MGA
      - MKD
      - MMK
      - MNT
      - MOP
      - MRO
      - MUR
      - MVR
      - MWK
      - MXN
      - MXV
      - MYR
      - MZN
      - NAD
      - NGN
      - NIO
      - NOK
      - NPR
      - NZD
      - OMR
      - PAB
      - PEN
      - PGK
      - PHP
      - PKR
      - PLN
      - PYG
      - QAR
      - RON
      - RSD
      - RUB
      - RWF
      - SAR
      - SBD
      - SCR
      - SDG
      - SEK
      - SGD
      - SHP
      - SLL
      - SLE
      - SOS
      - SRD
      - SSP
      - STD
      - SVC
      - SYP
      - SZL
      - THB
      - TJS
      - TMT
      - TND
      - TOP
      - TRY
      - TTD
      - TWD
      - TZS
      - UAH
      - UGX
      - USD
      - USN
      - USS
      - UYI
      - UYU
      - UZS
      - VEF
      - VND
      - VUV
      - WST
      - XAF
      - XAG
      - XAU
      - XBA
      - XBB
      - XBC
      - XBD
      - XCD
      - XDR
      - XOF
      - XPD
      - XPF
      - XPT
      - XTS
      - XXX
      - YER
      - ZAR
      - ZMK
      - ZMW
      - BTC
      - XUS
      x-enum-elements:
      - name: UNKNOWN_CURRENCY
        description: Unknown currency
      - name: AED
        description: United Arab Emirates dirham
      - name: AFN
        description: Afghan afghani
      - name: ALL
        description: Albanian lek
      - name: AMD
        description: Armenian dram
      - name: ANG
        description: Netherlands Antillean guilder
      - name: AOA
        description: Angolan kwanza
      - name: ARS
        description: Argentine peso
      - name: AUD
        description: Australian dollar
      - name: AWG
        description: Aruban florin
      - name: AZN
        description: Azerbaijani manat
      - name: BAM
        description: Bosnia and Herzegovina convertible mark
      - name: BBD
        description: Barbados dollar
      - name: BDT
        description: Bangladeshi taka
      - name: BGN
        description: Bulgarian lev
      - name: BHD
        description: Bahraini dinar
      - name: BIF
        description: Burundian franc
      - name: BMD
        description: Bermudian dollar
      - name: BND
        description: Brunei dollar
      - name: BOB
        description: Boliviano
      - name: BOV
        description: Bolivian Mvdol
      - name: BRL
        description: Brazilian real
      - name: BSD
        description: Bahamian dollar
      - name: BTN
        description: Bhutanese ngultrum
      - name: BWP
        description: Botswana pula
      - name: BYR
        description: Belarusian ruble
      - name: BZD
        description: Belize dollar
      - name: CAD
        description: Canadian dollar
      - name: CDF
        description: Congolese franc
      - name: CHE
        description: WIR Euro
      - name: CHF
        description: Swiss franc
      - name: CHW
        description: WIR Franc
      - name: CLF
        description: Unidad de Fomento
      - name: CLP
        description: Chilean peso
      - name: CNY
        description: Chinese yuan
      - name: COP
        description: Colombian peso
      - name: COU
        description: Unidad de Valor Real
      - name: CRC
        description: Costa Rican colon
      - name: CUC
        description: Cuban convertible peso
      - name: CUP
        description: Cuban peso
      - name: CVE
        description: Cape Verdean escudo
      - name: CZK
        description: Czech koruna
      - name: DJF
        description: Djiboutian franc
      - name: DKK
        description: Danish krone
      - name: DOP
        description: Dominican peso
      - name: DZD
        description: Algerian dinar
      - name: EGP
        description: Egyptian pound
      - name: ERN
        description: Eritrean nakfa
      - name: ETB
        description: Ethiopian birr
      - name: EUR
        description: Euro
      - name: FJD
        description: Fiji dollar
      - name: FKP
        description: Falkland Islands pound
      - name: GBP
        description: Pound sterling
      - name: GEL
        description: Georgian lari
      - name: GHS
        description: Ghanaian cedi
      - name: GIP
        description: Gibraltar pound
      - name: GMD
        description: Gambian dalasi
      - name: GNF
        description: Guinean franc
      - name: GTQ
        description: Guatemalan quetzal
      - name: GYD
        description: Guyanese dollar
      - name: HKD
        description: Hong Kong dollar
      - name: HNL
        description: Honduran lempira
      - name: HRK
        description: Croatian kuna
      - name: HTG
        description: Haitian gourde
      - name: HUF
        description: Hungarian forint
      - name: IDR
        description: Indonesian rupiah
      - name: ILS
        description: Israeli new shekel
      - name: INR
        description: Indian rupee
      - name: IQD
        description: Iraqi dinar
      - name: IRR
        description: Iranian rial
      - name: ISK
        description: Icelandic króna
      - name: JMD
        description: Jamaican dollar
      - name: JOD
        description: Jordanian dinar
      - name: JPY
        description: Japanese yen
      - name: KES
        description: Kenyan shilling
      - name: KGS
        description: Kyrgyzstani som
      - name: KHR
        description: Cambodian riel
      - name: KMF
        description: Comoro franc
      - name: KPW
        description: North Korean won
      - name: KRW
        description: South Korean won
      - name: KWD
        description: Kuwaiti dinar
      - name: KYD
        description: Cayman Islands dollar
      - name: KZT
        description: Kazakhstani tenge
      - name: LAK
        description: Lao kip
      - name: LBP
        description: Lebanese pound
      - name: LKR
        description: Sri Lankan rupee
      - name: LRD
        description: Liberian dollar
      - name: LSL
        description: Lesotho loti
      - name: LTL
        description: Lithuanian litas
      - name: LVL
        description: Latvian lats
      - name: LYD
        description: Libyan dinar
      - name: MAD
        description: Moroccan dirham
      - name: MDL
        description: Moldovan leu
      - name: MGA
        description: Malagasy ariary
      - name: MKD
        description: Macedonian denar
      - name: MMK
        description: Myanmar kyat
      - name: MNT
        description: Mongolian tögrög
      - name: MOP
        description: Macanese pataca
      - name: MRO
        description: Mauritanian ouguiya
      - name: MUR
        description: Mauritian rupee
      - name: MVR
        description: Maldivian rufiyaa
      - name: MWK
        description: Malawian kwacha
      - name: MXN
        description: Mexican peso
      - name: MXV
        description: Mexican Unidad de Inversion
      - name: MYR
        description: Malaysian ringgit
      - name: MZN
        description: Mozambican metical
      - name: NAD
        description: Namibian dollar
      - name: NGN
        description: Nigerian naira
      - name: NIO
        description: Nicaraguan córdoba
      - name: NOK
        description: Norwegian krone
      - name: NPR
        description: Nepalese rupee
      - name: NZD
        description: New Zealand dollar
      - name: OMR
        description: Omani rial
      - name: PAB
        description: Panamanian balboa
      - name: PEN
        description: Peruvian sol
      - name: PGK
        description: Papua New Guinean kina
      - name: PHP
        description: Philippine peso
      - name: PKR
        description: Pakistani rupee
      - name: PLN
        description: Polish zBoty
      - name: PYG
        description: Paraguayan guaraní
      - name: QAR
        description: Qatari riyal
      - name: RON
        description: Romanian leu
      - name: RSD
        description: Serbian dinar
      - name: RUB
        description: Russian ruble
      - name: RWF
        description: Rwandan franc
      - name: SAR
        description: Saudi riyal
      - name: SBD
        description: Solomon Islands dollar
      - name: SCR
        description: Seychelles rupee
      - name: SDG
        description: Sudanese pound
      - name: SEK
        description: Swedish krona
      - name: SGD
        description: Singapore dollar
      - name: SHP
        description: Saint Helena pound
      - name: SLL
        description: Sierra Leonean first leone
      - name: SLE
        description: Sierra Leonean second leone
      - name: SOS
        description: Somali shilling
      - name: SRD
        description: Surinamese dollar
      - name: SSP
        description: South Sudanese pound
      - name: STD
        description: São Tomé and Príncipe dobra
      - name: SVC
        description: Salvadoran colón
      - name: SYP
        description: Syrian pound
      - name: SZL
        description: Swazi lilangeni
      - name: THB
        description: Thai baht
      - name: TJS
        description: Tajikstani somoni
      - name: TMT
        description: Turkmenistan manat
      - name: TND
        description: Tunisian dinar
      - name: TOP
        description: Tongan pa'anga
      - name: TRY
        description: Turkish lira
      - name: TTD
        description: Trinidad and Tobago dollar
      - name: TWD
        description: New Taiwan dollar
      - name: TZS
        description: Tanzanian shilling
      - name: UAH
        description: Ukrainian hryvnia
      - name: UGX
        description: Ugandan shilling
      - name: USD
        description: United States dollar
      - name: USN
        description: United States dollar (next day)
      - name: USS
        description: United States dollar (same day)
      - name: UYI
        description: Uruguay Peso en Unidedades Indexadas
      - name: UYU
        description: Uruguyan peso
      - name: UZS
        description: Uzbekistan som
      - name: VEF
        description: Venezuelan bolívar soberano
      - name: VND
        description: Vietnamese ’Óng
      - name: VUV
        description: Vanuatu vatu
      - name: WST
        description: Samoan tala
      - name: XAF
        description: CFA franc BEAC
      - name: XAG
        description: Silver
      - name: XAU
        description: Gold
      - name: XBA
        description: European Composite Unit
      - name: XBB
        description: European Monetary Unit
      - name: XBC
        description: European Unit of Account 9
      - name: XBD
        description: European Unit of Account 17
      - name: XCD
        description: East Caribbean dollar
      - name: XDR
        description: Special drawing rights (International Monetary Fund)
      - name: XOF
        description: CFA franc BCEAO
      - name: XPD
        description: Palladium
      - name: XPF
        description: CFP franc
      - name: XPT
        description: Platinum
      - name: XTS
        description: Code reserved for testing
      - name: XXX
        description: No currency
      - name: YER
        description: Yemeni rial
      - name: ZAR
        description: South African rand
      - name: ZMK
        description: Zambian kwacha
      - name: ZMW
        description: Zambian kwacha
      - name: BTC
        description: Bitcoin
      - name: XUS
        description: USD Coin
      description: 'Indicates the associated currency for an amount of money. Values correspond

        to [ISO 4217](https://wikipedia.org/wiki/ISO_4217).'
      x-release-status: PUBLIC
    DisputeEvidence:
      type: object
      x-release-status: PUBLIC
      properties:
        evidence_id:
          type:
          - string
          - 'null'
          description: The Square-generated ID of the evidence.
          minLength: 1
          maxLength: 40
          x-release-status: DEPRECATED
        id:
          type: string
          description: The Square-generated ID of the evidence.
          minLength: 1
          maxLength: 40
        dispute_id:
          type:
          - string
          - 'null'
          description: The ID of the dispute the evidence is associated with.
          minLength: 1
          maxLength: 40
        evidence_file:
          $ref: '#/components/schemas/DisputeEvidenceFile'
          description: Image, PDF, TXT
        evidence_text:
          type:
          - string
          - 'null'
          description: Raw text
          minLength: 1
          maxLength: 500
        uploaded_at:
          type:
          - string
          - 'null'
          description: The time when the evidence was uploaded, in RFC 3339 format.
          minLength: 1
          maxLength: 40
        evidence_type:
          $ref: '#/components/schemas/DisputeEvidenceType'
          description: 'The type of the evidence.

            See [DisputeEvidenceType](#type-disputeevidencetype) for possible values'
    DisputeEvidenceType:
      type: string
      enum:
      - GENERIC_EVIDENCE
      - ONLINE_OR_APP_ACCESS_LOG
      - AUTHORIZATION_DOCUMENTATION
      - CANCELLATION_OR_REFUND_DOCUMENTATION
      - CARDHOLDER_COMMUNICATION
      - CARDHOLDER_INFORMATION
      - PURCHASE_ACKNOWLEDGEMENT
      - DUPLICATE_CHARGE_DOCUMENTATION
      - PRODUCT_OR_SERVICE_DESCRIPTION
      - RECEIPT
      - SERVICE_RECEIVED_DOCUMENTATION
      - PROOF_OF_DELIVERY_DOCUMENTATION
      - RELATED_TRANSACTION_DOCUMENTATION
      - REBUTTAL_EXPLANATION
      - TRACKING_NUMBER
      x-enum-elements:
      - name: GENERIC_EVIDENCE
        description: 'Square assumes this evidence type if you do not provide a type when uploading evidence.


          Use when uploading evidence as a file or string.'
      - name: ONLINE_OR_APP_ACCESS_LOG
        description: 'Server or activity logs that show proof of the cardholder’s identity and that the

          cardholder successfully ordered and received the goods (digitally or otherwise).

          Example evidence includes IP addresses, corresponding timestamps/dates, cardholder’s name and email

          address linked to a cardholder profile held by the seller, proof the same device and card (used

          in dispute) were previously used in prior undisputed transaction, and any related detailed activity.


          Use when uploading evidence as a file or string.'
      - name: AUTHORIZATION_DOCUMENTATION
        description: 'Evidence that the cardholder did provide authorization for the charge.

          Example evidence includes a signed credit card authorization.


          Use when uploading evidence as a file.'
      - name: CANCELLATION_OR_REFUND_DOCUMENTATION
        description: 'Evidence that the cardholder acknowledged your refund or cancellation policy.

          Example evidence includes a signature or checkbox showing the cardholder’s acknowledgement of your

          refund or cancellation policy.


          Use when uploading evidence as a file or string.'
      - name: CARDHOLDER_COMMUNICATION
        description: 'Evidence that shows relevant communication with the cardholder.

          Example evidence includes emails or texts that show the cardholder received goods/services or

          demonstrate cardholder satisfaction.


          Use when uploading evidence as a file.'
      - name: CARDHOLDER_INFORMATION
        description: 'Evidence that validates the customer''s identity.

          Example evidence includes personally identifiable details such as name, email address, purchaser IP

          address, and a copy of the cardholder ID.


          Use when uploading evidence as a file or string.'
      - name: PURCHASE_ACKNOWLEDGEMENT
        description: 'Evidence that shows proof of the sale/transaction.

          Example evidence includes an invoice, contract, or other item showing the customer’s acknowledgement

          of the purchase and your terms.


          Use when uploading evidence as a file or string.'
      - name: DUPLICATE_CHARGE_DOCUMENTATION
        description: 'Evidence that shows the charges in question are valid and distinct from one another.

          Example evidence includes receipts, shipping labels, and invoices along with their distinct payment IDs.


          Use when uploading evidence as a file.'
      - name: PRODUCT_OR_SERVICE_DESCRIPTION
        description: 'A description of the product or service sold.


          Use when uploading evidence as a file or string.'
      - name: RECEIPT
        description: 'A receipt or message sent to the cardholder detailing the charge.

          Note: You do not need to upload the Square receipt; Square submits the receipt on your behalf.


          Use when uploading evidence as a file or string.'
      - name: SERVICE_RECEIVED_DOCUMENTATION
        description: 'Evidence that the service was provided to the cardholder or the expected date that services will be rendered.

          Example evidence includes a signed delivery form, work order, expected delivery date, or other written agreements.


          Use when uploading evidence as a file or string.'
      - name: PROOF_OF_DELIVERY_DOCUMENTATION
        description: 'Evidence that shows the product was provided to the cardholder or the expected date of delivery.

          Example evidence includes a signed delivery form or written agreement acknowledging receipt of the goods or services.


          Use when uploading evidence as a file or string.'
      - name: RELATED_TRANSACTION_DOCUMENTATION
        description: 'Evidence that shows the cardholder previously processed transactions on the same card and did not dispute them.

          Note: Square automatically provides up to five distinct Square receipts for related transactions, when available.


          Use when uploading evidence as a file or string.'
      - name: REBUTTAL_EXPLANATION
        description: 'An explanation of why the cardho

# --- truncated at 32 KB (101 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/square/refs/heads/main/openapi/square-disputes-api-openapi.yml