{warning} This API is likely to change before the Beta period is over, please check back regularly to see the latest changes.

Check a Voucher

By passing a Site ID and Voucher Number you can check what, if anything is redeemable for the voucher provided.

Request

Headers

POST REQUEST (/redeem/check)

Header: Content-Type - application/json
Header: Accepts - application/json
Header: Smart-Auth sk_XXXXXXXXXXXXXXXXXX

Body

You can find the site number you should submit along with this request in the company configuration on the Smart Gift dashboard.

{
    "voucher_no":"XXXXXXXXXX",
    "site_id": "X"
}

Response

There are 2 types of voucher; monetary and experience. With experience vouchers you will get items that you can redeem, and monetary vouchers will show the balance available on the voucher in the remaining_value field, however experience vouchers also use this field to determine which experiences have already been redeemed, it is filled with the sum of the bit value of remaining experiences.

{
    "data": {
        "id": 1,
        "name": "Tour & Tasting",
        "description": "The tour of the Estate allows you to see how we turn our grapes into Sussex Sparkling wine. Walking through the vines in a small group with our experienced guide, exploring the Vineyard, history and wildlife of the Estate allows for full appreciation of Rathfinny’s place in this classic landscape. During this enjoyable tour, the group learns how a typical year of growing vines and wine production progresses and ends with a tasting of our Sussex wines. Among the highlights are a visit to our RIBA nominated Winery and modern Bottling building. Tours run on selected dates, May to September. To book, please call the Cellar Door on 01323 870022 or email cellardoor@rathfinnyestate.com. Booking in advance is essential and please mention the voucher at the time of booking. \r\n\r\nThis voucher is valid for 24 months after purchase.",
        "voucher_no": "XXXXXXXXX",
        "remaining_value": 3,
        "type": "experience",
        "experiences": [
            {
                "id": 1063,
                "name": "Tours",
                "site_id": 14,
                "site_name": "Cellar Door",
                "bit_value": 1,
                "price": 15.00,
                "revenue": {
                    "id": 100,
                    "name": "Tours",
                    "mapping_code": "1001", // department mapping code
                    "product_code": "1002", // additional mapping code for product or other reference
                    "rate": {
                        "id": 2,
                        "name": "5 Percent VAT",
                        "rate": 5,
                        "percent_text": "5%"
                    }
                }
            },
            {
                "id": 1064,
                "name": "Tasting",
                "site_id": 14,
                "site_name": "Cellar Door",
                "bit_value": 2,
                "price": 9.50,
                "revenue": {
                    "id": 101,
                    "name": "Tasting",
                    "mapping_code": "1001",
                    "product_code": "1002",
                    "rate": {
                        "id": 2,
                        "name": "5 Percent VAT",
                        "rate": 5,
                        "percent_text": "5%"
                    }
                }
            }
        ]
    }
}