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

# Pré-visualizar um arquivo de transações

> Use este endpoint para visualizar um arquivo de transações antes de importá-lo. Retorna linhas de amostra e colunas detectadas para ajudar a verificar a estrutura do arquivo e o mapeamento de campos.



## OpenAPI

````yaml pt/openapi/v3-current/matcher.yaml post /v1/imports/contexts/{contextId}/sources/{sourceId}/preview
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/imports/contexts/{contextId}/sources/{sourceId}/preview:
    post:
      tags:
        - Ingestion
      summary: Pré-visualizar um arquivo de transações
      description: >-
        Use este endpoint para visualizar um arquivo de transações antes de
        importá-lo. Retorna linhas de amostra e colunas detectadas para ajudar a
        verificar a estrutura do arquivo e o mapeamento de campos.
      operationId: previewFile
      parameters:
        - description: A unique identifier for tracing the request across services.
          in: header
          name: X-Request-Id
          schema:
            type: string
        - description: The unique identifier of the reconciliation context.
          in: path
          name: contextId
          required: true
          schema:
            type: string
        - description: The unique identifier of the reconciliation source.
          in: path
          name: sourceId
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/XIdempotencyKey'
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                file:
                  description: Arquivo de transações para visualização (CSV, JSON ou XML)
                  type: string
                  format: binary
                format:
                  description: >-
                    Formato do arquivo (detectado automaticamente pelo nome do
                    arquivo se omitido)
                  type: string
                  enum:
                    - csv
                    - json
                    - xml
                max_rows:
                  description: Número máximo de linhas de amostra a retornar
                  type: integer
                  minimum: 1
                  maximum: 20
                  default: 5
              required:
                - file
        required: true
      responses:
        '200':
          description: >-
            Pré-visualização do arquivo com colunas detectadas e linhas de
            amostra.


            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 [Retentativas e
            idempotência](/pt/reference/retries-idempotency) para mais detalhes.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilePreviewResponse'
          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'
        '404':
          description: Contexto ou fonte não encontrado
          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:
  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:
    FilePreviewResponse:
      description: >-
        Pré-visualização de um arquivo de transações com colunas detectadas e
        dados de amostra
      type: object
      properties:
        columns:
          type: array
          items:
            type: string
          description: Nomes de colunas detectados
          example:
            - date
            - amount
            - reference
            - description
        sampleRows:
          type: array
          items:
            items:
              type: string
            type: array
          description: Linhas de dados de amostra
        rowCount:
          type: integer
          description: Número de linhas de amostra retornadas
          example: 5
        format:
          type: string
          description: Formato de arquivo detectado
          example: csv
    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:
    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}")'

````