Skip to main content
GET
/
v1
/
disputes
List Disputes
curl --request GET \
  --url https://api.withflex.com/v1/disputes \
  --header 'Authorization: Bearer <token>'
{
  "disputes": [
    {
      "dispute_id": "obj_01EXAMPLE00000000000000000",
      "payment_intent_id": "obj_01EXAMPLE00000000000000000",
      "amount": 0,
      "currency": "usd",
      "charge_id": "obj_01EXAMPLE00000000000000000",
      "metadata": {},
      "created_at": "2024-01-01T00:00:00Z",
      "reason": "bank_cannot_process",
      "is_charge_refundable": false,
      "evidence": {},
      "evidence_details": {},
      "balance_transactions": [],
      "payment_method_details": {},
      "test_mode": false,
      "client_reference_id": "obj_01EXAMPLE00000000000000000"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Use a Bearer token to access this API.

Query Parameters

​
limit
integer<int64> | null

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

Example:

10

​
starting_after
string | null

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 fdsp_xyz, your subsequent call can include starting_after=fdsp_xyz to fetch the next page of the list.

Example:

"obj_01EXAMPLE00000000000000000"

​
ending_before
string | null

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 fdsp_abc, your subsequent call can include ending_before=fdsp_abc to fetch the previous page of the list.

Example:

"obj_01EXAMPLE00000000000000000"

​
charge
string | null

Filter by charge ID.

Example:

"obj_01EXAMPLE00000000000000000"

​
payment_intent
string | null

Filter by payment intent ID.

Example:

"obj_01EXAMPLE00000000000000000"

​
statuses
enum<string>[] | null

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

Status of a dispute, matching Stripe's dispute statuses. Note: Prevented is a Flex-internal status for disputes that were prevented before being filed with the payment network.

Available options:
lost,
needs_response,
under_review,
warning_closed,
warning_needs_response,
warning_under_review,
won
Example:

"lost"

Example:

"needs_response"

​
expand
string
default:""

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

Response

Success

​
disputes
object[]
required