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.

The Payouts plugin integrates seamlessly with Instant Prizes to create a structured, self-service claim experience for winners. Once installed, every instant prize win is automatically moved to the Payout portal — even prizes with no cash value — giving winners a clear path to claim their reward while significantly reducing the manual work on your end.

​
How It Works for Winners

When a customer wins an instant prize, they can visit the My Payouts section under their account to view all their wins and initiate a claim. Each prize may offer up to three options depending on how you’ve configured it.
Setting a Site Credit alternative slightly above the retail value of a prize encourages winners to choose instant site credit, saving you the time and cost of dispatching physical prizes or processing cash transfers.
When a winner clicks Claim, they are presented with their available options:
  • Exchange for Site Credit — rewarded instantly to their account.
  • Cash Payout — opens a payout request form.
  • Physical Prize — opens a delivery details form.

​
Setting Up a Payout Prize

1

Open the Instant Prize setup

Navigate to the Instant Prize configuration area where you normally create or edit an instant win.
2

Fill in the payout fields

In addition to the Prize name, complete the Site Credit Payout and Cash Payout fields to define the alternatives available to winners.
3

Save and go live

Once saved, the payout options will appear automatically in the winner’s claim flow the moment they win.
Cash Payouts can be routed directly to Wallet Cash, where customers can choose to convert their cash into site credit or withdraw it to their bank account.

​
Physical Prize Requests

When a winner selects the physical prize option, a delivery details form is presented. If the customer has previously submitted a physical prize request, the form is pre-filled with their stored details so they don’t have to re-enter their information each time.
If a winner closes the tab before submitting the form, their claim is not lost. A Submit Claim button will remain visible the next time they visit their Payouts page, allowing them to complete the submission at any time.
Once the form is submitted, a notification email is sent to the email address you use for Instant Prize win alerts, keeping your existing workflow intact.
This email notification can be disabled if you prefer to manage all prize claims entirely through the Winner History dashboard.
The notification email includes a unique Claim ID that you can paste directly into the Instant Prize History search bar to retrieve full order details for that winner.

​
Variant Prizes

For prizes that come in multiple variants (for example, a clothing item available in different sizes), you can add a dropdown selector to the physical prize payout form. This variant selection only applies to physical prizes — it is not available for cash alternative payouts.

​
Main Prize Payouts

The Payouts system also supports main competition prizes, not just instant wins. When you add a main prize as a payout, the reward is distributed to each main prize winner individually.
If a main prize is shared between multiple winners, divide the prize value before adding it as a payout. The system will issue the configured amount to every winner independently.

​
Identity Verification

An optional identity verification add-on is available to confirm the age and identity of winners who choose a cash or physical prize. Verification requires a passport or driving licence along with a selfie.
Winners can still claim site credit alternatives without completing identity verification. Verification is only required when choosing a cash or physical prize.
If a customer attempts to claim a cash or physical prize before verifying their identity, they will be prompted to complete verification first. Once verified, their status is displayed at the top of their account, and key verification details are surfaced in the Winner History to reduce the need for manual identity checks.

​
Manually Approving Customers

Go to Verifications in the admin menu to review all verification submissions. From there you can manually approve or decline individual customers. This is useful when a face-match score is low or when information is missing from a submission. Customers who are declined can reapply at any time using a different form of ID or a clearer selfie.

​
Auto Payouts

Auto Payouts integration allows cash payments to be processed within minutes without any manual admin involvement. Customers connect their bank account via the Payouts portal, and payments are dispatched automatically.

​
Global Instants

Global Instants let you create a single instant prize configuration that is shared across multiple live competitions simultaneously, saving setup time and allowing you to make bulk updates in one place.
If you use a fulfilment centre for physical prizes, you can configure Global Instants to automatically email your fulfilment provider when a physical prize is claimed.
A Global Instant can also offer multiple physical prize alternatives in a single payout, for example combining a cash payout, a site credit option, and a choice of physical prizes within the same instant win. Winners are presented with all available options when they make their claim.

​
Setting Up a Global Instant

1

Navigate to Global Instants

Go to Competitions → Global Instants in your admin menu.
2

Configure the prize

Fill in the fields exactly as you would for a standard instant win, including all desired payout alternatives and any physical prize variants.
3

Assign to competitions

Link the Global Instant to the competitions where it should appear. Any future updates to the Global Instant will apply across all linked competitions automatically.

Build docs developers (and LLMs) love

Get started for freeTalk to us