Rufen Sie den Kontostand, die Währung und den Wert für die Zahlungsbedingungen des Kontos ab, das Ihren API-Zugangsdaten zugeordnet ist. Dies ist eine Kontostandsabfrage; dabei wird weder Guthaben aufgeladen noch eine Bestellung aufgegeben.
Anfrage
Verwenden Sie API-Zugangsdaten serverseitig über HTTPS. Die Beispiele lesen Zugangsdaten aus Umgebungsvariablen; sie enthalten keine funktionsfähigen Zugangsdaten. Prüfen Sie status.code im JSON-Antworttext sowie den HTTP-Status. Diese älteren Handler setzen bei einem Anwendungsfehler nicht durchgängig einen HTTP-Fehlerstatus.
curl --user "$MULTITEL_API_USER:$MULTITEL_API_PASSWORD" \
"https://api.multitel.net/v3/getbalance"Es sind keine Pfad-, Abfrage- oder Body-Parameter erforderlich.
Antwort
Dies ist eine beispielhafte Antwortstruktur; sie enthält weder Kontodaten noch ein aktuelles Preisangebot.
{
"status": {
"code": 200,
"msg": ""
},
"response": {
"balance": "125.50",
"currency": "USD",
"terms": "prepaid"
}
}| Feld | Bedeutung |
|---|---|
balance | Der gespeicherte Kontostand. Behalten Sie bei der Verarbeitung von Geldbeträgen die Dezimalgenauigkeit bei. |
currency | Der für dieses Konto gespeicherte Währungswert. |
terms | Der für das Konto gespeicherte Wert für die Zahlungsbedingungen. Der Handler zählt die möglichen Werte weder auf noch normalisiert er den gespeicherten Wert; gehen Sie nicht davon aus, dass das Beispiel alle möglichen Werte abdeckt. |
Fehler und Verwendung
Bei fehlgeschlagener Authentifizierung wird die gemeinsame Authentifizierungsantwort der API verwendet. Dieser Handler definiert weder einen gesonderten Fehler für einen fehlenden Kontostand noch eine Paginierung. Ein zurückgegebener Kontostand stellt keine Reservierung von Geldmitteln dar und garantiert nicht, dass eine spätere Bestellung erfolgreich ist.