Attributes

Rewards

Thanx

Help Center

Status

Email Support

Overview

Consumer API

Partner API

Loyalty API

Webhooks

Data Exports

Introduction

Points Integration

Thanx sends users push notifications in a variety of situations, such as when they make a purchase or earn a reward.

Push Notifications

Deep Linking

Design

Design Best Practices

Card Enrollment

Card Enrollment Best Practices

Onboarding & Authentication

Loyalty & Rewards

Loyalty & Rewards Best Practices

Feedback & Support

Feedback & Support Best Practices

Messaging

Messaging Best Practices

This section calls out some patterns in this API.

Patterns

This section describes the headers expected by the Thanx API.

Headers

Thanx uses standard HTTP error codes to communicate the success / failure of a request.

Errors

Legal

A Consumer API integration must be certified before production credentials are made available.

Certification

Create User

This endpoint will return information for the currently logged in user.

Get User

This endpoint updates the specified user's information.

Update User

Submits a request for user account closure

Delete User

This section describes the process of authenticating with Thanx via Thanx SSO.

Single Sign-On (SSO) Overview

Legal Requirements

This endpoint triggers the passwordless login flow.

Acquire Authorization Code

Use this endpoint to acquire a user's access token.

Acquire Access Token

Use this endpoint to revoke a user's access token.

Revoke Access Token

This endpoint describes locations accessible for the provided client ID. If a merchant_id is provided the locations will be further filtered.

Get Locations

This endpoint returns the configuration for a merchant's features. If a merchant does not have a particular feature defined or enabled, the value for the associated feature key will be empty.

Get Features

This endpoint registers a new card with Thanx.

Create Card

This section describes endpoints that enable a third party to fetch and register a user's cards. This endpoint describes all registered cards for the given user.

Get Cards

This endpoint archives a registered card. The card is unenrolled from Visa/Mastercard/Amex.

Delete Card

The Thanx platform supports a number of different reward redemption types — allowing for significant flexibility in what brands can offer to their users.


Reward Overview

Get Rewards

This endpoint returns the reward corresponding to the ID in the path.

Get Reward

This endpoint activates the reward, transitioning reward state from available to active. For bonus points (also know as static rewards), this endpoint sets the reward state to used after activation (see [overview](/consumer/rewards/overview) for more information).

Activate Reward

This endpoint marks an unused reward as used, transitioning the reward state from active to used.

Finalize Reward

This endpoint grants the user a reward associated with the campaign provided.

Grant Reward

This endpoint updates the redemption location for an active reward.

Update reward

This section describes endpoints that enable a third party to fetch and update a user's tags. This endpoint describes all attribute tags for the given user.

Get Tags

This endpoint updates an attribute tag for the given user. The tag associated with the key in the request will be created or updated with the values passed in.

Update Tags

This endpoint deletes an attribute tag with the given ID.

Delete Tag

This endpoint returns a user's communication settings. The notification key reflects a user's settings for receiving push notifications in their app or via text if they don't have an app installed. The email key reflects a user's settings for receiving emails.

Get Communication Settings

This endpoint allows the update of a user's notification / email settings.

Update Communication Settings

This endpoint creates or updates a push registration record for a user's device.

Create Push Registration

This endpoint returns the points experiences for the merchant.

Get Points Experiences

This endpoint returns a single points experience specified by ID.

Get Points Experience

This endpoint returns the specified points experience balance for the given user

Get Points Balance

This endpoint returns the configured points products.

Get Points Products

This endpoint returns the configured points multipliers for the experience.

Get Points Multipliers

This endpoint exchanges the user's points for the specified points product

Exchange Points Product

This section describes endpoints that enable a third party to fetch the configuration of a merchant's tiers. This endpoint describes tier configurations for the merchants accessible via the provided credentials.

Get Tiers Configurations

This endpoint describes the user's current tier statuses.

Get Tier Statuses

Grant Tier Status

This endpoint describes the user's current feedback records.

Get Feedbacks

This endpoint returns the feedback record corresponding with the ID in the path.

Get Feedback

This endpoint will update a user's feedback record.

Update Feedback

This endpoint submits a purchase to our system for processing. Because this purchase is processed asynchronously, there is no response JSON. Please allow up to a couple minutes to receive this purchase back from the GET /purchases endpoint.

Create Purchase

This section describes endpoints that enable a third party to fetch a user's purchases. This endpoint describes all available purchases.

Get Purchases

This endpoint returns the purchase associated with the id in the path.

Get Purchase

This endpoint updates an attribute tag for the given purchase. The tag associated with the key in the request will be created or updated with the values passed in.

