API do Financeiro

Para ir direto para a documentação da API clique em swagger. Abaixo o índice dos serviços disponíveis.

Premissa

Para consumir as APIs da Sompo é preciso seguir os passos a abaixo.

Cadastro: O primeiro passo é fazer o cadastro no Portal Developers Sompo, este cadastro passará por uma aprovação interna.

Seleção dos Serviços: O segundo passo é criar um APP e adicionar as APIs que você deseja consumir neste APP.

Autenticação na plataforma de APIs da Sompo: Agora que você já tem um username, password e client-id, você precisa fazer a autenticação na API de Access-Token para receber uma credencial de acesso as APIs da Sompo.

A descrição completa do processo está descrita na página Autenticação na plataforma de API da Sompo.

Consulta Status de Pagamentos

Descrição de Negócio

Acesso a informações de parcelas de apolices. Retorna o status de pagamento de todas as apólices com a Sompo.

Serão dois passos, primeiro login da aplicação na plataforma de API da Sompo, segundo passo chamar a API.

Para maiores informações, documentação (swagger) do serviço Consulta Status de Pagamentos.

Premissas

Passo 1: A aplicação deve estar autenticada na plataforma de APIs da Sompo. Mais detalhes em Autenticação na plataforma de API da Sompo.

Campo da chamada (Request)

Endpoint: https://api.sompo.com.br/financial/v1/

Método: POST

Parâmetros:

  • Seção Header
    • Authorization: [inserir-access-token].
    • Content-Type: application/json
    • cliente_id: [inserir-client_id]
  • Seção Body:
    • {
      "numeroApolice": "9999999999",
      "numeroEndosso": "001",
      "tipoPessoa": "BR2",
      "codigoEmpresa": "2000",
      "documentoContratual": "97266710006"
      }

Exemplo de requisição:

{ "numeroApolice": "9999999999", "numeroEndosso": "001", "tipoPessoa": "BR2", "codigoEmpresa": "2000", "documentoContratual": "97266710006" }

Exemplo do JSON de resposta:

{
"MT_PaymentStatus_Resp": {
"listaCobrancaDetalhe": [
{
"numeroApolice": 0,
"numeroEndosso": "string",
"parcela": "string",
"referenciaContrato": "string",
"identificador": "string",
"montantePagamento": "string",
"valorIOF": "string",
"valorAdicionalFracionamento": "string",
"dataVencimento": "2024-08-20",
"dataCompensacao": "2024-08-20",
"formaPagamento": "D",
"statusParcela": "VENCIDA",
"dateLimiteCObertura": "2024-08-20",
"observacao": "string",
"ordemPagamento": "string",
"documentoSubstituto": "string",
"codigoRejeicao": "string",
"descricaoRejeicao": "string",
"subscriptionId": "string",
"ZZ_RECURRENTID": "string"
}
]
}
}

Undefined