Get Voucher
curl --request GET \
--url https://{cluster}.voucherify.io/v1/vouchers/{code} \
--header 'X-App-Id: <api-key>' \
--header 'X-App-Token: <api-key>'{
"id": "v_hrMBBeT4sOP9VSGPmj5KAgJwX202UjiY",
"code": "LOYALTY-CARD-xLPbpbXR",
"campaign": "Loyalty Program Fall 2022",
"campaign_id": "camp_f7fBbQxUuTN7dI7tGOo5XMDA",
"category": "First",
"category_id": "cat_0bb343dee3cdb5ec0c",
"categories": [
{
"id": "cat_0bb343dee3cdb5ec0c",
"name": "First",
"hierarchy": 1,
"created_at": "2022-09-16T11:47:19.568Z",
"object": "category"
}
],
"type": "LOYALTY_CARD",
"discount": null,
"gift": null,
"loyalty_card": {
"points": 110,
"balance": 100,
"next_expiration_date": "2023-12-31",
"next_expiration_points": 100
},
"start_date": null,
"expiration_date": null,
"validity_timeframe": null,
"validity_day_of_week": null,
"active": true,
"additional_info": null,
"metadata": {},
"assets": {
"qr": {
"id": "U2FsdGVkX19OrTPNyUztbNretF7tPRL4ZlUDPAUXVGL9e5UCPh6dic8zXEP8/6I6hUEqtz/F6IMIghWz1ljdjzpdizGHG3HZBw4c19fd8SD/DjhBRDSr8APqKGpZTLKe4QC2gislFTeDAq2lmJb6T1oOTBUGkUEwMgEX1Vlco9A=",
"url": "{{internalVoucherifyURL}}"
},
"barcode": {
"id": "U2FsdGVkX1/SpYuOrU9wd6/o1wzy6E/04wURHJ1xuMutzkIUx6OBTmHX5BO8XZRmEFHkgjC5eWJ27ArgAruJfwRXWuQfTNFD4raI9YvIiQNEzsZ0ydxwKBqJ/FJtiw69djuzQk1f4HdQo8s5gaZ7fd2U+1zbaeAvi9usyvRHZE4=",
"url": "{{internalVoucherifyURL}}"
}
},
"is_referral_code": false,
"created_at": "2022-09-19T07:56:22.355Z",
"updated_at": "2022-09-19T08:04:22.458Z",
"holder_id": "cust_eWgXlBBiY6THFRJwX45Iakv4",
"validation_rules_assignments": {
"object": "list",
"data_ref": "data",
"data": [],
"total": 0
},
"redemption": {
"quantity": null,
"redeemed_quantity": 1,
"redeemed_points": 10,
"object": "list",
"url": "/v1/vouchers/LOYALTY-CARD-xLPbpbXR/redemptions?page=1&limit=10"
},
"publish": {
"object": "list",
"count": 1,
"url": "/v1/vouchers/LOYALTY-CARD-xLPbpbXR/publications?page=1&limit=10"
},
"object": "voucher"
}Get Voucher
Retrieves the voucher with the given code or unique Voucherify ID. You can either pass the voucher ID which was assigned by Voucherify, e.g., v_7HxHkf4VAkMuc8u4lZs78lyRwhRze5UE, or the code of the voucher as the path parameter value, e.g., 7fjWdr.
GET
/
v1
/
vouchers
/
{code}
Get Voucher
curl --request GET \
--url https://{cluster}.voucherify.io/v1/vouchers/{code} \
--header 'X-App-Id: <api-key>' \
--header 'X-App-Token: <api-key>'{
"id": "v_hrMBBeT4sOP9VSGPmj5KAgJwX202UjiY",
"code": "LOYALTY-CARD-xLPbpbXR",
"campaign": "Loyalty Program Fall 2022",
"campaign_id": "camp_f7fBbQxUuTN7dI7tGOo5XMDA",
"category": "First",
"category_id": "cat_0bb343dee3cdb5ec0c",
"categories": [
{
"id": "cat_0bb343dee3cdb5ec0c",
"name": "First",
"hierarchy": 1,
"created_at": "2022-09-16T11:47:19.568Z",
"object": "category"
}
],
"type": "LOYALTY_CARD",
"discount": null,
"gift": null,
"loyalty_card": {
"points": 110,
"balance": 100,
"next_expiration_date": "2023-12-31",
"next_expiration_points": 100
},
"start_date": null,
"expiration_date": null,
"validity_timeframe": null,
"validity_day_of_week": null,
"active": true,
"additional_info": null,
"metadata": {},
"assets": {
"qr": {
"id": "U2FsdGVkX19OrTPNyUztbNretF7tPRL4ZlUDPAUXVGL9e5UCPh6dic8zXEP8/6I6hUEqtz/F6IMIghWz1ljdjzpdizGHG3HZBw4c19fd8SD/DjhBRDSr8APqKGpZTLKe4QC2gislFTeDAq2lmJb6T1oOTBUGkUEwMgEX1Vlco9A=",
"url": "{{internalVoucherifyURL}}"
},
"barcode": {
"id": "U2FsdGVkX1/SpYuOrU9wd6/o1wzy6E/04wURHJ1xuMutzkIUx6OBTmHX5BO8XZRmEFHkgjC5eWJ27ArgAruJfwRXWuQfTNFD4raI9YvIiQNEzsZ0ydxwKBqJ/FJtiw69djuzQk1f4HdQo8s5gaZ7fd2U+1zbaeAvi9usyvRHZE4=",
"url": "{{internalVoucherifyURL}}"
}
},
"is_referral_code": false,
"created_at": "2022-09-19T07:56:22.355Z",
"updated_at": "2022-09-19T08:04:22.458Z",
"holder_id": "cust_eWgXlBBiY6THFRJwX45Iakv4",
"validation_rules_assignments": {
"object": "list",
"data_ref": "data",
"data": [],
"total": 0
},
"redemption": {
"quantity": null,
"redeemed_quantity": 1,
"redeemed_points": 10,
"object": "list",
"url": "/v1/vouchers/LOYALTY-CARD-xLPbpbXR/redemptions?page=1&limit=10"
},
"publish": {
"object": "list",
"count": 1,
"url": "/v1/vouchers/LOYALTY-CARD-xLPbpbXR/publications?page=1&limit=10"
},
"object": "voucher"
}Authorizations
X-App-Id & X-App-TokenX-Voucherify-OAuth
Scopes
Response
Returns a voucher object if a valid identifier was provided.
Additionally, the response returns validation rules related to the voucher object. They can be inherited from a campaign.
Response body schema for GET v1/vouchers/{code}.

