Skip to main content

​
Overview

This guide explains how merchants and partners can integrate their ordering systems—whether mobile apps and web ordering sites—with Thanx to create a seamless, loyalty-driven customer experience. By connecting directly to Thanx, merchants can unify ordering, payments, and rewards in one platform, allowing customers to easily log in, earn points, redeem rewards, and view their loyalty status without leaving the ordering experience. This integration not only enhances convenience for users but also helps brands strengthen customer retention, increase repeat purchases, and gain valuable insights into customer behavior. For merchants, it simplifies loyalty management by automating reward activation, receipts, and tier tracking, while maintaining a consistent and engaging brand experience across digital channels. In short, integrating with Thanx enables a more personalized, rewarding, and data-driven relationship with every customer.

​
Credentials You Will Need

For this type of integration you will need
  • Client id
  • Client secret
  • Merchant id
  • Merchant Key

​
Best Practices

Based on our experience, we recommend the following best practices to engage with app users and maintain the highest standards for user experience and Thanx functionality. Here are key topics to consider when maintaining best practices within your integrations: Design Best Practices Card Enrollment Best Practices Onboarding and Authentication Best Practices Loyalty and Rewards Best Practices Feedback and Support Messaging Best Practices

​
Interactions

When building ordering integrations with Thanx—whether for mobile apps or web ordering systems—you’ll use both our Consumer API and our Loyalty API. While we recommend integrating all available endpoints from both APIs, we understand that not all are strictly required. Below is a list of the minimum required endpoints to build a successful integration with Thanx and leverage our core functionality.
  1. User Authentication User authentication should be done via our SSO flow as outlined in our docs. This ensures proper user validation and a seamless login experience. SSO Overview Acquire Auth Code Acquire Access Token If the user account does not exist, refer to the Create User endpoint to create the account and obtain a user token. User Authentication Workflow
  2. Credit Card Management (only for card-linked loyalty merchants) For card-linked loyalty, integrate card management endpoints. This allows users to enroll, view, and delete their enrolled cards within a merchant loyalty program. Create Card Get Cards Delete Card
  3. Check-in Page (only for check-in loyalty merchants) For check-in merchants, integrate the get check-in code endpoint. This retrieves the value that the custom experience should embed into a generated QR code. Users can then show this QR code to any system that supports QR code check-in for loyalty. Get Check In Code
  4. Bonus Points Automatic Activation Implement bonus points automatic activation so users can earn points when they receive a bonus points reward—without needing to manually redeem the reward itself. Rewards Overview Get Rewards Activate Reward
  5. In-Store Reward Redemption/Points Product Exchange (only for mobile apps) For mobile apps, implement in-store reward redemption and points product redemption logic. This means displaying in-store redemption codes when users redeem rewards in-store—whether as QR codes or the merchant’s preferred code format.
  6. Reward Redemption/Points Product Exchange at Checkout For all ordering experiences, reward redemption and points product exchange should be available at checkout when submitting baskets. The basket submission process should work as follows: At the checkout screen, make a Get Account API call to retrieve the user’s available points balance, available rewards, and points products. This allows you to display the applicable rewards and points products to the user so they can decide whether to include any benefits in their current basket. Then submit the basket to our Create or Update Basket endpoint. Include the proper Thanx location_uid with this basket submission, which can be retrieved via the Get Locations endpoint.
  7. Tier Information Display Users should be able to see their current tier status and available tiers within the Thanx experience. This can be achieved using the following endpoints: Get Tier Statuses Get Tier Configurations
  8. Push Notifications This is not a requirement for certification, but integration is possible using our API. Create Push Registration
  9. Receipt Upload (only for card-linked loyalty merchants) For card-linked loyalty merchants, implement receipt uploads within the ordering experience using the following endpoints: Create Receipt Get Receipts Get Upload Url
  10. User Account Management A user should be able to create an account, view their user details, update their information, and request account deletion. This is possible via the following endpoints: Create User Get User Update User Delete User

​
Postman API Collection

Here you will find the Mobile App - Web Ordering Integration API Postman Collection to import directly within your API testing tool. This collection is already completed and includes sample values for the credentials.Please replace them with the ones provided by your Thanx representative in order to achieve successful API calls. Download Postman Collection

​
Certification

Certification is a standard process that all experiences integrating with Thanx must pass before accessing our production environment. You can find more detailed information about this process on the following page To certify these types of experiences, we will need:
  • For mobile apps:
    • Access to TestFlight version for iOS builds
    • Access to Google Console Testing for Android builds
  • For web ordering experiences:
    • Test link for testing the online experience
Once we receive the needed materials for testing, we will review all of the outlined interactions and check our logs to confirm that everything worked as expected. After every interaction has been tested and we’ve verified that the logs show the correct information and headers are sent properly, we will provide the corresponding production credentials.