Cancelar apólice
Cancela uma única apólice; as demais apólices do mesmo pedido não são afetadas. Para cancelar todas as apólices de um pedido de uma vez, use o cancelamento do pedido em um pedido emitido.
O cancelamento vale no momento da chamada: a resposta já traz a apólice como canceled, a cobrança das parcelas seguintes é interrompida e o webhook de apólice cancelada é enviado. A comunicação com a seguradora acontece em seguida, de forma assíncrona, e não desfaz o cancelamento.
Devolução de prêmio
A devolução, quando devida, é calculada sobre o que já foi pago, a partir do momento da solicitação:
| Momento do cancelamento | Devolução |
|---|---|
| Até 7 dias corridos da contratação — direito de arrependimento | Integral do que foi pago. |
| Após 7 dias | Proporcional: a parte do que foi pago que excede o período de cobertura já decorrido. |
Request
ENDPOINT
/v1/insurance/policies/{policy_key}/cancelMÉTODO
POSTPath params
| Parâmetro | Tipo | Obrigatoriedade | Descrição |
|---|---|---|---|
policy_key | string | obrigatório | Chave da apólice. |
Request Body
{
"reason": "Cliente solicitou o cancelamento"
}
| Campo | Tipo | Obrigatoriedade | Descrição |
|---|---|---|---|
reason | string | opcional | Motivo do cancelamento, de 1 a 255 caracteres, registrado na trilha de eventos e enviado no webhook de cancelamento. Sem motivo informado, é registrado requester_requested. O corpo inteiro é opcional. |
Response
STATUS
200Response Body
{
"policy_key": "0b6e7c1a-9a4e-4c1e-b1d4-2f5a8c9e0d31",
"order_key": "5e2b3f60-7c4b-4c8e-9f1a-6d2e8b4a7c90",
"status": "canceled"
}
Semântica por status
| Status atual da apólice | Resultado |
|---|---|
active | 200 — a apólice é cancelada. |
active, com a vigência já encerrada | 409 POL000011 — a cobertura já terminou. |
canceled | 409 POL000012 — a apólice já foi cancelada. |
finished | 409 POL000011 — a vigência já terminou. |
| outra integração / inexistente | 404 POL000001 |
Erros
Todo erro (non-2xx) retorna o corpo padrão { "title", "description", "translation", "code" } — trate programaticamente apenas o campo code.
| Status | Código | Descrição |
|---|---|---|
401 / 403 | — | Falha de autenticação ou autorização. |
404 | POL000001 | Apólice inexistente ou pertencente a outra integração. |
409 | POL000011 | A vigência da cobertura já terminou. |
409 | POL000012 | A apólice já foi cancelada. |