KyvoPay

Status da plataforma

Endpoint público para monitorar a disponibilidade da KyvoPay.

GET/v1/public/statusChave de API

Status da plataforma#

GET/v1/public/statusSem autenticação

Endpoint aberto, sem chave de API. Serve para você plugar em um monitor externo, num painel interno ou numa página de status própria.

O campo operational resume tudo: ele é true quando todos os componentes estão saudáveis e não há manutenção em curso. Para um semáforo simples, basta esse campo.

Campos#

operationalbooleanopcional

Resumo geral. False quando algum componente falha ou há manutenção.

maintenance_modebooleanopcional

Manutenção programada em andamento.

components[]arrayopcional

Cada item traz name e ok: API, processamento de pagamentos e webhooks.

incidents[]arrayopcional

Últimos 20 incidentes registrados, do mais recente para o mais antigo.

GET/v1/public/status
curl https://api.kyvopay.com.br/v1/public/status
200 OKresposta
{
  "data": {
    "operational": true,
    "maintenance_mode": false,
    "components": [
      { "name": "API", "ok": true },
      { "name": "Processamento de pagamentos", "ok": true },
      { "name": "Webhooks", "ok": true }
    ],
    "incidents": [
      {
        "id": "3f9a...",
        "title": "Lentidão na confirmação de Pix",
        "status": "resolved",
        "severity": "minor",
        "body": "Normalizado às 14h20.",
        "created_at": "2026-08-11T13:40:00Z",
        "resolved_at": "2026-08-11T14:20:00Z"
      }
    ]
  },
  "error": null,
  "request_id": "req_9c0b1de4"
}

Healthcheck simples#

GET/healthSem autenticação

Para ferramentas de uptime que só olham o código HTTP, use /health. Ele responde rápido e sem tocar no banco — bom para checagens de alta frequência.

Frequência

Consulte /v1/public/status no máximo a cada 30 segundos. Para intervalos menores, use /health, que é bem mais leve.

Incidente não é erro da sua integração

Se operational for false, suas cobranças podem falhar temporariamente. Trate como indisponibilidade momentânea e repita com backoff — usando a mesma Idempotency-Key nas operações financeiras.
monitor externo
const res = await fetch(
  "https://api.kyvopay.com.br/v1/public/status",
);

const { data } = await res.json();

if (!data.operational) {
  await alertar({
    titulo: "KyvoPay fora do normal",
    componentes: data.components.filter((c) => !c.ok),
  });
}