Integrate Promotions and Virtual Currency in Shift4 Venue

Description: This guide explains how third-party developers can integrate with Shift4 Venue to manage eligible promotions and virtual currency (also known as stored value) for user accounts.

Use the Account Identifier

Use the same account identifier that the user uses to sign in. There are two primary integration scenarios:

VN SDK in a Third-Party App

• The app provider controls the account ID.

• Use the same account ID to manage promotions and virtual currency.

STVenue Mobile Web Ordering

• Supports three sign-in options: Ticketmaster, AXS, or Phone Sign-In.

• For Phone Sign-In, the account ID is the user’s phone number (e.g., +12121231987).

Manage Promotions

Shift4 Venue’s external promotions APIs support full CRUD (Create, Read, Update, Delete) functionality:

• Create a Promotion

• View Promotion Details

• Update a Promotion

• Delete a Promotion

Promotions can also be managed in the Shift4 Venue Canopy tool.

Assign Promotion Eligibility

Once a promotion is created and has a UUID:

• Use the Promotion Eligibility API to assign it to specific accounts.

• Promotions will automatically apply in the cart if eligible items and rules are met.

Manage Virtual Currency

Get an Account Balance

Use the Get Account Balance API with an account ID to retrieve:

• Account balance

• Email address

• Name

• Account creation date/time

• Organization’s virtual currency name (e.g., Buzz Bucks)

Note: This API is for single-account lookups only. Use the Kinesis stream below for real-time updates or large-scale access.

Adjust a Balance (Credit or Debit)

Use the Bulk Adjust API for both credits and debits:

• Debits (e.g., purchases or transfers): Pass a negative amount (e.g., -10).
  Note: The user’s balance will not drop below $0.

• Credits (e.g., refunds or rewards): Pass a positive amount.

Subscribe to Real-Time Updates

To monitor balance changes in real time:

• Subscribe to the Debits & Credits Kinesis Stream.

• Do not use the Get Account Balance API for near real-time updates.

Reporting via DataNow

The following reports are available in DataNow:

• Configured Promotions: Use the Promotion Details export.

• Promotion Usage: View in the F&B Sales Dashboard.

• Virtual Currency Balances and Usage: View in the Wallet Accounts Dashboard.