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.

Um Pacote de Taxa agrupa Regras de Taxa e define quando elas se aplicam às Transações.

​
Antes de começar

  • O plugin Fees Engine precisa estar habilitado nas configurações do Módulo Midaz.
  • Você precisa de um Ledger existente e ao menos uma Conta que possa receber valores de tarifa.
  • Se o Pacote deve se aplicar apenas a uma Rota ou Segmento específico, crie esses registros primeiro.

​
Criar o Pacote de Taxa

1
Acesse a página Pacotes de Taxa e clique no botão Novo Pacote.
2
O formulário Novo Pacote de Taxa será aberto com várias seções para configurar.
Consulte o guia de campos para mais informações sobre os campos do formulário.
1
Preencha a seção Basic Information.
2
Configure a seção Amount Range.
Transações fora dessa faixa não terão tarifas aplicadas por este Pacote.
3
Clique no botão Avançar.
4
Selecione uma das opções na seção Add Fee:
  • Flat Fee - Valor fixo independente do valor da transação.
  • Percentage - Percentual sobre o valor da transação.
  • Max Between Types - O maior valor entre a tarifa fixa e a percentual.
5
Adicione as informações da tarifa.
6
(Opcional) Você pode adicionar outra Regra de Taxa se necessário. Para isso, selecione um novo tipo de tarifa e preencha as informações.
7
Clique no botão Avançar.
8
(Opcional) Configure a seção Account Waivers:
  • Adicione os aliases das contas que devem ficar isentas das tarifas deste Pacote.
  • Clique em Adicionar para incluir cada conta isenta.
9
Clique no botão Avançar.
10
Revise as informações e confirme se está tudo correto.
11
Clique no botão Criar Pacote.
Se tudo der certo, você verá uma mensagem de confirmação e será redirecionado para a lista de Pacotes de Taxa.

​
Guia de campos

​
Basic Information

CampoDescriçãoExemplo
Nome do Pacote de TaxaNome obrigatório do Pacote. Use um nome que descreva o modelo de cobrança.Standard Transfer Fee
DescriçãoUma explicação de quando e por que o Pacote se aplica.Fixed fee for standard transfers
Rota de TransaçãoFiltro opcional por Rota para o Pacote.Pix Transfer Route
Ledger IDIdentificador único do Ledger onde este Pacote se aplica.Brazil Payments Ledger
Segment IDFiltro opcional por Segmento para tarifas direcionadas.Retail Customers
Minimum AmountMenor valor de transação elegível para o Pacote.10.00
Maximum AmountMaior valor de transação elegível para o Pacote.500.00

​
Regras de Taxa

Cada tarifa dentro de um Pacote tem uma Prioridade (1 = aplicada primeiro). A tarifa com prioridade 1 deve usar Original Amount como Valor de Referência.

​
Flat Fee

Um valor fixo aplicado à Transação independentemente do seu valor.
CampoDescriçãoExemplo
AmountO valor fixo cobrado por esta tarifa. Precisa ser um número positivo.5.00
Fee NameIdentificador único desta tarifa, usado como chave do objeto JSON. Precisa começar com letra ou underscore e conter apenas letras, números ou _.taxaAdm
Valor de ReferênciaBase usada no cálculo: Original Amount (valor da transação como enviado) ou After Fees Amount (valor após as tarifas anteriores do Pacote).Original Amount
Credit Account IDAlias da conta que recebe o valor da tarifa.@fees_transfers
Route FromOpcional. Nome ou UUID da Rota de origem desta operação de tarifa.payments_in
Route ToOpcional. Nome ou UUID da Rota de destino desta operação de tarifa.fees_revenue
Deductible from transaction?Quando ativado, a tarifa é deduzida do valor da transação (paga pelo recebedor); quando desativado, a tarifa é somada por cima (paga pelo remetente).Off
Quando Deductible from transaction? está ativado, Valor de Referência é forçado para Original Amount (a opção After Fees Amount fica desabilitada no formulário).

