Ir para o final dos metadados
Ir para o início dos metadados

Você está vendo a versão antiga da página. Ver a versão atual.

Comparar com o atual Ver Histórico da Página

« Anterior Versão 5 Próxima »

Tópicos:


Além da integração via callback, é possível integrar sua aplicação diretamente pela API, usando endereço abaixo como
base_url.

Este endereço deve ser usado como base para os endpoints listados abaixo

Listar tipos de reembolso

Endpoint: /plataforma_beneficiario/reembolso_online/v1/api/tipoReembolso
Tipo: GET
Parâmetros:
	id_operadora: Int
	mshash: String

return
{
	"status": true,
	"data": [{

		"id_tipo_reembolso": 999,
		"descricao": "Descrição",
		"id_operadora": 71,
		"id_aplicacao": 4
	}]

	"critical": null,
	"timestamp": "2017-08-01T17:34:52-03:00",
	"msg": "Sucesso"
}

Listar Status de Reembolso

Endpoint: /plataforma_beneficiario/reembolso_online/v1/api/reembolso/detalhe
Tipo: GET
Parâmetros:
	id_reembolso: Int
	mshash: String

Retorno Padrão
{
	"status": true,
	"data": [
{
		"id_reembolso": 12457,
		"numero_lote": null,
		"nome_titular": "TESTE GONCALVES DA TESTE",
		"cpf_titular": "99999999",
		"telefone": "99999999",
		"data_pagamento": null,
		"observacao": null,
		"matricula_titular": "2000130799999999300034",
		"protocolo": "9999992017080113144",
		"id_status_reembolso": 1,
		"id_ms_usuario": null,
		"data_solicitacao": "2017-08-01 16:11:04",
	"despesas": [{

		"id_despesa_reembolso": 99999,
		"utilizador_matricula": "9999999",
		"utilizador_nome": "TESTE GONCALVES DA SILVA",
		"data_despesa": "2017-03-19",
		"prestador_nome": null,
		"observacao": null,
		"prestador_documento": "999999999",
		"valor_despesa": 90.99,
		"valor_coparticipacao": null,
		"valor_reembolsado": null,
		"valor_glosado": null,
		"valor_uso_indevido": null,
		"id_status_reembolso": 1,
		"id_tipo_reembolso": 11,
		"arquivos": [{
			"url": "",
			"nome":"cf392e0b7d8b2bfd2057520be9f24193e09dcebce.pdf"
			}],
		"descricao_tipo_reembolso": "Assistência Farmacêutica"
		}
	],
	"valor_total_despesa": 90.99,
	"valor_total_reembolsado": 0,
	"quantidade_despesas": null,
	"id_tipo_reembolso": null,
	"descricao_tipo_reembolso": null,
	"valor_total_coparticipacao": 0,
	"valor_total_glosado": 0,
	"valor_total_uso_indevido": 0
	}
],
	"critical": null,
	"timestamp": "2017-08-01T17:34:52-03:00",
	"msg": "Sucesso"
}

Atualizar Reembolso

Endpoint: /plataforma_beneficiario/reembolso_online/v1/api/reembolso/atualizar
Tipo: POST
Parâmetros:
	mshash: String
	id_reembolso: Int
	id_status_reembolso: Int
	observacao: String
	despesas (array)
		despesas[0][id_status_reembolso]: String
		despesas[0][observacao]: String
		despesas[0][valor_reembolsado]: Float
		despesas[0][valor_coparticipacao]: Float
		despesas[0][valor_uso_indevido]: Float
		despesas[0][valor_glosado]: Float
		despesas[0][id_despesa_reembolso]: Int
	data_pagamento: String -> (Data YYYY-mm-dd)
	numero_lote: Int
	id_reembolso: Int

Retorno padrão:
{
	"status": true,
	"data": [],
	"critical": null,
	"timestamp": "2017-08-01T17:34:52-03:00",
	"msg": "Sucesso"
}

Atribuir Usuário ao Reembolso

Endpoint: /reembolso_online/v1/api/reembolso/atribuirUsuarioReembolso
Tipo: POST

Parâmetros:
	mshash (string)
	id_reembolso (int)
	Id_ms_usuario
Retorno padrão:
{
	"status": true,
	"data": [],
	"critical": null,
	"timestamp": "2017-08-01T17:34:52-03:00",
	"msg": "Sucesso"
}


  • Sem rótulos