PayZu GatewayWebhooks
Alterar um webhook
Mude o endereço, os eventos ou a descrição de um webhook, ou pause os avisos e reative depois.
Altere o webhook
bash
curl -X PATCH https://api.sandbox.payzu.dev/v1/webhooks/whe_oeQa3G4R1B4IW9KNJAiP1l \
-H "Authorization: Bearer SUA_CHAVE_DE_API" \
-H "Content-Type: application/json" \
-d '{ "events": ["invoice.paid", "invoice.refunded", "subscription.canceled"] }'A resposta traz o webhook já alterado, no formato da consulta.
Referência: Alterar um webhook
Campos
Envie pelo menos um destes campos. Nenhum outro é aceito.
| Campo | Regra |
|---|---|
url | Passa pelas regras do cadastro e vale para todo envio seguinte, inclusive as novas tentativas que já estavam na fila. |
events | Substitui a lista inteira. |
description | null apaga a descrição. |
status | inactive pausa e active reativa. |
Pause e reative
bash
curl -X PATCH https://api.sandbox.payzu.dev/v1/webhooks/whe_oeQa3G4R1B4IW9KNJAiP1l \
-H "Authorization: Bearer SUA_CHAVE_DE_API" \
-H "Content-Type: application/json" \
-d '{ "status": "inactive" }'Os eventos do período de pausa não geram entrega e não voltam na reativação.
Para repor o período, consulte os recursos na API, como em Listar as faturas.
As entregas que já estavam na fila esperam e saem depois que o webhook volta a active. O reenvio de uma delas sai na hora, mesmo com o webhook pausado, menos o da entrega cuja próxima tentativa sai em até cerca de 1 minuto.
Erros desta operação
| Código | HTTP | Mensagem |
|---|---|---|
PZ750 | 400 | URL 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. |
| - | 404 | Webhook não encontrado para o id informado. |
Os erros de autenticação, de idempotência e de validação estão no Catálogo de erros.