Zum Inhalt springen
meniodeveloper
menio DashboardVorschau

GET tokens/{id}/balance · Web API v3 · Entwurf

API-ReferenzWeb API v3 · Entwurftokens

GET tokens/{id}/balance

Web API v3 · Entwurf v3tokens
Entwurf; für neue Integrationen die aktuelle POS API v3 verwenden.
GET/tokens/{id}/balance

Hiermit können Sie das auf dem Token ggf. vorhandene Guthaben abfragen.

Bitte bilden Sie zur {id} eine Checksumme (siehe Security-Token) und geben Sie diese im SecurityToken-Header an.

Parameter

idstringErforderlich

Geben Sie hier den von einem Trägermedium ausgelesenen Token an, dessen Guthaben Sie abfragen wollen.

Beispiel: 'cardId123'

Request-Header

DevKey
{Ihr Key}
TrackingUnitId
{trackingUnitId}
SecurityToken
{checksumme über {id}}
Kontext: tokens

Tokens sind beliebig geartete, jedoch stets voneinander unterschiedliche, nicht wiederholbare Strings, welche sowohl zur Identifikation eines Konsumenten ( consumer ) als auch zur Identifikation eines Guthabens ( balance ) verwendet werden können. In der Regel werden diese Tokens auf einem beliebigen Trägermedium gespeichert und an einen Konsumenten in Form einer Kundenkarte oder Geschenkkarte ausgehändigt. Der Konsument wird bei seinen nächsten Käufen dieses Trägermedium am POS vorzeigen müssen, um auf das darin gespeicherte Guthaben zugreifen zu können bzw. die menio-Rewards angerechnet zu bekommen.

Originaler Blueprint-Ausschnitt
API Blueprint
oken unbekannt

## Guthaben abfragen [/tokens/{id}/balance]
### GET tokens/{id}/balance [GET]
Hiermit können Sie das auf dem Token ggf. vorhandene Guthaben abfragen. 

*Bitte bilden Sie zur* **{id}** *eine Checksumme (siehe [Security-Token](#introduction/grundlegendes/secutiry-token)) und geben Sie diese im `SecurityToken`-Header an.*

+ Parameters
    + id (string, `'cardId123'`) ... Geben Sie hier den von einem Trägermedium ausgelesenen Token an, dessen Guthaben Sie abfragen wollen. 

+ Request

    + Headers

            DevKey: {Ihr Key}
            TrackingUnitId: {trackingUnitId}
            SecurityToken: {checksumme über {id}}

+ Response 200

        {
            Balance = 50.0,
            CurrencyIso = "EUR"
        }

+ Response 500

        // HTTP-InternalServerError: Ein unbekannten Problem bei der Verarbeitung aufgetreten
        {
            "ErrorMessage":"some explanation"
            "StackTrace":"text"
        }

+ Response 403 

        // HTTP-Forbidden: trackingUnitId ist noch nicht vom Merchant aktiviert
            
+ Response 401 

        // HTTP-Unauthorized: DevKey, trackingUnitId oder SecurityToken nicht angegeben/falsch
            
+ Response 400

        {
            "ErrorId":123,
            "ErrorText":"Details zum Fehler"
        }
        
        // hier alle möglichen ErrorCodes inkl. Texte für diese Resource
        // 13001: token unbekannt
        // 13004: token ist temporär gesperrt, keine weitere Aktion möglich
        // 13008: token ist endgültig gesperrt, keine weitere Aktion möglich