Eventos · Saques
Saques
Saques do saldo da conta HyzePay para a chave PIX do merchant. Use para contabilidade e conciliação de caixa.
Disparados pelo painel (
POST /api/withdrawals) e pelo processador de saques padrão. Em falha de gateway: withdrawal.failed.Eventos
| Evento | Quando | Uso |
|---|---|---|
withdrawal.requested | Saque solicitado no painel | Contabilidade / fila |
| withdrawal.paid | Saque liquidado no gateway | Confirmar saída de caixa |
withdrawal.failed | Falha ao processar na Woovi/PIX | Retry / suporte |
Objeto withdrawal
| Campo | Tipo | Descrição |
|---|---|---|
id | string | UUID do saque |
code | string | Código wd_… |
status | string | processing | paid | failed… |
amount_cents | number | Valor bruto |
fee_cents | number | Taxa do saque |
speed | string | null | standard | instant… |
destination_pix_key_masked | string | null | Chave mascarada |
failure_reason | string | null | Se failed |
end_to_end_id | string | null | End-to-end PIX |
Exemplo de payload
{
"id": "evt_…",
"type": "withdrawal.paid",
"api_version": "v2",
"created": 1710000000,
"created_at": "2026-03-09T12:00:00.000Z",
"livemode": true,
"data": {
"object": {
"id": "uuid-saque",
"code": "wd_…",
"status": "paid",
"amount_cents": 50000,
"amount_label": "R$ 500,00",
"currency": "BRL",
"fee_cents": 0,
"speed": "standard",
"kind": "standard",
"destination_pix_key_masked": "12…8901",
"failure_reason": null,
"created_at": "…",
"paid_at": "…",
"end_to_end_id": "E…"
}
},
"source": "hyzepay"
}Quando dispara
withdrawal.requested— criação do saque no dashboardwithdrawal.paid— liquidação (instantânea ou apósprocess_afterno standard)withdrawal.failed— erro no gateway ao processar saque standard