Recuperar Saldo da Conta do Usuário

Serviço que recupera o saldo da conta do usuário da sessão, identificada pelo Token ou pelo Identificador de Sessão SSO.

Parâmetros de Cabeçalho

Parâmetro Formato Obrigatório? Descrição
t String sim O Token que identifica a Aplicação solicitante e o usuário autorizado.

Retorno da Chamada

Raiz: respostaPortalVO

Atributo Tipo Descrição
ok boolean Indica se a requisição foi processada com sucesso.
chaveRetorno String Chave de internacionalização, para exibição da mensagem de retorno em sistemas com suporte à I18n.
mensagemRetorno String Mensagem de retorno do servidor para o status da requisição.
statusHttp int Indica um status de retorno para a requisição, de acordo com as convenções do HTTP.
entidades Genérico Pode comportar uma lista de objetos, ou um objeto único, que contém as informações solicitadas pelo serviço. As informações específicas do serviço serão detalhadas em uma tabela separada (tabela Entidade).
tokenRenovacao String Quando o token da aplicação expira, a primeira chamada após o token expirar conterá um token de renovação, para que seja possível renovar o token de autorização da aplicação sem que seja necessária uma nova prova de credenciais.
validadeToken timestamp A data até a qual o token utilizado é válido.
horarioRetorno timestamp A hora do servidor no momento em que foi processada a resposta.

Entidade

Raiz: saldoContaPortalVO

Atributo Tipo Descrição
nome String Nome do usuário da sessão.
nomeUsuario String Nome de Usuário (login) do usuário da sessão.
identificadorSessaoSSO String Identificador da Sessão do Portal, ou Token de Autorização do usuário da sessão.
aliasCarteira String Um rótulo para a Conta selecionada na sessão.
nomeDonoConta String Nome do usuário que é dono da conta da sessão.
nomeUsuarioDonoConta String Nome de Usuário (login) do usuário que é dono da conta da sessão.
areaAtuacaoDonoConta String Área de atuação da empresa dona da conta compartilhada.
tipoRelacionamento String / InscricaoGrupoPortalEnum Define o tipo de relacionamento que o usuário da sessão possui com o dono da conta selecionada. Valores possíveis: CRIADOR, ADMINISTRADOR, MEMBRO, CONVIDADO, SOLICITANTE, NAOINSCRITO, BLOQUEADO, RECUSADO
saldoUsuario BigDecimal Saldo da Conta disponível para o usuário da sessão.
totalCota BigDecimal Se uma cota limitada dos créditos da conta foi definida para o usuário da sessão, este atributo retorna o valor desta cota (a cota é mensal).
totalGastoNoPeríodo String Quantos créditos já foram gastos pelo usuário no período, utilizando esta conta.
compartilhamento boolean Indica se a conta sendo utilizada é uma conta compartilhada (cujo dono não é o usuário que a está utilizando).
carteiraPessoal boolean Indica se o usuário e o dono da conta são a mesma pessoa.
cota boolean Indica se existe uma cota mensal limitada definida para o usuário.
podeTrocarConta boolean Indica se o usuário está autorizado a fazer troca de conta.
possuiCompartilhamentosPendentesOuAtivos boolean Indica se há algum convite de relacionamento pendente para o usuário.
posPago boolean Indica se trata-se de uma conta pós-paga (true) ou pré-paga (false).