Loyalty Events

qualifying_purchase.created

Fired when a transaction counts as a qualifying purchase (stamp) toward a loyalty program.

{
  "event_id": "evt_jkl012",
  "timestamp": "2024-01-15T10:30:00Z",
  "type": "qualifying_purchase.created",
  "qualifying_purchase_id": "qp_abc123",
  "loyalty_program_id": "lp_abc123",
  "transaction_id": "tx_def456",
  "transaction_ref": "txn_98765",
  "created_at": "2024-01-15T10:30:00Z"
}

Field	Type	Description
qualifying_purchase_id	string	Unique ID for this qualifying purchase
loyalty_program_id	string	The loyalty program this stamp applies to
transaction_id	string	Internal transaction ID
transaction_ref	string	Your external_id from the ingested transaction
created_at	string	ISO 8601 timestamp of when the purchase qualified

---

qualifying_purchase.voided

Fired when a qualifying purchase is voided (e.g. the transaction was refunded).

{
  "event_id": "evt_mno345",
  "timestamp": "2024-01-17T12:00:00Z",
  "type": "qualifying_purchase.voided",
  "qualifying_purchase_id": "qp_abc123",
  "loyalty_program_id": "lp_abc123",
  "transaction_id": "tx_def456",
  "transaction_ref": "txn_98765",
  "voided_at": "2024-01-17T12:00:00Z"
}

Field	Type	Description
qualifying_purchase_id	string	The qualifying purchase that was voided
loyalty_program_id	string	The loyalty program this applied to
transaction_id	string	Internal transaction ID
transaction_ref	string	Your external_id from the ingested transaction
voided_at	string	ISO 8601 timestamp of when it was voided

---

qualifying_purchase.unredeemed

Fired when a previously redeemed qualifying purchase is marked as unredeemed (e.g. due to a redemption reversal).

{
  "event_id": "evt_pqr678",
  "timestamp": "2024-01-18T09:00:00Z",
  "type": "qualifying_purchase.unredeemed",
  "qualifying_purchase_id": "qp_abc123",
  "loyalty_program_id": "lp_abc123",
  "transaction_id": "tx_def456",
  "transaction_ref": "txn_98765"
}

Fields are the same as qualifying_purchase.voided without the voided_at timestamp.