Kontostand Abfragen

Anfrage-URL

GET /v1/balance

Authentifizierung

Verwendet HTTP-Basisauthentifizierung. Fügen Sie Authorization im HTTP-Header hinzu:

Authorization: Basic ${base64_auth_string}

              
              Authorization: Basic ${base64_auth_string}

Diesen Codeblock im schwebenden Fenster anzeigen

Der base64_auth_string wird generiert durch: base64(dev_key:dev_secret)

Anfrage-Beispiel

Anfrage-Header

GET /v1/balance HTTP/1.1 Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0

              
              GET /v1/balance  HTTP/1.1
Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0

Diesen Codeblock im schwebenden Fenster anzeigen

Anfrage-Body

Keiner

Anfrage-Parameter

Keine

Antwort-Parameter

Erfolgreiche Antwort

Feld	Typ	Option	Beschreibung
balance10000	Integer	Pflichtfeld	Normales Guthaben, Ganzzahlwert multipliziert mit 10000
gift_balance10000	Integer	Pflichtfeld	Geschenkguthaben, Ganzzahlwert multipliziert mit 10000
balance	Number	Pflichtfeld	Normales Guthaben, Gleitkomma
gift_balance	Number	Pflichtfeld	Geschenkguthaben, Gleitkomma
total_balance10000	Integer	Pflichtfeld	Gesamtguthaben, Summe aus normalem Guthaben und Geschenkguthaben, Ganzzahlwert multipliziert mit 10000
total_balance	Number	Pflichtfeld	Gesamtguthaben, Summe aus normalem Guthaben und Geschenkguthaben, Gleitkomma

{ "balance10000": 123456, "gift_balance10000": 20000, "balance": 12.3456, "gift_balance": 2, "total_balance10000": 143456, "total_balance": 14.3456 }

              
              {
    "balance10000": 123456,
    "gift_balance10000": 20000,
    "balance": 12.3456,
    "gift_balance": 2,
    "total_balance10000": 143456,
    "total_balance": 14.3456
}

Diesen Codeblock im schwebenden Fenster anzeigen

Es wird empfohlen, dass Aufrufer bevorzugt die Felder balance10000, gift_balance10000 und total_balance10000 verwenden, um den Kontostand selbst zu formatieren und Gleitkomma-Präzisionsprobleme zu vermeiden.

Fehlgeschlagene Antwort

Der HTTP-Statuscode ist 4xx oder 5xx, der Antwort-Body enthält folgende Felder:

Feld	Typ	Option	Beschreibung
code	int	Pflichtfeld	Fehlercode, siehe Fehlercodes für Details
message	String	Pflichtfeld	Fehlerdetails

{ "code": 2001, "message": "invalid token" }

              
              {
    "code": 2001,
    "message": "invalid token"
}

Diesen Codeblock im schwebenden Fenster anzeigen

Fehlercodes

Fehlercode	HTTP Code	Beschreibung
1000	500	Interner Fehler, bitte versuchen Sie es später erneut
2001	401	Authentifizierung fehlgeschlagen, kein korrektes Token angegeben, oder der dem Token zugeordnete Händler existiert nicht
2002	401	Authentifizierung fehlgeschlagen, Token ist abgelaufen oder wurde deaktiviert
2002	403	Händler wurde gelöscht