Skip to main content
GET
/
v1
/
redemptions
/
{redemptionId}
Get Redemption
curl --request GET \
  --url https://{cluster}.voucherify.io/v1/redemptions/{redemptionId} \
  --header 'Authorization: Bearer <token>' \
  --header 'X-App-Id: <api-key>' \
  --header 'X-App-Token: <api-key>'
{
"id": "r_0bade27c428db5873e",
"object": "redemption",
"date": "2022-09-12T07:29:28.211Z",
"customer_id": "cust_eWgXlBBiY6THFRJwX45Iakv4",
"tracking_id": "track_9B0kB92+bJa8a+PegaWREw==",
"metadata": {},
"result": "SUCCESS",
"order": {
"id": "ord_ebmAU9uv3dTE2Khqyh7i5ka7",
"source_id": null,
"created_at": "2022-09-12T07:29:26.245Z",
"updated_at": null,
"status": "PAID",
"amount": 22500,
"discount_amount": 300,
"total_discount_amount": 300,
"total_amount": 22200,
"applied_discount_amount": 300,
"total_applied_discount_amount": 300,
"items": [
{
"object": "order_item",
"product_id": "prod_0b2c36568000039138",
"quantity": 1,
"amount": 22500,
"price": 22500,
"subtotal_amount": 22500,
"product": {
"id": "prod_0b2c36568000039138",
"source_id": "86",
"name": "[Sample] Able Brewing System",
"price": 22500
}
}
],
"metadata": {},
"customer": {
"id": "cust_eWgXlBBiY6THFRJwX45Iakv4",
"object": "customer"
},
"customer_id": "cust_eWgXlBBiY6THFRJwX45Iakv4",
"referrer_id": null,
"object": "order",
"redemptions": {
"r_0bade27c428db5873e": {
"date": "2022-09-12T07:29:26.282Z",
"related_object_type": "voucher",
"related_object_id": "v_c1yOEjZXOyVIe89VAYiRvL3QimZjXo8h"
}
}
},
"channel": {
"channel_id": "user_g24UoRO3Caxu7FCT4n5tpYEa3zUG0FrH",
"channel_type": "USER"
},
"customer": {
"id": "cust_eWgXlBBiY6THFRJwX45Iakv4",
"name": "Bob Jones",
"email": "bob.jones@email.com",
"source_id": "36_bob",
"metadata": {
"accepts_marketing": false
},
"object": "customer"
},
"related_object_type": "voucher",
"related_object_id": "v_c1yOEjZXOyVIe89VAYiRvL3QimZjXo8h",
"voucher": {
"id": "v_c1yOEjZXOyVIe89VAYiRvL3QimZjXo8h",
"code": "FB-metadata-string",
"campaign": null,
"campaign_id": null,
"category": null,
"categories": [],
"discount": null,
"gift": null,
"loyalty_card": null,
"start_date": null,
"expiration_date": null,
"validity_timeframe": null,
"validity_day_of_week": null,
"additional_info": null,
"assets": {
"qr": {},
"barcode": {}
},
"updated_at": null,
"object": "voucher"
}
}

Authorizations

X-App-Id
string
header
required
X-App-Token
string
header
required
Authorization
string
header
required

Path Parameters

redemptionId
string
required

Response

200 - application/json
  • Redemption
  • Redemption Rollback
id
string
required
Example:
object
enum<string>
default:redemption
required
Available options:
redemption
date
string<date-time>
required
Example:
customer_id
string | null
required
Example:
tracking_id
string | null
required
metadata
object | null
required
redemption
string | null
required
Example:
result
enum<string>
required
Available options:
SUCCESS,
FAILURE
status
enum<string>
required
Available options:
SUCCEEDED,
FAILED,
ROLLED_BACK
order
object
required
channel
object
required
customer
object
required
Available options:
voucher,
promotion_tier,
redemption
amount
integer
Example:
session
object
failure_code
string
Example:
failure_message
string
promotion_tier
object
reward
object
gift
object
loyalty_card
object
voucher
object