PayZu GatewayEventos de webhook
Assinatura alterada
WEBHOOKsubscription.updated
Confira o passo a passo → https://docs.payzu.com.br/docs/gateway/webhooks
Sai a cada alteração aceita do valor, do cartão ou do metadata da assinatura.
Headers
X-Webhook-Eventstringobrigatório
Evento. O mesmo de type no corpo.
subscription.updatedX-Webhook-Timestampstringobrigatório
Instante desta tentativa, em milissegundos (Unix). Muda a cada tentativa e entra na assinatura.
X-Webhook-Noncestringobrigatório
Valor aleatório, novo a cada tentativa. Entra na assinatura.
X-Webhook-Signaturestringobrigatório
HMAC-SHA256, em hexadecimal, de <X-Webhook-Timestamp>.<X-Webhook-Nonce>.<corpo cru>, calculado com o segredo do webhook.
Body
idstringobrigatório
ID do evento. O mesmo em todas as tentativas, no reenvio e em todos os webhooks que recebem o evento.
typestringobrigatório
Evento. O mesmo de X-Webhook-Event.
subscription.updatedcreated_atstringobrigatório
Data e hora do evento, em UTC. Não muda na nova tentativa nem no reenvio.
dataobjectobrigatório
O recurso do evento em subscription, como estava no momento do evento.
subscriptionobjectobrigatório
A assinatura já alterada: active na troca de valor ou de cartão; active ou canceled na troca de metadata.
idstringobrigatório
ID da assinatura.
codestringobrigatório
Código curto da assinatura.
statusstringobrigatório
Status da assinatura: active ou canceled neste evento.
activecancelednamestringobrigatório
Nome da assinatura.
amountintegerobrigatório
Valor de cada ciclo, em centavos.
recurrencestringobrigatório
Periodicidade da cobrança.
monthlybimonthlyquarterlysemiannualannualpayment_methodstringobrigatório
Meio de pagamento.
credit_cardpixcreated_atstringobrigatório
Data e hora da criação.
updated_atstringobrigatório
Data e hora da última alteração.
credit_cardobject | nullobrigatório
Cartão da assinatura; nulo no Pix.
cardobjectobrigatório
Cartão.
idstring | nullobrigatório
ID do cartão salvo; nulo quando o cartão não ficou salvo.
brandstring | nullobrigatório
Bandeira.
last_digitsstringobrigatório
Últimos 4 dígitos.
holder_namestring | nullobrigatório
Nome impresso no cartão.
billingobjectobrigatório
Ciclos de cobrança.
anchor_atstringobrigatório
Data de referência dos ciclos.
next_atstring | nullobrigatório
Data do próximo ciclo; nula na assinatura cancelada.
canceled_atstring | nullobrigatório
Data e hora do cancelamento.
renewal_failuresintegerobrigatório
Renovações seguidas que falharam.
graceobject | nullobrigatório
Carência depois de um ciclo sem pagamento; nula sem carência.
started_atstringobrigatório
Início da carência.
ends_atstring | nullobrigatório
Fim da carência: o limite para pagar a fatura do ciclo.
cancellationobject | nullobrigatório
Cancelamento; nulo se a assinatura não está cancelada.
reasonstring | nullobrigatório
Motivo do cancelamento.
initial_payment_failurerenewal_failureplan_changeinvoice_refundinvoice_chargebackcustomer_requestmerchant_requestothernotestring | nullobrigatório
Observação do cancelamento.
previous_cancellationsarray of objectsobrigatório
Cancelamentos desfeitos, do mais novo para o mais antigo; vazio se a assinatura nunca voltou de um cancelamento.
canceled_atstringobrigatório
Data e hora do cancelamento.
reasonstring | nullobrigatório
Motivo do cancelamento.
initial_payment_failurerenewal_failureplan_changeinvoice_refundinvoice_chargebackcustomer_requestmerchant_requestothernotestring | nullobrigatório
Observação do cancelamento.
reactivated_atstringobrigatório
Data e hora em que a assinatura voltou a active.
customerobjectobrigatório
Cliente.
idstringobrigatório
ID do cliente.
namestringobrigatório
Nome do cliente.
emailstringobrigatório
E-mail do cliente.
documentstringobrigatório
CPF ou CNPJ do cliente.
document_typestringobrigatório
Tipo do documento.
cpfcnpjplanobject | nullobrigatório
Plano de origem; nulo na assinatura avulsa.
idstringobrigatório
ID do plano.
namestringobrigatório
Nome do plano.
discountobject | nullobrigatório
Desconto dos primeiros ciclos, contando a adesão; nulo sem desconto.
typestringobrigatório
Tipo do desconto.
fixed_amountpercentagevalueintegerobrigatório
Desconto: centavos ou porcentagem, conforme o tipo.
cyclesintegerobrigatório
Ciclos com desconto, contando a adesão.
internal_descriptionstring | nullobrigatório
Descrição interna do desconto.
public_descriptionstring | nullobrigatório
Texto do desconto para o cliente.
metadataobject | nullobrigatório
Seus dados, em chave e valor; nulo sem metadata.
Responses
2XXQualquer 2xx em até 5 segundos confirma a entrega. Redirecionamento conta como falha, e o corpo da resposta não é lido. Sem 2xx, a entrega volta a ser tentada 1 minuto, 10 minutos, 1 hora, 6 horas e 24 horas depois da tentativa anterior.
sem corpo
Esta página ajudou?