Disputes - List Disputes

GET /disputes/list

Description: Retrieve a list of disputes.

Example — cURL

cURL
curl --request GET \
  --url https://sandbox.hyperswitch.io/disputes/list \
  --header 'api-key: <api-key>'

Response — 200 (application/json)

The dispute list was retrieved successfully.

Example response
[
  {
    "dispute_id": "<string>",
    "payment_id": "<string>",
    "attempt_id": "<string>",
    "amount": "<string>",
    "currency": "AED",
    "dispute_stage": "pre_dispute",
    "dispute_status": "dispute_opened",
    "connector": "<string>",
    "connector_status": "<string>",
    "connector_dispute_id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "connector_reason": "<string>",
    "connector_reason_code": "<string>",
    "challenge_required_by": "2023-11-07T05:31:56Z",
    "connector_created_at": "2023-11-07T05:31:56Z",
    "connector_updated_at": "2023-11-07T05:31:56Z",
    "profile_id": "<string>",
    "merchant_connector_id": "<string>"
  }
]

Authorizations

  • api-key (string, header, required) Use the API key created under your merchant account from the HyperSwitch dashboard. API key is used to authenticate API requests from your merchant server only. Don't expose this key on a website or embed it in a mobile application.

Query parameters

  • limit — integer | null The maximum number of Dispute Objects to include in the response.

  • dispute_status — enum The status of dispute.

    Available options:

    • dispute_opened

    • dispute_expired

    • dispute_accepted

    • dispute_cancelled

    • dispute_challenged

    • dispute_won

    • dispute_lost

  • dispute_stage — enum The stage of dispute.

    Available options:

    • pre_dispute

    • dispute

    • pre_arbitration

    • arbitration

    • dispute_reversal

  • reason — string | null The reason for dispute.

  • connector — string | null The connector linked to dispute.

  • received_time — string | null The time at which dispute is received.

  • received_time.lt — string | null Time less than the dispute received time.

  • received_time.gt — string | null Time greater than the dispute received time.

  • received_time.lte — string | null Time less than or equals to the dispute received time.

  • received_time.gte — string | null Time greater than or equals to the dispute received time.

Response fields

  • dispute_id — string (required) The identifier for dispute.

  • payment_id — string (required) The identifier for payment_intent.

  • attempt_id — string (required) The identifier for payment_attempt.

  • amount — string (required) Connector specific types to send.

  • currency — enum (required) The three-letter ISO 4217 currency code for the payment amount. This field is mandatory for creating a payment.

Available currency codes (click to expand)

AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FK P, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLE, SLL, SOS, SRD, SSP, STD, STN, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VES, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW, ZWL

  • dispute_stage — enum (required) Stage of the dispute. Options: pre_dispute, dispute, pre_arbitration, arbitration, dispute_reversal.

  • dispute_status — enum (required) Status of the dispute. Options: dispute_opened, dispute_expired, dispute_accepted, dispute_cancelled, dispute_challenged, dispute_won, dispute_lost.

  • connector — string (required) Connector to which dispute is associated.

  • connector_status — string (required) Status of the dispute sent by connector.

  • connector_dispute_id — string (required) Dispute id sent by connector.

  • created_at — string (required) Time at which dispute is received.

  • connector_reason — string | null Reason of dispute sent by connector.

  • connector_reason_code — string | null Reason code of dispute sent by connector.

  • challenge_required_by — string | null Evidence deadline of dispute sent by connector.

  • connector_created_at — string | null Dispute created time sent by connector.

  • connector_updated_at — string | null Dispute updated time sent by connector.

  • profile_id — string | null The profile_id associated with the dispute.

  • merchant_connector_id — string | null The merchant_connector_id of the connector / processor through which the dispute was processed.

Suggest edits: https://github.com/juspay/hyperswitch/edit/main/api-reference/v1/disputes/disputes--list.mdx Raise issue: https://github.com/juspay/hyperswitch/issues/new?title=Issue%20on%20docs&body=Path:%20/v1/disputes/disputes--list

PreviousdisputesNextmerchant-connector-account