Consumer API
- Overview
- Guides
- Best Practices
- Usage
Reference
- Users
- SSO
- Locations
- Features
- Cards
- Rewards
- Tags
- Communication Settings
- Push Registrations
- Points
- Tiers
- Feedbacks
- Purchases
- Receipts
- Archive
Get Points Experiences
This endpoint returns the points experiences for the merchant.
curl https://api.thanxsandbox.com/points_experiences \
-X GET \
$AUTH_HEADERS
{
"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"
}
}
}
]
}
Please review proper request headers here.
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
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 https://api.thanxsandbox.com/points_experiences \
-X GET \
$AUTH_HEADERS
{
"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"
}
}
}
]
}
curl https://api.thanxsandbox.com/points_experiences \
-X GET \
$AUTH_HEADERS
{
"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"
}
}
}
]
}