> ## Documentation Index
> Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt
> Use this file to discover all available pages before exploring further.

# Listar disputas

> Use este endpoint para recuperar todas as disputas. Suporta filtragem por estado, categoria e intervalo de datas com paginação por cursor.



## OpenAPI

````yaml pt/openapi/v3-current/matcher.yaml get /v1/disputes
openapi: 3.1.0
info:
  title: Matcher APIs
  description: >-
    Referência completa de API para o motor de conciliação Matcher, que fornece
    conciliação automática de transações entre o Midaz Ledger e sistemas
    externos.
  version: 4.1.0
  license:
    name: Lerian Studio General License
servers:
  - url: https://matcher.sandbox.lerian.net
security: []
paths:
  /v1/disputes:
    get:
      tags:
        - Exception
      summary: Listar disputas
      description: >-
        Use este endpoint para recuperar todas as disputas. Suporta filtragem
        por estado, categoria e intervalo de datas com paginação por cursor.
      operationId: listDisputes
      parameters:
        - description: A unique identifier for tracing the request across services.
          in: header
          name: X-Request-Id
          schema:
            type: string
        - description: The maximum number of items to include in the response.
          in: query
          name: limit
          schema:
            type: integer
            minimum: 1
            maximum: 200
            default: 20
        - description: The cursor value for retrieving the next page of results.
          in: query
          name: cursor
          schema:
            type: string
        - description: Filter by dispute state
          in: query
          name: state
          schema:
            type: string
            enum:
              - DRAFT
              - OPEN
              - PENDING_EVIDENCE
              - WON
              - LOST
        - description: Filter by dispute category
          in: query
          name: category
          schema:
            type: string
            enum:
              - BANK_FEE_ERROR
              - UNRECOGNIZED_CHARGE
              - DUPLICATE_TRANSACTION
              - OTHER
        - description: Start date filter (RFC 3339 format)
          in: query
          name: date_from
          schema:
            type: string
            format: date-time
        - description: End date filter (RFC 3339 format)
          in: query
          name: date_to
          schema:
            type: string
            format: date-time
      responses:
        '200':
          description: Lista de disputas com paginação por cursor
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListDisputesResponse'
        '400':
          description: A requisição contém parâmetros ou payload inválidos.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: A requisição não contém credenciais de autenticação válidas.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Você não tem permissão para acessar este recurso.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Ocorreu um erro inesperado no servidor.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                ErrorM0002:
                  $ref: '#/components/examples/ErrorM0002'
      security:
        - BearerAuth: []
components:
  schemas:
    ListDisputesResponse:
      description: Lista paginada de disputas
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/DisputeResponse'
        nextCursor:
          type: string
          description: Cursor para a próxima página de resultados
        prevCursor:
          type: string
          description: Cursor para a página anterior de resultados
        limit:
          type: integer
          description: Máximo de itens por página
          example: 20
        hasMore:
          type: boolean
          description: Se há mais resultados disponíveis
    ErrorResponse:
      description: Resposta de erro padrão retornada por todos os endpoints da API
      type: object
      required:
        - code
        - title
        - message
      properties:
        code:
          type: string
          description: Código de erro de aplicação estável.
          example: MTCH-0001
        title:
          type: string
          description: Título de erro legível por humanos.
          example: Bad Request
        message:
          type: string
          description: Mensagem de erro legível com detalhes.
          example: context not found
        error:
          type: string
          description: Descontinuado. Mensagem de erro para compatibilidade retroativa.
          deprecated: true
        details:
          description: Contexto adicional do erro como pares chave-valor
          additionalProperties: {}
          type: object
    DisputeResponse:
      description: Detalhes da disputa
      properties:
        category:
          description: Categoria da disputa
          enum:
            - BANK_FEE_ERROR
            - UNRECOGNIZED_CHARGE
            - DUPLICATE_TRANSACTION
            - OTHER
          example: BANK_FEE_ERROR
          type: string
        createdAt:
          description: Timestamp de criação no formato RFC3339
          example: '2025-01-15T10:30:00.000Z'
          type: string
        description:
          description: Descrição da disputa
          example: Transaction amount differs from expected
          type: string
        evidence:
          description: Evidências enviadas para esta disputa
          items:
            $ref: '#/components/schemas/EvidenceResponse'
          type: array
        exceptionId:
          description: ID da exceção à qual esta disputa se refere
          example: 019c96a0-10d2-7134-ba5f-664142ee7052
          type: string
        id:
          description: Identificador único da disputa
          example: 019c96a0-10d2-7193-8841-0d7347efd09a
          type: string
        openedBy:
          description: Usuário que abriu a disputa
          example: user@example.com
          type: string
        reopenReason:
          description: Motivo para reabertura, se reaberta
          example: New evidence discovered
          type: string
        resolution:
          description: Descrição da resolução ao ser encerrada
          example: Counterparty confirmed error
          type: string
        state:
          description: Estado atual
          enum:
            - DRAFT
            - OPEN
            - PENDING_EVIDENCE
            - WON
            - LOST
          example: OPEN
          type: string
        updatedAt:
          description: Timestamp da última atualização no formato RFC3339
          example: '2025-01-15T10:30:00.000Z'
          type: string
      type: object
    EvidenceResponse:
      description: Detalhes da evidência
      properties:
        comment:
          description: Comentário descrevendo a evidência
          example: Bank statement attached
          type: string
        disputeId:
          description: ID da disputa à qual esta evidência pertence
          example: 019c96a0-10d2-7193-8841-0d7347efd09a
          type: string
        fileUrl:
          description: URL para o arquivo de evidência
          example: https://storage.example.com/evidence/doc123.pdf
          type: string
        id:
          description: Identificador único da evidência
          example: 019c96a0-0c0d-7915-84b9-e497bfee9916
          type: string
        submittedAt:
          description: Quando a evidência foi enviada no formato RFC3339
          example: '2025-01-15T10:30:00.000Z'
          type: string
        submittedBy:
          description: Usuário que enviou a evidência
          example: user@example.com
          type: string
      type: object
  examples:
    ErrorM0002:
      summary: Internal Server Error
      value:
        code: MTCH-0002
        title: Internal Server Error
        message: internal server error
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: 'Autenticação por Bearer token (formato: "Bearer {token}")'

````