PayZu PixWebhooksCadastro e segredo
Cadastrar um webhook
POST/user/webhooks
Confira o passo a passo → https://docs.payzu.com.br/docs/pix/register-webhooks
Requisições recentes
Body Params
urlstringobrigatório
URL que recebe os avisos.
eventsarray of stringsPadrão: []
Eventos que o webhook recebe. Os dois de suspeita de fraude são aceitos, mas hoje não são enviados.
generateSecretbooleanPadrão: false
Gera um segredo para assinar as entregas.
activebooleanPadrão: true
Indica se o webhook começa ativo.
Headers
Authorizationstringobrigatório
Bearer seguido do token de API.
acceptstring
Formato da resposta.
Responses
201Webhook cadastrado
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_CHANGEDhasSecretbooleanIndica se o webhook tem segredo de assinatura.
createdAtstringData e hora do cadastro.
updatedAtstringData e hora da última alteração.
secretstring | nullSegredo de assinatura, mostrado só nesta resposta.
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.
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.
Esta página ajudou?