Paytronix Implementation Notes
This document describes details about the interaction between NorthStar Order Entry and Paytronix's Web Services.
Table of Contents
Paytronix Operations
Order Entry can invoke the following Paytronix operations.
| Paytronix Operation | Order Entry Operation |
|---|---|
activateAdd | Order a menu item with any of the following types:
|
addRedeem | Order a menu item with any of the following types:
Redeem a gift card. Redeem a comp or loyalty reward. |
activate | Use the "Activate comp" button from the Location Menu. |
Wallet Configuration
Paytronix must create wallets to support programs that the merchant wants to create. NorthStar Order Entry imports this configuration when the "Update" button is pressed in ECM.
$10.00 to spend on any food
- A wallet in Paytronix with the following properties:
- Wallet Type: Redeem
- Reward Type: Open Amount
- Value Type: Dollar Discount
Free Spinach and Artichoke Dip
- A wallet in Paytronix with the following properties:
- Wallet Type: Redeem
- Reward Type: Fixed Amount
- Value Type: Percent Discount
- Value Amount: 100.00 (this field is not visible in Paytronix's website)
- POS Item Type: 4 (Menu Item)
- POS Item ID: External code of the Spinach and Artichoke Dip
Free Appetizer
- A wallet in Paytronix with the following properties:
- Wallet Type: Redeem
- Reward Type: Fixed Amount
- Value Type: Percent Discount
- Value Amount: 100.00 (this field is not visible in Paytronix's website)
- POS Item Type: 2 (Major Group)
- POS Item ID: External code of the Appetizers menu item category
Accrual
Keeping track of dollars spent
A wallet in Paytronix with the following properties:
- Wallet Type: Add
- Reward Type: Open Amount
- POS Item Type: 1 (Whole Check)
- POS Item ID: 1
Keeping track of number of times a specific item is ordered
A wallet in Paytronix with the following properties:
- Wallet Type: Add
- Reward Type: Fixed Amount
- POS Item Type: 4 (Menu Item)
- POS Item ID: External code of the menu item
Points and Conversion to Rewards
NorthStar Order Entry has no control over points, nor does it control how points are converted to rewards. This is entirely controlled by "rules" on the Paytronix end.
Usually there will be at least three wallets involved:
- An "Add" wallet which keeps track of what the guest has purchased
- A "Points" wallet which keeps track of points
- A "Redeem" wallet which keep track of rewards that the guest can use
The workflow is:
| Controlled by NorthStar Order Entry | Controlled by Paytronix (Rules Engine) |
|---|---|
| Add value to a loyalty card's "Add" wallet based on what the guest purchases. | -- |
| -- | Adds value to the "Points" wallet based on the balance of the "Add" wallet. |
| -- | Adds value to the "Redeem" wallet based on the balance of the "Points" wallet. |
| Allows discounting items by redeeming from the "Redeem" wallet. | -- |
Excluding items
Paytronix wallets have a "POS Definition" field which they use to communicate which items/categories are excluded from programs. The Product Description must be a JSON object with the following structure (fields are optional):
{
"excludedItems": [1, 2, 3],
"excludedCategories": [1, 2, 3]
}
The excludedItems property is an array of Menu Item external codes.
The excludedCategories property is an array of Menu Item Category external codes.
If an item is excluded from a Redeem wallet, then that item may not be discounted by using that wallet.
If an item is excluded from an Add wallet, then when accruing, Order Entry will ignore any excluded items when calculating the amount to accrue.