Webhook de estado de cuenta

Allaria envía una notificación al endpoint registrado por el partner cada vez que cambia el estado de una cuenta. El partner debe implementar este endpoint para recibir las notificaciones.

El request se envía como un HTTP POST a la URL completa que el partner registró. El path es el del partner — Allaria no impone ninguno:

POSTla URL que registraste

Por ejemplo, un partner que registra https://api.partner.com/webhooks/allaria/account-state recibe todas las notificaciones ahí.

Registrar tu URL

Enviá la URL completa en la que querés recibir las notificaciones a integraciones@allaria.com.ar, una por ambiente. No hay un endpoint para esto — la suscripción se configura del lado de Allaria.

Si querés que el request se asegure con una API key, indicalo en el mismo mensaje. Hasta que la URL esté registrada no se envía ninguna notificación y nada falla de forma visible.

Request

Allaria envía este request al partner. El partner debe exponer el endpoint y responder con un status code 2XX para confirmar la recepción.

Headers

Campo	Tipo	Descripción
Content-Type	string	Siempre application/json
Header de API key	string	Solo si pediste seguridad por API key. El nombre del header y la key se acuerdan al registrar la URL. Rechazá el request con 401 cuando falte o sea incorrecta.

Path Parameters

No aplica.

Query Parameters

No aplica.

Body

Campo	Tipo	Descripción
type	string	Tipo de titular de la cuenta. Ver Valores de type.
taxId	string	Identificador tributario (CUIT) del titular. Solo dígitos.
state	string	Nuevo estado de la cuenta. Ver Valores de state.
email	string	Email del titular. Solo se envía cuando type es UnitHolder; en los demás casos no está.
accountNumber	string	El comitente de la cuenta. Ver Identificadores de cuenta.

Valores de type

Valor	Descripción
Individual	La cuenta pertenece a una persona humana.
LegalEntity	La cuenta pertenece a una persona jurídica.
UnitHolder	La cuenta pertenece a un cuotapartista. Es el único tipo que incluye email.

Valores de state

Valor	Descripción
aceptado	La cuenta fue aceptada.
operativo	La cuenta está operativa.
bloqueado	La cuenta está bloqueada.
detenido	La cuenta está detenida.
rechazado	La cuenta fue rechazada: permaneció en análisis más allá del plazo permitido (21 días) y se rechazó automáticamente. Puede reanudarse más adelante, en cuyo caso llega una nueva notificación.

Los valores de state se envían en español, exactamente como se muestran. Se envía una notificación en cada cambio de estado, por lo que el mismo estado puede llegar de nuevo si la cuenta vuelve a él.

Ejemplo de payload

{
  "type": "UnitHolder",
  "taxId": "30712345841",
  "state": "operativo",
  "email": "empresa.segunda@example.com",
  "accountNumber": "263"
}

Response

El partner debe responder con cualquier status code 2XX para confirmar la recepción.

advertencia

Asociá cada notificación a tu registro mediante accountNumber y considerá el último state recibido como el vigente.