Activate Vouchers

This API request is used to activate vouchers sold or distributed at the POS (point of sale).

Only physical vouchers need to be activated at the POS as they are issued in advance, but not activated. Printed issued physical vouchers can't be redeemed until they are activated.

Sequence Number

Sequence numbers are required for activation. This information is provided to the merchant beforehand.

A sequence number is unique across our system. It is associated 1-to-1 with the voucher number (also called ref in the Check Voucher or Redeem Voucher API requests).

In the request, a start and an end sequence number are required:

• start_sequence_voucher_ref: the start of the sequence number.
• end_sequence_voucher_ref: the end of the sequence number.

Note

The end sequence number can be identical to the start sequence number. Activate vouchers 1-by-1 by using identical start and end sequence numbers.

Note

All vouchers that have a sequence number between the start and the end of the sequence will be activated. To activate 2 vouchers that are not in sequence, please use 2 separate activation requests for 1 voucher.

Other Request Parameters

• X-Client-Id and X-Client-Secret: credentials of the shop interacting with the API, see also Authentication.

Information Returned

• status: confirming that the activation request has been successfully executed.

Example of an API Call

API Endpoint and Headers

POST https://api.merchant.demo.uniqrewards.com/v1/vouchers/actions/activate

Headers:
X-Client-Id: a1f64ebc9c4fef739df58f5933ceec94
X-Client-Secret: 1231f6112bbff1b03892306f53281bb0
Content-Type: application/json

Request Body

{
    "product_class": "ETX_001",
    "start_sequence_voucher_ref": "6488000004",
    "end_sequence_voucher_ref": "6488000004"
}

Response Body

{
    "data": {
        "mid": "000000000001234",
        "activation_id": ""
    },
    "meta": {
        "status": "succeeded"
    },
    "links": [
        {
            "rel": "deactivate",
            "href": "/api/vouchers/actions/deactivate",
        }
    ]
}

Note: the sample values in this page are mock-up values. They are not valid credentials and they are not associated to any actual product or voucher.

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