Ejemplos de Payloads para Open Link (BRE-B)

En esta página se detallan los diferentes escenarios de uso y estructuras de payload para la inicialización del SDK al generar Open Links con llaves BRE-B.

Parámetros del Payload

thirdUUID (string, Requerido): Identificador único del tercero asociado.
webhook (string, Requerido): URL donde se recibirán las notificaciones del estado del pago.
destinationType (string, Requerido): Tipo de destino del cobro. Para operaciones con BRE-B debe ser "BREB".
brebKey (object, Requerido): Objeto con la información de la llave BRE-B destino:
- key: Llave destino (ej. "@juanp").
- keyType: Tipo de llave ("ALFANUMERICA", "CELULAR", "EMAIL", etc.).
type (string, Opcional): Tipo de operación en el SDK (ej. "OPEN_LINK").
expirationSeconds (number, Opcional): Tiempo de vida del link en segundos (Mínimo: 60 seg / 1 min). Si se omite, aplica el valor predeterminado de 30 días (2592000 seg).
isReusable (boolean, Opcional): Define si el link puede recibir múltiples pagos (true) o un solo pago (false). Si se omite, por defecto es true.

Casos de Uso y Ejemplos de Payloads

1. Configuración por Defecto (Sin expiración explícita)

Este es el caso más común. Al omitir expirationSeconds e isReusable, el sistema asigna automáticamente una validez de 30 días y habilita la reutilización del link (isReusable: true).

JSON de ejemplo:

{  
  "thirdUUID": "third-uuid-aqui",  
  "webhook": "<https://tu-webhook.com/notify>",  
  "destinationType": "BREB",  
  "brebKey": {  
    "key": "@juanp" 
  }  
}

2. Expiración Corta y Uso Único (Ej. 1 hora)

Ideal para transacciones puntuales de cobro inmediato donde el link debe invalidarse automáticamente tras realizarse el primer pago exitoso (isReusable: false).

JSON de ejemplo:

{  
  "thirdUUID": "third-uuid-aqui",  
  "webhook": "<https://tu-webhook.com/notify>",  
  "destinationType": "BREB",  
  "brebKey": {  
    "key": "@juanp" 
  },  
  "expirationSeconds": 3600,  
  "isReusable": false  
}

3. Link Reutilizable sin Monto Fijo (Ej. 90 días)

Útil para escenarios tipo "caja registradora" o enlaces fijos de cobro donde se omite el amount para que sea el propio pagador quien defina el monto al abrir el enlace.

JSON de ejemplo:

{  
  "thirdUUID": "third-uuid-aqui",  
  "webhook": "<https://tu-webhook.com/notify>",  
  "destinationType": "BREB",  
  "brebKey": {  
    "key": "@juanp"
  },  
  "expirationSeconds": 7776000,  
  "isReusable": true  
}

4. Con llaves alternativas (brebKeys)

Diseñado para la fase de pruebas técnicas e integración, permitiendo validar rápidamente en tiempo real cómo responde su sistema cuando un enlace expira.

JSON de ejemplo:

{
  "thirdUUID": "third-uuid-aqui",
  "webhook": "https://tu-webhook.com/notify",
  "destinationType": "BREB",
  "brebKey": { "key": "@juanp" },
  "brebKeys": [
    { "key": "3001234567" },
    { "key": "@juan-empresa" }
  ]
}

5. Combinando con expiración/reusable

{
  "thirdUUID": "third-uuid-aqui",
  "webhook": "https://tu-webhook.com/notify",
  "destinationType": "BREB",
  "brebKey": { "key": "@juanp" },
  "brebKeys": [{ "key": "3001234567"}],
  "expirationSeconds": 3600,
  "isReusable": false
}