11.2 - Detalhe Extrato de Autorização

Método "detalheExtrato”

Este método irá retornar a lista de extrato de autorização disponíveis relacionadas ao beneficiário.

Caso implementado este método é obrigatório;
Atente-se aos critérios de preenchimento;
Atente-se as mensagens de retorno para cada HTTPS Status Code;

Endpoint

Endpoint	Método	Header Content-Type	Descrição
http://exemplo.com/ detalheExtrato Atenção O endpoint obrigatoriamente deve terminar com “/detalheExtrato”.	POST	application/json	Endpoint lista os detalhes do extrato.

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.

{
  "auth": [
       {
          "chave": "Authorization",
            "token": "JWT eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE1NzI5ODQ4MzgsIm5iZiI6MTU3Mjk4NDgzOSwiZXhwIjoxNTczMDI4MDM4LCJkYXRhIjp7ImxvZ2luIjoiZGVybGFuZHlAbW9iaWxlc2F1ZGUuY29tLmJyIn19.dzJOQhSG8pJx-l6WDDgMVszFsKB26PsIjF4rB1TnWrk"
        },
        {
            "chave": "Authorization-Custom",
            "token": "JWT eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE1NzI5ODQ4MzgsIm5iZiI6MTU3Mjk4NDgzOSwiZXhwIjoxNTczMDI4MDM4LCJkYXRhIjp7ImxvZ2luIjoiZGVybGFuZHlAbW9iaWxlc2F1ZGUuY29tLmJyIn19.dzJOQhSG8pJx-l6WDDgMVszFsKB26PsIjF4rB1TnWrk",
            "expiracao": 1574366666921
        }
    ] 
}

Serão enviados no BODY os seguintes parâmetros:

Parâmetro	Obrigatório	Tipo	Descrição
integracao	M	Objeto	Nó integração retornado no login do beneficiário
idAutorizacao	M	String	Id referente ao extrato.

Exemplo request

url: 
https://www.operadoradesaude.com.br/mobilesaude/extratoAutorizacao/detalheExtrato

Body:
{
  "integracao": {
        "xpto": "voluptatibus",
        "xyz": "quibusdam",
        "abcdef": 9288701
      },
  "idAutorizacao": "string"
}

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

Está indicado abaixo a estrutura de retorno do método. 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
numeroContrato	M	String	Número que identifica a qual contrato esse reembolso está vinculado	Texto livre
guia	M	Objeto	Objeto que indica a situação do pedido de autorização.	Obrigatório o preenchimento conforme objeto "guia" descrito posteriormente.
prestador	M	Objeto	Objeto com as informações do prestador.	Obrigatório o preenchimento conforme objeto "prestador" descrito posteriormente.
solicitante	OP	Objeto	Objeto com as informações do solicitante.	Opcional, caso seja preenchido, o mesmo deve estar em conformidade ao objeto "solicitante" descrito posteriormente.
textoPreparo	OP	String		Texto livre
chaveUnica	M	String	Chave de identificação do usuário retornada no login
nomeBeneficiario	M	String	Nome do beneficiário que aparecerá no extrato	Formato: Texto livre.
idTipoBeneficiario	M	String	Informe o tipo de beneficiário	Conteúdo válido: T = Titular D = Dependente A = Agregado Apenas maiúsculos.
numeroCartaoBeneficiario	M	String	Informe o número do cartão do beneficiário	Formato: Texto livre.
situacao	M	Objeto	Objeto que indica a situação do pedido de reembolso.	Obrigatório o preenchimento conforme objeto "situacao" descrito posteriormente.
eventos	M	Array de objetos ”eventos”	Retorna um array de objetos “eventos”	Deve retornar um array de objetos "eventos” descrito posteriormente.

Objeto guia

Atributo	Critério	Tipo	Descrição	Regra de preenchimento
idAutorizacao	M	String
numeroPedido	M	String
senhaAutorizacao	M	String
idTipoServico	M	String
descricaoTipoServico	M	String
dataSolicitacao	M	String	Data de solicitação	Formato: YYYY-MM-DD
dataAutorizacao	OP	String	Data da autorizacao	Formato: YYYY-MM-DD
dataValidade	OP	String	Data de validade	Formato: YYYY-MM-DD
numeroProtocolo	M	String
tipoTratamento	OP	String		Texto livre

Objeto prestador

Atributo	Critério	Tipo	Descrição	Regra de preenchimento
nome	M	String
especialidade	M	String

Objeto solicitante

Atributo	Critério	Tipo	Descrição	Regra de preenchimento
chaveUnica	M	String	Chave de identificação do usuario solicitante.
nomeSolicitante	M	String	Nome do solicitante que aparecerá no extrato	Formato: Texto livre.
idTipoSolicitante	M	String	Informe o tipo do solicitante	Conteúdo válido: T = Titular D = Dependente A = Agregado Apenas maiúsculos.
numeroCartaoSolicitante	M	String	Informe o número do cartão do solicitante	Formato: Texto livre.

Objeto situacao

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

id

M

String

Código ou ID que represente o status do débito no seus sistema.

descricao

M

String

Descrição da situação do pedido de reembolso

“Aprovado”, “Solicitado”, “Recusado”

cor

M

String