​
Percentage Fee

Um percentual do valor da Transação.
CampoDescriçãoExemplo
PercentageAlíquota percentual aplicada ao valor de referência. Precisa ser maior que 0 e menor ou igual a 100.2.5
Fee NameIdentificador único desta tarifa, usado como chave do objeto JSON. Precisa começar com letra ou underscore e conter apenas letras, números ou _.processingFee
Valor de ReferênciaOriginal Amount para cobrar sobre o valor enviado da transação ou After Fees Amount para cobrar sobre o valor após tarifas anteriores no Pacote.Original Amount
Credit Account IDAlias da conta que recebe o valor da tarifa.@fees_revenue
Route FromOpcional. Nome ou UUID da Rota de origem desta operação de tarifa.payments_in
Route ToOpcional. Nome ou UUID da Rota de destino desta operação de tarifa.fees_revenue
Deductible from transaction?Ative para que a tarifa seja deduzida do valor da transação; desative para somar a tarifa por cima.Disabled

​
Max Between Types

Calcula um valor fixo e um percentual e aplica o maior resultado. Ambos os cálculos são obrigatórios.
CampoDescriçãoExemplo
Flat Fee (Calculations)Primeira linha de cálculo. Candidato de valor fixo. Precisa ser um número positivo.1.00
Percentage Fee (Calculations)Segunda linha de cálculo. Candidato percentual; precisa ser maior que 0 e menor ou igual a 100.2.0
Fee NameIdentificador único desta tarifa, usado como chave do objeto JSON. Precisa começar com letra ou underscore e conter apenas letras, números ou _.guaranteeFee
Valor de ReferênciaBase usada para calcular o candidato percentual antes da comparação.Original Amount
Credit AccountAlias da conta que recebe o valor resultante (o maior) da tarifa.@fees_guarantee
Route FromOpcional. Nome ou UUID da Rota de origem desta operação de tarifa.payments_in
Route ToOpcional. Nome ou UUID da Rota de destino desta operação de tarifa.fees_revenue
Deductible from transaction?Quando ativado, o maior dos dois resultados é deduzido do valor da transação; quando desativado, é somado por cima.Disabled
O formulário Max Between Types sempre exige exatamente dois cálculos: um do tipo Flat Fee e outro do tipo Percentage Fee. O Console calcula os dois e aplica o maior.

​
Observações importantes

​
Ordem de prioridade das tarifas

Quando um Pacote contém várias tarifas, elas são aplicadas em ordem de prioridade (menor número primeiro). Isso importa ao usar After Fees Amount como referência, já que tarifas anteriores afetam a base de cálculo das seguintes. Exemplo:
  • Tarifa A (Prioridade 1): 1% sobre o valor original
  • Tarifa B (Prioridade 2): 0.5% sobre o valor após tarifas
Em uma transação de $100:
  • Tarifa A = $1.00 (1% de $100)
  • Tarifa B = $0.495 (0.5% de $99)

​
Considerações sobre a faixa de valor

  • As faixas não devem se sobrepor entre Pacotes para a mesma Rota de Transação.
  • Use 0.01 como mínimo para Pacotes que devam se aplicar a todas as transações.
  • Use um máximo alto (por exemplo, 999999999.99) para não ter limite superior.
  • Transações exatamente nos valores mínimo ou máximo estão incluídas na faixa.

​
Comportamento das contas isentas

  • Contas isentas pulam todas as tarifas do Pacote, não apenas tarifas específicas.
  • Use aliases de conta (não IDs) ao adicionar contas isentas.
  • As isenções valem quando a conta isenta é a origem da transação.

​
O que fazer em seguida

Após criar o Pacote de Taxa, rode um cálculo de teste em Executando uma Estimativa de Tarifas antes de usá-lo com Transações reais.

Equivalente na API

Endpoint Criar Pacote