Seguros

Oferece serviços para a gestão dos seguros adquiridos pelo titular do cartão ou por um dependente.

Figura 1. Diagrama de funcionamento da API Seguros

Possui integração direta com as APIs Portadores, Lojas, Serviços Bancários, Faturamentos e Lançamentos, sendo possível realizar estímulos de cobrança nas datas de corte da sua regra de negócio e visualizar campos, termos e bilhetes de adesão de cada cliente.

Endpoints

Todos os endpoints da API Seguros utilizam URL base /api/v1/seguros/.

Adesão aos seguros

Endpoints para gestão dos seguros, dos seus titulares e seus dependentes.

Gestão de titulares

Tipo	Endpoint	Documentação
`POST`	`/api/v1/seguros/adesao`	Vincula um titular a um seguro
`DELETE`	`/api/v1/seguros/adesao`	Cancela a adesão de um titular a um seguro
`GET`	`/api/v1/seguros/portador`	Visualiza os seguros de um portador
`GET`	`/api/v1/seguros/portador/{idPortador}`	Visualiza os seguros cancelados de um portador

Gestão de dependentes

Tipo	Endpoint	Documentação
`POST`	`/api/v1/seguros/dependente/adesao`	Vincula um dependente a um seguro
`DELETE`	`/api/v1/seguros/dependente/adesao`	Cancela a adesão de um dependente a um seguro
`GET`	`/api/v1/seguros/dependente/adesao`	Visualiza seguros do dependente

Gestão de seguros

Tipo	Endpoint	Documentação
`POST`	`/api/v1/seguros/adesao`	Visualiza os seguros disponíveis
`DELETE`	`/api/v1/seguros/adesao`	Cancela um seguro

Cobranças e pagamentos

Endpoint para estímulo de cobrança de acordo com sua regra de negócio e data de corte.

Tipo	Endpoint	Documentação
`GET`	`/api/v1/seguros/cobranca`	Realiza o estímulo da cobrança do seguro

Campos de adesão

Endpoints para visualização dos campos de adesão do seguro através de um seguro específico ou de um portador.

Tipo	Endpoint	Documentação
`GET`	`/api/v1/seguros/campos/adesao`	Visualiza os campos necessários para a adesão do seguro
`GET`	`/api/v1/seguros/campos/adesao/portador`	Visualiza os campos necessário para o portador aderir a um seguro

Bilhetes de adesão

Endpoints para visualização dos bilhetes de adesão ao seguro e seus modelos.

Tipo	Endpoint	Documentação
`GET`	`/api/v1/seguros/{codigoSeguro}/bilhetes/portador/{idPortador}`	Visualiza os bilhetes de seguro de um portador
`GET`	`/api/v1/seguros/bilhetes/portador/{idPortador}/adesao/{codigoAdesaoTitular}`	Visualiza o bilhetes de adesão de um seguro específico
`GET`	`/api/v1/seguros/{codigoSeguro}/bilhetes/modelos/operacao/{codigoOperacao}`	Lista o modelo de operação de um bilhete usando o código de operação

Termos de adesão

Endpoints para visualizar os termos de adesão de um seguro, do portador ou do modelo de código da operação.

Tipo	Endpoint	Documentação
`GET`	`/api/v1/seguros/termos/portador/{idPortador}/adesao/{codigoAdesaoTitular}`	Visualiza os termos de adesão de um seguro
`GET`	`api/v1/seguros/{codigoSeguro}/termos/portador/{idPortador}`	Visualiza os termos de adesão de um portador
`GET`	`/api/v1/seguros/{codigoSeguro}/termos/modelo/adesao/operacao/{codigoOperacao}`	Visualiza os modelos do código de operação

Casos de uso

Visualizando seguros disponíveis para adesão

Utilize o endpoint GET /api/v1/seguros/adesao para visualizar os seguros disponíveis para seus clientes:

O response body listando os seguros disponíveis, obtidos através do seu token:

[
 {
   "detalhamentoCategoria": "Loja 1",
   "possuiBilhete": true,
   "possuiTermoAdesao": true,
   "totalParcelas": "24",
   "idOperacao": "-",
   "categoria": "Categoria 11",
   "permiteDependente": false,
   "descricao": "Loja 1",
   "valorParcela": "9.99",
   "idProduto": "1",
   "possuiTermoCancelamento": false,
   "id": "1",
   "permiteMultiplaAdesao": false,
   "exclusivoPdv": false
 },
 {
   "detalhamentoCategoria": "Loja 2",
   "possuiBilhete": true,
   "possuiTermoAdesao": true,
   "totalParcelas": "24",
   "idOperacao": "1",
   "categoria": "Categoria 2",
   "permiteDependente": false,
   "descricao": "Loja 2",
   "valorParcela": "9.99",
   "idProduto": "2",
   "possuiTermoCancelamento": false,
   "id": "2",
   "permiteMultiplaAdesao": false,
   "exclusivoPdv": false
 },
 {
   "detalhamentoCategoria": "Loja 3",
   "possuiBilhete": true,
   "possuiTermoAdesao": true,
   "totalParcelas": "24",
   "idOperacao": "-1",
   "categoria": "Categoria 3",
   "permiteDependente": false,
   "descricao": "Loja 3",
   "valorParcela": "15.99",
   "idProduto": "3",
   "possuiTermoCancelamento": false,
   "id": "3",
   "permiteMultiplaAdesao": false,
   "exclusivoPdv": false
 }
]

