Discount

Overview

The Discount object represents any discount applied to a transaction or line item. It is used to track promotions, manual adjustments, and loyalty-based reductions applied during the transaction process.

When to Use This Object

Include a Discount object in the transaction payload when:

• A discount is applied to an item or entire transaction
• You need to log or trace the origin of a loyalty or promotional reduction
• Discounts are automatically or manually applied and must be reported

Field Reference

Field	Type	Required	Description
type	string	Yes	Type of discount (LOYALTY, PROMOTION, MANUAL, etc.)
reason	string	No	Optional description or reason for the discount
amount	number	Yes	Discount value (in smallest currency unit, e.g., cents or kuruş)
sourceId	string	No	Optional identifier for the source (e.g., campaign ID, asset ID)

Sample Payload

{
  "type": "LOYALTY",
  "reason": "Birthday Reward",
  "amount": 500,
  "sourceId": "BIRTHDAY-2025"
}

Related Use Cases

• Reporting discounts applied through /transaction
• Displaying applied benefits in member receipts or records
• Tracking benefit engine outcomes (e.g., birthday campaigns, combo deals)