Prizeout is a third-party gift card provider. A Prizeout redeem option lets a user exchange tokens for a gift card from Prizeout's marketplace.
Prerequisite
Prizeout integration requires you to be a Prizeout customer. If you don't already have an account, visit Prizeout to get started.
Configuration Steps
To set up a Prizeout redeem option, go to Redeem > Options, select Create, then select Prizeout. The sections below describe how to configure a Prizeout redeem option.
Add a Title and Description
Enter a Title and, optionally, a Description.
Configure the Widget Settings
Under Widget configurations, enter the following. These values are used by the loyalty widget to start the redemption process:
Partner Name: Your business name as it's registered in your Prizeout account. Take this from your Prizeout account.
Partner ID: Your Prizeout account's unique ID. Take this from your Prizeout account.
API Key - Active: The API key for your Prizeout account. The Xtremepush widget uses this to authenticate with Prizeout when it loads.
Environment: Choose whether the widget uses one of your Prizeout sandbox accounts, for testing, or your live Prizeout production account. The loyalty hub still treats sandbox redemptions as real, so tokens are deducted from the user's balance.
Conversion Rate: Your users hold tokens, which have no fixed value on their own. This rate sets what one token is worth in US dollars, and so determines how many tokens a user needs to redeem a gift card of a given value.
Session Token Cap (optional): If you want to cap the number of tokens a user can redeem in a single session, set that limit here.
Allowed Countries: Specify the countries this redeem option is available in, using the ISO 3166-1 alpha-2 format, for example
US.Product Image URL (optional): Upload a logo or image associated with this redeem option, which is then displayed on the widget.
Group (optional): Group this redeem option with others, both in the Redeem Options list and on the widget, by giving it a label, for example
Entertainment.
Configure the Private Settings
The private configuration gives Xtremepush the credentials it needs to call Prizeout on your behalf, and optionally lets Xtremepush notify your own backend whenever a user cashes out. Under Private configurations, enter the following:
Secret Key: Take this from your Prizeout account. It's the primary active key Xtremepush uses for backend API calls to Prizeout.
Security Token: Take this from your Prizeout account. Xtremepush sends it as a parameter with every HTTP callback, so Prizeout can identify the request.
Cashout Request Webhook URL (optional): The
httpsURL on your own server where Xtremepush sends aPOSTrequest whenever a user cashes out, so your own systems know a cashout has happened.Cashout Request Authorization Header (optional): If you're using a Cashout Request Webhook URL, you can also set this for extra security. Xtremepush sends it as an HTTP
Authorizationheader with each cashout request, so your server can confirm the request genuinely came from Xtremepush.
Set User Requirements
If you want this redeem option to only be visible to certain users, set up the user requirement here, using Add Requirement. By default there are no requirements, so the redeem option is visible to everyone.
Once you set a user requirement, decide whether users who don't qualify should still see this redeem option. Select Show to users who don't qualify to display it to everyone, along with a Not qualified message that explains why they can't use it yet. For example, if this redeem option is only available to Level 3 players, Level 1 and Level 2 players still see it, along with a message such as Complete more quests to unlock. The checkbox and the message work together: the checkbox controls whether ineligible users see the option at all, and the message tells them what they need to do.
You can also select Set usage limit to cap how many times this redeem option can be used, in total, across all users. Once the limit is reached, decide whether users should still see it: select Show to users when option limit is 0 to keep it visible, along with a message explaining that it's no longer available. This works the same way as Show to users who don't qualify: the checkbox controls visibility, and the message explains the situation.
Configure Widget Events
Decide what happens when a user finishes redeeming. Set Redirect After Completion to a deep link or route, for example https://deep.link.example.com/redeemCompleted, {"route": "redeemCompleted"}. The widget then sends a redirect event that your application can listen for, to take the user to the page you specify.