Pular para o conteúdo principal
Esta página cobre os campos específicos das operações do ledger do Midaz, incluindo saldos, rotas de transação, rotas de operação e índices de metadados.

1. Saldos


FieldDescriptionUsed in
keyIdentificador único do saldo dentro do contexto da contaMidaz
availableValor disponível para transaçõesMidaz
onHoldValor atualmente reservado ou retidoMidaz
versionVersão do saldo, atualizada a cada transação (para concorrência otimista)Midaz
accountTypeTipo de conta que detém este saldoMidaz
allowSendingSe o saldo pode ser usado para enviar transaçõesMidaz
allowReceivingSe o saldo pode ser usado para receber transaçõesMidaz
assetCodeCódigo de ativo ou moeda (ISO 4217, 3 caracteres)Midaz
aliasAlias da conta para fácil identificaçãoMidaz

2. Rotas de transação


FieldDescriptionUsed in
titleTexto curto que resume o propósito da rota (máx. 50 caracteres)Midaz
descriptionDescrição detalhada da rota de transação (máx. 250 caracteres)Midaz
operationRoutesArray de IDs de rotas de operação que definem a lógica de origem e destinoMidaz

3. Rotas de operação


FieldDescriptionUsed in
operationTypeDireção da rota: source ou destinationMidaz
codeCódigo de referência externo para a rota de operaçãoMidaz
accountRegra de seleção de conta para a operaçãoMidaz
ruleTypeMétodo de seleção de conta: alias ou account_typeMidaz
validIfCondição que deve ser satisfeita para a regra coincidirMidaz

4. Índices de metadados


FieldDescriptionUsed in
metadataKeyChave de metadados a indexar (máx. 100 caracteres, deve coincidir com o nome do campo nas entidades)Midaz
uniqueSe o índice impõe unicidade (valores duplicados rejeitados quando true)Midaz
sparseSe o índice é esparso (somente indexa entidades que contêm o campo)Midaz
indexNameNome do índice criadoMidaz
entityNameNome da coleção de entidades à qual o índice se aplicaMidaz