Link Search Menu Expand Document

Unclaiming vouchers

Returns an OK code and echoes the updated voucher details including the new voucher_status field. A sample is below:

    "result": {
        "code": 1,
        "status": "ok"
    "results": {
         "voucher_key": "a8c34c86c136e5ddf0ad374e140aa1e3504ebbf23d76d84788677268fd99b809",
         "voucher_id": 40577,
         "voucher_status": "generated",
         "voucher_locked": false,
         "campaign_id": 2,
         "campaign_type": "cashback",
         "campaign_title": "20 EUR voucher for every 200 EUR spent",
         "voucher_expiry_datetime_utc": "2050-01-01 00:00:00",
         "voucher_expiry_seconds_remaining": 1013819756,
         "voucher_currency_id": 2,
         "voucher_currency_symbol": "\u20ac",
         "voucher_amount_original": 20,
         "voucher_amount_redeemed": 0,
         "voucher_amount": 20,
         "voucher_text": "Your new voucher, enjoy!",
         "user_id": 1,
         "user_entity_card": {
             "type": "regular",
             "code": "1"
         "result_type": "unclaim-voucher"


  • Call name: unclaim-voucher
  • Endpoint URL:
  • Request methods: POST or PUT
  • Request Content-Type: multipart/form-data or application/x-www-form-urlencoded
  • Response Content-Type: application/json
  • Auth required: yes

Unclaims a voucher (variable price or other kind of voucher) which has been claimed by a user.

Permissions and Authentication

This API call requires a valid Spaaza session. The session can be as follows:

  • User authentication: a session generated by an end-user login.
  • Admin authentication: the performing user needs to be logged in and have write access to the entity (business or chain) to which the user is connected.
  • Privileged authentication: the use of privileged authentication is permitted for this endpoint.

Note that if a voucher is locked it can only be unclaimed using Admin or Privileged authentication.

HTTP Parameters

The following HTTP parameters can be passed to the API:

Parameter Description
voucher_key (mandatory) The unique voucher key of the voucher. This is a string, for instance c4bc4a3115e21e228936f4223dd89b22c238847c935514e1fdcb96f3c75118ac.
user_id required with admin and privileged authentication The Spaaza user id of the user whose voucher is being claimed.
chain_id required with admin and privileged authentication The ID of the Spaaza Chain or Entity`.


This API call requires write permissions for the user in the case of admin authentication.