---
title: "Scratchcards"
slug: "scratchcard"
updated: 2026-08-25T14:23:02Z
published: 2026-08-25T14:23:02Z
canonical: "docs.xtremepush.com/scratchcard"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.xtremepush.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Scratchcards

## Game Overview[](/docs/scratchcard#game-overview)

*Scratchcards* is a casino-style game in which players scratch tiles on a card to reveal matching images. Revealing enough matching images wins the player a prize.

The video below shows an example of a *Scratchcards* game with 3 available prizes:

[Embedded content](https://app.screencast.com/PJ8SIYAeObruI/e)

Each prize in a *Scratchcards* game has its own required number of matches, set independently in its **Matches Required** field. For example, one prize might require 2 matches, another 3, and another 5. You can give every prize the same number of matches if you want a consistent requirement across your game. This is simply a choice of values, not a separate configuration mode

Within the set of prizes a player is eligible for, which can be restricted by customer segment, the likelihood of winning each prize is determined by its weight. Prizes can also be capped by total volume and by daily or weekly limits. For more information, see [Prizes in Scratchcards](/documentation/docs/scratchcard#configure-prizes) below.

The game comes with a ready-to-use template, which you can select when creating your campaign. You can fully customise the game's appearance by replacing default assets, such as cards, backgrounds, and sounds, to match your brand's requirements.

The entire game is built and managed within the Xtremepush platform and can be embedded directly on your website.

## Prerequisites of Game Setup[](/docs/scratchcard#prerequisites-of-game-setup)

- User Segments: To target your game to specific players, you'll need pre-configured segments. These must be created on the Xtremepush platform before you start. For more information, see [Before You Create a Game Campaign](/documentation/docs/before-you-create-a-game-campaign).
- Game Assets: Have your game assets prepared. These include images for the game background, cards, and other branded elements.

## Setup Process Overview[](/docs/scratchcard#setup-process-overview)

The following sections provide a high-level overview of the steps required to set up a Scratchcards game:

### Create Campaign

Define the rules of your new game.

✏️

🎨

### Customise Design

Replace assets and update texts.

### Configure Mechanics

Configure prizes and optional time slots.

⚙️

🚀

### Launch & Monitor

Embed your game and view player activity.

## Create your Game Campaign[](/docs/scratchcard#create-your-game-campaign)

The first step in creating your game is creating a game campaign. A campaign acts as the container for your game, allowing you to define crucial aspects like target audiences, campaign duration and more. It also contains your game’s design, text, and prize configurations.

For more information on the required fields when setting up campaigns, see [Create a Game Campaign](/documentation/docs/create-a-game-campaign)

Selecting a template automatically loads a complete layout file and the necessary assets into your campaign's **Assets** tab. This streamlines configuration, allowing you to easily replace the default assets with your own without needing to build the game's layout from scratch.

## Make Design Changes to your Game[](/docs/scratchcard#make-design-changes-to-your-game)

After creating the campaign, the next step is to customise the game's visual design and text to match your brand. This involves three key areas:

- Replace or Add Assets : The template you select provides a standard asset pack, which includes default images for the background, cards, and prizes. You have two options for customisation:
  - You can replace any of the default assets with your own branded versions. For more information, see [Replace Assets](/documentation/docs/replace-assets).
  - You can also add new assets that are not part of the standard pack. For more information on adding new assets, see [Manage Assets](/documentation/docs/manage-assets). For a general overview on game assets, see [Assets Overview](/documentation/docs/assets-overview)
- Update Game Texts: In the **Texts** tab, you can update all the standard text that appears in your game's interface. However, the text displayed when a player reveals a specific prize is configured separately in the **Prizes** tab. For more information, see [Update Texts](/documentation/docs/update-game-texts)
- Make Design Changes in the Editor: For granular control over the game's front-end appearance, use the Editor. It allows you to make detailed visual adjustments, such as resizing or repositioning elements, modifying fonts and colours, or adding new components. For more information, see the following pages:
  - [Editor Overview](/documentation/docs/editor-overview)
  - [Editor Use Cases](/documentation/docs/handle-prize-redirects-from-your-website)
  - [Customise a Game Grid](/documentation/docs/customise-a-game-grid): See this page to add or remove cards from the grid in your *Scratchcards* game. To make changes to the available cards, go to **Editor** > **Layout** > **Card**.

## Configure Game Mechanics[](/docs/scratchcard#configure-game-mechanics)

### Configure Prizes

In the **Prizes** tab, you configure the prizes available in your game and map them to the prize-winning cards. For more information the different prize configuration fields, see [Configure Prizes](/documentation/docs/configure-prizes).

When configuring a prize, the three key fields are:

- **Prize Reference**: Links the prize you are configuring to a prize-winning card in the game. If you are using the game template, you must map each prize to **Prize 1**, **Prize 2**, or **Prize 3**, as these are the only prize-winning cards available. See [Prize References](/documentation/docs/scratchcard#prize-references) below for more information.
- **Matches Required**: The number of matching cards a player must receive to win this prize.
- **Weight**: Determines the likelihood of a player winning this prize by revealing the correct match. The chance of winning a prize is based on its weight relative to the total combined weight of all prizes available for that customer segment. A higher weight means a higher chance of winning.

> [!NOTE]
> **No-Win Outcomes**
> 
> You can configure a no-win prize for your game to handle no-win scenarios.
> 
> 
> 
> To do so, create a new prize and enable the **No win** toggle.
> 
> - For this no-win prize, configure a **Weight** in the same way as any other prize. This weight determines how likely your players are to not win any of the prizes you've configured.
> - You don't need to set **Matches Required**, since a no-win prize covers all no-win scenarios by default.

#### Prize References

Each prize you configure must be mapped to a prize reference, which links it to a specific card in the game. If you've selected the template when creating the campaign, you'll have six prize references available when configuring a prize, split between prize-winning and non-prize cards:

You can view all the cards available in your game under **Editor** > **Settings** > **Prize** > **References**:

![Configuration settings for prize tiles in a user interface layout.](https://cdn.document360.io/b056e88b-f6c1-4bd2-b5b8-08e9336a17c9/Images/Documentation/Screenshot 2026-07-16 at 14.30.24(1).png?sv=2026-02-06&spr=https&st=2026-08-25T13%3A35%3A43Z&se=2026-08-25T13%3A50%3A43Z&sr=c&sp=r&sig=aQXMc4eCJA%2B8gzMCbXqqWQ1NUQS9YsgtNLE4gB1daOc%3D)

- **Prize 1 to Prize 3** are your prize-winning cards.
- **Prize 4 to Prize 6** are your non-prize cards.

To change a non-prize card into a prize card, go to **Editor** > **Settings** > **Scratchcard**. In the **Dummy Symbols** section, you can see each non prize card along with the maximum number of times it can appear in a game:

![Scratchcard configuration settings including size and dummy symbols for prizes.](https://cdn.document360.io/b056e88b-f6c1-4bd2-b5b8-08e9336a17c9/Images/Documentation/Screenshot 2026-07-16 at 17.03.01.png)

> [!NOTE]
> **Card Size and References**
> 
> In the image above, **Size** (9) is the total number of tiles on the scratchcard grid. In the game template, **Size** is set to 9, giving a 3 by 3 card. Size is not related to the number of prize references or the paytable.

#### Example Prize Pool Configuration[](/docs/scratchcard#example-prize-pool-configuration)

The table below shows an example prize configuration for a game with three customer segments:

| **Prize** | **Prize Reference** | **Matches Required** | **Weight (VIP)** | **Weight (Standard, New User)** |
| --- | --- | --- | --- | --- |
| €20 Grand Prize | Prize 1 | 5 | 5 | 2 |
| €5 Bonus | Prize 2 | 3 | 20 | 15 |
| 5 Free Bets | Prize 3 | 2 | 25 | 20 |
| No Win | NA | NA | 25 | 45 |

In this example, *5 Free Bets* has a weight of 25 out of 75 for VIP players, making it more likely to be won than the *€20 Grand Prize*, which has a weight of 5 out of 75.

### Manage Time Slots[](/docs/scratchcard#manage-time-slots)

You can control your game's daily availability by setting up specific time slots when it can be played. For example, you could make the game available only during a 'happy hour' promotion from 5 PM to 7 PM.

For more information, see [Manage Time Slots (Optional)](/documentation/docs/manage-time-slots-optional).

## Launch and Monitor Game[](/docs/scratchcard#launch-and-monitor-game)

### Launch your Game[](/docs/scratchcard#launch-your-game)

To launch your game, you must embed it on your website. For added security, you can also use a JWT token to ensure that only authenticated users are able to play.

For more information, see the following pages:

- [Launch your Game](/documentation/docs/launch-your-game)
- [JWT Authentication Details](/documentation/docs/jwt-authentication-details).

### Monitor Player Activity[](/docs/scratchcard#monitor-player-activity)

The Xtremepush platform automatically tracks the following engagement data for the *Scratchcards* game, which you can view in the **Games** tab of your campaign:

- A record of every user who played the game.
- Timestamps for when the game was opened (**Created At**) and when a card was revealed (**Opened At**).
- Details on which users won a prize.
- Timestamps for when a prize was accepted or declined.