PayZu PixWebhooksCadastro e segredo

Alterar um webhook

PATCH/user/webhooks/{id}

Confira o passo a passo → https://docs.payzu.com.br/docs/pix/update-a-webhook


Path Params

idstringobrigatório
ID do webhook.

Body Params

urlstring
Nova URL que recebe os avisos.
activeboolean
Liga ou pausa as entregas.
eventsarray of strings
Nova lista de eventos, que substitui a anterior. Os dois de suspeita de fraude são aceitos, mas hoje não são enviados.

Headers

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

Responses

200Webhook alterado
idstringIdentificador do webhook.
urlstringURL que recebe os avisos.
activebooleanIndica se o webhook recebe entregas.
eventsarray of stringsEventos assinados.
TRANSACTION_PENDINGTRANSACTION_COMPLETEDTRANSACTION_CANCELEDTRANSACTION_WAITING_FOR_REFUNDTRANSACTION_REFUNDEDTRANSACTION_EXPIREDTRANSACTION_ERRORTRANSACTION_SUSPECTED_FRAUDTRANSACTION_SUSPECTED_FRAUD_REVERSALINFRACTION_CHANGED
hasSecretbooleanIndica se o webhook tem segredo de assinatura.
createdAtstringData e hora do cadastro.
updatedAtstringData e hora da última alteração.
400Requisição inválida
statusstringSempre ERROR.
errorstringNome do status HTTP.
errorCodestringCódigo do erro, como PZV001.
messagestringMotivo em texto, para exibir ou registrar.
statusCodeintegerO mesmo status HTTP da resposta.
requestIdstringInforme este id ao suporte para localizar a chamada.
detailsarray of objectsErros de validação por campo.
Campos de cada item 2
fieldstringCampo rejeitado.
messagestringMotivo da rejeição.
401Token ausente ou inválido
statusstringSempre ERROR.
errorstringNome do status HTTP.
errorCodestringCódigo do erro, como PZV001.
messagestringMotivo em texto, para exibir ou registrar.
statusCodeintegerO mesmo status HTTP da resposta.
requestIdstringInforme este id ao suporte para localizar a chamada.
403Acesso negado
statusstringSempre ERROR.
errorstringNome do status HTTP.
errorCodestringCódigo do erro, como PZV001.
messagestringMotivo em texto, para exibir ou registrar.
statusCodeintegerO mesmo status HTTP da resposta.
requestIdstringInforme este id ao suporte para localizar a chamada.
404Webhook não encontrado
statusstringSempre ERROR.
errorstringNome do status HTTP.
errorCodestringCódigo do erro, como PZV001.
messagestringMotivo em texto, para exibir ou registrar.
statusCodeintegerO mesmo status HTTP da resposta.
requestIdstringInforme este id ao suporte para localizar a chamada.
409Limite de webhooks ativos atingido
statusstringSempre ERROR.
errorstringNome do status HTTP.
errorCodestringCódigo do erro, como PZV001.
messagestringMotivo em texto, para exibir ou registrar.
statusCodeintegerO mesmo status HTTP da resposta.
requestIdstringInforme este id ao suporte para localizar a chamada.

Linguagem

Credenciais Bearer

Token de API

Gerar credencial de sandbox

curl --request PATCH \     --url https://pix.sandbox.payzu.dev/v1/user/webhooks/{id} \     --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