Eventos · Checkout
Checkout
Eventos da página de checkout HyzePay (/pay/…) e links de pagamento. Use para sincronizar pedidos, funil e analytics sem polling.
checkout.completed acompanha payment.paid quando o pagamento vem de um link. Para liberar produto, confira os dois ou só payment.paid com external_id.Eventos
| Evento | Quando | Uso |
|---|---|---|
checkout.created | Link de pagamento ou checkout de assinatura criado | Log / CRM / UTMs |
| checkout.completed | Cliente concluiu o pagamento no /pay | Confirmar conversão do link |
checkout.expired | Link inativado ou sem usos | Encerrar funil / oferta |
Objeto checkout
| Campo | Tipo | Descrição |
|---|---|---|
id | string | UUID do payment_link |
code | string | Código público (bill_…) |
kind | string | payment_link | subscription | charge |
title | string | null | Título do checkout |
status | string | active | inactive |
amount_cents | number | Valor em centavos |
amount_label | string | R$ formatado |
payment_method | string | null | pix, card… |
public_url | string | null | /pay/… |
payment_id | string | null | Pedido pago (completed) |
external_id | string | null | Seu ID no pedido |
Exemplo de payload
{
"id": "evt_…",
"type": "checkout.completed",
"api_version": "v2",
"created": 1710000000,
"created_at": "2026-03-09T12:00:00.000Z",
"livemode": true,
"data": {
"object": {
"id": "uuid-do-link",
"code": "bill_…",
"kind": "payment_link",
"title": "Plano Pro",
"status": "active",
"amount_cents": 9900,
"amount_label": "R$ 99,00",
"currency": "BRL",
"payment_method": "pix",
"product_id": "uuid-produto",
"public_url": "/pay/bill_…",
"success_url": "https://seusite.com/obrigado",
"return_url": null,
"paid_count": 1,
"max_uses": null,
"created_at": "…",
"payment_id": "uuid-do-pedido",
"external_id": "order_123"
}
},
"source": "hyzepay"
}Quando dispara na API
checkout.created—POST /api/payment-linkse criação de checkout de assinaturacheckout.completed— quando o pedido do link é marcado como pago (webhook PIX / confirmação)checkout.expired— ao inativar o link ou esgotar usos (quando implementado no fluxo)