POST api/Saldo/ConsultarSaldo

Consultar o saldo disponível para utilização

Request Information

URI Parameters

None.

Body Parameters

Dados para a consulta

ConsultarSaldo
NameDescriptionTypeAdditional information
metodo

Método a ser invocado (Opcional)

string

None.

token

Token de acesso Americanet

string

None.

tempo_vida

Tempo de vida do token

string

None.

token2

token de acesso a esta Api

string

None.

idoperador

Código do operador/colaborador

integer

None.

Numero_contrato

Número do contrato do assinante junto a AmericaNet

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "metodo": "sample string 1",
  "token": "sample string 2",
  "tempo_vida": "sample string 3",
  "token2": "sample string 4",
  "idoperador": 5,
  "Numero_contrato": 6
}

application/xml, text/xml

Sample:
<SaldoModel.ConsultarSaldo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/mvno">
  <Numero_contrato>6</Numero_contrato>
  <idoperador>5</idoperador>
  <metodo>sample string 1</metodo>
  <tempo_vida>sample string 3</tempo_vida>
  <token>sample string 2</token>
  <token2>sample string 4</token2>
</SaldoModel.ConsultarSaldo>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ConsultarSaldoRetorno
NameDescriptionTypeAdditional information
retorno

Código e mensagem de retorno do servidor. 0=Sucesso

SaldoMensagemRetorno

None.

token

Token de acesso, caso seja renovado

string

None.

tempo_vida

Tempo de vida do token

string

None.

Response Formats

application/json, text/json

Sample:
{
  "retorno": {
    "codigo": 1,
    "mensagem": "sample string 2",
    "Saldo_GB": 3.1
  },
  "token": "sample string 1",
  "tempo_vida": "sample string 2"
}

application/xml, text/xml

Sample:
<SaldoModel.ConsultarSaldoRetorno xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/mvno">
  <retorno>
    <Saldo_GB>3.1</Saldo_GB>
    <codigo>1</codigo>
    <mensagem>sample string 2</mensagem>
  </retorno>
  <tempo_vida>sample string 2</tempo_vida>
  <token>sample string 1</token>
</SaldoModel.ConsultarSaldoRetorno>