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": "<string>",
      "payment_intent_id": "<string>",
      "amount": 123,
      "currency": "<string>",
      "metadata": {},
      "created_at": "<string>",
      "status": "<unknown>",
      "reason": "bank_cannot_process",
      "is_charge_refundable": true,
      "test_mode": true,
      "charge_id": "<string>",
      "evidence_details": {
        "has_evidence": true,
        "past_due": true,
        "submission_count": 123,
        "due_by": "<string>"
      },
      "balance_transactions": [
        {
          "balance_transaction_id": "<string>",
          "amount": 123,
          "fee": 123,
          "net": 123,
          "status": "available",
          "type": "<string>",
          "reporting_category": "<string>",
          "created_at": "<string>"
        }
      ],
      "payment_method_details": {
        "type": "<string>",
        "card": {
          "brand": "<string>",
          "network_reason_code": "<string>"
        }
      },
      "client_reference_id": "<string>"
    }
  ]
}

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).

​
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.

​
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.

​
charge
string | null

Filter by charge ID.

​
payment_intent
string | null

Filter by payment intent ID.

Response

​
disputes
object[]
required