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

# Cancelar uma tarefa de exportação

> Use este endpoint para cancelar uma tarefa de exportação em fila ou em execução.



## OpenAPI

````yaml pt/openapi/v3-current/matcher.yaml post /v1/export-jobs/{jobId}/cancel
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/export-jobs/{jobId}/cancel:
    post:
      tags:
        - Export Jobs
      summary: Cancelar uma tarefa de exportação
      description: >-
        Use este endpoint para cancelar uma tarefa de exportação em fila ou em
        execução.
      operationId: cancelExportJob
      parameters:
        - description: A unique identifier for tracing the request across services.
          in: header
          name: X-Request-Id
          schema:
            type: string
        - description: Export Job ID
          in: path
          name: jobId
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/XIdempotencyKey'
      responses:
        '200':
          description: >-
            Indica que a requisição foi bem-sucedida e a resposta contém os
            dados esperados.


            A resposta inclui o cabeçalho `X-Idempotency-Replayed`.


            Se o valor for false, a requisição acabou de ser processada. Se o
            valor for true, a resposta é uma repetição de uma requisição
            processada anteriormente.


            Consulte [Retries and
            idempotency](/pt/reference/retries-idempotency) para mais detalhes.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExportJobResponse'
          headers:
            X-Idempotency-Replayed:
              $ref: '#/components/headers/XIdempotencyReplayed'
        '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'
              examples:
                ErrorM0103:
                  $ref: '#/components/examples/ErrorM0103'
        '404':
          description: O recurso solicitado não foi encontrado.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '409':
          description: Tarefa em estado terminal ou conflito de idempotência
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Ocorreu um erro inesperado no servidor.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - BearerAuth: []
components:
  parameters:
    XIdempotencyKey:
      name: X-Idempotency-Key
      in: header
      required: false
      description: >-
        Chave de idempotência opcional para novas tentativas seguras. Também
        aceita `Idempotency-Key` como nome alternativo do cabeçalho. Se a mesma
        chave for enviada novamente e a requisição original já tiver sido
        processada, a resposta em cache é retornada com `X-Idempotency-Replayed:
        true`.


        Consulte [Novas tentativas e
        idempotência](/pt/reference/retries-idempotency) para mais detalhes.
      schema:
        type: string
  schemas:
    ExportJobResponse:
      properties:
        bytesWritten:
          type: integer
        createdAt:
          type: string
        downloadUrl:
          type: string
        error:
          type: string
        expiresAt:
          type: string
        fileName:
          type: string
        finishedAt:
          type: string
        format:
          type: string
        id:
          type: string
        recordsWritten:
          type: integer
        reportType:
          type: string
        startedAt:
          type: string
        status:
          type: string
      type: object
    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
  headers:
    XIdempotencyReplayed:
      description: >-
        Indica se esta resposta foi servida a partir do cache de idempotência.
        Quando `true`, a resposta é uma repetição da requisição original com a
        mesma chave de idempotência.


        Consulte [Novas tentativas e
        idempotência](/pt/reference/retries-idempotency) para mais detalhes.
      schema:
        type: boolean
      example: false
  examples:
    ErrorM0103:
      summary: Insufficient Privileges
      value:
        code: MTCH-0004
        title: Forbidden
        message: >-
          You do not have the necessary permissions to perform this action.
          Please contact your administrator if you believe this is an error.
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: 'Autenticação por Bearer token (formato: "Bearer {token}")'

````