Eventos

Eventos de webhook

Cada evento é um POST assinado com HMAC para a URL que você cadastrou. Inscreva só o que precisa no painel Integração → Webhook.

Header X-HyzePay-Event traz o nome do evento (ex.: checkout.completed). No envelope v2 o mesmo valor está em type.

Catálogo por categoria

Checkout

Links e páginas /pay — criação, conclusão e expiração.

checkout.createdcheckout.completedcheckout.expired

Assinaturas

Ciclo de vida de assinaturas recorrentes.

subscription.createdsubscription.activatedsubscription.canceledsubscription.past_due

Transferências

Envios PIX / transferências de saída.

transfer.createdtransfer.paidtransfer.failed

Saques

Saques do saldo da conta para PIX.

withdrawal.requestedwithdrawal.paidwithdrawal.failed

Pagamentos

Cobranças PIX via API e pedidos — evento crítico payment.paid.

payment.createdpayment.paidpayment.expiredpayment.failedpayment.refunded

Envelope v2

Todos os eventos usam o mesmo envelope. O recurso específico fica em data.object (checkout, subscription, transfer, withdrawal ou payment).

{
  "id": "evt_…",
  "type": "checkout.completed",
  "api_version": "v2",
  "created": 1710000000,
  "created_at": "…",
  "livemode": true,
  "data": { "object": { /* recurso */ } },
  "source": "hyzepay"
}

Como se inscrever

Dashboard → Integração → Webhook
Crie ou edite o webhook e marque os eventos desejados
Valide a assinatura — veja Verificação e Segurança
Use Enviar teste e implemente idempotência por event.id