Paytronix Configuration

Table of Contents

Summary

Supported Paytronix Features

  • Gift cards

    • Activating a new card with a specified balance.
    • Adding value to the "Stored Value" wallet of an existing card
    • Redeeming from the "Stored Value" wallet of an existing card

  • Comp cards

    • Redeeming comp cards
      • Redeeming from a wallet that contains a dollar amount (Paytronix calls this an "open amount" wallet).
      • Redeeming from a wallet that contains a "number of uses" value (Paytronix calls this a "fixed amount" wallet).
    • Activating comp cards
      • Activating a card, specifying a value for a particular wallet.
      • Activating a card without specifying any wallets (Paytronix creates rules that load the card automatically).

  • Loyalty Cards

    • Creating new loyalty cards
      • Using a physical card, by entering a card number when creating a customer.
      • Creating a loyalty account without using a physical card (Paytronix calls this a "virtual card").
    • Tracking guest purchases
      • We tell Paytronix each time a loyalty card is attached to a check. (Paytronix calls this "identify customer").
      • Adding a dollar-value to an "Add" wallet when a check is closed with a loyalty card attached. (Adding to a "open amount" wallet).
      • Adding a quantity-value to an "Add" wallet when a check is closed with a loyalty card attached. (Adding to a "fixed amount" wallet).
    • Redeeming rewards
      • Redeeming from a wallet that contains a dollar amount (Paytronix calls this an "open amount" wallet).
      • Redeeming from a wallet that contains a "number of uses" value (Paytronix calls this a "fixed amount" wallet).

Configuration

Contact Paytronix to authorize NorthStar Order Entry

Paytronix must allow CBS to access the merchant's Paytronix account. Contact Paytronix's Integrations Team at (617) 649-3300. and deliver this message:

"This is <your name>. We are implementing NorthStar Order Entry for <merchant name> and we need our B2B REST credentials to have access to that merchant. Please ask the Paytronix Integrations Team to enable this for us.

Remember to ask for the Integrations team.

Please give Paytronix at least 1 week notice before you plan to continue.

If this is not completed, all Paytronix transactions will return the error "Contact Paytronix to authorize NorthStar Order Entry".

Firewall:

Sites may need to add the Paytronix URL to their firewall settings to allow NSOE to send info to Paytronix: Api.pxsweb.com

Site Settings

Retrieve the following information from Paytronix:

  • Whether the site uses Gift, uses Comp/Loyalty, or uses both.
  • The merchant's Merchant ID
  • Each site's Store Code
  • The BIN ranges used by this merchant for gift and/or loyalty cards
  • The card template code of the merchant's loyalty cards (only if using loyalty)
  • The Paytronix environment (Production or Fuji – choose Production unless Paytronix staff directs you otherwise).

All this information must be added to each site's Payment tab (reference: Payment - 4.0 and prior).

Wallets

Paytronix creates groups for the restaurant called wallets; these can include objects such as "Stored Value", "Number of hamburgers purchased" and "Free appetizers". The wallet below is an example of what a real wallet would look like.

(Pic from Paytronix website setup - assistance from Paytronix Support team for this)

POS Item TypePOS ITEM IDDescription
  • 2 (Major Group)
  • 3 (Minor Group)
Menu Item Category external code in ECMIf the POS Item type is set to 2 (Major group), then any item in the menu item category where the external code matches the POS Item ID in paytronix would qualify for that wallet type.
4 (Menu Item)Menu Item external code in ECMIf the POS Item type of 4 (Menu Item), then any item where the external code matches the POS Item ID in paytronix would qualify for that wallet type.
1 (Whole Check)We ignore thisApplies the value type to the whole check. If any categories are excluded in the POS Definition, we will not apply the check to those values.

Import Loyalty Programs from Paytronix

Once the sites have been configured, click "Update All Sites" on the Loyalty Programs page (reference: Loyalty Programs - archived). This will import the wallet configuration from Paytronix. If anything seems incorrect, it should be changed through Paytronix. "Update All Sites" must be clicked each time a change is made in Paytronix for it to be applied to Enterprise Content Management.

This is how the wallet appears in Enterprise Content Management.

Enterprise Content Management Configuration

Menu Item Categories

For this example, we will use “Comp dollars 15.” The menu item category can be named anything as desired.

This category will be used for the free salad loyalty reward. To associate the menu item category with free salads, the category's external code must match the POS Item ID corresponding to the item found in Paytronix (15 in this example).

To configure the menu item category in Enterprise Content Management, click the next to the category. Enter the external code and click Save.

Publish changes.

Operation

To redeem a loyalty reward, a customer with the reward must be attached to the location. Tap the blue person icon to open the Rewards window.

Enter the customer's information to attach their account to the table.

Tap View Rewards to view the rewards on the customer's account.

For this account, there are 101 free salads available for redemption.

Order the item from the corresponding item menu category.

After the item has been added to the check, tap Payment.

The Rewards for Check <check number> window will display. Tap the category you wish to redeem from.


Tap the item from the category. To redeem the item, tap Redeem at the bottom of the window to display a confirmation pop-up.

Tap Redeem on the pop-up to confirm the redemption.

The item has been comped. The effect on the item depends on how Paytronix has configured the reward.

Miscellaneous

 If you receive the message "Please contact Paytronix to authorize NorthStar Order Entry", then Paytronix is denying Order Entry access to the merchant. Only Paytronix's Integrations Team can fix this problem (assuming the merchant ID and store code are correct in ECM).

The "Connectivity Status" page in Paytronix's merchant port has no meaning with Order Entry. Sites may show red or green, but that does not affect Order Entry's ability to communicate with Paytronix.

Glossary of Paytronix terminology

WalletA single card can have multiple "wallets" stored in it. Example names of wallets are: "Stored Value", "Number of hamburgers purchased", "Free Appetizers".
"Stored Value" wallet

This is the gift card balance. Usually a card will EITHER have a Stored Value wallet OR Redeem wallets, but not both. This is because usually a card is EITHER a gift card OR a comp/loyalty card, but not both.

However, some merchants allow a loyalty card to be used as a gift card, so this isn't always true.

"Redeem" wallet

Contains a value that can be redeemed for products at the POS.

Examples:

  • A wallet called "Free Appetizers" might automatically add a discount to an appetizer. Each time this wallet is used, "1.0" is deducted from the wallet.
  • A wallet called "Comp Dollars" might contain a dollar amount that discounts any items.
"Add" wallet

Keep track of what a guest has purchased.

Examples:

  • A wallet called "Dollars Spent" probably keeps track of the total dollar value a guest has purchased.
  • A wallet called "Desserts Purchased" probably keeps track of the quantity of desserts a guest has purchased.
Rules

Paytronix creates rules that automatically run when certain things happen. These are usually to create reward programs such as "Buy $100 and get a free appetizer" or "Earn 20 points for every dollar you spend."

Rules are all implemented on Paytronix's side. NorthStar Order Entry does not have information regarding these rules.

Examples:

  • When the "Dollars Spent" wallet gets to $100.00, reduce its balance by $100.00 and add 1.0 to the "Free Appetizer" wallet. This means "Get a free appetizer for every $100 you spend."
  • When the "Hamburgers Purchased" wallet is incremented by 1, add 20 to the "Points" wallet. This means "Buying a hamburger earns you 20 points."
  • When the "Points" wallet gets to 1000, add 1.0 to the "Free Dessert" wallet. This means "Get a free dessert for every 1000 points you earn."