1. Saldos
| Field | Description | Used in |
|---|---|---|
| key | Identificador único do saldo dentro do contexto da conta | Midaz |
| available | Valor disponível para transações | Midaz |
| onHold | Valor atualmente reservado ou retido | Midaz |
| version | Versão do saldo, atualizada a cada transação (para concorrência otimista) | Midaz |
| accountType | Tipo de conta que detém este saldo | Midaz |
| allowSending | Se o saldo pode ser usado para enviar transações | Midaz |
| allowReceiving | Se o saldo pode ser usado para receber transações | Midaz |
| assetCode | Código de ativo ou moeda (ex.: BRL, USD) | Midaz |
| alias | Alias da conta para fácil identificação | Midaz |
2. Rotas de transação
| Field | Description | Used in |
|---|---|---|
| title | Texto curto que resume o propósito da rota (máx. 256 caracteres) | Midaz |
| description | Descrição detalhada da rota de transação (máx. 256 caracteres) | Midaz |
| operationRoutes | Em requisições, array de IDs de rotas de operação que define a lógica de origem e destino; em respostas, array de objetos OperationRoute | Midaz |
3. Rotas de operação
| Field | Description | Used in |
|---|---|---|
| operationType | Direção da rota: source ou destination | Midaz |
| code | Código de referência externo para a rota de operação | Midaz |
| account | Regra de seleção de conta para a operação | Midaz |
| ruleType | Método de seleção de conta: alias ou account_type | Midaz |
| validIf | Condição que deve ser satisfeita para a regra coincidir | Midaz |
4. Índices de metadados
| Field | Description | Used in |
|---|---|---|
| metadataKey | Chave de metadados a indexar (máx. 100 caracteres, deve coincidir com o nome do campo nas entidades) | Midaz |
| unique | Se o índice impõe unicidade (valores duplicados rejeitados quando true) | Midaz |
| sparse | Se o índice é esparso (somente indexa entidades que contêm o campo) | Midaz |
| indexName | Nome do índice criado | Midaz |
| entityName | Nome da coleção de entidades à qual o índice se aplica | Midaz |