Consulte el saldo, la moneda y el valor de las condiciones de pago de la cuenta correspondiente a sus credenciales de API. Esta operación es una consulta de saldo; no añade fondos ni realiza pedidos.
Solicitud
Utilice credenciales de API del lado del servidor a través de HTTPS. Los ejemplos leen las credenciales de variables de entorno; no contienen credenciales válidas para autenticarse. Compruebe status.code en el cuerpo JSON, además del estado HTTP. Estos manejadores heredados no siempre establecen un estado de error HTTP cuando se produce un error de la aplicación.
curl --user "$MULTITEL_API_USER:$MULTITEL_API_PASSWORD" \
"https://api.multitel.net/v3/getbalance"No se requieren parámetros de ruta, de consulta ni del cuerpo de la solicitud.
Respuesta
Esta estructura de respuesta es ilustrativa; no contiene datos de una cuenta ni constituye una cotización de precios vigente.
{
"status": {
"code": 200,
"msg": ""
},
"response": {
"balance": "125.50",
"currency": "USD",
"terms": "prepaid"
}
}| Campo | Significado |
|---|---|
balance | El saldo almacenado de la cuenta. Conserve la precisión decimal al procesar valores monetarios. |
currency | El valor de moneda almacenado para esta cuenta. |
terms | El valor de las condiciones de pago almacenado para la cuenta. El manejador no lo enumera ni lo normaliza; no suponga que el ejemplo abarca todos los valores posibles. |
Errores y uso
Cuando falla la autenticación, se utiliza la respuesta de autenticación compartida de la API. Este manejador no define un error específico para la ausencia de saldo ni paginación. El saldo devuelto no constituye una reserva de fondos ni garantiza que un pedido posterior se complete correctamente.