PayZu Conta HubWebhooks da contaCadastro de webhooks

Cadastrar um webhook

POST/transactions/webhooks

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


Body Params

urlstringobrigatório
URL que recebe os avisos.
eventsarray of stringsobrigatório
Eventos que o webhook recebe.
isActivebooleanPadrão: true
Indica se o webhook recebe entregas.

Headers

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

Responses

201Webhook cadastrado
idstringID do webhook.
urlstringURL que recebe os avisos.
eventsarray of stringsEventos que o webhook recebe.
PAYMENT_CREATEDPAYMENT_PAIDPAYMENT_REFUNDEDPAYMENT_EXPIREDWITHDRAW_CREATEDWITHDRAW_COMPLETEDWITHDRAW_FAILEDINFRACTION_OPENEDINFRACTION_CLOSEDINFRACTION_DEADLINEDEPOSIT_RECEIVEDREFUND_COMPLETEDREFUND_FAILEDACCOUNT_BLOCKEDACCOUNT_UNBLOCKEDINTERNAL_TRANSFER_SENTINTERNAL_TRANSFER_RECEIVEDWITHDRAW_REFUND_RECEIVED
isActivebooleanIndica se o webhook recebe entregas.
createdAtstringData e hora do registro.
updatedAtstringData e hora da última alteração.
secretstringSegredo de assinatura, mostrado só nesta resposta.
400Requisição inválida
messagestringMotivo em texto, para exibir ou registrar.
codestringCódigo do erro.
401Credencial ausente ou inválida
messagestringMotivo em texto, para exibir ou registrar.
codestringCódigo do erro.
403Acesso negado
messagestringMotivo em texto, para exibir ou registrar.
codestringCódigo do erro.
409URL já cadastrada
messagestringMotivo em texto, para exibir ou registrar.
codestringCódigo do erro.
422Operação recusada
messagestringMotivo em texto, para exibir ou registrar.
codestringCódigo do erro.

Linguagem

Credenciais Bearer

Token de API

curl --request POST \     --url https://api.sandbox.payzu.dev/api/v1/transactions/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