Skip to main content
POST
/
v1
/
loyalties
/
{campaignId}
/
members
/
{memberId}
/
redemption
Redeem Reward with campaign ID
curl --request POST \
  --url https://{cluster}.voucherify.io/v1/loyalties/{campaignId}/members/{memberId}/redemption \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-App-Id: <api-key>' \
  --header 'X-App-Token: <api-key>' \
  --data '{
  "reward": {
    "id": "rew_INt3fGH3n7xIr3ZQcq4kkUZ1",
    "points": 100
  },
  "order": {
    "items": [
      {
        "product_id": "prod_0c5d6689b39320059b",
        "quantity": "1"
      },
      {
        "product_id": "prod_0b2c36568000039138",
        "quantity": "2"
      }
    ]
  }
}'
{
  "id": "r_0c6b3abbfe8e60a9dd",
  "object": "redemption",
  "date": "2023-02-06T09:07:55.514Z",
  "customer_id": "cust_eWgXlBBiY6THFRJwX45Iakv4",
  "tracking_id": "track_9B0kB92+bJa8a+PegaWREw==",
  "metadata": null,
  "amount": 1,
  "result": "SUCCESS",
  "order": null,
  "customer": {
    "id": "cust_eWgXlBBiY6THFRJwX45Iakv4",
    "name": "Bob Jones",
    "email": "bob.jones@email.com",
    "source_id": "36_bob",
    "metadata": {
      "age": 26,
      "favorite_brands": [
        "Nike",
        "Adidas",
        "Reebok"
      ],
      "accepts_marketing": false,
      "acquisition_channel": "Facebook"
    },
    "object": "customer"
  },
  "related_object_type": "voucher",
  "related_object_id": "v_u3dRiZ0XHqX5Euhy5ezB5UQ5Sf85VXFP",
  "voucher": {
    "id": "v_u3dRiZ0XHqX5Euhy5ezB5UQ5Sf85VXFP",
    "code": "AnsvocvP",
    "campaign": "Loyalty Campaign - Test Points",
    "campaign_id": "camp_22noMlhTADb7Fq2UL3vWu3d1",
    "category": null,
    "category_id": "cat_0bb81a481615a37b5e",
    "categories": [],
    "type": "LOYALTY_CARD",
    "discount": null,
    "gift": null,
    "loyalty_card": {
      "points": 8000,
      "balance": 6887
    },
    "start_date": null,
    "expiration_date": null,
    "validity_timeframe": null,
    "validity_day_of_week": null,
    "active": true,
    "additional_info": null,
    "metadata": {},
    "assets": {
      "qr": {
        "id": "U2FsdGVkX1/Au841M0T7UjYYRxYTzCRbNdZW6jW5YRNcV9PgblvN2MD5hdRuZfBRHEAm+d2pvzc2FOVHFkuh9BQoaIq4KVyvy0FvkWtKkMLe4zO+qL4ocNUIbaRMSLeY6Xiz4hjxKNq918oLyGrp9w==",
        "url": "{{internalVoucherifyURL}}"
      },
      "barcode": {
        "id": "U2FsdGVkX1+xG42zWo9nivfp6tg5jNuFCYOIFtw7iwas8kcA/8H4gu04dxO/hrbD41gFvxDhCuTSnIKwIPg9dEXzOvh8qy9VWN0UwDc6PL7lfNQuY+8Os7dqVsyNhoRned9pBo1uO6V4pjNu1gRTrw==",
        "url": "{{internalVoucherifyURL}}"
      }
    },
    "is_referral_code": false,
    "created_at": "2022-11-10T06:28:59.970Z",
    "updated_at": "2023-02-06T09:07:55.515Z",
    "holder_id": "cust_eWgXlBBiY6THFRJwX45Iakv4",
    "holder": {
      "id": "cust_eWgXlBBiY6THFRJwX45Iakv4",
      "source_id": "36_bob",
      "metadata": {
        "age": 26,
        "favorite_brands": [
          "Nike",
          "Adidas",
          "Reebok"
        ],
        "accepts_marketing": false,
        "acquisition_channel": "Facebook"
      },
      "object": "customer"
    },
    "validation_rules_assignments": {
      "object": "list",
      "data_ref": "data",
      "data": [],
      "total": 0
    },
    "redemption": {
      "quantity": null,
      "redeemed_quantity": 9,
      "redeemed_points": 1113,
      "object": "list",
      "url": "/v1/vouchers/AnsvocvP/redemptions?page=1&limit=10"
    },
    "publish": {
      "object": "list",
      "count": 1,
      "url": "/v1/vouchers/AnsvocvP/publications?page=1&limit=10"
    },
    "object": "voucher",
    "applicable_to": {
      "data": [],
      "total": 0,
      "data_ref": "data",
      "object": "list"
    },
    "inapplicable_to": {
      "data": [],
      "total": 0,
      "data_ref": "data",
      "object": "list"
    }
  },
  "reward": {
    "customer": {
      "id": "cust_eWgXlBBiY6THFRJwX45Iakv4",
      "name": "Bob Jones",
      "email": "bob.jones@email.com",
      "source_id": "36_bob",
      "metadata": {
        "age": 26,
        "favorite_brands": [
          "Nike",
          "Adidas",
          "Reebok"
        ],
        "accepts_marketing": false,
        "acquisition_channel": "Facebook"
      },
      "object": "customer"
    },
    "assignment_id": "rewa_BpytIepuSekuXXwb9qkLJfCU",
    "voucher": {
      "id": "v_pQZDYaH8LzoOvgh3234DqZQjGJgbPov6",
      "code": "LOYALTY-CARD-zOR2sV9Q",
      "campaign": "Loyalty Program",
      "campaign_id": "camp_Hpt5hPTA8kSKRWGxBGw8Y0So",
      "category": null,
      "category_id": null,
      "categories": [],
      "type": "LOYALTY_CARD",
      "discount": null,
      "gift": null,
      "loyalty_card": {
        "points": 1020,
        "balance": 890
      },
      "start_date": null,
      "expiration_date": null,
      "validity_timeframe": null,
      "validity_day_of_week": null,
      "active": true,
      "additional_info": null,
      "metadata": {},
      "assets": {
        "qr": {
          "id": "U2FsdGVkX1/THRRj1QegAan0r5U+wRoHuFEA6FR7TrvZm8N+8cK7niF/8uAqFdVYTU1JD0/CdoSXlYqiGgz3PAFOGWFSJt8vkM50fcMtMNLsaudU+YrPDeT2HCB7o0Ts7h1FnbD85+0F7lwrbKmkGW6kub0mjCaRdJYS/axIAq4=",
          "url": "{{internalVoucherifyURL}}"
        },
        "barcode": {
          "id": "U2FsdGVkX1+yREd0zRAfZY9uwtMZsl4eDd8+LeiKGVI5OzOQRpjhtV91IuEe7/SXEW8m4F2Llg2//yieX2zsP3UtWasWxw8ZkHMRSIdxfxzSdSj8ap0dI5xwKW4OE1Q6Sgsb+kZVfCKUHbwXCcd8y5a6xTpVIg97y74Ng1Vg2PY=",
          "url": "{{internalVoucherifyURL}}"
        }
      },
      "is_referral_code": false,
      "created_at": "2022-07-11T08:19:28.780Z",
      "updated_at": "2023-01-25T15:44:33.500Z",
      "holder_id": "cust_eWgXlBBiY6THFRJwX45Iakv4",
      "redemption": {
        "quantity": null,
        "redeemed_quantity": 26,
        "redeemed_points": 130,
        "object": "list",
        "url": "/v1/vouchers/LOYALTY-CARD-zOR2sV9Q/redemptions?page=1&limit=10"
      },
      "publish": {
        "object": "list",
        "count": 1,
        "url": "/v1/vouchers/LOYALTY-CARD-zOR2sV9Q/publications?page=1&limit=10"
      },
      "object": "voucher"
    },
    "id": "rew_7ZM476Q77dH5KvHk4KzoRNvF",
    "object": "reward",
    "name": "Present on Loyalty Card",
    "created_at": "2023-01-25T15:43:40.716Z",
    "updated_at": null,
    "parameters": {
      "campaign": {
        "id": "camp_Hpt5hPTA8kSKRWGxBGw8Y0So",
        "balance": 20,
        "type": "LOYALTY_PROGRAM"
      }
    },
    "type": "CAMPAIGN"
  },
  "loyalty_card": {
    "points": 1
  }
}

Authorizations

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

Path Parameters

​
campaignId
string
required
Example:
​
memberId
string
required
Example:

Body

application/json
​
reward
object
​
order
object
​
metadata
object

Response

​
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
​
related_object_type
enum<string>
required
Available options:
voucher,
promotion_tier,
redemption
​
related_object_id
string
required
​
reward
object
required
​
amount
integer
Example:
​
session
object
​
related_redemptions
object
​
failure_code
string
Example:
​
failure_message
string
​
promotion_tier
object
​
gift
object
​
loyalty_card
object
​
voucher
object