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

# Open a dispute

> Use this endpoint to open a new dispute for an exception. Disputes are used to formally challenge or investigate discrepancies with external parties.



## OpenAPI

````yaml /en/openapi/v3-current/matcher.yaml post /v1/exceptions/{exceptionId}/disputes
openapi: 3.1.0
info:
  title: Matcher APIs
  description: >-
    Complete API reference for the Matcher reconciliation engine, providing
    automated transaction matching between Midaz Ledger and external systems.
  version: v2.1.1
  license:
    name: Elastic License 2.0
    url: https://www.elastic.co/licensing/elastic-license
servers:
  - url: https://matcher.sandbox.lerian.net
security: []
paths:
  /v1/exceptions/{exceptionId}/disputes:
    post:
      tags:
        - Exception
      summary: Open a dispute
      description: >-
        Use this endpoint to open a new dispute for an exception. Disputes are
        used to formally challenge or investigate discrepancies with external
        parties.
      operationId: openDispute
      parameters:
        - description: A unique identifier for tracing the request across services.
          in: header
          name: X-Request-Id
          schema:
            type: string
        - $ref: '#/components/parameters/XIdempotencyKey'
        - description: Exception ID
          in: path
          name: exceptionId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OpenDisputeRequest'
        description: Open dispute payload
        required: true
      responses:
        '201':
          description: >-
            Indicates that the resource was successfully created.


            The response includes the `X-Idempotency-Replayed` header.


            If the value is false, the request was just processed. If the value
            is true, the response is a replay of a previously processed request.


            See [Retries and idempotency](/en/reference/retries-idempotency) for
            more details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DisputeResponse'
          headers:
            X-Idempotency-Replayed:
              $ref: '#/components/headers/XIdempotencyReplayed'
        '400':
          description: The request contains invalid parameters or payload.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: The request lacks valid authentication credentials.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: You do not have permission to access this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: The requested resource was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An unexpected error occurred on the server.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - BearerAuth: []
components:
  parameters:
    XIdempotencyKey:
      name: X-Idempotency-Key
      in: header
      required: false
      description: >-
        Optional idempotency key for safe retries. Also accepts
        `Idempotency-Key` as an alternative header name. If the same key is sent
        again and the original request was already processed, the cached
        response is returned with `X-Idempotency-Replayed: true`.


        See [Retries and idempotency](/en/reference/retries-idempotency) for
        details.
      schema:
        type: string
  schemas:
    OpenDisputeRequest:
      description: Open dispute request payload
      properties:
        category:
          description: Category of the dispute
          example: AMOUNT_MISMATCH
          maxLength: 255
          type: string
        description:
          description: Detailed description of the dispute
          example: Transaction amount differs from invoice
          maxLength: 5000
          type: string
      required:
        - category
        - description
      type: object
    DisputeResponse:
      description: Dispute details
      properties:
        category:
          description: Category of the dispute
          enum:
            - BANK_FEE_ERROR
            - UNRECOGNIZED_CHARGE
            - DUPLICATE_TRANSACTION
            - OTHER
          example: BANK_FEE_ERROR
          type: string
        createdAt:
          description: Creation timestamp in RFC3339 format
          example: '2025-01-15T10:30:00.000Z'
          type: string
        description:
          description: Description of the dispute
          example: Transaction amount differs from expected
          type: string
        evidence:
          description: Evidence submitted for this dispute
          items:
            $ref: '#/components/schemas/EvidenceResponse'
          type: array
        exceptionId:
          description: Exception ID this dispute is for
          example: 019c96a0-10d2-7134-ba5f-664142ee7052
          type: string
        id:
          description: Unique identifier for the dispute
          example: 019c96a0-10d2-7193-8841-0d7347efd09a
          type: string
        openedBy:
          description: User who opened the dispute
          example: user@example.com
          type: string
        reopenReason:
          description: Reason for reopening if reopened
          example: New evidence discovered
          type: string
        resolution:
          description: Resolution description when closed
          example: Counterparty confirmed error
          type: string
        state:
          description: Current state
          enum:
            - DRAFT
            - OPEN
            - PENDING_EVIDENCE
            - WON
            - LOST
          example: OPEN
          type: string
        updatedAt:
          description: Last update timestamp in RFC3339 format
          example: '2025-01-15T10:30:00.000Z'
          type: string
      type: object
    ErrorResponse:
      description: Standard error response returned by all API endpoints
      type: object
      required:
        - code
        - title
        - message
      properties:
        code:
          type: string
          description: HTTP status code as a string.
          example: '404'
        title:
          type: string
          description: Error type identifier.
          example: not_found
        message:
          type: string
          description: Human-readable error message with details.
          example: context not found
        error:
          type: string
          description: Deprecated. Error message for backward compatibility.
          deprecated: true
        details:
          description: Additional error context as key-value pairs
          additionalProperties: {}
          type: object
    EvidenceResponse:
      description: Evidence details
      properties:
        comment:
          description: Comment describing the evidence
          example: Bank statement attached
          type: string
        disputeId:
          description: Dispute ID this evidence belongs to
          example: 019c96a0-10d2-7193-8841-0d7347efd09a
          type: string
        fileUrl:
          description: URL to evidence file
          example: https://storage.example.com/evidence/doc123.pdf
          type: string
        id:
          description: Unique identifier for the evidence
          example: 019c96a0-0c0d-7915-84b9-e497bfee9916
          type: string
        submittedAt:
          description: When the evidence was submitted in RFC3339 format
          example: '2025-01-15T10:30:00.000Z'
          type: string
        submittedBy:
          description: User who submitted the evidence
          example: user@example.com
          type: string
      type: object
  headers:
    XIdempotencyReplayed:
      description: >-
        Indicates whether this response was served from the idempotency cache.
        When `true`, the response is a replay of the original request with the
        same idempotency key.


        See [Retries and idempotency](/en/reference/retries-idempotency) for
        details.
      schema:
        type: boolean
      example: false
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: 'Bearer token authentication (format: "Bearer {token}")'

````