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

# Simular cálculo de tarifa

> Use este endpoint para simular o cálculo de tarifas para um valor bruto específico usando uma tabela de tarifas. Retorna o valor líquido, a tarifa total e o detalhamento por item.



## OpenAPI

````yaml pt/openapi/v3-current/matcher.yaml post /v1/fee-schedules/{scheduleId}/simulate
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/fee-schedules/{scheduleId}/simulate:
    post:
      tags:
        - Configuration Fee Schedules
      summary: Simular cálculo de tarifa
      description: >-
        Use este endpoint para simular o cálculo de tarifas para um valor bruto
        específico usando uma tabela de tarifas. Retorna o valor líquido, a
        tarifa total e o detalhamento por item.
      operationId: simulateFeeSchedule
      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 fee schedule.
          in: path
          name: scheduleId
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/XIdempotencyKey'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SimulateFeeRequest'
        description: Payload de simulação de tarifa
        required: true
      responses:
        '200':
          description: >-
            Resultado da simulação de tarifa.


            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/SimulateFeeResponse'
          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'
        '404':
          description: Tabela de tarifas não encontrada
          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:
    SimulateFeeRequest:
      description: Payload para simular o cálculo de tarifas em uma tabela de tarifas
      properties:
        grossAmount:
          description: Valor bruto da transação sobre o qual simular as tarifas
          example: '100.00'
          type: string
        currency:
          description: Código de moeda (ISO 4217)
          example: USD
          type: string
      required:
        - grossAmount
        - currency
      type: object
    SimulateFeeResponse:
      description: Resultado de uma simulação de tarifa
      properties:
        grossAmount:
          description: Valor bruto original
          example: '100.00'
          type: string
        netAmount:
          description: Valor após a dedução das tarifas
          example: '97.70'
          type: string
        totalFee:
          description: Valor total das tarifas
          example: '2.30'
          type: string
        currency:
          description: Código de moeda (ISO 4217)
          example: USD
          type: string
        items:
          description: Detalhamento dos itens de tarifa individuais
          items:
            $ref: '#/components/schemas/SimulateFeeItem'
          maxItems: 100
          type: array
      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
    SimulateFeeItem:
      description: Um único item de tarifa no resultado de uma simulação
      properties:
        name:
          description: Nome do item de tarifa
          example: interchange
          type: string
        fee:
          description: Valor calculado da tarifa
          example: '1.50'
          type: string
        baseUsed:
          description: Valor base utilizado para o cálculo desta tarifa
          example: '100.00'
          type: string
      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
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: 'Autenticação por Bearer token (formato: "Bearer {token}")'

````