Afeta
Equipes que constroem experiências de extrato com operações de conta do Midaz, incluindo integradores, arquitetos de solução, engenheiros de backend e equipes de produto que definem visões de atividade da conta. Esta atualização se aplica ao portal público de documentação. Ela não muda 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 de operações do ledger. O guia explica como:- Recuperar 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 mostrar valores de entrada e de saída - Tratar
ON_HOLDeRELEASEcomo eventos de bloqueio e de liberação de saldo - Manter as visões de extrato liquidado focadas em operações com
balanceAffected=true - Adicionar contexto de negócio pelos metadados da transação
Enquadramento mais claro para o cliente
A página deixa o modelo central explícito: 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 é o dado de origem 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 metadados e uma amostra de saída do extrato. Antes As equipes 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 As equipes podem seguir uma única página para ir das operações de conta até uma visão de extrato renderizada.Impacto
Esta é uma atualização apenas de documentação. Nenhuma migração é necessária. As integrações existentes com o Midaz continuam funcionando como hoje. Use o novo guia ao projetar, implementar ou revisar experiências de extrato de conta que usam operações de conta do Midaz.
O que você precisa fazer
1
Revise o novo guia de extrato de conta se o seu produto mostra atividade da conta, saldos ou histórico de transações para usuários finais.
2
Use
direction, e não type, para decidir se um valor aparece como entrada ou saída no extrato.3
Adicione metadados de negócio ao criar transações se o seu extrato precisa de descrições amigáveis, contrapartes, canais, categorias ou referências de pagamento.
4
Mantenha as visões de extrato liquidado focadas em operações onde
balanceAffected=true.