Afecta
Equipos que integran webhooks de BR Bank Transfer y cualquiera que use la referencia de API de BR Bank Transfer. Esta actualización se aplica al portal de documentación pública. No cambia el comportamiento del API en tiempo de ejecución.
El portal de documentación pública es la referencia orientada al cliente. Los archivos fuente del repositorio no deben tratarse como artefactos de integración ni como especificaciones API descargadas para uso de clientes.
Qué cambió
El API de autoservicio de webhooks ahora está documentado
La referencia de API ahora incluye los endpoints de registro de webhooks que faltaban en el portal: crear, listar, recuperar, actualizar y eliminar un registro de webhook, rotar su secreto de firma y listar los tipos de eventos soportados. Los registros tienen alcance por tenant, y el secreto de firma se devuelve una sola vez, en la creación.Formato de firma del webhook corregido
El esquema de firma documentado se corrigió para coincidir con lo que envía la plataforma. La firma es un HMAC-SHA256 versionado calculado sobre el prefijov1:, el timestamp, un separador de punto y el cuerpo crudo de la solicitud.
Before
X-Webhook-Event, X-Webhook-Timestamp y X-Webhook-Signature.
Nombres de eventos del webhook corregidos
El catálogo de eventos ahora coincide con los eventos que la plataforma realmente emite — por ejemplotransfer.rejected, los eventos transfer.reconciliation_*, transfer_incoming.completed, transfer_incoming.chargeback y transfer_outgoing.devolution_notified. Se eliminaron los nombres que nunca existieron (transfer.failed, transfer.cancelled).
Precisión de la referencia de API y la configuración
Las páginas de referencia de API y configuración de BR Bank Transfer se alinearon con la plataforma: el envelope de error estándar (code, service, category, message, requestId), el código de error de rate-limit, el intervalo de polling de entrada y los ajustes de configuración soportados.
Impacto
Esta es una actualización de documentación. Expone capacidades de webhook existentes y corrige detalles de referencia de los que depende una integración. Ningún comportamiento de producto cambió, y no se requiere migración solo por esta release note. Si construiste la validación de firma del webhook o te suscribiste a nombres de eventos basándote en la documentación anterior, revísalos — el formato de firma anterior y algunos nombres de eventos no coincidían con lo que envía la plataforma.
Qué necesitas hacer
Si validas firmas de webhook, confirma que tu código usa el formato
v1,sha256= sobre v1: + timestamp + . + el cuerpo crudo de la solicitud.Verifica que los nombres de eventos a los que te suscribes coincidan con el catálogo de eventos corregido, y reemplaza cualquier nombre eliminado.