Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/Rahat-Pagecode/gitbook-competitions/llms.txt

Use this file to discover all available pages before exploring further.

Scratch Cards and Spinner are two of the most popular minigames on the platform. Both overlay a visual reveal experience on top of your existing Instant Prize competitions, replacing the standard win/loss screen with an interactive moment customers look forward to. This guide covers setup, customisation, and customer-facing behaviour for both games.
The Minigame Plugin must be installed on your website before either game will function. Contact support if you need help with installation.

​
Scratch Cards

Scratch Cards give customers a virtual card to scratch away, revealing whether they’ve won. You can customise the reveal images and the scratch overlay graphic to match your brand.

​
Setting Up Scratch Cards

1

Open the competition editor

Go to your product list and click Edit on the competition you want to apply Scratch Cards to. This must be an Instant Prize competition.
2

Locate the Mini Games box

Scroll down on the right-hand side of the editor until you find the Mini Games box.
3

Select Scratch Cards

Click Choose a game and select Scratch Cards from the dropdown. Save the competition.
4

Test the experience

Purchase a test ticket. Instead of the standard instant win reveal, the customer will now be presented with a scratch card they need to scratch to see their result.
Once Scratch Cards is enabled on a competition, every ticket purchased will trigger the scratch card flow — including tickets bought before the change if the customer hasn’t played them yet.

​
Customising Your Scratch Cards

You can personalise Scratch Cards in several ways from Minigames → Settings in your admin panel.

​
Happy and Sad Reveal Images

Upload images to your Media Library and paste the URLs into the relevant boxes:
  • Positive image — shown when the customer scratches a winning card.
  • Negative image — shown when the customer scratches a losing card.
These images appear as soon as the customer finishes scratching, before the full prize details are shown.
If no image is selected, the reveal will default to the product image every time a card is scratched.

​
Default SVG Overlay

You can set a custom SVG that replaces the default grey scratch surface shown before a customer scratches. This is a great way to add your logo or a branded pattern to the unscratched card.
We recommend contacting support if you need help adding a custom SVG — for example, embedding your logo into the grey scratch layer.

​
Free Scratches

When setting up the minigame mode on a competition, you can optionally enable Free Scratches. This allows customers to claim a free scratch without purchasing a ticket, which can be a useful acquisition or engagement tool.
Free Scratches are configured in the same Mini Games box where you choose the game type — look for the free scratch/spin option directly below the game selector.

​
How Customers Access Their Scratch Card

Customers can open their scratch card in two places:
  • Product page — a button appears above the Add to Cart button on any competition with Scratch Cards enabled.
  • Thank You page — after completing a purchase, the button is shown on the post-checkout confirmation page so customers can scratch immediately.
Each ticket a customer purchases adds one scratch card to their account. If they have multiple unplayed cards, they can scratch them one at a time at any point.

Build docs developers (and LLMs) love

Get started for freeTalk to us