API CONSULTA DE SALDO


Este servicio permite consultar el saldo disponible asociado a las credenciales proporcionadas en la petición.


DATOS DEL REQUEST

La petición debe enviarse en formato JSON e incluir las credenciales y los datos del dispositivo.

PropiedadTipoObligatorioDescripción
header.security.keyStringSíLlave de acceso asignada al usuario.
header.security.passwordStringSíContraseña asociada a la llave de acceso.
device.applicationNameStringSíNombre de la aplicación que realiza la consulta.
device.typeStringSíTipo de dispositivo o cliente desde el que se realiza la petición.
Ejemplo JSON
{
  "header": {
    "security": {
      "key": "...",
      "password": "..."
    }
  },
  "device": {
    "applicationName": "API HUIPIX",
    "type": "Web"
  }
}
Ejemplo curl
curl -X POST 'https://sistemahuipix.com/ws-get-balance' \
  -H 'Content-Type: application/json' \
  -d '{
    "header": {
      "security": {
        "key": "...",
        "password": "..."
      }
    },
    "device": {
      "applicationName": "API HUIPIX",
      "type": "Web"
    }
  }'

RESPUESTA EXITOSA

La respuesta devuelve el saldo disponible en la propiedad balance.

{
  "balance": 2820
}
PropiedadTipoDescripción
balanceNumberSaldo disponible asociado a la cuenta.
© , ENVIOS HUIPIX