PayZu GatewayWebhooks

Consultar entregas


Nesta páginaListe as entregasConsulte uma entregaStatus da entregaErros desta operação

Confira o que a PayZu enviou ao seu endpoint em cada evento: o status da entrega, as tentativas, a última resposta e o corpo.

Liste as entregas

bash
curl "https://api.sandbox.payzu.dev/v1/webhook-deliveries?webhook_id=whe_oeQa3G4R1B4IW9KNJAiP1l&limit=2" \
  -H "Authorization: Bearer SUA_CHAVE_DE_API"

A resposta traz as entregas em items, da mais nova para a mais antiga, cada uma no formato da consulta abaixo. Cada página tem até 100 entregas, com next_cursor para a seguinte.

Referência: Listar as entregas dos webhooks

FiltroRegra
webhook_idUm id que não existe traz a lista vazia.
statusUm dos status da entrega.
event_typeUm dos eventos ou ping.
created_from e created_toDia de criação em AAAA-MM-DD, no fuso de São Paulo, com os dois dias incluídos.

Um valor fora da lista em status ou em event_type responde 400.

As entregas concluídas ficam 30 dias na lista.

As entregas delivered e failed saem da lista 30 dias depois da criação.

Consulte uma entrega

bash
curl https://api.sandbox.payzu.dev/v1/webhook-deliveries/whd_Aduv7DfwwLFCdrFLtEmNrd \
  -H "Authorization: Bearer SUA_CHAVE_DE_API"

Referência: Consultar uma entrega

O exemplo é a entrega do evento de teste ping, que o painel envia com o webhook inteiro em data.webhook. Nos outros eventos, payload traz o corpo descrito em Modelo de evento.

CampoO que traz
payloadCorpo do evento como foi guardado na criação da entrega, igual em todas as tentativas e no reenvio.
webhook.urlEndereço atual do webhook.
attempts.countTentativas feitas.
attempts.last_atMomento da última tentativa.
attempts.next_atMomento da próxima tentativa.
attempts.last_status_codeStatus HTTP da última resposta, ou null quando o endpoint não respondeu.
attempts.last_errorMotivo da última falha, como HTTP 500.

Status da entrega

StatusO que significa
pendingEspera a primeira ou a próxima tentativa.
deliveredEntrega concluída.
failedSexta tentativa sem 2xx, entrega do ping sem 2xx, que não tem nova tentativa, ou reenvio de entrega failed ou delivered que não teve 2xx.

Erros desta operação

CódigoHTTPMensagem
-404Entrega não encontrada para o id informado.

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