EMISSION_REQUIRED tem false como padrão. Defina EMISSION_REQUIRED=true em um deploy cujos sistemas downstream dependem desses eventos. O bootstrap então falha fechado, a menos que a emissão de eventos esteja totalmente conectada.
Os webhooks registrados recebem eventos duráveis do plano de controle. As famílias settlement.* e spb.ldl.* vão apenas para o backbone de streaming. Os sistemas downstream leem o estado de liquidação dos eventos de streaming settlement.* e não fazem polling.
Famílias de eventos
Integração com o ledger
O seu consumidor de ledger deve receber as duas famílias,
str.operation.* e settlement.*, no backbone de streaming. O evento str.operation.accepted sinaliza a aceitação do despacho, não a liquidação no BACEN, então use-o para registrar um lançamento pendente.
Registre a posição final a partir dos fatos settlement.* no backbone de streaming. A transição de negócio por trás de settlement.settled acontece quando a perna R de entrada move a operação para CONFIRMED. A entrega pelo broker é pelo menos uma vez e pode reentregar o fato. O ce-id é determinístico, então deduplique pelo par (ce-source, ce-id).
O evento settlement.failed dispara quando o BACEN rejeita a operação ou quando um cancelamento estorna um original que nunca liquidou. O evento settlement.returned dispara quando uma devolução confirmada estorna um original liquidado. A devolução segue o mesmo padrão: str.operation.returnRequested sinaliza a aceitação do despacho da devolução, e o lançamento pai é estornado em settlement.returned. O Lerian SPB não mantém posição contábil. O trilho carrega a mensagem e o seu estado de liquidação, e o seu ledger registra o dinheiro.
Webhooks
Os consumidores de webhook se autorregistram nas constantes canônicas de evento. Eles negociam os formatos de payload a partir de um catálogo de eventos compartilhado. A entrega é durável. Você pode repetir manualmente uma entrega que falhou. Um caminho de dead-letter trata as entregas que esgotam as novas tentativas.
Convenções da API
- A autenticação é um bearer token.
- As escritas são idempotentes por uma chave de idempotência. Um reenvio não despacha em duplicidade.
- As leituras do log de mensagens não expõem o frame assinado que trafega na rede. Você lê uma única mensagem pelo seu NUOp para obter dados estruturados. Quando o trilho reteve um frame, leia o XML reconstruído pela rota de frame dedicada, autorizada separadamente. Ele não retém separadamente os bytes literais enviados.
- Ids desconhecidos retornam um not-found uniforme. A resposta nunca revela se existe uma operação que a sua instituição não possui.