Iniciar un Pago

Visión General

Este endpoint permite iniciar un pago a través de la infraestructura Bre-B utilizando la API de Passport. Una solicitud exitosa crea el objeto de pago y devuelve los detalles de la transacción, incluyendo su estado y la información del destinatario.

Este endpoint solo crea el objeto de pago en tu entorno. Para enviar el pago a la infraestructura Bre-B, es necesario ejecutar una solicitud adicional (ver: ).

Detalles del Endpoint

Parámetro	Descripción
Endpoint	https://bre-b-sandbox.api.visionamos.passportfintech.com/v1/paas/entities/customers/payments/breb
Método	POST
Encabezados	Content-Type: application/json, Authorization
Autenticación	Token de Acceso (Bearer Token)

Cuerpo de la Solicitud

Parámetro	Tipo	Descripción
account_id	String	ID único de la cuenta desde la cual se realizará el pago.
breb_recipient_id	String	ID único del destinatario registrado en Bre-B que recibirá el pago.
amount.value	String	Valor a transferir.
amount.currency	String	Moneda de la transacción. Debe ser `"COP"`.
reference	String	Referencia o descripción del pago.

La notación amount.value hace referencia al campo value dentro del objeto amount.

Ejemplo de Solicitud

JSON
    
 
curl --location 'https://bre-b-sandbox.api.visionamos.passportfintech.com/v1/paas/entities/customers/breb/payments' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
--data '{
    "account_id": "9bb99e5e-5bd0-44c9-944a-d01c9d8ffe21", 
    "breb_recipient_id": "8e5dbe27-b17e-4366-a116-82f9c52bcdab",
    "amount": { 
        "value": "100000",
        "currency": "COP"
    },
    "reference": "Test payment"
}'
Copy

Cuerpo de la Respuesta

Código HTTP: 200 OK
Retorna los datos del pago junto con su ID único.

Ejemplo de Respuesta

JSON
    
 
{
    "breb_resolved_key": {
        "account_type": "LOW_VALUE",
        "account_number": "00880798997",
        "business_name": "DQDevelopEntity12HQ",
        "identification_number": "8905045638",
        "identification_type": "NIT"
    },
    "payment": {
        "status": "PENDING",
        "reference": "Test payment",
        "account_id": "9bb99e5e-5bd0-44c9-944a-d01c9d8ffe21",
        "breb_recipient_id": "8e5dbe27-b17e-4366-a116-82f9c52bcdab",
        "amount": {
            "currency": "COP",
            "value": "100000"
        },
        "id": "cdb5ae4b-fd6e-4244-9e16-a4e6262f0fe2"
    }
}
Copy

El campo status comienza en PENDING. Es necesario ejecutar el paso siguiente Confimar Pago para que el pago se envíe realmente a la red Bre-B.

Errores Comunes y Manejo

Código HTTP	Significado	Descripción
400 Bad Request	Datos inválidos	Faltan campos requeridos o contienen valores incorrectos.
401 Unauthorized	Token inválido	El token de acceso ha expirado o es inválido.
403 Forbidden	Acceso denegado	No tienes permisos para crear un pago.
500 Server Error	Error del servidor	Error inesperado al procesar el pago.

Buenas Prácticas

Verifica que los campos account_id y breb_recipient_id correspondan a entidades válidas.
Usa el campo reference para facilitar la trazabilidad del pago.
Monitorea el estado del pago (PENDING, SETTLED, etc.) para confirmar su procesamiento.
Implementa manejo de errores en tu integración para gestionar rechazos o demoras en el procesamiento.

Última actualización el