Discover a Giftcard

Discover a Gift Card

GET https://api.pos.zmyle.de/service/v1.1/gift_cards/find

Use this endpoint to discover/find giftcards in our API.

Query Parameters

[
  {
    "activation": {
        "amount": 2000,
        "minAmount": 100,
        "maxAmount": 25000,
        "isDynamicAmount": false
    },
    "expectedAction": "redeem",
    "authorizedActions": [
        "redeem",
        "activate"
    ],
    "availableBalance": 2000,
    "balance": 2000,
    "id": "18jja4mf08fn08f7gp9l",
    "initialAmount": 2000,
    "shortId": "QTHX",
    "accessToken": "hg84zhgnzuigui4hg3hg7834",
    "currency": "EUR",
    "transactions": [
        {
            "confirmedAt": "20171124T213259Z",
            "statementDescriptor": "Aktivierung",
            "amount": 2000,
            "id": "18k5ejn09hm88394qz32"
        }
    ]
  }
]

You can use this endpoint to find a giftcard when scanning the QR Code of a gift card. Just use the entire content from the QR Code as the value for the query parameter.

Make sure to URL-encode the value that you use with the query parameter. Our QR Codes often contain URLs; if you simply use this URL without URL-encoding it, your request won't be a valid request.

Example Request using a short ID:

curl https://api.pos.zmyle.de/service/v1.1/gift_cards/find?query=QTHX \
  -u <api_key>:<api_secret>

Example Request using contents from a QR Code:

This example demonstrates how to use the scanned contents of a QR Code to find a giftcard. In this scenario, you have a QR Code scanner that scans the code on a zmyle gift card. The scanned contents of the QR Code are passed into the query parameter (URL encoded). In this example, the QR Code contains the URL: https://www.zmyle.de/g/18jja4mf08fn08f7gp9l/redeem?rt=o19y18jja4mf3kd8m3zkn4 And the resulting query parameter is: https%3A%2F%2Fwww.zmyle.de%2Fg%2F18jja4mf08fn08f7gp9l%2Fredeem%3Frt%3Do19y18jja4mf3kd8m3zkn4

curl https://api.pos.zmyle.de/service/v1.1/gift_cards/find?query=https%3A%2F%2Fwww.zmyle.de%2Fg%2F18jja4mf08fn08f7gp9l%2Fredeem%3Frt%3Do19y18jja4mf3kd8m3zkn4 \
  -u <api_key>:<api_secret>

Response Error Codes

PreviousThe Giftcard ObjectNextActivate a Giftcard

Last updated