2.5 - Resumo de cobrança

Índice

1 Índice
2 Orientações
- 2.1 Parâmetros de entrada
3 Critérios de preenchimento
4 Objetos e atributos de retorno
5 Método de resumoCobranca
- 5.1 Endpoint
- 5.2 Parâmetros de entrada
- 5.3 Exemplo request
- 5.4 Descrição dos objetos e atributos de retorno - Sucesso
  - 5.4.1 Exemplo retorno API - sucesso
  - 5.4.2 Descrição dos objetos e atributos de retorno - falha
  - 5.4.3 Exemplo retorno API - falha

Só são suportadas integrações no padrão REST.

Orientações

Parâmetros de entrada

Serão enviados no HEADER os headers estáticos definidos ao configurar a integração, combinado com os tokens retornados pela configuração de autorização da integração (caso seja vinculada) e os headers de segurança retornado no login do beneficiário.

Critérios de preenchimento

Abreviação	Nome	Descrição

Abreviação	Nome	Descrição
M	Mandatório	O preenchimento do atributo é obrigatório. Caso o atributo esteja nulo ou em branco, seu "response" será rejeitado.
C	Condicional	O atributo pode tornar-se obrigatório quando um ou mais atributos auxiliares for preenchido / atualizado.
OP	Opcional	Seu preenchimento não é obrigatório. Pode-se enviar NULL para objetos, ou arrays vazios para tipos Array

Objetos e atributos de retorno

Os atributos devem seguir exatamente os mesmos nomes indicados nesta documentação, caso contrário, serão rejeitados pelo validador de integração.

Exemplo do atributo “contratos”:

Contrato
contrato
Contratos
contratos

Método de resumoCobranca

Endpoint

Endpoint	Método	Header Content-Type	Descrição

Endpoint

Método

Header Content-Type

Descrição

exemplo.com/resumoCobranca

POST

application/json

Endpoint para retornar as informações para exibir o resumo de cobrança

Parâmetros de entrada

Parâmetro	Obrigatório	Tipo	Descrição

Parâmetro	Obrigatório	Tipo	Descrição
idTitulo	OP	Number	Id de banco de dados da título no seu sistema interno.
codigoTitulo	M	String	Código do titulo no seu sistema interno. O aplicativo irá enviar a mesma informação que recebeu do atributo codigoTitulo do método listaDebito
chaveUnica	M	String	Chave de identificação do usuário retornada no login
integracao	OP	Objeto	Nó integração retornado no login do usário

Exemplo request

url: 
https://www.operadoradesaude.com.br/mobilesaude/resumoCobranca

Body:
{
  "chaveUnica": "101012",
  "integracao": {
    "xpto": "voluptatibus",
    "xyz": "quibusdam",
    "abcdef": 9288701
  },
  "idTitulo": 579,
  "codigoTitulo": "MS00579"
}

Descrição dos objetos e atributos de retorno - Sucesso

Está indicado abaixo a estrutura de retorno do seu método login. Esse método deve obedecer as regras indicadas no objeto principal e em seus desdobramentos.

Objeto principal

Atributo	Critério	Tipo	Descrição	Regra de preenchimento

Atributo	Critério	Tipo	Descrição	Regra de preenchimento
titulo	M	String	titulo da tela	texto livre
tituloTotalizador	M	String	titulo totalizador dos registros de cobranças	texto livre
valorTotal	M	Float	valor total do débito
dataVencimento	M	String	Data de vencimento da fatura	Formato: Formato: YYYY-MM-DD
registros	M	Array	Array de objetos do tipo "registro"

Objeto registro

Atributo	Critério	Tipo	Descrição	Regra de preenchimento

Atributo	Critério	Tipo	Descrição	Regra de preenchimento
titulo	M	String	titulo da tela	texto livre
icone	OP	String	Ícones suportados pelo aplicativo Mosia Omnichannel
valorTotal	M	Float	Valor total do registro
valores	M	Array	Array de objetos do tipo "cobranca"

Objeto cobranca

Atributo	Critério	Tipo	Descrição	Regra de preenchimento

Atributo	Critério	Tipo	Descrição	Regra de preenchimento
id	M	String	id da cobranca no seu sistema	texto livre
descricao	M	String	Descrição da cobrança	texto livre
valor	M	Float	Valor da cobrança

Exemplo retorno API - sucesso

{
  "titulo": "Resumo de cobrança",
  "tituloTotalizador": "Mensalidade",
  "valorTotal": 1257.99,
  "dataVencimento": "2021-01-18",
  "registros": [
    {
      "titulo": "Débitos",
      "icone": "icon_minus",
      "valorTotal": 442.2,
      "valores": [
        {
          "id": "101",
          "descricao": "mensalidade Victor Silva",
          "valor": 102.8
        },
        {
          "id": "105",
          "descricao": "mensalidade Júlia Rizzi",
          "valor": 120.9
        }
      ]
    },
    {
      "titulo": "Créditos",
      "icone": "icon_plus",
      "valorTotal": 442.1,
      "valores": [
        {
          "id": "901",
          "descricao": "devolução cobrança indevida",
          "valor": 12.2
        },
        {
          "id": "926",
          "descricao": "reembolso prot 0010020003004005",
          "valor": 35.45
        }
      ]
    }
  ]
}

Descrição dos objetos e atributos de retorno - falha

Objetos e atributos de retorno

Atributo	Critério	Tipo	Descrição	Regra de preenchimento

Atributo	Critério	Tipo	Descrição	Regra de preenchimento
mensagem	M	String	mensagem para ser exibida para o cliente	texto livre

Exemplo retorno API - falha

{
  "mensagem": "Resumo de cobrança não encontrado!"
}