Retrieve a huggg voucher

Overview

GET /api/v2/hugggs/{hugggId}/voucher/claimed

This endpoint will return a voucher for the huggg if it exists.

Request

URL Parameters

Key Value Description
hugggId string The ID or shortcode of the huggg that you want a voucher for

Examples

Retrieve a huggg voucher

GET /api/v2/hugggs/{hugggId}/voucher/claimed

Response

The successful response returns a Voucher V2 entity.

HTTP/1.1 200 OK

{
    "voucherType": "wegift",
    "segment": {
        "id": "b6zfA70H4XguvjtZauial",
        "name": "This is a segment",
        "voucherType": "wegift",
        "expiry": 1000,
        "configuration": {
            ...
        }
    },
    "expiresAt": "2020-07-01T00:00:00.000Z",
    "data": [
        {
            "type": "qr",
            "label": "Scan me!",
            "value": "619421851736374"
        },
        {
            "type": "alpha/qr",
            "label": "",
            "value": "619421851736374"
        },
        {
            "type": "alpha/pin",
            "label": "Pin",
            "value": "48739"
        }
    ],
    "dateCreated": "2019-07-01T15:16:58.560Z",
    "dateModified": "2019-07-01T15:16:58.560Z",
    "hugggId": "a_huggg_id"
}