PayZu PixWebhooks e callbacks

Cadastrar webhooks


Nesta páginaCadastre o webhookDepois do cadastroErros desta operação

Receba os avisos de todas as transações da conta num endereço só, sem informar o endereço em cada chamada.

Cadastre o webhook

bash
curl -X POST https://pix.sandbox.payzu.dev/v1/user/webhooks \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://sualoja.com.br/webhook",
    "events": ["TRANSACTION_COMPLETED", "TRANSACTION_REFUNDED"],
    "generateSecret": true,
    "active": true
  }'

Referência: Cadastrar um webhook

CampoRegra
urlhttp ou https, pública, sem usuário e senha e sem IPv6 literal. Fora disso, a resposta é 400.
eventsA lista de eventos; vazia, assina todos.
generateSecretCom true, a resposta traz o secret. Guarde: ele só aparece nesta resposta.
activefalse cadastra o webhook pausado.

A conta tem até 5 webhooks ativos.

O sexto cadastro ativo, ou a reativação de um pausado além do limite, responde 409.

No sandbox, o webhook só recebe entregas depois de provar que a URL é sua.

Veja Webhooks no sandbox. Em produção não há essa etapa.

Depois do cadastro

Erros desta operação

CódigoHTTPMensagem
PZA204403Conta bloqueada para alterações. Desbloqueie a conta antes de alterar.
PZG409409Limite de 5 webhooks ativos atingido

Os códigos de autenticação e de validação estão no Catálogo de erros.