Guthabenabfrage-API: Kontoguthaben prüfen

Fragen Sie Ihr aktuelles Kontoguthaben ab. Gibt das gesamte verfügbare Guthaben Ihres API-Schlüssels zurück.

Beispielcode:

curl --location 'https://api.checknumber.ai/v1/balance' \
--header 'X-API-Key: API-KEY'

Beispielantwort bei erfolgreicher Anfrage

{
    "balance": 9850.50
}

Beispielantwort bei nicht autorisierter Anfrage

{
    "error": "unauthorized",
    "message": "Access key is required (X-API-Key or X-Access-Key)"
}

HTTP-Anfrage

GET https://api.checknumber.ai/v1/balance

Anfrage-Header

Header	Beschreibung
X-API-Key	string, Ihr API-Schlüssel (erforderlich). Wird auch als X-Access-Key akzeptiert

Antwortfelder

Feld	Beschreibung	Beispiel
balance	Gesamtes verfügbares Guthaben für den API-Schlüssel (Credits)	9850.50

Statuscodes

Status	Beschreibung
200	Anfrage erfolgreich, Guthaben zurückgegeben
401	Nicht autorisiert, API-Schlüssel fehlt oder ist ungültig
502	Guthabenabfrage fehlgeschlagen, Fehler beim vorgelagerten Dienst