Especificação do Callback do Reembolso Online

Tópicos:

URL Base

Ambientes	URL
Homologação	https://ms3.tapcore.com.br/mssuite/
Produção	https://ms3.tapcore.com.br/mssuite/

Endpoint

Endpoint	Método	Descrição
reembolso/inserir	POST	Descrição do método POST.

Parâmetros

O callback será feito através de uma requisição HTTP do tipo POST ao serviço cadastrado, os parâmetros serão enviados via RAW no formato JSON, conforme as especificações abaixo:

Parâmetro	Obrigatório	Tipo	Descrição
protocolo	true	Inteiro
id_operadora	true	Inteiro	Id da operadora para a qual serão buscados os grupos de menu
mshash	true	String	HASH que identifica de qual ambiente (Homologação ou Produção) os dados serão buscados.
matricula_titular	true	String
matricula_beneficiario	true	String
cpf_titular	true	String
telefone	false	String
nome_titular	false	String
operadora_ans	false	String
despesas	true	Array
despesas.utilizador_matricula	true	String
despesas.utilizador_nome	true	String
despesas.id_tipo_reembolso	true	String
despesas.prestador_documento	true	String
despesas.data_despesa	true	String
despesas.valor_despsa	true	String
despesas.arquivos	true	Array
despesas.arquivos.url	true	String
despesas.arquivos.nome	true	String
utilizado_matricula	true	String
utilizador_nome	true	String
utilizador_nome	true	String
id_tipo_reembolso	true	String
prestador_documento	true	String
data_despesa	true	String
valor_despsa	true	String
arquivos	true	Array
arquivos.url	true	String
arquivos.nome	true	String
url	true	String
nome	true	String
diretorio	true	String

{
    "protocolo": "31390420132237080113117" ,
    "id_operadora": "721",
    "mshash": "NjA1ZDhjkskkzN2RjMzE3NTg2ZjUyMzgyZTk5ZTkyMGU4MDA2ZGFiNg==",
    "matricula_titular": "32323309100060",
    "matricula_beneficiario": "33320309100060",
    "cpf_titular": "11122233396",
    "telefone": "",
    "nome_titular": "",
    "operadora_ans": "",
    "despesas":
    [{
        "utilizador_matricula": "321",
        "utilizador_nome": "",
        "id_tipo_reembolso": "",
        "prestador_documento": "",
        "data_despesa": "2016-11-20",
        "valor_despsa": "200.40",
        "arquivos": [{
            "url": "http://mobilesaude.com.br/files/teste.txt",
            "nome": "teste.txt"
        },
        {
            "url": "http://mobilesaude.com.br/files/teste.txt",
            "nome": "teste.txt"
        }]
    },
    {
        "utilizado_matricula": "321",
        "utilizador_nome": "",
        "id_tipo_reembolso": "",
        "prestador_documento": "",
        "data_despesa": "2016-11-20",
        "valor_despsa": "200.40",
        "arquivos": [],
        "url": "http://mobilesaude.com.br/files/teste.txt",
        "nome": "teste.txt",
        "diretorio": "reembolsos"
    }]
}

Retorno com Alteração de Valores

Os valores devem ser atribuidos por despesas como no padrão abaixo

{
    "protocolo" : "31390420170801133212" ,
    "mshash" : "NjA1ZDhkNjkzN2RjMz213bNTg2ZjUyMzgyZTk5ZTkyMGU4MDA2ZGFiNg==" ,
    "despesas" : [{
        "id_status_reembolso" : "" ,
        "id_despesa_reembolso" : "" ,
        "valor_glosado" : 99.99,
        "valor_uso_indevido" : 99.99,
        "valor_coparticipacao" : 99.99 ,
        "valor_reembolsado" : 99.99 ,
        "observacao" : "Teste observacao"
    }]
}

Exemplo de retorno API (Sucesso)

{
    "protocolo" : "3139042017080113117" ,
    "mshash" : "NjA1ZDhkNjkzN2RjMz213bNTg2ZjUyMzgyZTk5ZTkyMGU4MDA2ZGFiNg==" ,
    "status" : "2"
}

Exemplo de retorno (Erro)

{
    "status": false,
    "data": [],
    "critical": [
        {
            "COD": 0,
            "DESC": "Atributo [prestador_documento] é obrigatório para inserção de uma despesa",
            "origem": "/mssuite/plataforma_beneficiario/reembolso_online/v2/api/reembolso/inserir",
            "trace": "#0 /var/www/html/mssuite/plataforma_beneficiario/reembolso_online/v2/application/libraries/entity/DespesaEntity.php(86): DespesaEntity->verificaAtributo('prestador_docum...'),#1 /var/www/html/mssuite/plataforma_beneficiario/reembolso_online/v2/application/controllers/api/Reembolso.php(361): DespesaEntity->verificarIntegridadeDespesa(Object(ConfiguracaoEntity)),#2 /var/www/html/mssuite/shared/library/ci/3.1.0/system/core/CodeIgniter.php(514): Reembolso->inserir(),#3 /var/www/html/mssuite/plataforma_beneficiario/reembolso_online/v2/index.php(293): require_once('/var/www/html/m...'),#4 {main}",
            "SOLU": null,
            "REAL": null,
            "CONT": null
        }
    ],
    "timestamp": "2019-04-22T11:58:36-03:00",
    "msg": "Atributo [prestador_documento] é obrigatório para inserção de uma despesa"
}