Quando fizer sentido para o canal, é possível que seja configurado um fluxo de renovação de emissões existentes. Isto é definido por uma distância em dias do fim da vigência atual a partir do qual é permitido realizar a renovação de uma emissão.
Se este valor for de 30 dias, por exemplo, isto significa que a partir de 30 dias antes do fim da vigência atual será possível realizar uma nova emissão com vigência futura iniciando no primeiro dia onde a emissão atual deixa de ter validade. Com isto o cliente segurado fica coberto continuamente.
Além disso, é possível configurar por quantos dias após a vigência do seguro original a renovação está disponível. Se este valor for 3, por exemplo, isto significa que até 3 dias após o fim da vigência é possível fazer a renovação.
Renovação disponível
Para cada emissão que se enquadra no cenário descrito acima será criada uma entidade de renovação no estado disponivel que pode ser listada pelo endpoint GET /sagas/v1/renovacoes . Também é possível ser notificado via webhook quando isto acontece assinando o evento renovacao-disponivel.
Iniciar uma renovação
Uma renovação pode ser iniciada através do endpoint POST /sagas/v1/renovacoes/:id-renovacao/iniciar informando a opção de pagamento desejada (pagamento) e os detalhes do aceite (aceite). Ambos os parâmetros são opcionais – porém, se é necessário informar alguma delas em emissões regulares, também será necessário informar ao iniciar um fluxo de renovação.
É possível informar os dados do cliente-segurado se for desejável fazer alterações (por exemplo, telefone ou e-mail). Não é permitido enviar um cliente diferente (validado via CPF/CNPJ). Ao omitir este parâmetro, o cliente-segurado existente será utilizado – considerando possíveis alterações (endossos) realizados.
Em relação aos parâmetros de emissão que serão utilizados na renovação, como coberturas e limites, existem dois fluxos possíveis: simplificado e com alteração nos parâmetros de emissão.
Fluxo simplificado
Quando uma renovação fica disponível, uma nova cotação é provida com os mesmos parâmetros (coberturas, limites e adicionais) utilizados na emissão original. Seu ID é informado no campo id-cotacao-sugerida nos detalhes da renovação. Se for desejável utilizar esta cotação sugerida, basta realizar uma chamada para o endpoint POST /sagas/v1/renovacoes/:id-renovacao/iniciar com a opção de pagamento e aceite (quando necessário). Os detalhes da cotação sugerida podem ser obtidos pelo endpoint GET /sagas/v1/cotacoes/:id-cotacao.
A cotação sugerida replica os metadados da cotação original, quando existirem.
Fluxo com alteração nos parâmetros de emissão
Para que a renovação aconteça com parâmetros diferentes da emissão original, como com a inclusão ou remoção de coberturas, ou ajustes nos limites de indenização, é necessário realizar uma cotação (POST /sagas/v1/cotacoes) com os parâmetros desejados e informando os campos instante-vigencia-inicio e instante-vigencia-fim com valores idênticos aos obtidos em vigencia-renovacao para a renovação em questão via listagem ou pelo endpoint GET /sagas/v1/renovacoes/:id-renovacao.
Em seguida, basta informar o id-cotacao obtido na chamada ao endpoint POST /sagas/v1/renovacoes/:id-renovacao/iniciar junto às demais informações necessárias.
Renovação iniciada
Quando uma renovação é iniciada por qualquer um dos fluxos descritos acima, uma nova proposta de emissão é criada para a nova emissão. O id-proposta resultante pode ser obtido na própria resposta do endpoint POST /sagas/v1/renovacoes/:id-renovacao/iniciar ou por consultas posteriores a GET /sagas/v1/renovacoes/:id-renovacao.
Renovação completa
Se a proposta for concluída com sucesso (por exemplo, o pagamento é efetuado, quando isto é uma pendência), a nova emissão será concluída e a renovação também irá para o estado completa. O ID da nova emissão estará no campo id-venda nos detalhes da renovação correspondente.
Novas tentativas e renovação cancelada
Se a proposta de renovação for cancelada, seja diretamente ou por expiração, a renovação pode voltar para o estado disponivel se ainda houver tempo para uma nova tentativa, ou então ela irá para o estado cancelada e não poderá mais ser usada.
Webhooks
É possível assinar notificações para cada uma das transições de estado descritas acima. Confira os detalhes em eventos de webhook.