Sign in

v1

latestOpenAPI 3.1.02026-07-2684271522.2 KB
Disputes

List Disputes

Returns a list of your disputes, most recent first.

Evidence is omitted by default; pass expand=evidence to include the parsed evidence for each dispute.

get/v1/disputes

Query parameters

limitinteger nullable

Maximum number of disputes to return (default 20, max 100).

Example:10

Maximum number of disputes to return (default 20, max 100).

starting_afterstring nullable

A cursor for use in pagination. starting_after is a dispute ID that defines your place in the list. For instance, if you make a list request and receive 20 disputes, ending with fdp_xyz, your subsequent call can include starting_after=fdp_xyz to fetch the next page of the list.

Example:fdp_01J9XR8M3K7VZ8N2YB4WJ6T0RA

A cursor for use in pagination. starting_after is a dispute ID that defines your place in the list. For instance, if you make a list request and receive 20 disputes, ending with fdp_xyz, your subsequent call can include starting_after=fdp_xyz to fetch the next page of the list.

ending_beforestring nullable

A cursor for use in pagination. ending_before is a dispute ID that defines your place in the list. For instance, if you make a list request and receive 20 disputes, starting with fdp_abc, your subsequent call can include ending_before=fdp_abc to fetch the previous page of the list.

Example:fdp_01J9XR8M3K7VZ8N2YB4WJ6T0RA

A cursor for use in pagination. ending_before is a dispute ID that defines your place in the list. For instance, if you make a list request and receive 20 disputes, starting with fdp_abc, your subsequent call can include ending_before=fdp_abc to fetch the previous page of the list.

chargestring nullable

Filter by charge ID.

Example:fch_01J9XR8M3K7VZ8N2YB4WJ6T0RA

Filter by charge ID.

payment_intentstring nullable

Filter by payment intent ID.

Example:fpi_01J9XR8M3K7VZ8N2YB4WJ6T0RA

Filter by payment intent ID.

Filter by dispute statuses (comma-separated, e.g. ?statuses=needs_response,under_review).

expandstring

Comma-separated list of fields to expand (e.g., ?expand=evidence).

Comma-separated list of fields to expand (e.g., ?expand=evidence).

Response

An envelope wrapping a list of dispute objects.

Example response

{
  "disputes": [
    {
      "dispute_id": "fdp_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
      "payment_intent_id": "fpi_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
      "checkout_session_id": "fcs_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
      "amount": 2500,
      "currency": "usd",
      "charge_id": "fch_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
      "metadata": {
        "order_id": "8842",
        "channel": "shopify"
      },
      "created_at": "2026-06-15T14:30:00Z",
      "reason": "bank_cannot_process",
      "is_charge_refundable": false,
      "test_mode": false,
      "client_reference_id": "obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA"
    }
  ]
}