> ## Documentation Index > Fetch the complete documentation index at: https://api-reference.hyperswitch.io/llms.txt > Use this file to discover all available pages before exploring further. # Disputes - List Disputes > Lists all the Disputes for a merchant ## OpenAPI ````yaml get /disputes/list openapi: 3.0.3 info: title: Hyperswitch - API Documentation description: > ## Get started Hyperswitch provides a collection of APIs that enable you to process and manage payments. Our APIs accept and return JSON in the HTTP body, and return standard HTTP response codes. You can consume the APIs directly using your favorite HTTP/REST library. We have a testing environment referred to "sandbox", which you can setup to test API calls without affecting production data. Currently, our sandbox environment is live while our production environment is under development and will be available soon. You can sign up on our Dashboard to get API keys to access Hyperswitch API. ### Environment Use the following base URLs when making requests to the APIs: | Environment | Base URL | |---------------|------------------------------------| | Sandbox | | | Production | | ## Authentication When you sign up on our [dashboard](https://app.hyperswitch.io) and create a merchant account, you are given a secret key (also referred as api-key) and a publishable key. You may authenticate all API requests with Hyperswitch server by providing the appropriate key in the request Authorization header. | Key | Description | |-----------------|-----------------------------------------------------------------------------------------------| | api-key | Private key. Used to authenticate all API requests from your merchant server | | publishable key | Unique identifier for your account. Used to authenticate API requests from your app's client | Never share your secret api keys. Keep them guarded and secure. contact: name: Hyperswitch Support url: https://hyperswitch.io email: support.global@juspay.io license: name: Apache-2.0 version: 0.1.0 servers: - url: https://sandbox.hyperswitch.io description: Sandbox Environment security: [] tags: - name: Merchant Account description: Create and manage merchant accounts - name: Profile description: Create and manage profiles - name: Merchant Connector Account description: Create and manage merchant connector accounts - name: Payments description: Create and manage one-time payments, recurring payments and mandates - name: Refunds description: Create and manage refunds for successful payments - name: Mandates description: Manage mandates - name: Customers description: Create and manage customers - name: Payment Methods description: Create and manage payment methods of customers - name: Disputes description: Manage disputes - name: API Key description: Create and manage API Keys - name: Payouts description: Create and manage payouts - name: payment link description: Create payment link - name: Routing description: Create and manage routing configurations - name: Event description: Manage events - name: Authentication description: Create and manage authentication - name: Subscriptions description: Subscription management and billing endpoints - name: Card Issuer description: Create and manage card issuers paths: /disputes/list: get: tags: - Disputes summary: Disputes - List Disputes description: Lists all the Disputes for a merchant operationId: List Disputes parameters: - name: limit in: query description: The maximum number of Dispute Objects to include in the response required: false schema: type: integer format: int64 nullable: true - name: dispute_status in: query description: The status of dispute required: false schema: allOf: - $ref: '#/components/schemas/DisputeStatus' nullable: true - name: dispute_stage in: query description: The stage of dispute required: false schema: allOf: - $ref: '#/components/schemas/DisputeStage' nullable: true - name: reason in: query description: The reason for dispute required: false schema: type: string nullable: true - name: connector in: query description: The connector linked to dispute required: false schema: type: string nullable: true - name: received_time in: query description: The time at which dispute is received required: false schema: type: string format: date-time nullable: true - name: received_time.lt in: query description: Time less than the dispute received time required: false schema: type: string format: date-time nullable: true - name: received_time.gt in: query description: Time greater than the dispute received time required: false schema: type: string format: date-time nullable: true - name: received_time.lte in: query description: Time less than or equals to the dispute received time required: false schema: type: string format: date-time nullable: true - name: received_time.gte in: query description: Time greater than or equals to the dispute received time required: false schema: type: string format: date-time nullable: true responses: '200': description: The dispute list was retrieved successfully content: application/json: schema: type: array items: $ref: '#/components/schemas/DisputeResponse' '401': description: Unauthorized request security: - api_key: [] components: schemas: DisputeStatus: type: string description: Status of the dispute enum: - dispute_opened - dispute_expired - dispute_accepted - dispute_cancelled - dispute_challenged - dispute_won - dispute_lost DisputeStage: type: string description: Stage of the dispute enum: - pre_dispute - dispute - pre_arbitration - arbitration - dispute_reversal DisputeResponse: type: object required: - dispute_id - payment_id - attempt_id - amount - currency - dispute_stage - dispute_status - connector - connector_status - connector_dispute_id - created_at - is_already_refunded properties: dispute_id: type: string description: The identifier for dispute payment_id: type: string description: The identifier for payment_intent attempt_id: type: string description: The identifier for payment_attempt amount: $ref: '#/components/schemas/StringMinorUnit' currency: $ref: '#/components/schemas/Currency' dispute_stage: $ref: '#/components/schemas/DisputeStage' dispute_status: $ref: '#/components/schemas/DisputeStatus' connector: type: string description: connector to which dispute is associated with connector_status: type: string description: Status of the dispute sent by connector connector_dispute_id: type: string description: Dispute id sent by connector connector_reason: type: string description: Reason of dispute sent by connector nullable: true connector_reason_code: type: string description: Reason code of dispute sent by connector nullable: true challenge_required_by: type: string format: date-time description: Evidence deadline of dispute sent by connector nullable: true connector_created_at: type: string format: date-time description: Dispute created time sent by connector nullable: true connector_updated_at: type: string format: date-time description: Dispute updated time sent by connector nullable: true created_at: type: string format: date-time description: Time at which dispute is received profile_id: type: string description: The `profile_id` associated with the dispute nullable: true merchant_connector_id: type: string description: >- The `merchant_connector_id` of the connector / processor through which the dispute was processed nullable: true is_already_refunded: type: boolean description: >- Shows if the disputed amount(dispute_lost statuses only) + refunded amount is greater than captured amount StringMinorUnit: type: string description: Connector specific types to send Currency: type: string description: >- The three-letter ISO 4217 currency code (e.g., "USD", "EUR") for the payment amount. This field is mandatory for creating a payment. enum: - 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 - FKP - 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 securitySchemes: api_key: type: apiKey in: header name: api-key description: >- 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. ````