Afeta
Times que constroem experiências de extrato com operações de conta do Midaz, incluindo integradores, arquitetos de solução, engenheiros de backend e times de produto que definem visões de atividade da conta. Esta atualização se aplica ao portal público de documentação. Não altera o comportamento da API do Midaz em runtime.
O que mudou
Novo guia para construir extratos
O Midaz agora tem um guia dedicado para construir extratos de conta a partir das operações do ledger. O guia explica como:- Recuperar as operações de conta de um período específico
- Aplicar filtros de consulta e paginação
- Transformar cada operação em uma linha do extrato
- Usar
directionpara exibir valores de entrada e saída - Tratar
ON_HOLDeRELEASEcomo eventos de bloqueio e liberação de saldo - Manter as visões de extrato liquidado focadas em operações com
balanceAffected=true - Adicionar contexto de negócio por meio de metadata de transação
Enquadramento mais claro voltado ao cliente
A página deixa explícito o modelo central: o Midaz retorna eventos do ledger. O sistema integrador transforma esses eventos na experiência de extrato que os usuários finais veem. Isso evita tratar o endpoint de operações como uma tela de extrato pronta. Ele é a fonte de dados de um extrato.Exemplos práticos
O guia inclui uma visão do fluxo, mapeamento de campos, regras de exibição, orientação sobre paginação, exemplos de metadata e uma saída de extrato de exemplo. Antes Os times tinham a referência da API para listar operações de conta, mas nenhum guia único que conectasse essas operações a um extrato voltado ao usuário. Depois Os times podem seguir uma única página para passar das operações de conta a uma visão de extrato renderizada.Impacto
Esta é uma atualização exclusiva de documentação. Nenhuma migração é necessária. As integrações existentes do Midaz continuam funcionando como hoje. Use o novo guia ao projetar, implementar ou revisar experiências de extrato de conta que utilizem operações de conta do Midaz.
O que você precisa fazer
Revise o novo guia de extrato de conta se seu produto exibe atividade da conta, saldos ou histórico de transações para usuários finais.
Adicione metadata de negócio ao criar transações se seu extrato precisa de descrições amigáveis ao usuário, contrapartes, canais, categorias ou referências de pagamento.