{
  "opencollection": "1.0.0",
  "info": {
    "name": "GOV.UK Pay Agreements Disputes API",
    "version": "1.0.3"
  },
  "items": [
    {
      "info": {
        "name": "Disputes",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Search disputes",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://publicapi.payments.service.gov.uk/v1/disputes",
            "params": [
              {
                "name": "from_date",
                "value": "2015-08-13T12:35:00Z",
                "type": "query",
                "description": "Returns disputes raised on or after the `from_date`. Date and time must be coordinated Universal Time (UTC) and ISO 8601 format to second-level accuracy - `YYYY-MM-DDThh:mm:ssZ`."
              },
              {
                "name": "to_date",
                "value": "2015-08-13T12:35:00Z",
                "type": "query",
                "description": "Returns disputes raised before the `to_date`. Date and time must be coordinated Universal Time (UTC) and ISO 8601 format to second-level accuracy - `YYYY-MM-DDThh:mm:ssZ`."
              },
              {
                "name": "from_settled_date",
                "value": "",
                "type": "query",
                "description": "Returns disputes settled on or after the `from_settled_date`. Date must be in ISO 8601 format to date-level accuracy - `YYYY-MM-DD`. Disputes are settled when your payment service provider takes the disputed amount from a payout to your bank account."
              },
              {
                "name": "to_settled_date",
                "value": "",
                "type": "query",
                "description": "Returns disputes settled before the `to_settled_date`. Date must be in ISO 8601 format to date-level accuracy - `YYYY-MM-DD`. Disputes are settled when your payment service provider takes the disputed amount from a payout to your bank account."
              },
              {
                "name": "status",
                "value": "won",
                "type": "query",
                "description": "Returns disputes with a matching `status`. `status` reflects what stage of the dispute process a dispute is at. You can [read more about the meanings of the different status values](https://docs.payments.service.gov.uk/disputes/#dispute-status)"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Returns a specific page of results. Defaults to `1`."
              },
              {
                "name": "display_size",
                "value": "",
                "type": "query",
                "description": "The number of disputes returned per results page. Defaults to `500`. Maximum value is `500`."
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "You can use this endpoint to search disputes. A dispute is when [a paying user challenges a completed payment through their bank](https://docs.payments.service.gov.uk/disputes/)."
        }
      ]
    }
  ],
  "bundled": true
}