Program Meta

Get information about business-level data, such as program type, platform configurations, list of redeemables (in case of points unlock redeemable program), etc.

Any update made to the configuration in the platform will be reflected in the response after 15 minutes, instead of in real time, in order to improve the response time.

Headers

Authorization
Type: string
required

This is a combination of unique API key as well as business key (UUID) as the Authorization header.
Accept-Language
Type: string

Short code for locale variant (e.g., fr-ca, es-ES, en-EN, etc.)

Responses

application/json

get/api/pos/meta

curl https://SERVER_NAME_GOES_HERE.punchh.com/api/pos/meta \
  --header 'Authorization: Token token=LOCATION_KEY_GOES_HERE, btoken=BUSINESS_KEY_GOES_HERE' \
  --header 'Accept-Language: en'

Show Schema

{
  "minimum_payable_price": null,
  "maximum_discountable_quantity": null,
  "program_type": "points_unlock_redeemables",
  "points_conversion_type": "staged",
  "visits_per_card": 5,
  "card_redemption_value": 2,
  "minimum_visit_amount": 5,
  "minimum_visit_hours": 4,
  "minimum_age_to_signup": 0,
  "earning_unit": "point",
  "currency_earned": 0,
  "points_conversion_threshold": 50,
  "redemption_expiry_minutes": 24,
  "pending_points": true,
  "pending_points_duration": 15,
  "configurable_default_time_eod": "23:59:59",
  "autocreate_user_phone": true,
  "coupon_prefix": "",
  "redeemables": [
    {
      "redeemable_image_url": "IMAGE_URL_GOES_HERE",
      "redeemable_properties": null,
      "meta_data": "Meta data",
      "redeemable_id": "REDEEMABLE_ID_GOES_HERE",
      "name": "Test Redeemable #2",
      "description": "Test redeemable description",
      "points_required_to_redeem": 20
    },
    {
      "redeemable_image_url": "IMAGE_URL_GOES_HERE",
      "redeemable_properties": null,
      "redeemable_id": "REDEEMABLE_ID_GOES_HERE",
      "name": "Chips & Salsa",
      "description": "Chips & Salsa redeemable. only be used in the redemption of Chips & Salsa",
      "points_required_to_redeem": 35
    },
    {
      "redeemable_image_url": "IMAGE_URL_GOES_HERE",
      "redeemable_properties": null,
      "meta_data": "deal 1",
      "redeemable_id": "REDEEMABLE_ID_GOES_HERE",
      "name": "50% off",
      "description": "Test Description",
      "points_required_to_redeem": 200
    },
    {
      "redeemable_image_url": "IMAGE_URL_GOES_HERE",
      "redeemable_properties": null,
      "redeemable_id": "REDEEMABLE_ID_GOES_HERE",
      "name": "Test Redeemable",
      "description": "Redeemable to test redemption!",
      "points_required_to_redeem": 1500
    }
  ],
  "multiple_redemptions": {
    "exclude_interoperability_strategy_between": [
      "offer|loyalty",
      "loyalty|pre_purchased",
      "promo_coupon|offer",
      "pre_purchased|promo_coupon"
    ],
    "auto_unlock_duration": 100,
    "discount_processing_strategy": "date_of_expiry",
    "processing_priority_by_discount_type": [
      "reward"
    ],
    "allow_multiple_redemption_on_item": true,
    "allow_qualifying_items_reused": true,
    "auto_redemption": true,
    "auto_redemption_discounts": [
      "offer",
      "subscription"
    ],
    "enable_auto_unlock": true,
    "enable_discount_locking": true,
    "max_redemptions_in_transaction": 20,
    "processing_priority_by_acquisition_type": [
      {
        "code": "offer",
        "priority": 1,
        "multiplication_factor": 20
      },
      {
        "code": "loyalty",
        "priority": 2,
        "multiplication_factor": 10
      },
      {
        "code": "promo_coupon",
        "priority": 3,
        "multiplication_factor": 5
      },
      {
        "code": "pre_purchased",
        "priority": 4,
        "multiplication_factor": 4
      }
    ]
  },
  "multiple_redemptions_enabled": true
}

Automated approach based on different programs: A partner could use different values and also programmatically identify to display them accordingly via the Program Meta API.

For program_type as “visits”, in order to fetch the count for available unredeemed cards, use the “unredeemed_cards” field. In this case, net_balance will show the available visits balance earned for a user.
For program_type as “points” -- “points_conversion_type”: “currency” -- in order to fetch the value for dollar amount available in the user’s account, use the “banked_rewards” field. In this case, net_balance will also show banked reward currency available, but if you want to display current points available, use points_balance. This gets reset once it reaches the threshold value (returned in meta API under “points_conversion_threshold”) where those points are converted to fixed banked reward value as configured in the platform. For example, if as per business setup every 100 points earned get converted to $10 and the user currently has 40 points, then the points_balance value will be 40 until the user earns 60 more points where they will get converted to $10. Once the user earns 60 more points, the points_balance reaches 100 where it will get converted to $10 and the points_balance value will become 0.
For program_type as “points_unlock_redeemables” -- “points_conversion_type”: “staged” or “points_conversion_type”: “none” -- in this case, in order to fetch the current balance, you can use the net_balance value from the balance object which will get updated after every check-in or redemption. The points_balance value will also update based on earnings but will reset once it reaches the threshold value. Here, we do not recommend the point_balance value to be displayed as there is no conversion into currency or reward.
For program_type as "points" -- “points_conversion_type”: “rewards” -- in this case, the points_balance will show current points which will get reset once it reaches the threshold value (returned in meta API under “points_conversion_threshold”) where points are converted to a reward. Also, net_balance will display total available points of the user. For example, if as per business setup every 100 points earned get converted to a reward and the user currently has 40 points, then the points_balance value will be 40 until the user earns 60 more points where they will get converted to a reward. Once the user earns 60 more points, the points_balance reaches 100 where it will get converted to a reward and the points_balance value will become 0.