Zum Inhalt springen
meniodeveloper
menio DashboardVorschau

POST tokens/{id}/addBalance?balanceToAdd={balanceToAdd} · Web API v3 · Deutsch

API-ReferenzWeb API v3 · Deutschtokens

POST tokens/{id}/addBalance?balanceToAdd={balanceToAdd}

Web API v3 · Deutsch v3tokens
Aktualität laut Confluence unklar. Die englische POS API v3 ist die aktuelle Referenz.
POST/tokens/{id}/addBalance?balanceToAdd={balanceToAdd}

Hiermit können Sie das auf dem Token ggf. vorhandene Guthaben um einen beliebigen Betrag erhöhen.

Bitte bilden Sie zum '{id}_{balanceToAdd}' (z.B. 'card123_1.99') 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.

Beispiel: 'cardId123'
balanceToAdddecimalErforderlich
Beispiel: 1.99

Request-Header

DevKey
{Ihr Key}
TrackingUnitId
{trackingUnitId}
SecurityToken
{checksumme über '{id}_{balanceToWithdraw}'} (in diesem Beispiel über 'card123_1.99')
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
### POST tokens/{id}/addBalance?balanceToAdd={balanceToAdd} [POST]
Hiermit können Sie das auf dem Token ggf. vorhandene Guthaben um einen beliebigen Betrag erhöhen. 

*Bitte bilden Sie zum* **'{id}_{balanceToAdd}'** *(z.B. 'card123_1.99') 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.
    + balanceToAdd (decimal, `1.99`) .. Geben Sie hier den Betrag an, der auf das Guthaben dieses Tokens aufgeladen werden soll. Negative Beträge sind nicht erlaubt

+ Request

    + Headers

            DevKey: {Ihr Key}
            TrackingUnitId: {trackingUnitId}
            SecurityToken: {checksumme über '{id}_{balanceToWithdraw}'} (in diesem Beispiel über 'card123_1.99')
    
    + Body
        
            {
                "ReceiptPdfUrl":"https://..."
            }
    
+ Response 200

        {
            "oldBalance":1.5
            "newBalance":3.49
        }

+ 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 Ressource
        // 13001: token unbekannt
        // 13004: token ist gesperrt, keine weitere Aktion möglich
        // 13005: Es sind nur positive Werte zum Aufladen bzw. Abheben erlaubt
        // 13006: Limit zum Abheben/Aufladen überschritten