{
  "opencollection": "1.0.0",
  "info": {
    "name": "Square ApplePay Disputes API",
    "version": "2.0"
  },
  "items": [
    {
      "info": {
        "name": "Disputes",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Square List Disputes",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://connect.squareup.com/v2/disputes",
            "params": [
              {
                "name": "cursor",
                "value": "",
                "type": "query",
                "description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this cursor to retrieve the next set of results for the original query.\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)."
              },
              {
                "name": "states",
                "value": "",
                "type": "query",
                "description": "The dispute states used to filter the result. If not specified, the endpoint returns all disputes."
              },
              {
                "name": "location_id",
                "value": "",
                "type": "query",
                "description": "The ID of the location for which to return a list of disputes.\nIf not specified, the endpoint returns disputes associated with all locations."
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://connect.squareup.com/oauth2/authorize",
              "accessTokenUrl": "https://connect.squareup.com/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Returns a list of disputes associated with a particular account."
        },
        {
          "info": {
            "name": "Square Retrieve Dispute",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://connect.squareup.com/v2/disputes/:dispute_id",
            "params": [
              {
                "name": "dispute_id",
                "value": "",
                "type": "path",
                "description": "The ID of the dispute you want more details about."
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://connect.squareup.com/oauth2/authorize",
              "accessTokenUrl": "https://connect.squareup.com/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Returns details about a specific dispute."
        },
        {
          "info": {
            "name": "Square Accept Dispute",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://connect.squareup.com/v2/disputes/:dispute_id/accept",
            "params": [
              {
                "name": "dispute_id",
                "value": "",
                "type": "path",
                "description": "The ID of the dispute you want to accept."
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://connect.squareup.com/oauth2/authorize",
              "accessTokenUrl": "https://connect.squareup.com/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Accepts the loss on a dispute. Square returns the disputed amount to the cardholder and\nupdates the dispute state to ACCEPTED.\n\nSquare debits the disputed amount from the seller’s Square account. If the Square account\ndoes not have sufficient funds, Square debits the associated bank account."
        },
        {
          "info": {
            "name": "Square List Dispute Evidence",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://connect.squareup.com/v2/disputes/:dispute_id/evidence",
            "params": [
              {
                "name": "dispute_id",
                "value": "",
                "type": "path",
                "description": "The ID of the dispute."
              },
              {
                "name": "cursor",
                "value": "",
                "type": "query",
                "description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this cursor to retrieve the next set of results for the original query.\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)."
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://connect.squareup.com/oauth2/authorize",
              "accessTokenUrl": "https://connect.squareup.com/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Returns a list of evidence associated with a dispute."
        },
        {
          "info": {
            "name": "Square Create Dispute Evidence File",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://connect.squareup.com/v2/disputes/:dispute_id/evidence-files",
            "params": [
              {
                "name": "dispute_id",
                "value": "",
                "type": "path",
                "description": "The ID of the dispute for which you want to upload evidence."
              }
            ],
            "body": {
              "type": "multipart-form",
              "data": [
                {
                  "name": "request",
                  "type": "text",
                  "value": ""
                },
                {
                  "name": "image_file",
                  "type": "text",
                  "value": ""
                }
              ]
            },
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://connect.squareup.com/oauth2/authorize",
              "accessTokenUrl": "https://connect.squareup.com/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Uploads a file to use as evidence in a dispute challenge. The endpoint accepts HTTP\nmultipart/form-data file uploads in HEIC, HEIF, JPEG, PDF, PNG, and TIFF formats."
        },
        {
          "info": {
            "name": "Square Create Dispute Evidence Text",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://connect.squareup.com/v2/disputes/:dispute_id/evidence-text",
            "params": [
              {
                "name": "dispute_id",
                "value": "",
                "type": "path",
                "description": "The ID of the dispute for which you want to upload evidence."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://connect.squareup.com/oauth2/authorize",
              "accessTokenUrl": "https://connect.squareup.com/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Uploads text to use as evidence for a dispute challenge."
        },
        {
          "info": {
            "name": "Square Retrieve Dispute Evidence",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://connect.squareup.com/v2/disputes/:dispute_id/evidence/:evidence_id",
            "params": [
              {
                "name": "dispute_id",
                "value": "",
                "type": "path",
                "description": "The ID of the dispute from which you want to retrieve evidence metadata."
              },
              {
                "name": "evidence_id",
                "value": "",
                "type": "path",
                "description": "The ID of the evidence to retrieve."
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://connect.squareup.com/oauth2/authorize",
              "accessTokenUrl": "https://connect.squareup.com/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Returns the metadata for the evidence specified in the request URL path.\n\nYou must maintain a copy of any evidence uploaded if you want to reference it later. Evidence cannot be downloaded after you upload it."
        },
        {
          "info": {
            "name": "Square Delete Dispute Evidence",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://connect.squareup.com/v2/disputes/:dispute_id/evidence/:evidence_id",
            "params": [
              {
                "name": "dispute_id",
                "value": "",
                "type": "path",
                "description": "The ID of the dispute from which you want to remove evidence."
              },
              {
                "name": "evidence_id",
                "value": "",
                "type": "path",
                "description": "The ID of the evidence you want to remove."
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://connect.squareup.com/oauth2/authorize",
              "accessTokenUrl": "https://connect.squareup.com/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Removes specified evidence from a dispute.\nSquare does not send the bank any evidence that is removed."
        },
        {
          "info": {
            "name": "Square Submit Evidence",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://connect.squareup.com/v2/disputes/:dispute_id/submit-evidence",
            "params": [
              {
                "name": "dispute_id",
                "value": "",
                "type": "path",
                "description": "The ID of the dispute for which you want to submit evidence."
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://connect.squareup.com/oauth2/authorize",
              "accessTokenUrl": "https://connect.squareup.com/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Submits evidence to the cardholder's bank.\n\nThe evidence submitted by this endpoint includes evidence uploaded\nusing the [CreateDisputeEvidenceFile](api-endpoint:Disputes-CreateDisputeEvidenceFile) and\n[CreateDisputeEvidenceText](api-endpoint:Disputes-CreateDisputeEvidenceText) endpoints and\nevidence automatically provided by Square, when available. Evidence cannot be removed from\na dispute after submission."
        }
      ]
    }
  ],
  "bundled": true
}