Sign in

v1

latestOpenAPI 3.0.0Apache 2.02026-07-143281,4552.1 MB
Disputes

ListDisputes

Returns a list of disputes associated with a particular account.

get/v2/disputes

Query parameters

cursorstring

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.

states'INQUIRY_EVIDENCE_REQUIRED' | 'INQUIRY_PROCESSING' | 'INQUIRY_CLOSED' | 'EVIDENCE_REQUIRED' | 'PROCESSING' | 'WON' | 'LOST' | 'ACCEPTED'

The list of possible dispute states.

The dispute states used to filter the result. If not specified, the endpoint returns all disputes.

location_idstring

The ID of the location for which to return a list of disputes. If not specified, the endpoint returns disputes associated with all locations.

Response

Success

cursorstring

The pagination cursor to be used in a subsequent request. If unset, this is the final response. For more information, see Pagination.

Example response

{
  "cursor": "G1aSTRm48CLjJsg6Sg3hQN1b1OMaoVuG",
  "disputes": [
    {
      "amount_money": {
        "amount": 2500,
        "currency": "USD"
      },
      "brand_dispute_id": "100000809947",
      "card_brand": "VISA",
      "created_at": "2022-06-29T18:45:22.265Z",
      "disputed_payment": {
        "payment_id": "zhyh1ch64kRBrrlfVhwjCEjZWzNZY"
      },
      "due_at": "2022-07-13T00:00:00.000Z",
      "id": "XDgyFu7yo1E2S5lQGGpYn",
      "location_id": "L1HN3ZMQK64X9",
      "reason": "NO_KNOWLEDGE",
      "reported_at": "2022-06-29T00:00:00.000Z",
      "state": "ACCEPTED",
      "updated_at": "2022-07-07T19:14:42.650Z",
      "version": 2
    },
    {
      "amount_money": {
        "amount": 2209,
        "currency": "USD"
      },
      "brand_dispute_id": "r5Of6YaGT7AdeRaVoAGCJw",
      "card_brand": "VISA",
      "created_at": "2022-04-29T18:45:22.265Z",
      "disputed_payment": {
        "payment_id": "zhyh1ch64kRBrrlfVhwjCEjZWzNZY"
      },
      "due_at": "2022-05-13T00:00:00.000Z",
      "id": "jLGg7aXC7lvKPr9PISt0T",
      "location_id": "18YC4JDH91E1H",
      "reason": "NOT_AS_DESCRIBED",
      "reported_at": "2022-04-29T00:00:00.000Z",
      "state": "EVIDENCE_REQUIRED",
      "updated_at": "2022-04-29T18:45:22.265Z",
      "version": 1
    }
  ]
}