POST tokens/{id}/Allowances?pin={pin} · POS API

API-ReferenzPOS APItokens

POST tokens/{id}/Allowances?pin={pin}

POS API v3tokens

POST/tokens/{id}/Allowances?pin={pin}

This allows you to withdraw an amount from the allowances of the token.

*Please form a checksum (see Security-Token) for the ** {id} *and specify it in the 'SecurityToken' header.

Parameter

idstringErforderlich

Enter the token read from a carrier medium here. If the token is longer than 50 bytes, it should be transmitted via the token request header instead of the URL.

Beispiel: 'cardId123'

pinstring

Enter the optional PIN here in case the field RequiresPin of the response of GET tokens/{id}/info is set to true. The PIN will usually be printed on the gift card

Beispiel: 'PQ123'

Request-Header

DevKey

{Your Key}

TrackingUnitId

{trackingUnitId}

SecurityToken

{checksum over {id}}

Token

optional {the token read from a carrier medium as customer identifier}

Kontext: tokens

Tokens are arbitrary, but always different, non-repeatable strings, which can be used for identification purposes as well as for of a consumer ('consumer') as well as for the identification of a credit balance ('balance'). As a rule these tokens are stored on any carrier medium and sent to a consumer in the form of a 'customer card' or 'gift card handed over. The consumer will have to present this carrier medium at the POS with his next purchases in order to access the to be able to access credit or to be credited with menio-Rewards.

Originaler Blueprint-Ausschnitt

API BlueprintKopieren

### POST tokens/{id}/Allowances?pin={pin} [POST]
This allows you to withdraw an amount from the allowances of the token.

*Please form a checksum (see [Security-Token](#introduction/basic/security-token)) for the ** **{id}** *and specify it in the 'SecurityToken' header.

+ Parameters
    + id (string, `'cardId123'`) ... Enter the token read from a carrier medium here. If the token is longer than 50 bytes, it should be transmitted via the token request header instead of the URL.
    + pin (optional, string, `'PQ123'`) ... Enter the optional PIN here in case the field `RequiresPin` of the response of GET tokens/{id}/info is set to `true`. The PIN will usually be printed on the gift card

+ Request

    + Headers

            DevKey: {Your Key}
            TrackingUnitId: {trackingUnitId}
            SecurityToken: {checksum over {id}}
            Token: optional {the token read from a carrier medium as customer identifier}
            
    + Body
    
            {
                "UserGroup": {
                    "Key": "123",
                    "Name": "Internal Customers"
                },
                "Allowances": [
                    {
                        "Id": 1,
                        "ThirdPartyId": "9999",
                        "Amount": 5.99
                    }
                ]
            }

+ response 200
        
        [
            {
                "Id": 1,
                "ThirdPartyId": "9999",
                "Amount": 5.99,
                "Success": true
            }
        ]

Request

cURLKopieren

curl --request POST \
  'https://pos-playground-eu.qnips.com/api/pos/v3/tokens/{id}/Allowances?pin={pin}' \
  --header 'DevKey: {YOUR_DEV_KEY}' \
  --header 'TrackingUnitId: {trackingUnitId}' \
  --header 'SecurityToken: {checksum over {id}}' \
  --header 'Token: optional {the token read from a carrier medium as customer identifier}' \
  --data-raw '{
    "UserGroup": {
        "Key": "123",
        "Name": "Internal Customers"
    },
    "Allowances": [
        {
            "Id": 1,
            "ThirdPartyId": "9999",
            "Amount": 5.99
        }
    ]
}
'

Dokumentationsbeispiel. Platzhalter vor der Verwendung ersetzen.

Response

200

Response 200Kopieren

[
    {
        "Id": 1,
        "ThirdPartyId": "9999",
        "Amount": 5.99,
        "Success": true
    }
]