Link Search Menu Expand Document

Claiming vouchers

A sample response is shown below.

  "result": {
    "code": 1,
    "status": "ok"
  "results": {
    "voucher_key": "13918dc12e44bc183cb168fa10684d0714115ff37132d4c265f4a8ab6678a741",
    "voucher_id": 35735,
    "voucher_status": "claimed",
    "voucher_locked": false,
    "campaign_id": 136,
    "campaign_type": "signup",
    "campaign_title": "Earn €5 on signup",
    "voucher_expiry_datetime_utc": "2050-01-01 00:00:00",
    "voucher_expiry_seconds_remaining": 996899028,
    "voucher_currency_id": 2,
    "voucher_currency_symbol": "€",
    "voucher_amount_original": 5,
    "voucher_amount_redeemed": 0,
    "voucher_amount": 5,
    "voucher_text": null,
    "user_id": 1107604,
    "user_entity_card": {
      "type": "custom",
      "code": "404064"
    "result_type": "claim-voucher"


  • Call name: claim-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

Claims a voucher (variable price or other kind of voucher) which has been offered to a user.

The claim-voucher API allows a user to claim a voucher which has been earned in the get-var-price-user API call or through other voucher generating mechanisms. It uses the voucher_key values supplied to claim the price. Once the price has been claimed, the retailer can verify it using another call.

HTTP Parameters

The following HTTP parameters can be passed to the API:

Parameter Description
voucher_key (string, mandatory*) The unique voucher key generated for the voucher. This is a string, for instance c4bc4a3115e21e228936f4223dd89b22c238847c935514e1fdcb96f3c75118ac.
voucher_id (integer, mandatory*) The unique id generated for the voucher. This is an integer, for instance 4064783. It is recommended to use the voucher_key parameter if possible.
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`.

* At least one of the parameters voucher_key or voucher_id must be used.


This API call requires no specific permissions for the user.