cor da label a ser exibida.

Hexadecimal. com o #. da cor que deseja que seja usada para representar a situação do reembolso.

Ex.: #FF0000

Objeto eventos

Atributo	Critério	Tipo	Descrição	Regra de preenchimento
idAgrupador	M	String	Código ou ID que represente o agrupador
descricaoAgrupador	M	String	Descrição do agrupador	Texto livre
textos	OP	Objeto		Opcional, caso seja preenchido, o mesmo deve estar em conformidade ao objeto "textos" descrito posteriormente.
procedimentos	M	Array de objetos ”procedimentos”	Retorna um array de objetos “procedimentos”	Deve retornar um array de objetos "procedimentos” descrito posteriormente.

Objeto textos

Atributo	Critério	Tipo	Descrição	Regra de preenchimento
titulo	M	String
descricao	M	String

Objeto procedimentos

Atributo	Critério	Tipo	Descrição	Regra de preenchimento
idEventoGuia	M	String
codigo	M	String
descricao	M	String
quantidadeSolicitada	M	Float	Valor solicitado (Numérico, 2 posições decimais)	Numérico, 2 posições decimais. Indicador decimal = PONTO (9999999.99)
quantidadeAutorizada	OP	Float	Valor autorizado (Numérico, 2 posições decimais)	Numérico, 2 posições decimais. Indicador decimal = PONTO (9999999.99)
quantidadeExecutada	OP	Float	Valor executado (Numérico, 2 posições decimais)	Numérico, 2 posições decimais. Indicador decimal = PONTO (9999999.99)
dataAutorizacao	OP	String
textoGlosa	OP	String		Texto livre.
textoProcedimento	OP	Objeto		Opcional, caso seja preenchido, o mesmo deve estar em conformidade ao objeto "textoProcedimento" descrito posteriormente.
situacao	M	Objeto	Objeto que indica a situação do pedido de reembolso.	Obrigatório o preenchimento conforme objeto "situacao" descrito posteriormente.

Objeto textoProcedimento

Atributo	Critério	Tipo	Descrição	Regra de preenchimento
titulo	M	String
descricao	M	String

Objeto situacao

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

id

M

String

Código ou ID que represente o status do débito no seus sistema.

descricao

M

String

Descrição da situação do pedido de reembolso

“Aprovado”, “Solicitado”, “Recusado”

cor

M

String

cor da label a ser exibida.

Hexadecimal. com o #. da cor que deseja que seja usada para representar a situação do reembolso.

Ex.: #FF0000

Retorno da API - Sucesso

{
  "numeroContrato": "99991",
  "guia": {
    "idAutorizacao": "01918",
    "numeroPedido": "7151819191",
    "senhaAutorizacao": "xtp1826xyz",
    "idTipoServico": "01918",
    "descricaoTipoServico": "Consulta",
    "dataSolicitacao": "2021-03-01",
    "dataAutorizacao": "2021-03-01",
    "dataValidade": "2021-03-01",
    "numeroProtocolo": "19172918jsjs817171",
    "tipoTratamento": "texto livre"
  },
  "prestador": {
    "nome": "clinica dos olhos",
    "especialidade": "oftalmologia"
  },
  "solicitante": {
    "chaveUnica": "10101012",
    "nomeSolicitante": "Victor Hugo Prando",
    "idTipoSolicitante": "T",
    "numeroCartaoSolicitante": "010187161515"
  },
  "textoPreparo": "texto livre para o preparo",
  "chaveUnica": "10101012",
  "nomeBeneficiario": "Victor Hugo Prando",
  "idTipoBeneficiario": "T",
  "numeroCartaoBeneficiario": "010187161515",
  "situacao": {
    "id": "xyz",
    "descricao": "Autorizado",
    "cor": "#71J171J"
  },
  "eventos": [
    {
      "idAgrupador": "01",
      "descricaoAgrupador": "Exames simples",
      "textos": {
        "titulo": "Preparo",
        "descricao": "texto livre para o preparo"
      },
      "procedimentos": [
        {
          "idEventoGuia": "10101",
          "codigo": "10101012",
          "descricao": "Consulta eletiva em consultorio",
          "quantidadeSolicitada": 10.00,
          "quantidadeAutorizada": 10.00,
          "quantidadeExecutada": 5.00,
          "dataAutorizacao": "2021-03-01",
          "textoGlosa": "texto livre para justificar a negativa",
          "textoProcedimento": {
            "titulo": "Preparo",
            "descricao": "texto livre para o preparo"
          },
          "situacao": {
            "id": "xyz",
            "descricao": "Autorizado",
            "cor": "#71J171J"
          }
        }
      ]
    }
  ]
}

Retorno da API - Falha

Atente-se as mensagens de retorno para cada HTTPS Status Code;
Siga as instruções de Descrição dos objetos e atributos de retorno - falha;

11.2 - Detalhe Extrato de Autorização

[data-colorid=wtta2yrnk3]{color:#36b37e} html[data-color-mode=dark] [data-colorid=wtta2yrnk3]{color:#4cc994}Método "detalheExtrato”

Endpoint

Parâmetros de entrada

Exemplo request

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

Retorno da API - Sucesso

Retorno da API - Falha

Método "detalheExtrato”