Pensiones

Las pensiones permiten registrar accesos recurrentes para clientes autorizados dentro de un establecimiento.

Este módulo se utiliza para operar membresías, permisos mensuales, accesos por placa y reglas de uso por día y horario.


¿Qué es una pensión?

Una pensión representa un permiso de acceso asociado a:

  • Un establecimiento.
  • Un cliente.
  • Una o más placas.
  • Un periodo de vigencia.
  • Un monto de cobro.
  • Reglas de acceso por día y horario.

Casos de uso

Pensión mensual

Acceso recurrente para clientes con pago mensual.

Acceso por placa

Permite validar vehículos autorizados mediante placas registradas.

Reglas por horario

Define días y ventanas de tiempo permitidas para el acceso.

Control por establecimiento

Cada pensión pertenece a un establecimiento específico.


Datos principales

CampoDescripción
establishment_idEstablecimiento donde aplica la pensión
establishment_customer_idCliente asociado al establecimiento
nameNombre descriptivo de la pensión
amountMonto de la pensión
currencyMoneda del cobro
valid_from_utcFecha inicial de vigencia
valid_to_utcFecha final de vigencia
billing_period_unitUnidad del periodo de cobro
billing_period_countCantidad de periodos

Placas autorizadas

Cada pensión puede incluir una o más placas autorizadas.

[
  {
    "plate": "ABC123",
    "plate_raw": "ABC-123"
  }
]
CampoDescripción
platePlaca normalizada
plate_rawPlaca capturada o mostrada originalmente

Reglas de acceso

Las reglas definen cuándo puede utilizarse la pensión.

CampoDescripción
day_of_weekDía de la semana
start_time_localHora inicial local
end_time_localHora final local
crosses_midnightIndica si la regla cruza medianoche

Días de la semana

La API utiliza la siguiente convención:

ValorDía
1Lunes
2Martes
3Miércoles
4Jueves
5Viernes
6Sábado
7Domingo

Ejemplo de pensión mensual

{
  "establishment_id": 1,
  "establishment_customer_id": 2,
  "name": "Pensión mensual Emiliano",
  "amount": "1500.00",
  "currency": "MXN",
  "valid_from_utc": "2026-06-01T00:00:00Z",
  "valid_to_utc": "2027-06-30T00:00:00Z",
  "billing_period_unit": "MONTH",
  "billing_period_count": 1,
  "plates": [
    {
      "plate": "ABC123",
      "plate_raw": "ABC-123"
    }
  ],
  "rules": [
    {
      "day_of_week": 1,
      "start_time_local": "00:00:00",
      "end_time_local": "23:59:59",
      "crosses_midnight": false
    }
  ]
}

Referencia API



Did this page help you?