Consulta il saldo, la valuta e il valore delle condizioni di pagamento del conto identificato dalle tue credenziali API. Questa operazione consulta il saldo; non aggiunge fondi né effettua un ordine.
Richiesta
Utilizza le credenziali API lato server tramite HTTPS. Gli esempi leggono le credenziali dalle variabili di ambiente; non contengono credenziali funzionanti. Controlla status.code nel corpo JSON oltre allo stato HTTP. Questi gestori legacy non impostano sistematicamente uno stato di errore HTTP in caso di errore applicativo.
curl --user "$MULTITEL_API_USER:$MULTITEL_API_PASSWORD" \
"https://api.multitel.net/v3/getbalance"Non sono richiesti parametri nel percorso, nella stringa di query o nel corpo della richiesta.
Risposta
Questa struttura di risposta è fornita a scopo illustrativo e non rappresenta dati di un conto né un preventivo aggiornato.
{
"status": {
"code": 200,
"msg": ""
},
"response": {
"balance": "125.50",
"currency": "USD",
"terms": "prepaid"
}
}| Campo | Significato |
|---|---|
balance | Il saldo memorizzato del conto. Mantieni la precisione decimale durante l'elaborazione dei valori monetari. |
currency | Il valore della valuta memorizzato per questo conto. |
terms | Il valore delle condizioni di pagamento memorizzato per il conto. Il gestore non ne elenca i valori possibili né lo normalizza; non presumere che l'esempio comprenda tutti i valori possibili. |
Errori e utilizzo
In caso di autenticazione non riuscita viene utilizzata la risposta di autenticazione comune dell'API. Questo gestore non definisce un errore specifico per l'assenza del saldo né prevede la paginazione. Il saldo restituito non costituisce una prenotazione di fondi e non garantisce che un ordine successivo vada a buon fine.