- Documentation
- Help Center
- Status
- Email Support
- Overview
- Overview
Guides
Best Practices
Usage
Reference
Users
SSO
Locations
Features
Cards
Rewards
Tags
Communication Settings
Push Registrations
Points
Tiers
Feedbacks
Purchases
Receipts
Archive
Introduction
Consumer API
Get Points Experiences
This endpoint returns the points experiences for the merchant.
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Only return points experiences configured for this merchant
curl --request GET \
--url https://api.thanx.com/points_experiences \
--header 'Authorization: Bearer <token>'{
"points_experiences": [
{
"id": "590485d6f0",
"merchant_id": "woeri34",
"name": "Merchant Points",
"currency": {
"name": "Star",
"plural": "Stars",
"description": "Collect 1 star for every 1 dollar spent",
"conversion": 1.0
},
"images": {
"earn": {
"small": "https://...png",
"default": "https://...png",
"large": "https://...png"
},
"currency_primary": {
"small": "https://...png",
"medium": "https://...png",
"default": "https://...png",
"large": "https://...png"
},
"currency_secondary": {
"small": "https://...png",
"medium": "https://...png",
"default": "https://...png",
"large": "https://...png"
}
}
}
]
}
Parameters
Only return points experiences configured for this merchant
Response
The ID of the points experience
The ID of the merchant
The name of the points experience
The points experience's currency name
The plural tense of the points experience's currency name
Text describing how to collect currency
Conversion rate for dollars to experience currency
Image describing how to collect currency
URL of the small variant of the earn_image (width: 375px)
URL of the default variant of the earn_image (width: 750px)
URL of the large variant of the earn_image (width: 1125px)
Primary points currency icon
URL of the small variant of the currency_primary icon (16x16)
URL of the default variant of the currency_primary icon (64x64)
URL of the default variant of the currency_primary icon (128x128)
URL of the large variant of the currency_primary icon (192x192)
Primary points currency icon
URL of the small variant of the currency_secondary icon (16x16)
URL of the default variant of the currency_secondary icon (64x64)
URL of the default variant of the currency_secondary icon (128x128)
URL of the large variant of the currency_secondary icon (192x192)
curl --request GET \
--url https://api.thanx.com/points_experiences \
--header 'Authorization: Bearer <token>'{
"points_experiences": [
{
"id": "590485d6f0",
"merchant_id": "woeri34",
"name": "Merchant Points",
"currency": {
"name": "Star",
"plural": "Stars",
"description": "Collect 1 star for every 1 dollar spent",
"conversion": 1.0
},
"images": {
"earn": {
"small": "https://...png",
"default": "https://...png",
"large": "https://...png"
},
"currency_primary": {
"small": "https://...png",
"medium": "https://...png",
"default": "https://...png",
"large": "https://...png"
},
"currency_secondary": {
"small": "https://...png",
"medium": "https://...png",
"default": "https://...png",
"large": "https://...png"
}
}
}
]
}