PayZu PaymentsCobranças

Estornar uma cobrança


Nesta páginaEstorne a cobrançaConfirme o estornoErros desta operação

Cancele uma venda confirmada estornando o valor total da cobrança, uma única vez, com o valor debitado do saldo da sua conta.

Estorne a cobrança

  • Cobrança: chargeId é o id da cobrança, que precisa estar com creditCardPayment.status igual a 2 e reversedAmount vazio.
  • Corpo: a rota não recebe corpo.
  • Valor: não envie amount na query. O estorno parcial não está disponível.
bash
curl --request PUT \
  --url 'https://api.sandbox.payzu.dev/v1/charges/e3b7a1f2-8c4d-4a09-9f1e-2b6c8d5a7e90/reverse' \
  --header "Authorization: Bearer $PAYZU_TOKEN" \
  --cert "$PAYZU_CLIENT_CERT" --key "$PAYZU_CLIENT_KEY"

Referência: Estornar ou devolver uma cobrança

A resposta traz a cobrança inteira; o exemplo mostra só os campos que mudam.

Um estorno não se desfaz.

Antes de chamar a rota, confira se o id é o da cobrança certa.

Uma segunda chamada para a mesma cobrança espera de 3 a 5 segundos pela primeira. Se a primeira terminar o estorno nesse intervalo, a segunda retorna 422; se a primeira ainda estiver em andamento, a segunda retorna 409.

Confirme o estorno

MomentoO que a cobrança mostra
Logo depois do PUTreversedAmount com o valor da cobrança e reversedDate preenchidos. creditCardPayment.status pode continuar 2.
Cancelamento confirmadocreditCardPayment.status muda para 10 ou 11, e a PayZu envia o aviso charge.update para a postbackUrl da cobrança.

O aviso é o canal recomendado para refletir a mudança no seu sistema; veja Webhooks. A consulta por GET /charges/{chargeId} mostra os mesmos campos a qualquer momento.

Erros desta operação

CódigoHTTPMensagem
PZ404400Valor do estorno excede o saldo disponível
PZ403403Estorno parcial não disponível
PZ100404Cobrança não encontrada
PZ402409Já existe um estorno em andamento para esta cobrança
PZ406409Estorno desta cobrança já está em processamento
PZ104422Conta sem provedor de pagamento configurado
PZ108422Configuração de pagamento da conta incompleta
PZ400422Cobrança não disponível para estorno
PZ401422Cobrança já estornada
PZ800422Conta sem carteira configurada
PZ900422O provedor de pagamento recusou a operação
PZ901503Não foi possível estabelecer comunicação com o provedor de pagamento. Tente novamente em instantes.

Os erros de autenticação e de validação e os demais códigos estão no Catálogo de erros.