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

# Dispatch exception to external system

> Use this endpoint to dispatch an exception to an external ticketing system such as JIRA or ServiceNow for tracking and resolution.



## OpenAPI

````yaml /en/openapi/v3-current/matcher.yaml post /v1/exceptions/{exceptionId}/dispatch
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}/dispatch:
    post:
      tags:
        - Exception
      summary: Dispatch exception to external system
      description: >-
        Use this endpoint to dispatch an exception to an external ticketing
        system such as JIRA or ServiceNow for tracking and resolution.
      operationId: dispatchException
      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/DispatchRequest'
        description: Dispatch payload
        required: true
      responses:
        '200':
          description: >-
            Indicates that the request was successful and the response contains
            the expected data.


            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/DispatchResponse'
          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'
        '422':
          description: The request was well-formed but contains semantic errors.
          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:
    DispatchRequest:
      description: Dispatch request payload
      properties:
        queue:
          description: Optional queue or team assignment
          example: RECON-TEAM
          maxLength: 255
          type: string
        targetSystem:
          description: Target system to dispatch to
          enum:
            - JIRA
            - SERVICENOW
            - WEBHOOK
            - MANUAL
          example: JIRA
          maxLength: 255
          type: string
      required:
        - targetSystem
      type: object
    DispatchResponse:
      description: Dispatch result
      properties:
        acknowledged:
          description: Whether the dispatch was acknowledged
          example: true
          type: boolean
        dispatchedAt:
          description: When the dispatch occurred in RFC3339 format
          example: '2025-01-15T10:30:00.000Z'
          type: string
        exceptionId:
          description: Exception ID that was dispatched
          example: 019c96a0-10d2-7134-ba5f-664142ee7052
          type: string
        externalReference:
          description: External reference ID from target system
          example: RECON-1234
          type: string
        target:
          description: Target system dispatched to
          example: JIRA
          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
  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}")'

````