Health check

Use GET /v1/health para monitorar se a API da Allya Payments está respondendo.

Esse endpoint é público, não exige API key e não consome rate limit de pagamentos. Ele serve como liveness check para ferramentas de uptime monitoring.

curl https://payments-api.allyasolutions.com/v1/health

Resposta:

{
  "ok": true,
  "service": "allya-payments"
}

Escopo

O health check confirma apenas que o processo HTTP está respondendo. Ele não valida conexão com banco, credenciais de gateways, rotas de pagamento, webhooks ou dependências externas.

Para monitorar o fluxo completo de pagamentos, combine esse endpoint com testes sintéticos em ambiente sandbox.

Veja também

• Autenticação: GET /v1/auth/test valida a chave (mais informativo, mas requer auth).
• Indo para produção: onde encaixar /v1/health no monitoramento.