VOvoucherifyio
Redemptions

Get Voucher's Redemptions

Retrieve the number of times a voucher was redeemed and each of the redemption details.

get/v1/vouchers/{code}/redemption

Request

  • Base URL
    https://api.voucherify.io
  • URL
    https://api.voucherify.io/v1/vouchers/{code}/redemption
  • Auth
    • API key in header X-App-Id and API key in header X-App-Token
    • or OAuth 2
      Implicit: https://api.voucherify.io/v1/oauth/token
      Scopes: api, vouchers

Response

A dictionary with a redemption_entries property that contains an array of voucher's redemptions.

quantityinteger nullable required

The maximum number of times a voucher can be redeemed.

redeemed_quantityinteger required

The number of times the voucher was redeemed successfully.

objectstring required

The type of the object represented by JSON. This object stores information about redemptions in a dictionary.

urlstring required

URL

data_refstring required

Identifies the name of the attribute that contains the array of redemption_entries.

totalinteger required

Total number of redemption objects.

Changes

No recorded changes to this operation across all 1 revision of this API.