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

# Criar um contexto de conciliação

> Use este endpoint para criar um novo contexto de conciliação. Os contextos são usados para delimitar regras de conciliação e organizar a configuração de conciliação.



## OpenAPI

````yaml pt/openapi/v3-current/matcher.yaml post /v1/contexts
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/contexts:
    post:
      tags:
        - Configuration Contexts
      summary: Criar um contexto de conciliação
      description: >-
        Use este endpoint para criar um novo contexto de conciliação. Os
        contextos são usados para delimitar regras de conciliação e organizar a
        configuração de conciliação.
      operationId: createContext
      parameters:
        - description: A unique identifier for tracing the request across services.
          in: header
          name: X-Request-Id
          schema:
            type: string
        - $ref: '#/components/parameters/XIdempotencyKey'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateContextRequest'
        description: Payload de criação do contexto
        required: true
      responses:
        '201':
          description: >-
            Contexto criado com sucesso.


            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 reproduçã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/ReconciliationContextResponse'
          headers:
            X-Idempotency-Replayed:
              $ref: '#/components/headers/XIdempotencyReplayed'
        '400':
          description: Payload da requisição inválido
          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'
        '409':
          description: 'Conflito de idempotência: requisição com a mesma chave em andamento'
          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:
    CreateContextRequest:
      properties:
        name:
          example: Bank Reconciliation Q1
          maxLength: 100
          minLength: 1
          type: string
        type:
          allOf:
            - $ref: '#/components/schemas/ContextType'
          enum:
            - '1:1'
            - 1:N
            - N:M
          example: '1:1'
        interval:
          example: daily
          maxLength: 100
          minLength: 1
          type: string
        feeToleranceAbs:
          description: Valor absoluto de tolerância de tarifa
          example: '0.01'
          type: string
        feeTolerancePct:
          description: Tolerância de tarifa percentual
          example: '0.5'
          type: string
        feeNormalization:
          description: Modo de normalização de tarifas
          enum:
            - NET
            - GROSS
          example: NET
          type: string
        autoMatchOnUpload:
          description: >-
            Se a conciliação deve ser disparada automaticamente após o upload de
            arquivo
          example: false
          type: boolean
        sources:
          description: Lista opcional de fontes a criar junto com o contexto
          type: array
          maxItems: 10
          items:
            $ref: '#/components/schemas/CreateContextSourceRequest'
        rules:
          description: Lista opcional de regras de conciliação a criar junto com o contexto
          type: array
          maxItems: 50
          items:
            type: object
            required:
              - priority
              - type
            properties:
              priority:
                description: Prioridade da regra (número menor = maior prioridade)
                example: 1
                minimum: 1
                maximum: 1000
                type: integer
              type:
                description: Tipo de estratégia de conciliação
                enum:
                  - EXACT
                  - TOLERANCE
                  - DATE_LAG
                example: EXACT
                type: string
              config:
                description: Configuração específica da regra
                additionalProperties: {}
                type: object
      required:
        - name
        - type
        - interval
      type: object
    ReconciliationContextResponse:
      description: Contexto de configuração para regras de conciliação
      properties:
        id:
          description: Identificador único do contexto
          example: 019c96a0-10a0-72d2-9fb0-2b7de8093182
          type: string
        tenantId:
          description: ID do tenant ao qual este contexto pertence
          example: 019c96a0-0a98-7287-9a31-786e0809c769
          type: string
        name:
          description: Nome do contexto de conciliação
          example: Bank Reconciliation Q1
          type: string
        type:
          description: Tipo de topologia de conciliação
          enum:
            - '1:1'
            - 1:N
            - N:M
          example: '1:1'
          type: string
        interval:
          description: Intervalo de execução
          example: daily
          type: string
        status:
          description: Status atual do contexto
          enum:
            - DRAFT
            - ACTIVE
            - PAUSED
            - ARCHIVED
          example: ACTIVE
          type: string
        feeToleranceAbs:
          description: Valor absoluto de tolerância de tarifa
          example: '0.50'
          type: string
        feeTolerancePct:
          description: Tolerância de tarifa percentual
          example: '0.01'
          type: string
        feeNormalization:
          description: Modo de normalização de tarifas
          enum:
            - NET
            - GROSS
          example: NET
          type: string
        autoMatchOnUpload:
          description: >-
            Se a conciliação é disparada automaticamente após o upload de
            arquivo
          example: false
          type: boolean
        createdAt:
          description: Timestamp de criação no formato RFC3339
          example: '2025-01-15T10:30:00.000Z'
          type: string
        updatedAt:
          description: Timestamp da última atualização no formato RFC3339
          example: '2025-01-15T10:30:00.000Z'
          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
    ContextType:
      description: Topologia de conciliação (cardinalidade entre fontes)
      enum:
        - '1:1'
        - 1:N
        - N:M
      type: string
      x-enum-varnames:
        - ContextTypeOneToOne
        - ContextTypeOneToMany
        - ContextTypeManyToMany
    CreateContextSourceRequest:
      description: Payload da requisição para criar uma fonte junto com um contexto
      type: object
      properties:
        name:
          description: Nome da fonte
          example: Primary Bank Account
          maxLength: 50
          minLength: 1
          type: string
        type:
          description: Tipo de fonte
          enum:
            - LEDGER
            - BANK
            - GATEWAY
            - CUSTOM
            - FETCHER
          example: BANK
          type: string
        side:
          description: Qual lado da conciliação esta fonte representa
          enum:
            - LEFT
            - RIGHT
          example: LEFT
          type: string
        config:
          description: Configuração específica da fonte
          additionalProperties: {}
          type: object
        mapping:
          description: Mapeamento de campos opcional para esta fonte
          additionalProperties: {}
          type: object
      required:
        - name
        - side
        - type
  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}")'

````