Referencia de payload de webhook
Estructura de payload y tipos de evento entregados por los webhooks de Bre-B participant
Esta guía describe el envelope que Mono usa para cada entrega de webhook de Bre-B participant y lista los eventos de transferencia saliente que tu endpoint puede esperar.
Verifica primero
Antes de confiar en cualquier payload, verifica el header Mono-Signature. Ver Verificación
de firma de webhook.
Estructura del payload
Todos los webhooks comparten el mismo envelope. El string event.type te dice qué
evento se disparó e implícitamente qué campos esperar dentro de event.data.
interface WebhookPayload {
timestamp: string; // Hora de entrega en ISO 8601
event: {
type: string; // e.g., "outgoing_transfer.created", "outgoing_transfer.failed"
data: {
id: string;
state: string;
// ...los campos adicionales dependen de event.type
};
};
}Para la forma exacta del objeto data de cada evento, sigue el enlace en la
tabla de eventos abajo — cada evento tiene un schema dedicado en la referencia de API.
Eventos de transferencia saliente
| Evento | Descripción |
|---|---|
outgoing_transfer.created | La transferencia fue creada. Schema |
outgoing_transfer.processing | La transferencia se está procesando. Schema |
outgoing_transfer.target_resolved | El target (llave Bre-B) fue resuelto. Schema |
outgoing_transfer.held | Los fondos fueron retenidos en la cuenta origen. Schema |
outgoing_transfer.sent_to_breb_provider | La transferencia fue enviada al proveedor Bre-B. Schema |
outgoing_transfer.successful | La transferencia se completó exitosamente. Schema |
outgoing_transfer.failed | La transferencia falló. Revisa state_reason para la causa. Schema |
Cuando recibes outgoing_transfer.failed, el campo state_reason te dice
por qué — ver Códigos de error de transferencia saliente
para la lista completa y el manejo sugerido por código.