Saltar al contenido principal
Version: v1.0 (Legacy)

Creación de Cuentas (Intents)

La creación de una cuenta comercio se inicializa mediante la creación de una Intención de Registro (Intent). Este proceso genera una sesión temporal y segura.

Crear Intent de Onboarding

Genera una URL única para que el comercio cliente complete su afiliación.

  • Endpoint: api/v1/onboarding/intent
  • Método: POST

Parámetros de Petición (Body JSON)

AtributoTipoObligatorioDescripción
success_urlstringNoURL de redirección (callback) tras una activación exitosa.
cancel_urlstringNoURL de redirección si el comercio aborta el proceso.
metadataobjectNoObjeto de clave-valor para almacenar datos de trazabilidad (ej. tenant_id, user_id). Se devolverá intacto en el Webhook.
idempotency_keystringNoClave de idempotencia para prevenir múltiples registros accidentales.

Ejemplo de Petición:

{
"success_url": "https://dashboard.tu-ecommerce.com/onboarding/success",
"metadata": {
"tenant_id": "T-9872",
"plan": "premium"
}
}

Ejemplo de Respuesta:

{
"success": true,
"data": {
"code": "ONB-XXXX-XXXX",
"url": "https://onboarding.vendis.com/start/onb_abcdef123...",
"expires_at": "2026-04-24T15:51:00Z"
}
}