PayZu OnboardingEventos de webhook

Proposta encerrada

WEBHOOKproposal.closed

Confira o passo a passo → https://docs.payzu.com.br/docs/onboarding/callbacks


Enviado quando a proposta termina sem decisão: foi cancelada ou o prazo venceu. A proposta em análise também pode terminar cancelada, embora a rota de cancelamento recuse esse caso com proposal_in_analysis. Proposta em análise não vence.

Headers

X-Callback-Eventstringobrigatório
Evento. O mesmo de event no corpo.proposal.closed
X-Callback-Idstringobrigatório
Identificador da entrega. Igual em todas as tentativas.
X-Callback-Attemptintegerobrigatório
Número desta tentativa.
X-Callback-Timestampintegerobrigatório
Instante desta tentativa, em segundos (Unix). Entra na assinatura.
X-Callback-Signaturestringobrigatório
sha256= seguido do HMAC-SHA256, em hexadecimal, de <X-Callback-Timestamp>.<corpo cru>, com o segredo do seu tenant.

Body

idstringobrigatório
Identificador da entrega, o mesmo de X-Callback-Id. Igual em todas as tentativas.
eventstringobrigatório
Evento, o mesmo de X-Callback-Event.proposal.closed
occurredAtstringobrigatório
Quando o fato aconteceu.
attemptintegerobrigatório
Número desta tentativa, de 1 a 6.
proposalobjectobrigatório
A proposta, lida na hora da entrega.
idstringobrigatório
ID da proposta.
clientCodestringobrigatório
Seu identificador, enviado na criação.
typestringobrigatório
Tipo de pessoa da proposta.PERSONCOMPANY
taxIdstring | nullobrigatório
CPF ou CNPJ do titular da proposta.
contactstring | nullobrigatório
Celular ou e-mail do titular.
statusstringobrigatório
Status da proposta.CREATEDIN_PROGRESSSUBMITTEDIN_ANALYSISWAITING_DATAAPPROVEDREPROVEDEXPIREDCANCELED
deliverystringobrigatório
Como o titular entra na jornada: por link ou embutida.LINKEMBEDDED
expiresAtstringobrigatório
Data e hora em que a proposta expira.
submittedAtstring | nullobrigatório
Data e hora do envio para análise.
decidedAtstring | nullobrigatório
Data e hora da decisão.
versionintegerobrigatório
Versão atual; envie em expectedVersion.
createdAtstringobrigatório
Data e hora do registro.
updatedAtstringobrigatório
Data e hora da última alteração.
dataobjectobrigatório
O fato, gravado quando aconteceu.
statusstringobrigatório
Cancelada (CANCELED) ou vencida (EXPIRED).CANCELEDEXPIRED

Responses

2XXQualquer 2xx em até 10 segundos confirma a entrega. Outro status, redirecionamento, que nunca é seguido, ou demora maior contam como falha, e a entrega se repete 1, 5, 30, 120 e 480 minutos depois, num total de seis tentativas.

sem corpo

Exemploapplication/json
{  "id": "9a3f7c02-6d1e-4b58-a0c9-4e8b2f61d7a3",  "event": "proposal.closed",  "occurredAt": "2026-10-20T12:05:00.000Z",  "attempt": 1,  "proposal": {    "id": "cmw5p2r8t0009s60c3h6k1m4z",    "clientCode": "crm-4502",    "type": "COMPANY",    "taxId": "11222333000181",    "contact": "financeiro@empresa.com.br",    "status": "EXPIRED",    "delivery": "EMBEDDED",    "expiresAt": "2026-10-20T12:00:00.000Z",    "submittedAt": null,    "decidedAt": null,    "version": 3,    "createdAt": "2026-10-13T12:00:00.000Z",    "updatedAt": "2026-10-20T12:05:00.000Z"  },  "data": {    "status": "EXPIRED"  }}