🚀 Fase beta. ERP en fase privada —solicita acceso
Guías de la API Guía 5 de 6

La pool: cuánto te queda

Cómo se consulta la pool, qué significa cada campo, qué descuenta y qué no, y qué pasa cuando se para o se cierra.

Qué es la pool

La pool es el saldo de procesos del mes de quien paga. Todas sus llaves de procesar descuentan de ella, sean de una empresa o de varias.

Qué descuenta y qué no

➖

Descuenta

Cada factura que se entrega terminada descuenta un proceso. También la que llega con avisos: un aviso no rechaza la factura.

⭕

No descuenta

Un trabajo rechazado o fallido. Una subida repetida con la misma Idempotency-Key y la misma llave en menos de 24 horas (devuelve el mismo trabajo). Los 500 y 503: «No se ha descontado nada».

Consultarla, paso a paso

1

Pide la pool con cualquier llave

GET /v1/pool vale con cualquier llave de la pool, de procesar o de administrar:

curl -sS https://api.munincloud.com/v1/pool \
  -H "Authorization: Bearer $MC_LLAVE_PROCESAR"
{
  "estado": "activa",
  "periodo": {"desde": "2026-10-01", "hasta": "2026-10-31"},
  "cupo_mes": 3000,
  "arrastre": 600,
  "disponibles_mes": 3600,
  "usados_mes": 1188,
  "disponibles": 2412,
  "aviso_80": false,
  "parada_desde": null,
  "recargar": null
}
2

Lee cada campo

campoqué es
estadoactiva, parada o cerrada (abajo)
periodoel mes en curso: desde y hasta
cupo_meslos procesos que da el plan cada mes
arrastrelo que pasó del mes anterior: como mucho el 20 % de su cupo
disponibles_mescupo + arrastre + recargas vivas
usados_meslo gastado este mes
disponiblesdisponibles_mes − usados_mes: lo que te queda
aviso_80true cuando se ha gastado más del 80 % de lo disponible en el mes
parada_desdesi está parada, desde cuándo
recargardónde se recarga la pool, o null
3

No hace falta preguntar a propósito

Cada respuesta de la API dice lo que queda, en las cabeceras X-Pool-Disponibles (los procesos que le quedan a la pool este mes) y X-Pool-Estado (activa, parada o cerrada). Y cada trabajo trae un resumen en pool:

"pool": {"estado": "activa", "disponibles": 2412, "aviso_80": false}

Tu programa puede vigilar aviso_80 en cada trabajo y avisar a quien paga antes de que la pool se pare.

Los tres estados

estadoqué pasaqué contesta
activale queda saldo y procesa—
paradael plan del mes y las recargas, a cero: no procesa. Al recargar vuelve a funcionar con las mismas llaves. Tras 3 meses parada sin recargar, se cierra402 POOL_AGOTADA al subir, con recargar
cerradadefinitivo: sus llaves están anuladas y no se emiten llaves nuevas402 POOL_CERRADA
{
  "error": {
    "codigo": "POOL_AGOTADA",
    "mensaje": "La pool está parada porque se han agotado el plan del mes y las recargas. Al recargarla, las mismas llaves vuelven a funcionar.",
    "recargar": "https://munincloud.com/api/recargar"
  }
}

Lo siguiente

Con los resultados en la mano, llévalos a tu programa contable: Llevar el resultado a tu programa con un conector.