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.

Use a Calculadora de Taxa no Módulo Midaz para estimar cálculos de taxas antes de processar Transações reais. O estimador é somente leitura — não cria uma Transação nem afeta nenhum saldo do Ledger.

Antes de começar


Executando uma estimativa


1
Na barra lateral do Módulo Midaz, expanda Fees Engine e clique em Calculadora.
2
Preencha a transação estimada. Consulte o Guia de campos abaixo para cada entrada.
3
Clique em Calcular Taxas para executar a estimativa.
4
Revise os resultados exibidos abaixo do formulário.

Guia de campos


CampoO que informarExemplo
Valor da TransaçãoValor total para estimar as taxas.100.00
MoedaCódigo do Ativo para a transação estimada.BRL
Pacote de TaxaPacote de Taxa a ser testado.Standard Transfer Fee
Conta de OrigemAlias da conta que seria debitada.@customer_123
Conta de DestinoAlias da conta que seria creditada.@merchant_456
DescriçãoDescrição opcional para a estimativa.Pix transfer test
A Calculadora de Taxa é uma ferramenta somente leitura. Ela não afeta o Ledger nem cria nenhuma transação. Você pode executar quantas estimativas precisar com segurança.

Entendendo os resultados


Após executar uma estimativa, você verá um detalhamento de como as taxas são calculadas:

Resumo

  • Taxa Total - O valor combinado de todas as taxas que seriam cobradas
  • Valor Líquido - O valor que o destino receberia após as taxas dedutíveis

Detalhamento de taxas

Para cada Regra de Taxa aplicada, você verá:
CampoDescrição
Rótulo da TaxaNome que identifica a taxa
PrioridadeOrdem em que a taxa foi aplicada
Tipo de Cálculoflat ou percentage
Valor de ReferênciaO valor base usado para o cálculo
Valor CalculadoO valor real da taxa
Conta de CréditoConta que receberia a taxa
É DedutívelSe a taxa é deduzida da transação

Exemplos de estimativa


Cenário: Testar uma taxa fixa de $2.00 em uma transferência de $100Entrada:
  • Pacote de Taxa: Standard Transfer Fee
  • Ativo: USD
  • Valor: 100.00
  • Origem: @customer/checking
  • Destino: @merchant/revenue
Resultado esperado:
  • Taxa Total: $2.00
  • Valor Líquido: $98.00 (se dedutível) ou $100.00 (se não dedutível)
Cenário: Testar uma taxa de 1.5% em uma transferência de $500Entrada:
  • Pacote de Taxa: Percentage Transaction Fee
  • Ativo: USD
  • Valor: 500.00
  • Origem: @customer/savings
  • Destino: @vendor/payments
Resultado esperado:
  • Taxa Total: $7.50 (1.5% de $500)
  • Cálculo: 500 × 0.015 = 7.50
Cenário: Testar a taxa max(flat, percentage) em valores diferentesTeste 1 - Transação pequena ($30):
  • Flat: $1.00
  • Percentage: 2% = $0.60
  • Resultado: $1.00 (a fixa é maior)
Teste 2 - Transação grande ($200):
  • Flat: $1.00
  • Percentage: 2% = $4.00
  • Resultado: $4.00 (a porcentagem é maior)
Cenário: Pacote com duas taxas aplicadas em ordem de PrioridadeTaxa A (Prioridade 1): 1% sobre o valor original Taxa B (Prioridade 2): 0.5% sobre o valor após taxasEntrada: Transação de $1000Resultado esperado:
  • Taxa A: $10.00 (1% de $1000)
  • Taxa B: $4.95 (0.5% de $990)
  • Taxa Total: $14.95

Casos de uso para estimativa de taxas


Validar novos Pacotes de Taxa

Antes de habilitar um novo pacote de taxa, execute estimativas com vários valores de transação para garantir que as taxas sejam calculadas corretamente em toda a faixa de valores.

Testar casos extremos

Estime transações nos limites mínimo e máximo dos valores para verificar o comportamento das taxas nos limites das faixas configuradas.

Comparar estruturas de taxas

Execute a mesma transação por diferentes pacotes de taxa para comparar resultados e escolher a melhor estrutura para o seu caso de uso.

Documentar taxas esperadas

Use os resultados das simulações para criar documentação para a sua equipe financeira ou clientes sobre os valores de taxas esperados.

Depurar problemas de taxas

Se as transações estiverem mostrando taxas inesperadas, use o estimador para reproduzir o cenário e entender o detalhamento do cálculo.

Boas práticas


  • Teste faixas completas de valor - Não teste apenas um valor; estime transações no mínimo, máximo e vários pontos intermediários.
  • Verifique a ordem de Prioridade - Quando os pacotes têm várias taxas, confirme se elas são aplicadas na ordem esperada.
  • Verifique as Contas Isentas - Teste com contas que deveriam estar isentas para confirmar que são excluídas das taxas.
  • Documente seus testes - Mantenha um registro dos resultados das estimativas para fins de auditoria e conformidade.
  • Compartilhe com stakeholders - Use os detalhamentos das estimativas para alinhar com as equipes financeiras sobre os resultados de taxas esperados antes de ir para produção.

O que fazer em seguida


Após validar o resultado da taxa, ajuste o Pacote de Taxa se necessário em Editando um Pacote de Taxa, ou crie uma Transação real em Criando uma Transação.

Equivalente na API