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

# Dados financeiros

> Consulte os campos de dados financeiros usados no Midaz, CRM, Pix e no Fees Engine: dados bancários, chaves Pix, valores e códigos de moeda.

Esta página reúne todos os campos de informações financeiras usados no Midaz, CRM, Pix e no Fees Engine.

## 1. Dados bancários

***

| Campo         | Descrição                              | Usado em |
| ------------- | -------------------------------------- | -------- |
| branch        | Código da agência bancária             | CRM, Pix |
| account       | Número da conta                        | CRM      |
| accountNumber | Número de conta genérico               | Pix      |
| accountDigit  | Dígito verificador                     | Pix      |
| agency        | Agência bancária                       | Pix      |
| accountType   | Tipo de conta                          | CRM, Pix |
| iban          | Número Internacional de Conta Bancária | CRM      |
| bankId        | Identificador do banco                 | CRM, Pix |
| openingDate   | Data de abertura da conta              | CRM      |

## 2. Chaves Pix

***

| Campo                | Descrição                                             | Usado em |
| -------------------- | ----------------------------------------------------- | -------- |
| key                  | Valor da chave Pix                                    | Pix      |
| keyType              | Tipo de chave (e-mail, telefone, CPF/CNPJ, aleatória) | Pix      |
| requiresConfirmation | Requer confirmação por token                          | Pix      |
| confirmationToken    | Token para confirmação da chave                       | Pix      |
| claimId              | Identificador da reivindicação                        | Pix      |
| claimReason          | Motivo da reivindicação                               | Pix      |
| claimType            | Tipo de reivindicação                                 | Pix      |
| authorizationCode    | Código de autorização                                 | Pix      |
| checked              | Sinalizador de verificação da chave                   | Pix      |

## 3. Transações financeiras

***

| Campo           | Descrição                          | Usado em        |
| --------------- | ---------------------------------- | --------------- |
| amount          | Valor monetário                    | Midaz, Pix, Fee |
| value           | Valor numérico                     | Fee, Pix        |
| totalAmount     | Valor total da operação            | Pix             |
| minimumAmount   | Valor mínimo permitido             | Fee             |
| maximumAmount   | Valor máximo permitido             | Fee             |
| originalAmount  | Valor antes das tarifas            | Fee             |
| afterFeesAmount | Valor após a aplicação da tarifa   | Fee             |
| description     | Descrição da transação             | Midaz, Pix      |
| asset           | Código do ativo (BRL, USD)         | Midaz, Fee      |
| code            | Código de transação ou autorização | Midaz           |
| route           | Rota de operação                   | Midaz           |
| pending         | Status pendente                    | Midaz           |
| priority        | Prioridade (alta/média/baixa)      | Pix             |
| flow            | Fluxo da transação (entrada/saída) | Pix             |
| isPixSaque      | Sinalizador de saque Pix           | Pix             |
| isPixTroco      | Sinalizador de troco Pix           | Pix             |
| isReversal      | Sinalizador de estorno             | Pix             |
| isInternal      | Sinalizador de transação interna   | Pix             |
| reversalType    | Tipo de estorno                    | Pix             |
| refundId        | Identificador da devolução         | Pix             |
| returnId        | Identificador do retorno           | Pix             |
| returnReason    | Motivo do retorno                  | Pix             |
| returnedAt      | Timestamp do retorno               | Pix             |
| failureReason   | Motivo da falha                    | Pix             |

## 4. QR Codes Pix

***

| Campo             | Descrição                           | Usado em |
| ----------------- | ----------------------------------- | -------- |
| qrCode            | String do QR Code Pix               | Pix      |
| qrCodeType        | Tipo de QR (estático/dinâmico)      | Pix      |
| txId              | ID da transação (até 25 caracteres) | Pix      |
| recipientName     | Nome do destinatário                | Pix      |
| expirationTime    | Tempo de expiração em segundos      | Pix      |
| isValid           | Indica se o QR é válido             | Pix      |
| validationMessage | Mensagem de validação               | Pix      |
| additionalData    | Dados adicionais do QR              | Pix      |

## 5. Limites e controles

***

| Campo      | Descrição       | Usado em |
| ---------- | --------------- | -------- |
| limitType  | Tipo de limite  | Pix      |
| periodType | Tipo de período | Pix      |

\| used          | Valor usado no período                    | Pix     |
\| remaining     | Valor restante                            | Pix     |
\| resetDate     | Data de reinício do período               | Pix     |
\| waivedAccounts| Contas isentas de tarifas                 | Fee     |
