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

# Criando um Pacote de Tarifas

> Monte um novo Pacote de Tarifas no Módulo Midaz configurando informações básicas, faixas de valores, regras de tarifa fixa ou percentual, isenções e prioridades pela interface do Console.

Um Pacote de Tarifas agrupa regras de tarifa e define quando elas se aplicam a Transações.

## Antes de começar

***

* Habilite o **Fees Engine** em [Configurações do Módulo Midaz](https://docs.lerian.studio/pt/platform/console/plugin-settings.md).
* Você precisa de um Ledger existente e pelo menos uma Conta que possa receber valores de tarifa.
* Se o pacote for para se aplicar apenas a uma rota ou segmento específico, crie esses registros primeiro.

## Criar o Pacote de Tarifas

***

**Step 1**

Vá para a página **Pacotes de Taxas** e clique no botão **Novo Pacote**.

**Step 2**

O formulário **Novo Pacote de Taxas** abre com várias seções para configurar.

> [!TIP]
>
> Consulte o guia de campos para mais informações sobre os campos do formulário.

**Step 1**

Preencha a seção **Informações Básicas**.

**Step 2**

Defina **Valor Mínimo** e **Valor Máximo** na mesma seção.

> [!NOTE]
>
> Transações fora dessa faixa não recebem tarifas deste pacote.

**Step 3**

Clique no botão **Próximo**.

**Step 4**

Selecione uma das opções na seção **Adicionar Nova Taxa**:

* **Taxa Fixa** - Valor fixo, independente do valor da transação.
* **Percentual** - Percentual do valor da transação.
* **Máximo Entre Tipos** - Maior valor entre o fixo e o percentual.

**Step 5**

Adicione as informações da tarifa.

**Step 6**

(Opcional) Você pode adicionar outra regra de tarifa, se necessário. Para isso, selecione um novo tipo de tarifa e preencha as informações.

**Step 7**

Clique no botão **Próximo**.

**Step 8**

(Opcional) Configure a seção **Contas Isentas**:

* Adicione os aliases de conta que você quer isentar de tarifas neste pacote
* Clique em **Adicionar** para cada conta isenta

**Step 9**

Clique no botão **Próximo**.

**Step 10**

Revise as informações e confirme que está tudo correto.

**Step 11**

Clique no botão **Criar Pacote**.

Se tudo der certo, o Console mostra uma mensagem de confirmação e abre a lista de Pacotes de Tarifas.

## Guia de campos

***

### Informações básicas

| Campo | Descrição | Exemplo |
| - | - | - |
| Nome do Pacote de Tarifas | Nome obrigatório do pacote. Use um nome que descreva o modelo de cobrança. | `Standard Transfer Fee` |
| Descrição | Explicação de quando e por que o pacote se aplica. | `Fixed fee for standard transfers` |
| Rota de Transação | Filtro de rota opcional para o pacote. | `Pix Transfer Route` |
| Segmento | Filtro de segmento opcional para tarifas direcionadas. | `Retail Customers` |
| Valor Mínimo | Menor valor de transação elegível para o pacote. | `10.00` |
| Valor Máximo | Maior valor de transação elegível para o pacote. | `500.00` |
| Arredondamento | Opcional. **Nenhum** mantém o valor calculado exato. **Arredondar para baixo** e **Arredondar metade para cima** arredondam cada tarifa que o pacote cobra. Ao escolher um modo, defina **Casas decimais a manter** de `0` a `18`. Começa em `2`. | `Round down`, `2` |
| Seletor de metadados | Pares de metadados opcionais. O pacote se aplica apenas a transações cujos metadados trazem cada par com o mesmo valor de texto. Você não pode alterar os pares depois de criar o pacote. Para precificar um TED ou Pix por um rótulo, veja [contexto de tarifa](https://docs.lerian.studio/pt/products/midaz/fees/using-fee-engine.md#price-a-ted-or-pix-by-a-fee-context). | `feeContext` = `ted_salario` |

### Regras de tarifa

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

#### Tarifa fixa

Um valor fixo aplicado à Transação, independente do seu valor.

| Campo | Descrição | Exemplo |
| - | - | - |
| Valor | O valor fixo cobrado por esta tarifa. Deve ser um número positivo. | `5.00` |
| Nome da Tarifa | Identificador único desta tarifa, usado como chave do objeto JSON. **Deve começar com uma letra minúscula** e conter apenas letras e números. | `taxaAdm` |
| Valor de Referência | Base usada no cálculo: **Valor Original** (valor da transação como enviado) ou **Valor Após Taxas** (valor após tarifas anteriores no pacote). | `Original Amount` |
| ID da Conta de Crédito | Alias da conta que recebe o valor da tarifa. | `@fees_transfers` |
| Rota de Origem | Opcional. Nome ou UUID da rota de origem para esta operação de tarifa. | `payments_in` |
| Rota de Destino | Opcional. Nome ou UUID da rota de destino para esta operação de tarifa. | `fees_revenue` |
| Dedutível da transação? | Quando habilitado, a tarifa é deduzida do valor da transação (o recebedor paga); quando desabilitado, a tarifa é somada por cima (o remetente paga). | Desligado |
| Adiável | Quando habilitado, a parte desta tarifa que o pagador não consegue cobrir pode virar uma [dívida de tarifa](https://docs.lerian.studio/pt/products/midaz/fees/fee-debt.md). Fica desabilitado enquanto **Dedutível da transação?** está habilitado. | Desligado |

> [!NOTE]
>
> Quando você habilita **Dedutível da transação?**, o formulário força o **Valor de Referência** para **Valor Original** e desabilita a opção **Valor Após Taxas**.

#### Tarifa percentual

Um percentual do valor da Transação.

| Campo | Descrição | Exemplo |
| - | - | - |
| Percentual | Taxa percentual aplicada ao valor de referência. Deve ser maior que `0` e menor ou igual a `100`. | `2.5` |
| Nome da Tarifa | Identificador único desta tarifa, usado como chave do objeto JSON. Deve começar com uma letra minúscula e conter apenas letras e números. | `processingFee` |
| Valor de Referência | **Valor Original** para cobrar sobre o valor da transação como enviado, ou **Valor Após Taxas** para cobrar sobre o valor após tarifas anteriores no pacote. | `Original Amount` |
| ID da Conta de Crédito | Alias da conta que recebe o valor da tarifa. | `@fees_revenue` |
| Rota de Origem | Opcional. Nome ou UUID da rota de origem para esta operação de tarifa. | `payments_in` |
| Rota de Destino | Opcional. Nome ou UUID da rota de destino para esta operação de tarifa. | `fees_revenue` |
| Dedutível da transação? | Habilite para que a tarifa seja deduzida do valor da transação; desabilite para somar a tarifa por cima da transação. | `Disabled` |
| Adiável | Quando habilitado, a parte desta tarifa que o pagador não consegue cobrir pode virar uma [dívida de tarifa](https://docs.lerian.studio/pt/products/midaz/fees/fee-debt.md). Fica desabilitado enquanto **Dedutível da transação?** está habilitado. | `Disabled` |

#### Máximo entre tipos

Calcula um valor fixo **e** um percentual, depois aplica o maior resultado. O formulário exige os dois cálculos.

| Campo | Descrição | Exemplo |
| - | - | - |
| Tarifa Fixa (Cálculos) | Primeira linha de cálculo. Candidato a valor fixo. Deve ser um número positivo. | `1.00` |
| Tarifa Percentual (Cálculos) | Segunda linha de cálculo. Candidato a percentual; deve ser maior que `0` e menor ou igual a `100`. | `2.0` |
| Nome da Tarifa | Identificador único desta tarifa, usado como chave do objeto JSON. Deve começar com uma letra minúscula e conter apenas letras e números. | `guaranteeFee` |
| Valor de Referência | Base usada para calcular o candidato percentual antes da comparação. | `Original Amount` |
| Conta de Crédito | Alias da conta que recebe o valor final (o maior) da tarifa. | `@fees_guarantee` |
| Rota de Origem | Opcional. Nome ou UUID da rota de origem para esta operação de tarifa. | `payments_in` |
| Rota de Destino | Opcional. Nome ou UUID da rota de destino para esta operação de tarifa. | `fees_revenue` |
| Dedutível da transação? | Quando habilitado, o maior dos dois resultados é deduzido do valor da transação; quando desabilitado, ele é somado por cima. | `Disabled` |
| Adiável | Quando habilitado, a parte desta tarifa que o pagador não consegue cobrir pode virar uma [dívida de tarifa](https://docs.lerian.studio/pt/products/midaz/fees/fee-debt.md). Fica desabilitado enquanto **Dedutível da transação?** está habilitado. | `Disabled` |

### Contas isentas

| Campo | Descrição | Exemplo |
| - | - | - |
| Alias da Conta | O alias da conta que será isenta. | `@customer_john_checking` |

## Prioridade, faixas e contas isentas

***

### Ordem de prioridade das tarifas

Quando um pacote contém múltiplas tarifas, o Midaz as aplica em ordem de prioridade (menor número primeiro). Com **Valor Após Taxas** como referência, as tarifas anteriores afetam a base de cálculo das tarifas seguintes.

**Exemplo**:

* Tarifa A (Prioridade 1): 1% sobre o valor original, não dedutível
* 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,505 (0,5% de \$101)

### Considerações sobre a faixa de valores

* O Midaz rejeita um pacote cuja faixa se sobrepõe à de outro pacote com a mesma rota de transação e o mesmo segmento
* Use `0.01` como mínimo para pacotes que devem se aplicar a todas as transações
* Use um máximo alto (por exemplo, `999999999.99`) para não ter limite superior
* A faixa inclui Transações exatamente nos valores mínimo ou máximo

### Comportamento das contas isentas

* Uma conta isenta ignora todas as tarifas do pacote, não apenas tarifas específicas
* Use aliases de conta (não IDs) ao adicionar contas isentas
* Quando todas as contas de origem estão isentas, o pacote não cobra tarifa. Caso contrário, a tarifa é dividida entre as contas que a isenção não cobre: as de origem para uma tarifa somada por cima, as de destino para uma tarifa dedutível.

## O que fazer a seguir

***

Depois de criar o Pacote de Tarifas, execute um cálculo de teste em [Executando uma Estimativa de Tarifa](https://docs.lerian.studio/pt/products/midaz/fees/console/fe-fee-simulation.md) antes de usá-lo com Transações reais.

> [card] Equivalente na API
>
> [Endpoint de criação de pacote](https://docs.lerian.studio/pt/reference/products/midaz/v2/create-package.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.