Versões comparadas

Versão antiga 1

changes.mady.by.user Bruno Vieira (Unlicensed)

Gravado em

comparado com

Nova versão 2

changes.mady.by.user Bruno Vieira (Unlicensed)

Gravado em

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

Tópicos:

Índice

URL Base

AmbientesURL
Homologaçãohttps://exemplo.tapcore.com.br/
Produçãohttps://exemplo.tapcore.com.br/


Endpoint

EndpointMétodoDescrição

/plataforma_beneficiario/reembolso_online/v1/api/reembolso/atualizar

POST

Atualizar pedido de reembolso realizado.

Parâmetros

ParâmetroObrigatórioTipoDescrição
protocolotrue


Cor do plano de fundo
color#EDEEF1
Inteiro



id_reembolsotrue


Cor do plano de fundo
color#EDEEF1
Inteiro



id_status_reembolsotrue


Cor do plano de fundo
color#EDEEF1
Inteiro



observacaofalse


Cor do plano de fundo
color#EDEEF1
idtipo
String



despesas[0][id_status_reembolso]true


Cor do plano de fundo
color#EDEEF1
Inteiro



despesas[0][valor_reembolsado]true


Cor do plano de fundo
color#EDEEF1
Float



despesas[0][valor_coparticipacao]true


Cor do plano de fundo
color#EDEEF1
Float



despesas[0][valor_uso_indevido]true


Cor do plano de fundo
color#EDEEF1
Float



despesas[0][valor_glosado]true


Cor do plano de fundo
color#EDEEF1
Float



despesas[0][id_despesa_reembolso]true


Cor do plano de fundo
color#EDEEF1
Inteiro



data_pagamentotrue


Cor do plano de fundo
color#EDEEF1
idtipo
String



numero_lotetrue


Cor do plano de fundo
color#EDEEF1
Inteiro



mshash

true


Cor do plano de fundo
color#EDEEF1
idtipo
String


HASH que identifica de qual ambiente (Homologação ou Produção) os dados serão buscados.

despesas[1][id_despesa_reembolso]true


Cor do plano de fundo
color#EDEEF1
Inteiro



despesas[1][valor_glosado]true


Cor do plano de fundo
color#EDEEF1
Inteiro



despesas[1][id_status_reembolso]true


Cor do plano de fundo
color#EDEEF1
Inteiro




Bloco de código
languagejs
themeMidnight
titleParâmetros Postman
linenumberstrue
protocolo:31390420180906000004
id_reembolso:90811
id_status_reembolso:2
observacao:' or protocolo = '33221120180925800002'
despesas[0][id_status_reembolso]:2
despesas[0][valor_reembolsado]:5.44
despesas[0][valor_coparticipacao]:0
despesas[0][valor_uso_indevido]:0
despesas[0][valor_glosado]:0
despesas[0][id_despesa_reembolso]:110088
data_pagamento:2018-10-01
numero_lote:1231231
mshash:ZjMxNjY3YzY3ZDQ1ZmQxZDI1Njc0Nzg2MDhkZGY1NzEwMzZhMjc3ZQ==
despesas[1][id_despesa_reembolso]:116885
despesas[1][valor_glosado]:100
despesas[1][id_status_reembolso]:3


Retorno API (Sucesso)

Bloco de código
languagejs
themeMidnight
linenumberstrue
{
    "status": true,
    "data": [],
    "critical": null,
    "timestamp": "2019-04-22T13:40:43-03:00",
    "msg": "Reembolso atualizado com sucesso!"
}
5-

Exemplo de retorno API (Erro)

Bloco de código
languagejs
themeMidnight
linenumberstrue
{
    "status": false,
    "data": [],
    "errorcritical": [
        {
           "Erro: Cliente não encontrado.", "COD": 500,
            "DESC": "Protocolo não encontrado",
            "origem": "/mssuite/plataforma_beneficiario/reembolso_online/v2/api/reembolso/atualizar",
            "trace": null,
            "SOLU": null,
     "code       "REAL": 0null,
    "status": false
}
Nota
titleATENÇÃO
Esse endpoint não possui retorno de erro mesmo enviando dados inválidos ele retorna como se não tivesse registro.Padrões documentação API
        "CONT": null
        }
    ],
    "timestamp": "2019-04-22T13:52:22-03:00",
    "msg": "Protocolo não encontrado"
}