Cancelar uma proposta
Encerre o pedido que não vai seguir enquanto a proposta está com o cliente, em preenchimento ou em WAITING_DATA, mesmo com o prazo vencido.
Cancele a proposta
curl --request POST \
--url 'https://api.sandbox.payzu.dev/v1/proposals/cmf0p8x1a0001qk08prop0001/actions/cancel' \
--header 'Authorization: Bearer SEU_TOKEN' \
--header 'Content-Type: application/json' \
--data '{
"expectedVersion": 0,
"reason": "Cliente desistiu da abertura"
}'A resposta traz a proposta com status em CANCELED e a version seguinte.
Referência: Cancelar uma proposta
| Campo | Regra |
|---|---|
expectedVersion | A version da sua última leitura. |
reason | Opcional. O motivo do cancelamento. |
Depois do envio para análise, a proposta não pode mais ser cancelada.
Espere proposal.waiting_data, proposal.decided ou proposal.closed: a proposta em análise também pode terminar em CANCELED. Para trocar o modo da jornada, cancele antes do envio e crie outra proposta, com outro clientCode.
Consulte a proposta antes de repetir um cancelamento recusado por versão.
A resposta de version_conflict traz a versão vigente em currentVersion. Confira se o cancelamento ainda faz sentido.
Erros desta operação
| Código | HTTP | Mensagem |
|---|---|---|
proposal_not_found | 404 | Proposta não encontrada. |
proposal_in_analysis | 409 | A proposta já foi enviada para análise e não pode mais ser cancelada. |
proposal_not_open | 409 | A proposta já foi decidida, expirou ou foi cancelada. |
version_conflict | 409 | O registro mudou desde a leitura. Releia e tente de novo. |
Autenticação e validação estão no Catálogo de erros.