The future of incentives is agent ready. See what we're building.
Endpoints
Rollback Stackable Redemptions
curl --request POST \
--url https://{cluster}.voucherify.io/v1/redemptions/{parentRedemptionId}/rollbacks \
--header 'Content-Type: application/json' \
--header 'X-App-Id: <api-key>' \
--header 'X-App-Token: <api-key>' \
--data '
{
"customer": {
"id": "cust_SolpIN5N4oZbCnrxZ5NHrbVB",
"name": "Annie Lemons",
"email": "annie@lemon.com",
"phone": "+1 933 222 3334",
"birthday": "1900-12-02",
"birthdate": "1900-12-01",
"address": {
"city": "New York",
"state": "NY",
"line_1": "123 Main St.",
"line_2": "APT 3 BLG 5",
"country": "United States",
"postal_code": "100012"
},
"metadata": {
"age": 23
}
},
"order": {
"source_id": "test_rollback_8"
},
"metadata": {
"location_id": [
"L2"
]
}
}
'{
"rollbacks": [
{
"id": "rr_0efeb3dab05e62e599",
"object": "redemption_rollback",
"date": "2021-12-22T10:13:06.487Z",
"customer_id": "cust_i8t5Tt6eiKG5K79KQlJ0Vs64",
"tracking_id": "<string>",
"metadata": {},
"redemption": "r_0c656311b5878a2031",
"result": "SUCCESS",
"status": "SUCCEEDED",
"order": {
"id": "<string>",
"source_id": "<string>",
"status": "CREATED",
"amount": 123,
"initial_amount": 123,
"discount_amount": 123,
"items_discount_amount": 123,
"total_discount_amount": 123,
"total_amount": 123,
"applied_discount_amount": 123,
"items_applied_discount_amount": 123,
"total_applied_discount_amount": 123,
"metadata": {},
"object": "order",
"created_at": "2021-12-22T10:13:06.487Z",
"updated_at": "2021-12-22T10:14:45.316Z",
"customer_id": "cust_7iUa6ICKyU6gH40dBU25kQU1",
"referrer_id": "cust_nM4jqPiaXUvQdVSA6vTRUnix",
"redemptions": {},
"items": [
{
"object": "order_item",
"id": "<string>",
"sku_id": "<string>",
"product_id": "<string>",
"related_object": "product",
"source_id": "<string>",
"quantity": 123,
"discount_quantity": 123,
"initial_quantity": 123,
"amount": 123,
"discount_amount": 123,
"applied_discount_amount": 123,
"applied_discount_quantity": 123,
"applied_quantity": 123,
"applied_quantity_amount": 123,
"initial_amount": 123,
"price": 123,
"subtotal_amount": 123,
"product": {
"id": "<string>",
"source_id": "<string>",
"override": true,
"name": "<string>",
"metadata": {},
"price": 123
},
"sku": {
"id": "<string>",
"source_id": "<string>",
"override": true,
"sku": "<string>",
"price": 123,
"metadata": {}
},
"metadata": {}
}
]
},
"channel": {
"channel_id": "user_g24UoRO3Caxu7FCT4n5tpYEa3zUG0FrH",
"channel_type": "USER"
},
"customer": {
"id": "<string>",
"name": "<string>",
"email": "<string>",
"source_id": "<string>",
"metadata": {},
"object": "customer"
},
"related_object_type": "voucher",
"related_object_id": "<string>",
"amount": -10000,
"reason": "<string>",
"failure_code": "customer_rules_violated",
"failure_message": "<string>",
"voucher": {
"id": "v_mkZN9v7vjYUadXnHrMza8W5c34fE5KiV",
"code": "WVPblOYX",
"campaign": "Gift Card Campaign",
"campaign_id": "camp_FNYR4jhqZBM9xTptxDGgeNBV",
"category": "<string>",
"category_id": "cat_0bb343dee3cdb5ec0c",
"type": "GIFT_VOUCHER",
"discount": {
"type": "AMOUNT",
"amount_off": 123,
"amount_off_formula": "<string>",
"aggregated_amount_limit": 123,
"effect": "APPLY_TO_ORDER",
"is_dynamic": true
},
"gift": {
"amount": 10000,
"subtracted_amount": 123,
"balance": 500,
"effect": "APPLY_TO_ORDER"
},
"loyalty_card": {
"points": 7000,
"balance": 6970,
"next_expiration_date": "2023-05-30",
"next_expiration_points": 123,
"pending_points": 123,
"expired_points": 123,
"subtracted_points": 123
},
"start_date": "2021-12-01T00:00:00.000Z",
"expiration_date": "2021-12-31T00:00:00.000Z",
"validity_timeframe": {
"duration": "PT1H",
"interval": "P2D"
},
"validity_day_of_week": [
0
],
"validity_hours": {
"daily": [
{
"start_time": "12:00",
"days_of_week": [
0
],
"expiration_time": "14:00"
}
]
},
"active": true,
"additional_info": "<string>",
"metadata": {},
"assets": {
"qr": {
"id": "U2FsdGVkX19ucFhvVmBVpVYG5KoswTsjSIaqoKg5L9ie4BK+t4pp7U7oFzjGJzj9q/bmuMOj9mEFiVKDMIkSaruKedMvHbKoPX5Sg+BaZk5QwXMf8k/OzSlOEVybpwSq+AiqPoNtjeuqtIgkDyvT6Q==",
"url": "https://dev.dl.voucherify.io/api/v1/assets/qr/U2FsdGVkX19ucFhvVmBVpVYG5KoswTsjSIaqoKg5L9ie4BK%2Bt4pp7U7oFzjGJzj9q%2FbmuMOj9mEFiVKDMIkSaruKedMvHbKoPX5Sg%2BBaZk5QwXMf8k%2FOzSlOEVybpwSq%2BAiqPoNtjeuqtIgkDyvT6Q%3D%3D"
},
"barcode": {
"id": "U2FsdGVkX19eJhGfWwUrH9+tulBkON+AnMktic+N6CVWzZ9+fHVxuVx22WakrzxiWXy0skuvvEHSeZIw9HlgyIJ+kJ1iPdUKpyENuNYJKzoZlO0mmTf6WQM6/pFs61apEn9SJx32ttCF6d3oxKISQQ==",
"url": "https://dev.dl.voucherify.io/api/v1/assets/barcode/U2FsdGVkX19eJhGfWwUrH9%2BtulBkON%2BAnMktic%2BN6CVWzZ9%2BfHVxuVx22WakrzxiWXy0skuvvEHSeZIw9HlgyIJ%2BkJ1iPdUKpyENuNYJKzoZlO0mmTf6WQM6%2FpFs61apEn9SJx32ttCF6d3oxKISQQ%3D%3D"
}
},
"is_referral_code": true,
"created_at": "2021-12-22T10:13:06.487Z",
"updated_at": "2021-12-22T10:14:45.316Z",
"holder_id": "cust_eWgXlBBiY6THFRJwX45Iakv4",
"referrer_id": "cust_Vzck5i8U3OhcEUFY6MKhN9Rv",
"object": "voucher",
"publish": {
"object": "list",
"count": 0,
"url": "/v1/vouchers/WVPblOYX/publications?page=1&limit=10"
},
"redemption": {
"quantity": 123,
"redeemed_quantity": 1,
"redeemed_points": 100000,
"object": "list",
"url": "/v1/vouchers/WVPblOYX/redemptions?page=1&limit=10"
},
"categories": [
{
"id": "<string>",
"name": "<string>",
"hierarchy": 1,
"object": "category",
"created_at": "2022-07-14T10:45:13.156Z",
"updated_at": "2022-08-16T10:52:08.094Z"
}
]
},
"promotion_tier": {
"id": "promo_63fYCt81Aw0h7lzyRkrGZh9p",
"created_at": "2021-12-15T11:34:01.333Z",
"updated_at": "2022-02-09T09:20:05.603Z",
"name": "<string>",
"banner": "<string>",
"action": {
"discount": {
"type": "AMOUNT",
"amount_off": 123,
"amount_off_formula": "<string>",
"aggregated_amount_limit": 123,
"effect": "APPLY_TO_ORDER",
"is_dynamic": true
}
},
"metadata": {},
"hierarchy": 123,
"promotion_id": "<string>",
"campaign": {
"id": "<string>",
"start_date": "2022-09-22T00:00:00.000Z",
"expiration_date": "2022-09-30T00:00:00.000Z",
"validity_timeframe": {
"duration": "PT1H",
"interval": "P2D"
},
"validity_day_of_week": [
0
],
"validity_hours": {
"daily": [
{
"start_time": "12:00",
"days_of_week": [
0
],
"expiration_time": "14:00"
}
]
},
"active": true,
"category_id": "cat_0b688929a2476386a6",
"object": "campaign"
},
"campaign_id": "<string>",
"active": true,
"start_date": "2022-09-23T00:00:00.000Z",
"expiration_date": "2022-09-26T00:00:00.000Z",
"validity_timeframe": {
"duration": "PT1H",
"interval": "P2D"
},
"validity_day_of_week": [
0
],
"validity_hours": {
"daily": [
{
"start_time": "12:00",
"days_of_week": [
0
],
"expiration_time": "14:00"
}
]
},
"summary": {
"redemptions": {
"total_redeemed": 123
},
"orders": {
"total_amount": 123,
"total_discount_amount": 123
}
},
"object": "promotion_tier",
"category_id": "cat_0c9da30e7116ba6bba",
"categories": [
{
"id": "<string>",
"name": "<string>",
"hierarchy": 1,
"object": "category",
"created_at": "2022-07-14T10:45:13.156Z",
"updated_at": "2022-08-16T10:52:08.094Z"
}
]
},
"gift": {
"amount": 123
},
"loyalty_card": {
"points": 123
}
}
],
"order": {
"id": "<string>",
"source_id": "<string>",
"status": "CREATED",
"amount": 123,
"initial_amount": 123,
"discount_amount": 123,
"items_discount_amount": 123,
"total_discount_amount": 123,
"total_amount": 123,
"applied_discount_amount": 123,
"items_applied_discount_amount": 123,
"total_applied_discount_amount": 123,
"metadata": {},
"object": "order",
"created_at": "2021-12-22T10:13:06.487Z",
"updated_at": "2021-12-22T10:14:45.316Z",
"customer_id": "cust_7iUa6ICKyU6gH40dBU25kQU1",
"referrer_id": "cust_nM4jqPiaXUvQdVSA6vTRUnix",
"redemptions": {},
"items": [
{
"object": "order_item",
"id": "<string>",
"sku_id": "<string>",
"product_id": "<string>",
"related_object": "product",
"source_id": "<string>",
"quantity": 123,
"discount_quantity": 123,
"initial_quantity": 123,
"amount": 123,
"discount_amount": 123,
"applied_discount_amount": 123,
"applied_discount_quantity": 123,
"applied_quantity": 123,
"applied_quantity_amount": 123,
"initial_amount": 123,
"price": 123,
"subtotal_amount": 123,
"product": {
"id": "<string>",
"source_id": "<string>",
"override": true,
"name": "<string>",
"metadata": {},
"price": 123
},
"sku": {
"id": "<string>",
"source_id": "<string>",
"override": true,
"sku": "<string>",
"price": 123,
"metadata": {}
},
"metadata": {}
}
]
}
}Rollback Stackable Redemptions
Rollback a stackable redemption. When you roll back a stacked redemption, all child redemptions will be rolled back. Provide the parent redemption ID as the path parameter. However, you can use this endpoint to roll back a single redemption that does not have a parent, similarly to POST Rollback redemption.
🚧 You can roll back a redemption up to 3 months back.
POST
/
v1
/
redemptions
/
{parentRedemptionId}
/
rollbacks
Rollback Stackable Redemptions
curl --request POST \
--url https://{cluster}.voucherify.io/v1/redemptions/{parentRedemptionId}/rollbacks \
--header 'Content-Type: application/json' \
--header 'X-App-Id: <api-key>' \
--header 'X-App-Token: <api-key>' \
--data '
{
"customer": {
"id": "cust_SolpIN5N4oZbCnrxZ5NHrbVB",
"name": "Annie Lemons",
"email": "annie@lemon.com",
"phone": "+1 933 222 3334",
"birthday": "1900-12-02",
"birthdate": "1900-12-01",
"address": {
"city": "New York",
"state": "NY",
"line_1": "123 Main St.",
"line_2": "APT 3 BLG 5",
"country": "United States",
"postal_code": "100012"
},
"metadata": {
"age": 23
}
},
"order": {
"source_id": "test_rollback_8"
},
"metadata": {
"location_id": [
"L2"
]
}
}
'{
"rollbacks": [
{
"id": "rr_0efeb3dab05e62e599",
"object": "redemption_rollback",
"date": "2021-12-22T10:13:06.487Z",
"customer_id": "cust_i8t5Tt6eiKG5K79KQlJ0Vs64",
"tracking_id": "<string>",
"metadata": {},
"redemption": "r_0c656311b5878a2031",
"result": "SUCCESS",
"status": "SUCCEEDED",
"order": {
"id": "<string>",
"source_id": "<string>",
"status": "CREATED",
"amount": 123,
"initial_amount": 123,
"discount_amount": 123,
"items_discount_amount": 123,
"total_discount_amount": 123,
"total_amount": 123,
"applied_discount_amount": 123,
"items_applied_discount_amount": 123,
"total_applied_discount_amount": 123,
"metadata": {},
"object": "order",
"created_at": "2021-12-22T10:13:06.487Z",
"updated_at": "2021-12-22T10:14:45.316Z",
"customer_id": "cust_7iUa6ICKyU6gH40dBU25kQU1",
"referrer_id": "cust_nM4jqPiaXUvQdVSA6vTRUnix",
"redemptions": {},
"items": [
{
"object": "order_item",
"id": "<string>",
"sku_id": "<string>",
"product_id": "<string>",
"related_object": "product",
"source_id": "<string>",
"quantity": 123,
"discount_quantity": 123,
"initial_quantity": 123,
"amount": 123,
"discount_amount": 123,
"applied_discount_amount": 123,
"applied_discount_quantity": 123,
"applied_quantity": 123,
"applied_quantity_amount": 123,
"initial_amount": 123,
"price": 123,
"subtotal_amount": 123,
"product": {
"id": "<string>",
"source_id": "<string>",
"override": true,
"name": "<string>",
"metadata": {},
"price": 123
},
"sku": {
"id": "<string>",
"source_id": "<string>",
"override": true,
"sku": "<string>",
"price": 123,
"metadata": {}
},
"metadata": {}
}
]
},
"channel": {
"channel_id": "user_g24UoRO3Caxu7FCT4n5tpYEa3zUG0FrH",
"channel_type": "USER"
},
"customer": {
"id": "<string>",
"name": "<string>",
"email": "<string>",
"source_id": "<string>",
"metadata": {},
"object": "customer"
},
"related_object_type": "voucher",
"related_object_id": "<string>",
"amount": -10000,
"reason": "<string>",
"failure_code": "customer_rules_violated",
"failure_message": "<string>",
"voucher": {
"id": "v_mkZN9v7vjYUadXnHrMza8W5c34fE5KiV",
"code": "WVPblOYX",
"campaign": "Gift Card Campaign",
"campaign_id": "camp_FNYR4jhqZBM9xTptxDGgeNBV",
"category": "<string>",
"category_id": "cat_0bb343dee3cdb5ec0c",
"type": "GIFT_VOUCHER",
"discount": {
"type": "AMOUNT",
"amount_off": 123,
"amount_off_formula": "<string>",
"aggregated_amount_limit": 123,
"effect": "APPLY_TO_ORDER",
"is_dynamic": true
},
"gift": {
"amount": 10000,
"subtracted_amount": 123,
"balance": 500,
"effect": "APPLY_TO_ORDER"
},
"loyalty_card": {
"points": 7000,
"balance": 6970,
"next_expiration_date": "2023-05-30",
"next_expiration_points": 123,
"pending_points": 123,
"expired_points": 123,
"subtracted_points": 123
},
"start_date": "2021-12-01T00:00:00.000Z",
"expiration_date": "2021-12-31T00:00:00.000Z",
"validity_timeframe": {
"duration": "PT1H",
"interval": "P2D"
},
"validity_day_of_week": [
0
],
"validity_hours": {
"daily": [
{
"start_time": "12:00",
"days_of_week": [
0
],
"expiration_time": "14:00"
}
]
},
"active": true,
"additional_info": "<string>",
"metadata": {},
"assets": {
"qr": {
"id": "U2FsdGVkX19ucFhvVmBVpVYG5KoswTsjSIaqoKg5L9ie4BK+t4pp7U7oFzjGJzj9q/bmuMOj9mEFiVKDMIkSaruKedMvHbKoPX5Sg+BaZk5QwXMf8k/OzSlOEVybpwSq+AiqPoNtjeuqtIgkDyvT6Q==",
"url": "https://dev.dl.voucherify.io/api/v1/assets/qr/U2FsdGVkX19ucFhvVmBVpVYG5KoswTsjSIaqoKg5L9ie4BK%2Bt4pp7U7oFzjGJzj9q%2FbmuMOj9mEFiVKDMIkSaruKedMvHbKoPX5Sg%2BBaZk5QwXMf8k%2FOzSlOEVybpwSq%2BAiqPoNtjeuqtIgkDyvT6Q%3D%3D"
},
"barcode": {
"id": "U2FsdGVkX19eJhGfWwUrH9+tulBkON+AnMktic+N6CVWzZ9+fHVxuVx22WakrzxiWXy0skuvvEHSeZIw9HlgyIJ+kJ1iPdUKpyENuNYJKzoZlO0mmTf6WQM6/pFs61apEn9SJx32ttCF6d3oxKISQQ==",
"url": "https://dev.dl.voucherify.io/api/v1/assets/barcode/U2FsdGVkX19eJhGfWwUrH9%2BtulBkON%2BAnMktic%2BN6CVWzZ9%2BfHVxuVx22WakrzxiWXy0skuvvEHSeZIw9HlgyIJ%2BkJ1iPdUKpyENuNYJKzoZlO0mmTf6WQM6%2FpFs61apEn9SJx32ttCF6d3oxKISQQ%3D%3D"
}
},
"is_referral_code": true,
"created_at": "2021-12-22T10:13:06.487Z",
"updated_at": "2021-12-22T10:14:45.316Z",
"holder_id": "cust_eWgXlBBiY6THFRJwX45Iakv4",
"referrer_id": "cust_Vzck5i8U3OhcEUFY6MKhN9Rv",
"object": "voucher",
"publish": {
"object": "list",
"count": 0,
"url": "/v1/vouchers/WVPblOYX/publications?page=1&limit=10"
},
"redemption": {
"quantity": 123,
"redeemed_quantity": 1,
"redeemed_points": 100000,
"object": "list",
"url": "/v1/vouchers/WVPblOYX/redemptions?page=1&limit=10"
},
"categories": [
{
"id": "<string>",
"name": "<string>",
"hierarchy": 1,
"object": "category",
"created_at": "2022-07-14T10:45:13.156Z",
"updated_at": "2022-08-16T10:52:08.094Z"
}
]
},
"promotion_tier": {
"id": "promo_63fYCt81Aw0h7lzyRkrGZh9p",
"created_at": "2021-12-15T11:34:01.333Z",
"updated_at": "2022-02-09T09:20:05.603Z",
"name": "<string>",
"banner": "<string>",
"action": {
"discount": {
"type": "AMOUNT",
"amount_off": 123,
"amount_off_formula": "<string>",
"aggregated_amount_limit": 123,
"effect": "APPLY_TO_ORDER",
"is_dynamic": true
}
},
"metadata": {},
"hierarchy": 123,
"promotion_id": "<string>",
"campaign": {
"id": "<string>",
"start_date": "2022-09-22T00:00:00.000Z",
"expiration_date": "2022-09-30T00:00:00.000Z",
"validity_timeframe": {
"duration": "PT1H",
"interval": "P2D"
},
"validity_day_of_week": [
0
],
"validity_hours": {
"daily": [
{
"start_time": "12:00",
"days_of_week": [
0
],
"expiration_time": "14:00"
}
]
},
"active": true,
"category_id": "cat_0b688929a2476386a6",
"object": "campaign"
},
"campaign_id": "<string>",
"active": true,
"start_date": "2022-09-23T00:00:00.000Z",
"expiration_date": "2022-09-26T00:00:00.000Z",
"validity_timeframe": {
"duration": "PT1H",
"interval": "P2D"
},
"validity_day_of_week": [
0
],
"validity_hours": {
"daily": [
{
"start_time": "12:00",
"days_of_week": [
0
],
"expiration_time": "14:00"
}
]
},
"summary": {
"redemptions": {
"total_redeemed": 123
},
"orders": {
"total_amount": 123,
"total_discount_amount": 123
}
},
"object": "promotion_tier",
"category_id": "cat_0c9da30e7116ba6bba",
"categories": [
{
"id": "<string>",
"name": "<string>",
"hierarchy": 1,
"object": "category",
"created_at": "2022-07-14T10:45:13.156Z",
"updated_at": "2022-08-16T10:52:08.094Z"
}
]
},
"gift": {
"amount": 123
},
"loyalty_card": {
"points": 123
}
}
],
"order": {
"id": "<string>",
"source_id": "<string>",
"status": "CREATED",
"amount": 123,
"initial_amount": 123,
"discount_amount": 123,
"items_discount_amount": 123,
"total_discount_amount": 123,
"total_amount": 123,
"applied_discount_amount": 123,
"items_applied_discount_amount": 123,
"total_applied_discount_amount": 123,
"metadata": {},
"object": "order",
"created_at": "2021-12-22T10:13:06.487Z",
"updated_at": "2021-12-22T10:14:45.316Z",
"customer_id": "cust_7iUa6ICKyU6gH40dBU25kQU1",
"referrer_id": "cust_nM4jqPiaXUvQdVSA6vTRUnix",
"redemptions": {},
"items": [
{
"object": "order_item",
"id": "<string>",
"sku_id": "<string>",
"product_id": "<string>",
"related_object": "product",
"source_id": "<string>",
"quantity": 123,
"discount_quantity": 123,
"initial_quantity": 123,
"amount": 123,
"discount_amount": 123,
"applied_discount_amount": 123,
"applied_discount_quantity": 123,
"applied_quantity": 123,
"applied_quantity_amount": 123,
"initial_amount": 123,
"price": 123,
"subtotal_amount": 123,
"product": {
"id": "<string>",
"source_id": "<string>",
"override": true,
"name": "<string>",
"metadata": {},
"price": 123
},
"sku": {
"id": "<string>",
"source_id": "<string>",
"override": true,
"sku": "<string>",
"price": 123,
"metadata": {}
},
"metadata": {}
}
]
}
}Authorizations
X-App-Id & X-App-TokenX-Voucherify-OAuth
Path Parameters
Unique identifier of a parent redemption, e.g. r_JQfm73zWSJFQxs3bGxweYjgm.
Example:
"r_0ba186c4824e4881e1"
Body
application/json
Add information about the original customer and order. Customer data and Redemption metadata can be updated in Voucherify when passing the customer data in the request body.
Request body schema for POST v1/redemptions/{parentRedemptionId}/rollbacks.
Response
Returns an array with the individual redemption rollback results along with the parent rollback result and related order.
Response body schema for POST /redemptions/{parentRedemptionID}/rollbacks.
Contains the rollback redemption objects of the particular incentives.
Show child attributes
Show child attributes
This is an object representing a redemption rollback.
Show child attributes
Show child attributes
Order information.
Show child attributes
Show child attributes
Last modified on April 2, 2026
Was this page helpful?
⌘I