Especificação do Callback do Reembolso Online

Tópicos:

1 URL Base
2 Endpoint
3 Status do Reembolso
4 Segurança das URLs
- 4.1 Importante
5 Parâmetros
6 Retorno com Alteração de Valores
- 6.1 Os valores devem ser atribuidos por despesas como no padrão abaixo
7 Exemplo de retorno API (Sucesso)
8 Exemplo de retorno (Erro)

URL Base

Ambientes	URL

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

Endpoint

Endpoint	Método	Descrição

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

Status do Reembolso

ID	Descrição

ID	Descrição
1	Solicitado
2	Aprovado
3	Recusado
4	Em Análise
5	Parcialmente Aprovado
6	Pago
19	Cancelado

Segurança das URLs

Importante

Todas as imagens que estão sob nosso domínio não são disponibilizadas de forma pública, favor seguir as recomendações abaixo!

Por questões de segurança todas as imagens ou objetos disponíveis através de uma URL serão enviadas com uma assinatura, desta forma, o download dos objetos ou imagens disponíveis, só serão possíveis por um período de aproximadamente 15 minutos.

Recomenda-se que seja feito o download da imagem ou objeto assinado assim que receber este payload e não salve a URL pois ela ficará indisponível após o tempo pré-determinado.

Em casos que seja necessário o acesso a este objeto ou imagem depois desse período, re-envie o callback através do painel para receber uma nova assinatura válida por mais 15 minutos

Exemplo da url ->https://autorizacao.s3-sa-east-1.amazonaws.com/AWSAccessKeyId=ABC&Expires=1616095118&Signature=ABCD

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:

{
    "id_reembolso": "508923",
    "id_operadora": "9999",
    "id_status_reembolso": "1",
    "nome_titular": "BENEFICIARIO DEMONSTRACAO DA SILVA",
    "cpf_titular": "99999999999",
    "telefone": "49909090913",
    "matricula_titular": "315263333333",
    "matricula_beneficiario": "315263333333",
    "id_sistema_interno": "2544890",
    "observacao_interna": null,
    "protocolo": "999999920210531000242",
    "mshash": "LAKSJDFLKAJSDLFKJASLDKFJALKSDJFLKAJSDLKFJASLKDJF==",
    "operadora_ans": "98989-8",
    "despesas": [
        {
            "id_despesa_reembolso": "586336",
            "utilizador_matricula": "31526292",
            "utilizador_nome": "BENEFICIARIO DEMONSTRACAO DA SILVA",
            "data_despesa": "2021-05-27",
            "prestador_documento": "98989898989898",
            "valor_despesa": "199.00",
            "id_tipo_reembolso": "171",
            "prestador_estado": "PR",
            "prestador_cidade": "CURITIBA",
            "observacao_interna": null,
            "arquivos": [
                {
                    "nome": "imagem-1-temp.jpeg",
                    "diretorio": "reembolsos",
                    "url": "http://abcdefghil.jpeg"
                },
                {
                    "nome": "imagem2-temp.jpeg",
                    "diretorio": "reembolsos",
                    "url": "http://abcdefghil2.jpeg"
                }
            ]
        }
    ],
    "terceiro_passo": {
        "banco": "999",
        "agencia": "111222333",
        "conta": "555666777",
        "nome": "BENEFICIARIO DEMONSTRACAO DA SILVA",
        "cpf": "999.999.999-22",
        "hospital": "Medicos de Olhos",
        "observacao": "aos devs: referente a todos os atributos do 3o passo: estes campos podem ser modificados (3o passo) portanto nao sao obrigatorios, podendo nem mesmo existir",
        "prestador": "teste teste teste"
    }
}

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)

Obs: As informações enviadas pelo Callback a Api gravará e devolverá um retorno como o exemplo abaixo, mas devemos dar atenção ao atributo "status", caso tenha intenção de atualizar o status do reembolso no CMS sem a intervenção direta, devemos informar o codigo do "status" do reembolso no retorno e a rotina de callback irá disparar um recurso para executar essa mudança. Portanto, caso exista um fluxo de aprovação manual da operadora e não terá o recurso de atualização direta, não será necessário o retorno abaixo.

Os status de reembolso estão no inicio deste documento.

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