Consultar Saldo

Este servicio recibe el token y genera los elementos que componen la consulta de saldos:

  • ID saldo cliente
  • ID cliente usuario
  • Saldo timbres
  • Timbres utilizados
  • Fecha de expiracion
  • Ilimitado
  • Timbres asignados


Ruta
Operación
Descripción
/account/balance
GET Ruta para consulta de saldo.

Los servicios de consultas de saldo son servicios REST.

Paso 1: Obtener token de acceso, o en su defecto usar token infinito

Primeramente se deberá autenticar en nuestros servicios en orden de obtener token de acceso, o si se desea, se puede usar el token infinito.

Paso 2: Enviar token de acceso

Se envía el token para realizar la consulta de saldo.

HTTP Request

HTTP Response

Consultar saldo con las librerias


‘ tab_head_2=’Java’ tab_content_2=’
Ir al Repositorio de Java en GitHub

‘ tab_head_3=’PHP’ tab_content_3=’
Ir al Repositorio de PHP en GitHub

‘ tab_head_4=’Node.js’ tab_content_4=’
Ir al Repositorio de Node.js en GitHub

‘ id=”” class=”” style=””]

Respuestas de consulta de saldo

El response de consulta de saldo retorna la siguiente estructura en caso de error o en caso de petición satisfactoria:

Tipos de respuesta

En caso de una respuesta exitosa, se regresará un 200. En caso de una respuesta no exitosa, se regresará un código diferente de 200, el código puede variar dependiendo del problema dado.

Respuesta exitosa

En este caso se recibe un mensaje JSON, el cual contiene los siguientes datos:

  • idSaldoCliente: Id del registro.
  • idClienteUsuario: Id del usuario.
  • saldoTimbres: saldo de los timbres.
  • timbresUtilizados: timbres utilizados.
  • fechaExpiracion: fecha de expiración.
  • unlimited: En caso de que sea verdadero la forma de validar el saldo depende del numero de timbres que tenga el distribuidor. En caso de verdadero le descontará los timbres al distribuidor.
  • timbresAsignados: timbres asignados.

Respuesta no exitosa

Para realizar la integración con nuestros servicios recomendamos utilizar POSTMAN , facilita las pruebas previas a la codificación.
Puedes importar el archivo POSTMAN-collection que proporcionamos al final del articulo para su descarga en POSTMAN para que puedas realizar pruebas funcionales de nuestro servicio.

Updated on marzo 11, 2022

Article Attachments

Was this article helpful?

Related Articles