Afeta
Equipes que implementam novas tentativas e idempotência para endpoints de transação. Esta atualização se aplica ao portal público de documentação. Ela não muda o comportamento da API em runtime, a menos que a documentação do produto vinculada diga o contrário.
O que mudou
O guia Novas tentativas e idempotência recebeu uma reescrita ampla, com escopo mais claro, exemplos melhores e novas tabelas de referência.
Mudanças principais
- Escopo esclarecido: O suporte a idempotência se aplica a seis endpoints de transação, não a todas as APIs do Midaz
- Chaves geradas automaticamente: Se você omitir o header
X-Idempotency, o Midaz gera uma chave automaticamente usando um hash SHA-256 do corpo da requisição - Comportamento em erros: O Midaz apaga as chaves de idempotência em erros de validação e de saldo, então você pode repetir com segurança a mesma chave depois de corrigir o problema
- Comparação entre produtos: Uma nova tabela mostra o suporte a idempotência em Midaz, Matcher, TED, Pix Indireto, Pix Direto e Reporter, incluindo nomes de headers, TTL e escopo
- Restrições de unicidade de entidades: Uma nova tabela lista as regras de unicidade por recurso (Ledger, Asset, Segment, Account, Account Type) com os códigos de erro correspondentes
- Exemplos de código atualizados: O pseudocódigo genérico foi substituído por requisições HTTP concretas, com endpoints e payloads reais
- Novas perguntas frequentes: “Posso reutilizar uma chave em endpoints diferentes?” e “Posso reutilizar uma chave em organizações ou ledgers diferentes?”
Impacto
Esta é uma atualização de documentação. As integrações existentes não precisam de migração apenas por esta nota de release.
O que você precisa fazer
1
Revise o escopo de idempotência esclarecido e o comportamento de novas tentativas antes de mudar a lógica de repetição das transações.