Visualizando seguros aderidos pelo portador

Utilize o endpoint GET /api/v1/seguros/portador para visualizar os seguros que um portador aderiu utilizando seu identificador:

Exemplo de request body utilizando o idPortador:

 {
  idPortador: 2001
 }

O response body listando os seguros do portador:

{
 [
  {
   "detalhamentoCategoria": "Seguro 1",
   "valorParcela": "100",
   "categoria": "CATEGORIA 1",
   "dataAdesao": "2024-01-01",
   "numeroDaSorte": "1",
   "dataSorteio": "2024-01-01",
   "codigoSeguro": "1",
   "descricaoSeguro": "Seguro 1",
   "codigoAdesao": "1"
  },
  {
   "detalhamentoCategoria": "Seguro 2",
   "valorParcela": "500",
   "categoria": "CATEGORIA 2",
   "dataAdesao": "2023-04-05",
   "numeroDaSorte": "2",
   "dataSorteio": "2023-12-31",
   "codigoSeguro": "2",
   "descricaoSeguro": "Seguro 2",
   "codigoAdesao": "2"
  }   
 ]
}

Cancelando seguros aderidos pelo portador

Utilize o endpoint DELETE /api/v1/seguros/adesao para cancelar a adesão de um titular a um seguro.

No request body do endpoint, insira as informações de codigoAdesao, meioCancelamento, usuarioCancelamento, motivoCancelamento e lojaCancelamento:

{
  "codigoAdesaoDependente": "1234567",
  "meioCancelamento": "HORIZON",
  "usuarioCancelamento": "2001",
  "motivoCancelamento": "TESTE DE CANCELAMENTO"
  "lojaCancelamento": "2001"
}

Uma solicitação bem sucedida tem o response body abaixo, indicando que a solicitação de cancelamento foi aceita:

{
  "httpStatus": "ACCEPTED",
  "mensagens": []
}

Visualizando os seguros aderidos pelo dependente

Utilize o endpoint GET /api/v1/seguros/dependente/adesao para visualizar os seguros aderidos por um dependente através do seu identificador:

Exemplo de request body utilizando o codigoAdesaoTitular:

 {
  idPortador: 2001
 }

O response body listando os seguros do dependente:

{
 [
  {
   "detalhamentoCategoria": "Seguro 1",
   "valorParcela": "100",
   "categoria": "CATEGORIA 1",
   "dataAdesao": "2024-01-01",
   "numeroDaSorte": "1",
   "dataSorteio": "2024-01-01",
   "codigoSeguro": "1",
   "descricaoSeguro": "Seguro 1",
   "codigoAdesao": "1"
  },
  {
   "detalhamentoCategoria": "Seguro 2",
   "valorParcela": "500",
   "categoria": "CATEGORIA 2",
   "dataAdesao": "2023-04-05",
   "numeroDaSorte": "2",
   "dataSorteio": "2023-12-31",
   "codigoSeguro": "2",
   "descricaoSeguro": "Seguro 2",
   "codigoAdesao": "2"
  }   
 ]
}

Cancelando seguros aderidos por um dependente

Utilize o endpoint DELETE /api/v1/seguros/dependente/adesao para cancelar a adesão de um dependente a um seguro.

No request body do endpoint, insira as informações de codigoAdesaoDependente, meioCancelamento, usuarioCancelamento, motivoCancelamento e lojaCancelamento:

{
  "codigoAdesaoDependente": "762",
  "meioCancelamento": "HORIZON",
  "usuarioCancelamento": "2001",
  "motivoCancelamento": "Motivo Cancelamento"
  "lojaCancelamento": "2001"
}

Uma solicitação bem sucedida tem o response body abaixo, indicando que a solicitação de cancelamento foi aceita:

{
  "httpStatus": "ACCEPTED",
  "mensagens": []
}

Serviços relacionados

API Portadores

API Lojas

API Lançamentos

Materiais relacionados

Como testar endpoints através do Tote

Interpretando os códigos de resposta

Diretrizes básicas do Horizon

Clique no botão abaixo para nos contar o que achou da nova plataforma. Você será redirecionado para um formulário rápido.

Enviar feedback

Endpoints#

Adesão aos seguros#

Gestão de titulares#

Gestão de dependentes#

Gestão de seguros#

Cobranças e pagamentos#

Campos de adesão#

Bilhetes de adesão#

Termos de adesão#

Casos de uso#

Serviços relacionados#

Materiais relacionados#