These webhooks are sent anytime Thanx detects a qualifying user purchase.
Duplicate deliveries are expected. A single purchase can trigger this
webhook multiple times — the same id is re-sent as the purchase is processed
through authorization and settlement, and across payment rails. Delivery is
not exactly-once (best-effort, with duplicates expected). Deduplicate by id
and treat repeat deliveries for an id as updates. Because amount and
products may be refined between deliveries, prefer the values from the last
delivery you receive for a given id.
Payload Description
string
The ID of the purchase record in Thanx
hash
User information
Show user
string
The ID of the user record in Thanx
string
The user’s email. This value may not be present.
string
The user’s first name. This value may not be present.
string
The user’s last name. This value may not be present.
hash
Merchant information
Show merchant
string
The ID of the merchant record in Thanx
string
The name of the merchant
hash
Location information
Show location
string
The location name or category
string
The ID of the location record in Thanx, if permitted
string
The street address of the location, if permitted
string
The location’s city, if permitted
string
The location’s state, if permitted
string
The location’s zip code, if permitted
string
The location’s time zone, if permitted
string
The location’s latitude, if permitted
string
The location’s longitude, if permitted
string
Time the purchase was made in ISO8601-format
string
The purchase amount, represented as a string to prevent precision issues commonly associated with floating point numbers on the receiving side. This value may be refined between the authorization and settlement deliveries for the same purchase id; prefer the value from the last delivery you receive.
hash
The order information, if this purchase reflects an online order
Show order
string
The order ID in the provider’s system
enum
(OLO, Toast, Other)
array(string)
By default, these webhooks are sent 10 minutes after a purchase record is
initially captured by the Thanx platform (usually initially from the credit
card networks or ordering providers). Due to the nature of how Thanx collects
item-level data, this data may not always be captured by Thanx by the time
this webhook is sent out. If the purchase is digital (placed via Thanx-managed
ordering experiences), this attribute will be populated. If the purchase is
an in-store purchase, this attribute may not be populated depending on how
quickly the webhook is configured to send.This data can be collected by working with the Thanx team to adjust the
webhook latency, send an additional webhook at the time of item matching,
or looked up via other mechanisms.Because of this, later deliveries for the same purchase id may include
products that earlier deliveries omitted; treat the last delivery you
receive as the most complete.