Saltar al contenido principal
Version: v2.0 (RESTful)

Estados del Intent

El proceso de registro y afiliación de un nuevo comercio se gestiona a través de una Intención de Registro (Intent). Este intent tiene un ciclo de vida con estados bien definidos que representan el progreso del comercio desde que la Plataforma Integradora solicita la URL de onboarding hasta que la cuenta es completamente habilitada o el proceso se da por terminado.


Diccionario de Estados del Intent

El campo status devuelto en las consultas del estado de afiliación o en los eventos asíncronos de la API puede tomar uno de los siguientes valores de tipo string (ENUM):

EstadoSignificadoComportamiento e Impacto
createdCreado / Activo. El intent de onboarding ha sido generado exitosamente vía API. La URL de registro está lista para que el comercio ingrese y complete sus datos.La sesión temporal está activa. El comercio puede acceder al formulario web y realizar el pago de activación.
expiredExpirado. La sesión de registro superó el tiempo límite de validez definido (por defecto 120 minutos / 2 horas) sin completarse.La URL se invalida automáticamente. Si el comercio intenta ingresar, verá una pantalla de error. La plataforma deberá generar un nuevo intent vía API.
completedCompletado. El comercio completó exitosamente el formulario de registro, realizó el pago de activación y el sistema lo procesó de manera conforme.Se dispara el Webhook onboarding.completed hacia la Plataforma Integradora con el business_code listo para la generación de credenciales API.
cancelledCancelado. El comercio decidió abortar explícitamente el flujo interactivo presionando el botón "Cancelar" o saliendo del proceso asistido.El comercio es redirigido a la cancel_url provista. La sesión de registro se invalida inmediatamente.
failedFallido. Ocurrió un error crítico no recuperable durante la verificación del pago de activación del comercio o la validación interna del perfil.La afiliación se bloquea. El integrador debe revisar los detalles o ponerse en contacto con Soporte Técnico para reabrir el caso o generar un nuevo intent.

Ciclo de Vida y Transiciones

A continuación, se detalla el flujo de estados que experimenta una Intención de Registro:

Recomendaciones clave para el Integrador:

  1. Monitoreo Asíncrono de Estados:
    • La Plataforma Integradora debe escuchar activamente el webhook onboarding.completed para capturar el business_code e inyectar de manera segura la credencial del comercio.
  2. Redirección de Flujo:
    • Aprovecha los parámetros success_url y cancel_url al crear el intent. Si el estado cambia a cancelled, redirige amigablemente al comercio dentro de tu plataforma y ofrécele la opción de reintentar el proceso.
  3. Manejo de Expiraciones (expired):
    • No guardes URLs de onboarding de manera permanente. Al expirar, genera siempre un nuevo intent fresco para garantizar la seguridad de la sesión.