Check Vouchers

Version

This page is for the Client API v2. For the Client API v3 documentation, please see the retrieve vouchers information page.

The API uses the reference of the voucher(s) voucher_settlement_refs and will return.

• The current status of the voucher(s). There are 5 possible statuses for the voucher:

  Status	Description
  Active	The voucher can be used by the recipient.
  Inactive	The voucher needs to be activated to be used.
  Expired	The voucher is past its expiration date and can't be used anymore by the recipient.
  Trashed	This voucher is not in circulation anymore and can't be used by the recipient.
  Used	The voucher has been used by the recipient.

• The voucher expiration date in the format "DD MMM YYYY"

• The Remaining value of the voucher. It can be:

  • An amount denominated in the currency of the voucher for value based vouchers.
  • A quantity for product based vouchers.

Example of an API Call

This section uses sample values that can't be used to query the API or use a voucher.

API Endpoint

POST https://api.demo.uniqrewards.com/v2/catalogs/{product_class}/vouchers/actions/check

Request Body

{
  "voucher_settlement_refs": [
    "2d859a93-838a-9bc7-7809-97b9b53f4cbe",
    "33497e40-8457-8f42-c72f-daf945de5977",
    "83478eb3-17fe-ced2-b199-6f80b3324932"
  ]
}

Response Body

{
    "meta": {
        "status": "succeeded"
    },
    "data": [
        {
            "expiration_date": "18 Mar 2022",
            "remaining_value": 1,
            "voucher_settlement_ref": "2d859a93-838a-9bc7-7809-97b9b53f4cbe",
            "status": "Active"
        },
        {
            "expiration_date": "30 Jun 2021",
            "remaining_value": 1,
            "voucher_settlement_ref": "33497e40-8457-8f42-c72f-daf945de5977",
            "status": "Expired"
        },
        {
            "expiration_date": "24 Feb 2022",
            "remaining_value": 1,
            "voucher_settlement_ref": "83478eb3-17fe-ced2-b199-6f80b3324932",
            "status": "Trashed"
        }
    ]
}

More details can be found on the Technical Documentation (opens new window).