PayZu GatewayWebhooks

Cadastrar webhooks


Nesta páginaCadastre o webhookCamposRegras da URLErros desta operação

Receba os avisos da conta em até 5 endereços do seu sistema, cada um só com os eventos de que ele precisa.

Cadastre o webhook

bash
curl -X POST https://api.sandbox.payzu.dev/v1/webhooks \
  -H "Authorization: Bearer SUA_CHAVE_DE_API" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://loja.exemplo.com.br/webhooks/payzu",
    "description": "Sistema de pedidos",
    "events": ["invoice.paid", "invoice.refunded"]
  }'

Referência: Cadastrar um webhook

Guarde o segredo que vem na resposta.

O secret só aparece nesta resposta e na troca do segredo. É com ele que você confere a assinatura de cada aviso.

O webhook nasce active. O cadastro ignora o cabeçalho Idempotency-Key: repetir a chamada cria outro webhook.

Campos

CampoRegra
urlObrigatório. Segue as regras da URL, abaixo.
eventsObrigatório. Lista com pelo menos um dos eventos.
descriptionOpcional. De 1 a 120 caracteres.

Regras da URL

  • Usa https na porta 443.
  • Não tem usuário nem senha.
  • Não aponta para endereço interno, para localhost nem para domínio que resolve para endereço interno.
  • Não aponta para domínio de serviço do Google Cloud: *.run.app, *.cloudfunctions.net, *.appspot.com, *.googleapis.com, *.goog e *.internal.

A conta tem até 5 webhooks, ativos ou pausados.

Para cadastrar o sexto, exclua um webhook e libere a vaga.

Erros desta operação

CódigoHTTPMensagem
PZ750400URL inválida.
A URL não pode ter usuário ou senha.
A URL precisa usar https.
A URL precisa usar a porta 443.
A URL aponta para um endereço interno.
A URL aponta para um serviço interno do Google Cloud. Use um domínio próprio.
A URL resolve para um endereço interno.
PZ751422Limite de 5 webhooks atingido. Apague um antes de criar outro.

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