Pular para o conteúdo principal

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.

Pacotes de Taxa são os blocos de construção do Fees Engine. Cada pacote define um conjunto de Regras de Taxa e as condições sob as quais elas se aplicam às Transações.
O plugin Fees Engine precisa estar habilitado nas configurações do Módulo Midaz para que esta página fique disponível.

​
O que um Pacote de Taxa contém

Um Pacote de Taxa permite que você:
  • Defina regras de cálculo de taxas — taxas fixas, taxas baseadas em porcentagem ou cálculos combinados.
  • Defina faixas de valores — aplique taxas apenas a transações dentro de uma faixa mín/máx.
  • Vincule a Rotas de Transação — direcione fluxos de transação específicos.
  • Isente taxas para contas específicas — exclua contas de origem selecionadas.
  • Priorize a aplicação de taxas — controle a ordem em que múltiplas taxas são aplicadas.
Pacotes de Taxa se combinam com Rotas Contábeis e Segmentos para um controle granular.

​
Acessando a página Pacotes de Taxa

Na barra lateral do Módulo Midaz, expanda Fees Engine e selecione Pacotes de Taxa. A página lista todos os pacotes configurados.
Se você não tiver nenhum Pacote de Taxa, a lista aparecerá vazia com uma indicação para criar seu primeiro pacote.

​
Ações disponíveis

A partir da página Pacotes de Taxa, você pode:

Criar um Pacote de Taxa

Defina novas regras de cálculo de taxas para transações

Editar um Pacote de Taxa

Atualize configurações e regras de taxas

Excluir um Pacote de Taxa

Remova um pacote de taxa da sua configuração

​
Entendendo a estrutura de um Pacote de Taxa

Ao criar ou editar um pacote de taxa no Módulo Midaz, você trabalha com:

​
Informações básicas

  • Rótulo do Grupo de Taxa (obrigatório) - Um nome descritivo para o pacote de taxa
  • Descrição (obrigatório) - Explicação da finalidade do pacote e quando ele se aplica
  • Rota de Transação (opcional) - Vincula a uma Rota de Transação específica
  • Segmento (opcional) - Associa a um Segmento específico
  • Ledger (obrigatório) - O Ledger ao qual este pacote se aplica

​
Faixa de valor

  • Valor Mínimo (obrigatório) - Valor de transação mais baixo para aplicação da taxa
  • Valor Máximo (obrigatório) - Valor de transação mais alto para aplicação da taxa
  • Contas Isentas (opcional) - Lista de aliases de contas isentas destas taxas

​
Regras de Taxa

Cada pacote de taxa pode conter várias Regras de Taxa com:
  • Rótulo da Taxa - Nome que identifica esta taxa específica
  • Regra de Aplicação - Como a taxa é calculada:
    • flatFee - Valor fixo independente do valor da transação
    • percentual - Porcentagem do valor da transação
    • maxBetweenTypes - O maior valor entre o cálculo fixo e o percentual
  • Tipo de Cálculo - flat ou percentage
  • Valor de Cálculo - O valor ou porcentagem da taxa
  • Valor de Referência - Base para o cálculo do percentual:
    • originalAmount - Calcular sobre o valor original da transação
    • afterFeesAmount - Calcular após a aplicação de outras taxas
  • Prioridade - Ordem de aplicação da taxa (números menores são aplicados primeiro)
  • Dedutível De - Se esta taxa é deduzida da transação
  • Conta de Crédito - Conta que recebe o valor da taxa

​
Casos de uso comuns

Aplica uma taxa fixa a todas as transações dentro de uma faixa de valores:
  • Regra de Aplicação: flatFee
  • Cálculo: flat com valor 2.50
  • Exemplo: Taxa de 2.50emcadatransac\ca~oentre2.50 em cada transação entre 10 e $1000
Cobra uma porcentagem do valor da transação:
  • Regra de Aplicação: percentual
  • Cálculo: percentage com valor 1.5
  • Exemplo: Taxa de 1.5% em transferências, em que transferência de 100=100 = 1.50 de taxa
Crie vários pacotes com faixas de valores diferentes:
  • Pacote 1: 0−0-100 → taxa de 2%
  • Pacote 2: 100−100-1000 → taxa de 1.5%
  • Pacote 3: $1000+ → taxa de 1%
  • Taxas menores para transações de maior valor
Aplica o maior valor entre fixo e porcentagem:
  • Regra de Aplicação: maxBetweenTypes
  • Cálculos: flat: 1.00 e percentage: 2.0
  • Exemplo: Em transação de 30:max(30: max(1.00, 0.60)=0.60) = 1.00 de taxa
  • Exemplo: Em transação de 100:max(100: max(1.00, 2.00)=2.00) = 2.00 de taxa
Isenta contas específicas de taxas:
  • Crie o pacote com regras de taxa padrão
  • Adicione os aliases das contas premium à lista Contas Isentas
  • Essas contas transacionam sem incorrer nas taxas configuradas

​
Boas práticas

1

Planeje sua estrutura de taxas

Projete seus pacotes de taxa antes da implementação. Considere os tipos de transação, faixas de valores e segmentos de cliente que exigem tratamentos de taxa diferentes.
2

Use rótulos descritivos

Escolha rótulos e descrições claros para o grupo de taxa que expliquem quando e por que as taxas se aplicam. Isso ajuda em auditoria e comunicação com clientes.
3

Defina faixas de valor adequadas

Defina valores mínimos e máximos com cuidado para evitar lacunas ou sobreposições na sua estrutura de taxas.
4

Teste os cálculos de taxas

Use o recurso Estimativa de Taxa para verificar os cálculos antes de habilitar os pacotes em produção.
5

Gerencie a Prioridade com cuidado

Quando usar várias taxas em um pacote, defina prioridades para garantir que as taxas sejam aplicadas na ordem correta.
6

Documente as contas isentas

Mantenha registro do motivo pelo qual certas contas estão isentas de taxas para fins de auditoria e conformidade.

​
Fluxo de cálculo de taxas

Quando uma transação é processada, o Fees Engine:
  1. Identifica pacotes de taxa aplicáveis com base na Rota de Transação e no Segmento
  2. Filtra os pacotes por faixa de valor (a transação precisa estar dentro do mín/máx)
  3. Verifica se a conta de origem está na lista de Contas Isentas
  4. Aplica as Regras de Taxa em ordem de Prioridade
  5. Calcula cada taxa com base na Regra de Aplicação e no Valor de Referência
  6. Credita os valores das taxas nas contas designadas
Pacotes de taxa precisam estar habilitados para serem aplicados a transações. Você pode desabilitar pacotes temporariamente sem excluí-los.