PayZu GatewayWebhooksCadastro de webhooks

Cadastrar um webhook

POST/v1/webhooks

Confira o passo a passo → https://docs.payzu.com.br/docs/gateway/register-webhooks


Body Params

urlstringobrigatório
Endereço que recebe os eventos.
descriptionstring
Descrição do webhook.
eventsarray of stringsobrigatório
Eventos que o webhook recebe.

Headers

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

Responses

201Webhook cadastrado
idstringID do webhook.
statusstringStatus do webhook.
activeinactive
urlstringEndereço que recebe os eventos.
descriptionstring | nullDescrição do webhook.
eventsarray of stringsEventos que o webhook recebe.
masked_secretstringFinal do segredo, para conferir qual está em uso.
secretstringSegredo do webhook, que assina cada entrega. Só aparece aqui.
created_atstringData e hora da criação.
updated_atstringData e hora da última alteração.
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.
422Operação recusada
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 POST \     --url https://api.sandbox.payzu.dev/v1/webhooks \     --header 'authorization: Bearer SEU_TOKEN' \     --header 'accept: application/json' \     --header 'content-type: application/json' \     --data '{}'
Resposta

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

application/json