Consultar saldos

El método consultarSaldos es usado para consultar los saldos disponibles de la cuenta, es un método tipo POST y la URL de consumo es la siguiente:

https://app.sivetel.com/ApiWS/consultarSaldos

Los parámetros que deben ser enviados se describen en la Tabla 1 y los parámetros de respuesta se describen en la Tabla 2.

Tabla 1. Parámetros de envío para el método consultarSaldos

Campo	Tipo	Valor	Ejemplo
cuenta	Numérico	Este es el número con el que se realizó el registro.	5555555505
usuario	Alfanumérico	El usuario que fue generado al momento de realizar el registro.	nombre.usuario
password	Alfanumérico	La contraseña generada al momento de realizar el registo.	KVL96J3

Tabla 2. Parámetros de respuesta del método consultarSaldos

Campo	Valor	Ejemplo
status	Boleano (True o False).	true
error	Número de error generado.	0
message	El mensaje de respuesta generado.	Consulta Exitosa
data	JSON de respuesta con los saldos disponibles.	{"tiempoaire":"72.50","pagoservicios":"120.80"}

Ejemplo de respuesta JSON

{
  "status": true,
  "error": 0,
  "message": "Consulta Exitosa",
  "data": {
    "tiempoaire": "72.50",
    "pagoservicios": "120.80",
  }
}

Ejemplo de error de respuesta

Nota

Si alguno de los parámetros enviados es incorrecto o faltante, el servicio devolverá una respuesta de error.

Tabla con ejemplo de parámetros de envío para el método consultarSaldos cuando la contraseña es incorrecta

Campo	Tipo	Valor	Ejemplo
cuenta	Numérico	Este es el número con el que se realizó el registro.	5555555505
usuario	Alfanumérico	El usuario que fue generado al momento de realizar el registro.	nombre.usuario
password	Alfanumérico	La contraseña generada al momento de realizar el registo( ejemplificada con valores erroneos).	KVL96S4

Tabla con ejemplo de respuesta del método consultarSaldos cuando la contraseña es incorrecta

Campo	Tipo	Ejemplo
status	Boleano (True o False).	false
error	Numero de error generado.	401
message	El mensaje de respuesta generado.	Los datos de la cuenta son incorrectos
data	JSON de respuesta con los saldos disponibles.	[]

Ejemplo de respuesta JSON

{
  "status": false,
  "error": 401,
  "message": "Los datos de la cuenta son incorrectos",
  "data": []
}