Update Purchase Tags

This endpoint submits a receipt for processing.

Create Receipt

This endpoint describes the receipts in Thanx.

Get Receipts

This endpoint provides a pre-signed url where an image or file can be uploaded.

Get Upload URL

Archive Overview

This endpoint describes the user's current loyalty statuses.

Get Loyalty Statuses

Returns API scopes accessible to the current credentials

Get Scopes

This endpoint will return all accessible merchants records

Get Merchants

This endpoint will return all accessible location records

Create Subscriber

This endpoint will return all the users of the specified merchant.

Get Users

This endpoint will return one particular user of the specified merchant.

Create Access Token

This endpoint submits a purchase to Thanx for processing. This allows for issuance of loyalty points to the given user.

Upsert Tags

Delete Tags

Get Feedback Records

Respond to Feedback

This endpoint returns a user's communication settings for the specified merchant. The notification key reflects a user's settings for receiving push notifications in their app or via text if they don't have an app installed. The email key reflects a user's settings for receiving emails.

Get User's Communication Settings

This endpoint allows the update of a user's notification / email settings for the specified merchant.

Update User's Communication Settings

POS Coupon Codes Integration

All Ordering / Loyalty integration API endpoints described below must include the following headers.

This endpoint allows the retrieval of a user account information, including the user's rewards.

Get Account

This endpoint is used to notify Thanx of the states that a basket is in, apply rewards to the order, and accrue loyalty progress or points for the order.

Column	Data Type	Description
`reward_id`	`string`	The unique identifier of the reward in Thanx.
`reward_uid`	`string`	The unique identifier for the reward in Thanx APIs.
`merchant_id`	`string`	The unique identifier of the merchant in Thanx.
`program_id`	`string`	The unique identifier of the program in Thanx. The program is what issues rewards.
`user_id`	`string`	The unique identifier of the customer in Thanx.
`earning_purchase_id`	`string`	The ID of the purchase that resulted in this reward reaching 100% progress.
`redemption_purchase_id`	`string`	The ID of the purchase that is associated with this reward being redeemed.
`redeem_title`	`string`	The title of the reward. This value is defined by the merchant when they create a reward template and visible to the consumer.
`program_type`	`string`	The type of program that issues the reward.
		`automated campaign`
		`automated campaign - referral program`
		`birthday program`
		`exclusive deals`
		`feedback`
		`intro offer - premium`
		`intro offer - standard`
		`loyalty - incremental`
		`loyalty - points`
		`loyalty - spend`
		`loyalty - surprise and delight`
		`loyalty - visit`
		`one-time campaign`
		`one-time campaign - afternoon shoppers`
		`one-time campaign - close a location`
		`one-time campaign - evening shoppers`
		`one-time campaign - midday shoppers`
		`one-time campaign - morning shoppers`
		`one-time campaign - promote a location`
		`one-time campaign - reopen a location`
		`one-time campaign - vips`
		`one-time campaign - weekday shoppers`
		`one-time campaign - weekend shoppers`
		`reputation manager`
		`special offer`
		`special offer at a location`
		`vip program - spend`
		`vip program - visit based`
		`winback program`
`state`	`string`	The state of the reward. (`active`, `delivered`, `fraudulent`, `pending use`, `refunded`, `retired`, `used`)
`delivered_at`	`timestamp`	The time and date that the reward was delivered to the user. This is in UTC.
`activated_at`	`timestamp`	The time and date that the user activated the reward. This is in UTC.
`used_at`	`timestamp`	The time and date that the user used the reward. This is in UTC.
`retired_at`	`timestamp`	The time and date that the reward expired (if it wasn’t used). This is in UTC.
`expiration_at`	`timestamp`	The time and date this reward expires/expired. This is in UTC.
`estimated_cost`	`number`	The estimated cost of the reward. This value is based on COGS defined by the merchant, or estimated margins.
`discount`	`number`	The applied discount amount of the reward. When we have the exact discount amount via integrated redemption, this will be the exact amount discounted from the purchase. For some reward types with non-integrated redemption, this will be a value based on the estimate you provided when configuring the reward template in the merchant dashboard.
`redemption_pos_order_id`	`string`	Coming Soon POS ID of the order with which this reward was redeemed. Set for merchants with in-store POS integrations enabled for rewards that were redeemed in-store.
`redemption_pos_provider`	`string`	Coming Soon POS provider for the integrated in-store redemption.

Data Exports

Thanx Connex

Models

Rewards

SFTP Exports

Thanx Connex

Attributes

Data Exports

Thanx Connex

Models

SFTP Exports

Thanx Connex

​Attributes

Attributes