PayZu GatewayWebhooksEntregas

Listar as entregas dos webhooks

GET/v1/webhook-deliveries

Confira o passo a passo → https://docs.payzu.com.br/docs/gateway/look-up-deliveries


Query Params

statusstring enum
Filtra pelo status da entrega.pendingdeliveredfailed
webhook_idstring
Filtra pelo ID do webhook.
event_typestring enum
Filtra pelo tipo do evento.
created_fromstring
Criados a partir deste dia, no horário de Brasília.
created_tostring
Criados até este dia, no horário de Brasília.
cursorstring
next_cursor da página anterior, como veio.
limitintegerPadrão: 100
Itens por página; sem ele, 100.

Headers

Authorizationstringobrigatório
Bearer seguido do token de API.
acceptstring
Formato da resposta.

Responses

200Sucesso
itemsarray of objectsItens da página.
Campos de cada item 8
idstringID da entrega.
statusstringStatus da entrega.
pendingdeliveredfailed
delivered_atstring | nullData e hora da entrega; nula sem entrega.
created_atstringData e hora da criação.
webhookobjectWebhook da entrega.
Campos do objeto 2
idstringID do webhook.
urlstringEndereço atual do webhook, para onde vão as novas tentativas e o reenvio.
eventobjectEvento enviado.
Campos do objeto 2
idstringID do evento, o mesmo em todas as tentativas.
typestringTipo do evento.
attemptsobjectTentativas de envio.
Campos do objeto 5
countintegerTentativas feitas.
last_atstring | nullData e hora da última tentativa.
next_atstring | nullData e hora da próxima tentativa; nula sem próxima.
last_status_codeinteger | nullStatus HTTP da última resposta.
last_errorstring | nullErro da última tentativa.
payloadobjectCorpo do evento enviado, como chega no webhook: id, type, created_at e data, com o recurso no formato da consulta dele.
next_cursorstring | nullCursor da próxima página; nulo na última.
400Requisição inválida
status_codeintegerStatus HTTP.
errorstringNome do status HTTP.
messagestringMotivo em texto.
codestringCódigo do erro, quando existe.
request_idstringID da chamada, para o suporte.
fieldsarray of objectsCampos recusados na validação.
Campos de cada item 2
namestringCaminho do campo recusado.
messagestringMotivo da recusa.
401Chave ausente ou inválida
status_codeintegerStatus HTTP.
errorstringNome do status HTTP.
messagestringMotivo em texto.
codestringCódigo do erro, quando existe.
request_idstringID da chamada, para o suporte.
403Acesso negado
status_codeintegerStatus HTTP.
errorstringNome do status HTTP.
messagestringMotivo em texto.
codestringCódigo do erro, quando existe.
request_idstringID da chamada, para o suporte.
500Erro interno
status_codeintegerStatus HTTP.
errorstringNome do status HTTP.
messagestringMotivo em texto.
request_idstringID da chamada, para o suporte.

Linguagem

Credenciais Bearer

Token de API

curl --request GET \     --url https://api.sandbox.payzu.dev/v1/webhook-deliveries \     --header 'authorization: Bearer SEU_TOKEN' \     --header 'accept: application/json'
Resposta

Clique em Try It! para enviar uma requisição e ver a resposta aqui. Ou escolha um exemplo:

application/json