Bre-B

La solución de PayOut usando Bre-B Key proporciona servicios para enviar fondos desde un Cobre Balance o cuenta bancaria a un beneficiario registrado con una Bre-B Key en Colombia, utilizando el riel de pagos inmediatos Bre-B.

Los PayOuts de Bre-B se utilizan comúnmente para enviar fondos instantáneamente usando un destino basado en clave, eliminando la necesidad de compartir detalles tradicionales de cuenta bancaria y habilitando una experiencia de pago rápida y fácil de usar.

Limitaciones de Bre-B y comportamiento de enrutamiento

Los PayOuts que utilizan el riel Bre-B Key están sujetos a ciertos límites operacionales.

El monto máximo permitido por transacción a través del riel Bre-B es aproximadamente COP 11,500,000.

Si se crea un PayOut con un monto que excede el máximo permitido para Bre-B, Cobre intentará automáticamente enrutar la transacción a través de Fast Pay o ACH, dependiendo del banco del beneficiario y la disponibilidad. Este comportamiento de enrutamiento es manejado internamente por Cobre.

Recomendamos validar los montos de transacción esperados con anticipación cuando se usen Bre-B Keys, especialmente para PayOuts de alto valor.

Contrapartes soportadas

El PayOut vía Bre-B Key soporta los siguientes tipos de destino en Colombia:

Tipo de Destino	Tipo de Contraparte	Rieles
Bre-B Key	`breb_key`	Bre-B / Fast Pay* / ACH*

( * ) Fast Pay o ACH solo se utilizan cuando es necesario re-enrutar la transacción debido a las limitaciones del riel Bre-B.

Flujo de Autorización (opcional)

Checker Approval es una solución opcional que puede ser utilizada dentro del flujo de PayOut. Activa un flujo de autorización antes de que la transacción sea enviada a la red de pagos. Mientras la aprobación está pendiente, el Money Movement permanece en estado pending_approval hasta que sea aprobado o rechazado. El proceso de aprobación puede completarse ya sea a través del Portal de Cobre o programáticamente vía API.

Ciclo de vida del PayOut

Un PayOut a través de Bre-B Key sigue un ciclo de vida simple:

1. Crear una contraparte Bre-B Key (beneficiario)
Crear una contraparte de tipo breb_key usando la información registrada de Bre-B Key del beneficiario.
Esta contraparte representa el destino de la transacción PayOut.

2. Crear un Money Movement
Crear un Money Movement usando:

El account_id del cual los fondos serán debitados, usado como el source_id.

El counterparty_id del paso anterior como el destination_id

Los metadatos con una description

El external_id donde puedes usar para enviar una referencia desde tu sistema.

El monto proporcionado en la unidad más pequeña de la moneda (ej., 100.00 COP debe representarse como 10000).

El checker_approval como true si quieres usar nuestro flujo de autorización.

3. El Money Movement es procesado
Una vez creado, el Money Movement inicia en el estado initiated.

Si todas las validaciones pasan, el estado cambia a processing. En este punto, la transacción es enviada a través de Bre-B

Si ocurre un error durante la validación o procesamiento, el Money Movement transiciona al estado final failed.

Si el Money Movement es creado con checker_approval = true, primero se mueve al estado pending_approval y solo transicionará a processing o canceled una vez que se tome la decisión de aprobación.

4. Los fondos son debitados
Una vez que el Money Movement transiciona al estado processing, los fondos son debitados del Cobre Balance asociado.

5. Esperar el resultado final del Money Movement.

Si el Money Movement está completed, el beneficiario ha recibido exitosamente los fondos.

Si el Money Movement está rejected, los fondos son acreditados de vuelta a tu Cobre Balance.

6. Recibir actualizaciones de estado
Los cambios de estado del Money Movement son comunicados vía Webhooks.

Acciones realizadas en un Money Movement (PayOut)

🔑 Crear

🔍 Consulta

Descripción: Creación de Money Movement.
Qué esperar después de la acción: Money Movement es creado en Cobre.
📘 Aprende más:

🔗 Crear un Money Movement

Idempotencia del Money Movement

La creación de Money Movement soporta idempotencia.

Las claves de idempotencia son válidas por 24 horas.

Cómo Empezar

Antes de comenzar, recomendamos revisar las siguientes consideraciones.

Antes de usar esta API

Necesitas un Cobre Balance en Colombia

Para enviar fondos usando Bre-B, debes tener una cuenta Cobre Balance activa en Colombia con fondos suficientes.

Crear la Contraparte beneficiaria

Antes de crear un Money Movement de PayOut, debes crear una Contraparte con la información del beneficiario, que coincida con el tipo de destino seleccionado.

Definir la configuración del PayOut

Decidir el tipo de destino, monto, y cualquier metadato requerido necesario para procesar el PayOut.

Implementar Webhooks para rastrear el estado del pago

Para mantenerte informado sobre el estado de las transacciones PayOut, recomendamos fuertemente implementar Webhooks. Los Webhooks notifican a tu sistema cuando un pago es iniciado, procesado, completado, o falla. También suscríbete a los eventos requeridos para recibir notificaciones sobre débitos y créditos de transacciones.

Ver Notificaciones y Suscripciones para más detalles.

Qué esperar después de usar esta API

Iniciar el PayOut

Una vez que la solicitud de creación de Money Movement es enviada, será creada con un estado iniciado.
Asegúrate de que tu sistema esté preparado para recibir actualizaciones de estado mientras el Money Movement progresa a través de su ciclo de vida.

Rastrear el estado de la transacción

Monitorea el ciclo de vida del PayOut usando Webhooks o endpoints de consulta.

Los fondos son entregados al beneficiario

Cuando el PayOut es exitoso, los fondos son acreditados a la cuenta del beneficiario y el estado del Money Movement es actualizado correspondientemente.

Bre-B

Limitaciones de Bre-B y comportamiento de enrutamiento#

Contrapartes soportadas#

Flujo de Autorización (opcional)#

Ciclo de vida del PayOut#

Acciones realizadas en un Money Movement (PayOut)#

Idempotencia del Money Movement#

Cómo Empezar#

Antes de usar esta API#

Qué esperar después de usar esta API#