6.1 - Lista extrato reembolso

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

Método "listaReembolsos”

Este método irá retornar a lista de extrato de reembolso disponíveis relacionadas ao beneficiário.

Endpoint

Endpoint

Método

Header Content-Type

Descrição

Endpoint

Método

Header Content-Type

Descrição

http://exemplo.com/ listaReembolsos

Atenção

O endpoint obrigatoriamente deve terminar com “/listaReembolsos”.

POST

application/json

Endpoint lista os beneficiários agrupados por contrato.

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.

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

Parâmetro

Obrigatório

Tipo

Descrição

Parâmetro

Obrigatório

Tipo

Descrição

integracao

M

Objeto

 Nó integração retornado no login do beneficiário

chaveUnica

M

String

 Chave de identificação do usuário retornada no login

dataInicial

M

String

Data inicial do periodo desejado.

dataFinal

M

String

Data final do periodo. desejado.

Exemplo request

url: https://www.operadoradesaude.com.br/mobilesaude/extratoReembolso/listaReembolsos Body: { "integracao": { "xpto": "voluptatibus", "xyz": "quibusdam", "abcdef": 9288701 }, "chaveUnica": "string", "dataInicial": "YYYY-MM-DD", "dataFinal": "YYYY-MM-DD" }

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

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

contratos

M

Array de objetos”contrato”

Retorna um array de objetos “contratos”

Deve retornar um array de objetos

 

Objeto contratos

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

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

extrato

M

Array

Array de objetos do tipo "extrato"

Precisa ser preenchido com pelo menos um item

 

Objeto extrato

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

IdTipoServico

M

String

 

 

descricaoTipoServico

M

String

Descrição do tipo de serviço realizado, exemplo: Consultas, Exames/Terapias, Internação, Odontologia, outras despesas, entre outras.

Formato: Texto livre.

idReembolso

M

String

Id de banco de dados do título no seu sistema interno.

Se o seu sistema exigir o id do título como chave para localizar o mesmo nos demais métodos, este campo deverá ser considerado obrigatório.

Somente números inteiros (Não podem existir letras, espaços em branco, ou pontos decimais).

numeroGuiaReembolso

M

String

Número da guia de registro do serviço/atendimento prestado.

Formato: Texto livre.

numeroProtocolo

M

String

Número de protocolo gerado pelo pedido de reembolso

 

chaveUnica

M

String

Chave de identificação do usuario.

 

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.

situacao

M

Objeto

Objeto que indica a situação do pedido de reembolso.

Obrigatório o preenchimento conforme objeto "situacao" descrito posteriormente.

dataSolicitacao

M

String

Data de solicitação do reembolso

Formato: YYYY-MM-DD HH:mm:ss

valorSolicitado

M

Float

Valor solicitado do reembolso (Numérico, 2 posições decimais)

Numérico, 2 posições decimais. Indicador decimal = PONTO (9999999.99)

valorReembolsado

M

Float

Valor reembolsado do pedido (Numérico, 2 posições decimais)

Numérico, 2 posições decimais. Indicador decimal = PONTO (9999999.99)

 

Objeto situacao

Atributo

Critério

Tipo

Descrição

Regra de preenchimento

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 ( 1 Contrato )

{ "contratos": [ { "numeroContrato": "99991", "extrato": [ { "idTipoServico": "01918", "descricaoTipoServico": "Consulta", "idReembolso": "xptoyxz", "numeroGuiaReembolso": "YPXTOYXZZZ", "numeroProtocolo": "19172918jsjs817171", "chaveUnica": "10101012", "nomeBeneficiario": "Victor Hugo Prando", "idTipoBeneficiario": "T", "situacao": { "id": "xyz", "descricao": "Aprovado", "cor": "#71J171J" }, "dataSolicitacao": "2021-03-01", "valorSolicitado": 129, "valorReembolsado": 129 }, { "idTipoServico": "01918", "descricaoTipoServico": "Consulta", "idReembolso": "xptoyxz", "numeroGuiaReembolso": "YPXTOYXZZZ", "numeroProtocolo": "19172918jsjs817171", "chaveUnica": "10101012", "nomeBeneficiario": "Victor Hugo Prando", "idTipoBeneficiario": "T", "situacao": { "id": "xyz", "descricao": "Aprovado", "cor": "#71J171J" }, "dataSolicitacao": "2021-03-01", "valorSolicitado": 129, "valorReembolsado": 129 }, { "idTipoServico": "01918", "descricaoTipoServico": "Consulta", "idReembolso": "xptoyxz", "numeroGuiaReembolso": "YPXTOYXZZZ", "numeroProtocolo": "19172918jsjs817171", "chaveUnica": "10101012", "nomeBeneficiario": "Victor Hugo Prando", "idTipoBeneficiario": "T", "situacao": { "id": "xyz", "descricao": "Aprovado", "cor": "#71J171J" }, "dataSolicitacao": "2021-03-01", "valorSolicitado": 129, "valorReembolsado": 129 } ] } ] }

 

Retorno da API - Sucesso ( Multi contrato )

{ "contratos" : [ { "numeroContrato": "99991", "extrato" : [ { "idTipoServico": "01918", "descricaoTipoServico": "Consulta", "idReembolso": "xptoyxz", "numeroGuiaReembolso" : "YPXTOYXZZZ", "numeroProtocolo" : "19172918jsjs817171", "chaveUnica": "10101012", "nomeBeneficiario": "Victor Hugo Prando", "idTipoBeneficiario" : "T", "situacao" : { "id" : "xyz", "descricao" : "Aprovado", "cor" : "#71J171J" }, "dataSolicitacao": "2021-03-01", "valorSolicitado" : 129.00, "valorReembolsado" : 129.00 } ] }, { "numeroContrato": "99992", "extrato" : [ { "idTipoServico": "01918", "descricaoTipoServico": "Consulta", "idReembolso": "xptoyxz", "numeroGuiaReembolso" : "YPXTOYXZZZ", "numeroProtocolo" : "19172918jsjs817171", "chaveUnica": "10101012", "nomeBeneficiario": "Victor Hugo Prando", "idTipoBeneficiario" : "T", "situacao" : { "id" : "xyz", "descricao" : "Aprovado", "cor" : "#71J171J" }, "dataSolicitacao": "2021-03-01", "valorSolicitado" : 129.00, "valorReembolsado" : 129.00 }, { "idTipoServico": "01918", "descricaoTipoServico": "Consulta", "idReembolso": "xptoyxz", "numeroGuiaReembolso" : "YPXTOYXZZZ", "numeroProtocolo" : "19172918jsjs817171", "chaveUnica": "10101012", "nomeBeneficiario": "Victor Hugo Prando", "idTipoBeneficiario" : "T", "situacao" : { "id" : "xyz", "descricao" : "Aprovado", "cor" : "#71J171J" }, "dataSolicitacao": "2021-03-01", "valorSolicitado" : 129.00, "valorReembolsado" : 129.00 } ] } ] }

 

Retorno da API - Falha

  

 

Mobile Saúde - Mosia Omnichannel