Atualizações Recentes

Lançamento da API v1

Estamos lançando a API pública HyzePay v1 — REST JSON para gerar cobranças PIX, consultar status, listar e cancelar pagamentos, com autenticação por API Key e webhooks assinados.

Prefixo: /api/v1. Chaves no formato hzp_live_…, geradas no dashboard (Integração → API) com 2FA.

O que entra neste lançamento

• Health check público em GET/api/v1/health
• Criar pagamento PIX via POST/api/v1/payments — devolve br_code, QR e checkout_url
• Consultar por UUID ou external_id — GET/api/v1/payments/{id}
• Listar com filtros de status e paginação — GET/api/v1/payments
• Cancelar / expirar pagamentos pending — DELETE/api/v1/payments/{id}
• Idempotência com external_id estável (retries não geram segundo PIX)
• Webhooks de merchant com HMAC (X-HyzePay-Signature), envelope v2 e evento payment.paid
• API Keys com escopos payments:read / payments:write e criação protegida por 2FA
• CLI oficial (@hyzepay/cli) para dev, CI e validação de webhooks

Status de pagamento

Ciclo suportado na v1:

• pending — aguardando PIX
• paid — confirmado (libere o produto)
• expired — expirou ou foi cancelado
• failed / refunded

Exemplo rápido

curl -X POST "$HYZEPAY_BASE_URL/api/v1/payments" \
  -H "Authorization: Bearer $HYZEPAY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "amount_cents": 1500,
    "description": "Pedido #1001",
    "external_id": "pedido-1001"
  }'

Onde ler a docs

• Referência → PIX
• Webhooks
• CLI
• Guia: Chaves de API

Breaking changes

Este é o primeiro release público da API v1 — não há migração de versões anteriores. Header de versão em todas as respostas:

X-HyzePay-API-Version: v1