PayZu GatewayClientes e cartões
Excluir um cliente
Nesta página
Exclua o clienteO que muda depois da exclusãoTraga o cliente de voltaErros desta operaçãoA exclusão arquiva o cliente e responde 204, sem corpo.
Exclua o cliente
bash
curl -X DELETE https://api.sandbox.payzu.dev/v1/customers/cus_bdQT0ls1QMIXVuhngvhbwC \
-H "Authorization: Bearer SUA_CHAVE_DE_API"Referência: Excluir um cliente
A exclusão é recusada enquanto o cliente tem assinatura ou pagamento em andamento.
A recusa responde 409 nas situações da tabela abaixo.
| Situação do cliente | Antes de excluir |
|---|---|
Assinatura active ou incomplete. | Cancele a assinatura. |
Fatura dele com tentativa de pagamento pending ou processing. | Aguarde o desfecho do pagamento. |
O que muda depois da exclusão
| O que | Como fica |
|---|---|
| Cliente | Sai da lista, e as rotas dele, inclusive as de cartões, respondem 404. |
customer_id | Responde 404 em faturas e assinaturas novas, como um id desconhecido. |
| Cartões salvos | São apagados. |
| Faturas e assinaturas antigas | Continuam disponíveis para consulta e mostram o cliente como era. |
| Reativação de uma assinatura dele | Responde 404 enquanto o cliente está excluído. |
A Idempotency-Key é opcional e segue as regras de Idempotência.
Traga o cliente de volta
Cadastre de novo com o mesmo documento ou envie esse documento em customer ao criar uma fatura ou uma assinatura. O cliente volta com o mesmo id, sem os cartões salvos.
Erros desta operação
| Código | HTTP | Mensagem |
|---|---|---|
| - | 404 | Cliente não encontrado para o id informado. |
PZ702 | 409 | O cliente tem assinatura ativa. Cancele a assinatura antes de excluir o cliente. |
PZ703 | 409 | O cliente tem pagamento pendente. Aguarde a conclusão do pagamento antes de excluir o cliente. |
Os erros de autenticação, de idempotência e de validação estão no Catálogo de erros.