Sign in

v39

latestOpenAPI 3.0.1raw.githubusercontent.com2025-10-031646108.8 KB
Disputes

Search disputes

You can use this endpoint to search disputes. A dispute is when a paying user challenges a completed payment through their bank.

get/v1/disputes

Query parameters

from_datestring

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.

to_datestring

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.

from_settled_datestring

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.

to_settled_datestring

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.

status'needs_response' | 'under_review' | 'lost' | 'won'

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

pagestring

Returns a specific page of results. Defaults to 1.

display_sizestring

The number of disputes returned per results page. Defaults to 500. Maximum value is 500.

Response

OK - your request was successful.

countinteger

Number of disputes on the current page of search results.

pageinteger

The page of results you’re viewing. To view other pages, make this request again using the 'page' parameter.

totalinteger

Number of total disputes matching your search criteria.

Example response

{
  "count": 20,
  "links": {
    "first_page": {
      "href": "https://an.example.link/from/payment/platform",
      "method": "GET"
    },
    "last_page": {
      "href": "https://an.example.link/from/payment/platform",
      "method": "GET"
    },
    "next_page": {
      "href": "https://an.example.link/from/payment/platform",
      "method": "GET"
    },
    "prev_page": {
      "href": "https://an.example.link/from/payment/platform",
      "method": "GET"
    },
    "self": {
      "href": "https://an.example.link/from/payment/platform",
      "method": "GET"
    }
  },
  "page": 1,
  "results": [
    {
      "_links": {
        "payment": {
          "href": "https://an.example.link/from/payment/platform",
          "method": "GET"
        }
      },
      "amount": 1200,
      "created_date": "2022-07-28T16:43:00.000Z",
      "dispute_id": "hu20sqlact5260q2nanm0q8u93",
      "evidence_due_date": "2022-07-28T16:43:00.000Z",
      "fee": 1200,
      "net_amount": -2400,
      "payment_id": "hu20sqlact5260q2nanm0q8u93",
      "reason": "fraudulent",
      "settlement_summary": {
        "settled_date": "2022-07-28"
      },
      "status": "under_review"
    }
  ],
  "total": 100
}