Get Points Experiences

curl https://api.thanxsandbox.com/points_experiences \
  -X GET \
  -H "Content-Type: application/json"  \
  -H "Accept-Version: v4.0" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer ${token}" \
  -H "X-ClientId: ${client_id}" 

{
  "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"
        }
      }
    }
  ]
}

GET

points_experiences

curl https://api.thanxsandbox.com/points_experiences \
  -X GET \
  -H "Content-Type: application/json"  \
  -H "Accept-Version: v4.0" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer ${token}" \
  -H "X-ClientId: ${client_id}" 

{
  "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

string

Only return points experiences configured for this merchant

Response

string

The ID of the points experience

string

The ID of the merchant

string

The name of the points experience

hash

Show currency

string

The points experience's currency name

string

The plural tense of the points experience's currency name

string

Text describing how to collect currency

decimal

Conversion rate for dollars to experience currency

hash

Show images

hash

Image describing how to collect currency

Show earn

string

URL of the small variant of the earn_image (width: 375px)

string

URL of the default variant of the earn_image (width: 750px)

string

URL of the large variant of the earn_image (width: 1125px)

hash

Primary points currency icon

Show currency_primary

string

URL of the small variant of the currency_primary icon (16x16)

string

URL of the default variant of the currency_primary icon (64x64)

string

URL of the default variant of the currency_primary icon (128x128)

string

URL of the large variant of the currency_primary icon (192x192)

hash

Primary points currency icon

Show currency_secondary

string

URL of the small variant of the currency_secondary icon (16x16)

string

URL of the default variant of the currency_secondary icon (64x64)

string

URL of the default variant of the currency_secondary icon (128x128)

string

URL of the large variant of the currency_secondary icon (192x192)

curl https://api.thanxsandbox.com/points_experiences \
  -X GET \
  -H "Content-Type: application/json"  \
  -H "Accept-Version: v4.0" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer ${token}" \
  -H "X-ClientId: ${client_id}" 

{
  "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"
        }
      }
    }
  ]
}

⌘I

Consumer API

Reference

Get Points Experiences

Parameters

Response

​Parameters

​Response

Parameters

Response