Este servicio permite consultar el saldo disponible asociado a las credenciales proporcionadas en la petición.
La petición debe enviarse en formato JSON e incluir las credenciales y los datos del dispositivo.
| Propiedad | Tipo | Obligatorio | Descripción |
|---|---|---|---|
header.security.key | String | Sí | Llave de acceso asignada al usuario. |
header.security.password | String | Sí | Contraseña asociada a la llave de acceso. |
device.applicationName | String | Sí | Nombre de la aplicación que realiza la consulta. |
device.type | String | Sí | Tipo de dispositivo o cliente desde el que se realiza la petición. |
{
"header": {
"security": {
"key": "...",
"password": "..."
}
},
"device": {
"applicationName": "API HUIPIX",
"type": "Web"
}
}
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"
}
}'
La respuesta devuelve el saldo disponible en la propiedad balance.
{
"balance": 2820
}
| Propiedad | Tipo | Descripción |
|---|---|---|
balance | Number | Saldo disponible asociado a la cuenta. |