PayZu GatewayCobranças

Cancelar uma fatura


Nesta páginaCancele a faturaO que pode ser canceladoErros desta operação

Feche uma fatura em aberto que não deve mais ser paga, como um pedido desfeito antes do pagamento.

Cancele a fatura

bash
curl -X POST https://api.sandbox.payzu.dev/v1/invoices/in_5Hn9WqZc2LmXv6BtYr1dKe/cancel \
  -H "Authorization: Bearer SUA_CHAVE_DE_API" \
  -H "Content-Type: application/json" \
  -d '{ "note": "Cliente desistiu da compra" }'

Referência: Cancelar uma fatura

A resposta é 200, com a fatura inteira, e sai o evento invoice.canceled.

CampoRegra
noteOpcional, de 1 a 255 caracteres. Volta em cancellation.note. O corpo também é opcional.
Idempotency-KeyOpcional. Com ela, repetir o cancelamento retorna a resposta guardada; sem ela, o segundo cancelamento é recusado porque a fatura já não está em aberto.

O que pode ser cancelado

  • Status: só a fatura pending. A fatura paga se desfaz pelo estorno.
  • Fatura de assinatura: não é cancelada sozinha. Cancele a assinatura, como em Cancelar uma assinatura: as faturas em aberto dela sem pagamento confirmado passam a canceled junto, com cancellation.reason igual a subscription_cancellation, e sai um invoice.canceled por fatura.
  • Tentativa já paga: se a fatura em aberto já tem uma tentativa paga, ela passa a paid, sai invoice.paid, e o cancelamento é recusado.

O cancelamento não desfaz o Pix já emitido.

O QR Code de uma tentativa pending vale até pix.expires_at. Se o cliente pagar nesse prazo, ou se uma tentativa de cartão em andamento for aprovada, a fatura volta a paid, com cancellation e billing.canceled_at nulos, e sai invoice.paid.

Erros desta operação

CódigoHTTPMensagem
-404Fatura não encontrada para o id informado.
PZ111409Só uma fatura em aberto pode ser paga ou cancelada.
PZ120409Fatura de assinatura não é cancelada sozinha. Cancele a assinatura.

Os erros de autenticação, de idempotência e de validação estão no Catálogo de erros.