Home Page
Get started
About Xsolla
Solutions
Web Shop
Overview Integration flow Demo walkthrough
Catalog and items
Create project Import item catalog from JSON file Import item catalog from external platforms Set up catalog manually Automatic catalog update via API Grant purchases to user Set up subscription sales
Create Web Shop
Legal aspects Create site and customize main blocks Localization Set up user authentication Publish news articles on your site Set up Progressive Web Application
Promotions
Personalization Free items Featured offers Discount promotions Bonus promotions Promo codes and coupons Time limited and number limited offers Daily rewards Reward system Offer chain Referral program First Login Reward via PWA Using query parameters
Test and publish Web Shop
Test Web Shop in sandbox mode Publish Web Shop Access restrictions Test Web Shop in live mode
Analytics
Integration with AppsFlyer Integration with Adjust Integration with Singular Connecting analytics services
Buy Button for mobile games
Overview Enable Buy Button via link-outs to Web Shop Enable Buy Button via Mobile SDK Enable Buy Button with custom checkout
Payments
Overview Integration scenarios
Generation of payment token on client side
Get started Create and set up project in Publisher Account Authenticate users in your application Get catalog on client side of application Set up item purchase Set up order status tracking Launch
Generation of payment token on server side
Get started Create and set up project in Publisher Account Get catalog in your application Set up item purchase Set up order status tracking Launch
Catalog configuration
Catalog creation Catalog import Personalization
Customization
Payment UI theme customization Design guidelines Receipt email customization
Promotions
Coupons Bonus promotions Discount promotions
Payment UI management
Payment UI localization Payment methods setup Top payment methods management Redirects configuration Tokenization Event analytics
Anti-fraud
Overview Anti-fraud setup Anti-fraud analytics in Publisher Account Chargeback Chargeback and dispute fee
Cloud Gaming
Overview Integration flow
Integration guide
Prerequisites Uploading game build in Publisher Account
How-tos
How to manage game streams and pricing How to work with promotions How to delete game How to set up virtual gamepad How to enable voice input
Features
Allowlist Cloud game keys sale Play Now button
Digital Distribution Hub Loyalty as service
XPS
Build your publishing platform
Overview Set up publishing platform using headless CMS Create multi-page site to sell your games
Sell virtual goods in-game or online
Overview Use F2P template Use your own UI
Prerequisites
Create project Sign licensing agreement Pass tax interview
Sell game keys
Overview Integration flow
Prerequisites
Create project Sign licensing agreement Pass tax interview
Catalog
Create game keys packages Create bundle with game keys
Create site
Create site and customize main blocks Localization Test site in sandbox mode Access restrictions Publish site Analytics for the website Test site in live mode Publish news articles on your site
Set up authentication
Set up authentication when selling game keys
Set up selling game keys
Set up selling game keys Set up webhooks Get user order status
Promotions and other features
Bundles Pre-orders Discount promotions Bonus promotions Promo codes Coupons Offer chain Upsell Item attributes Personalization Free game keys Local prices Keys sale restrictions Regional sale restrictions Limiting the display time for items in the store Number limited offers Entitlement system
Launch pre-orders Deliver a game with Launcher Set up a cross-platform monetization
Products
Pay Station
Overview
Features
One-click payment Gateways Anti-fraud setup Tokenization Refund Event analytics Payment UI theme customization Management via Publisher Account Localization Payments in compliance with Content Security Policy (CSP)
How-tos
How to manage top payment methods How to set up payment method How to open payment UI How to open payment UI in mobile application How to customize Pay Station How to configure redirects How to open external browser from game launcher How to customize emails to users How to get payment token
References
Design guidelines
Shop Builder
Overview
Integration guide
Get started Use ready-to-use solutions Create project Create catalog in Publisher Account Set up webhooks Legal aspects Set up selling items Integrate store into game Set up promotional campaigns
Features
Virtual items Virtual currency Bundles Free items Number limited offers Time limit for displaying items in store Item attributes Coupons Promo codes Unique catalog offer Upsell Bonus promotions Discount promotions Personalization Local prices Regional sales restrictions Daily rewards Reward system Offer chain Referral program
How-tos
How to create and update an item catalog using JSON import How to group bundles in catalog How to import catalog How to group and sort items in catalog How to encourage users to make first purchase How to provide users with daily rewards How to create items not for sale How to automate catalog updates
Extensions
Integration with PlayFab
Tutorials
Item catalog personalization
Subscriptions
Overview
Integration guide
Get started Create project Set up subscription plan Set up user authentication Set up subscription catalog display and purchase Get subscription information Legal aspects
Features
Grace period Retry period Gift subscription Subscriber account
How-tos
How to cancel last payment if subscription is canceled How to allow a user to change a subscription plan How to change the charge amount for an active subscription How to manually renew subscriptions How to set up bonuses How to set up coupons How to avoid fraud How to increase first payment for subscription How to set up selling multiple plans or subscriptions for a single user How to set up subscription-based products and plan groups
Site Builder
Overview
Quick start
Get started Blocks Create project Create site Legal aspects Create Web Shop for mobile games How to create site for game sales Access restrictions
Store
How to configure site to sell goods Possible items Test site in live mode
Content
How to publish news articles on your site How to manage website pages
Localization
Localization How to display content depending on site language
Design
How to use custom fonts on your site How to implement parallax scroll How to show images in modal windows
Analytics and promotion
Services and applications How to connect analytics services
Partner Network
Overview
Integration guide
Get started Create project Integrate payment solution Set up payment attribution Create campaign Launch campaign
Features
Promo codes with fixed discount Promo codes with flexible discount Game key distribution Participation guidelines Creator storefront Individual statistics on creators Rosters Reports on rosters coverage Game information
How-tos
How to edit active campaigns How to find and invite creator to campaign How to customize affiliate & affiliate network campaigns How to set up and customize dedicated domain How to set up campaign with Creator tag
References
Attribution types Recommendations for creator campaigns Promo materials for affiliate networks Creator Account
Login
Overview API reference FAQs
Integration guide
Get started Create project Set up Login project in Publisher Account Connect user data storage Integrate solution on application side
Authentication options
Passwordless login Cross-platform account Silent authentication Login with device ID Social login Authentication via your own OAuth 2.0 provider
User data storage
What is it for Comparison of user data storage options Xsolla storage PlayFab storage Firebase storage Custom user data storage Managing the collection of user data
Security
What is it for OAuth 2.0 protocol Single Sign-on JWT signature Email address validation
Customization
What is it for Widget customization JSON files with widget settings Email customization SMS customization
Communication service providers
What is it for Email providers SMS providers
Features
Collecting email addresses and phone numbers JSON to user profile key name map Tracking new users Delayed registration in browser games Displaying authentication statistics User attributes User data import and export Additional features Working with users
How-tos
How to set up a shadow Login project How to export users to Mailchimp How to create Mailchimp merge tags How to integrate User Account How to integrate user authentication via Xsolla account How to use Login Widget SDK API calls
Extensions
Integration with Zendesk Chat Authorization in Xsolla Publisher Account via Okta
Legal settings
Terms and policies Processing of personal data Age restrictions
References
Metaframe
Overview
Integration guide
Create project Sign licensing agreement Set up user authentication via Xsolla Wallet account Set up Metaframe and add it to web application Use Metaframe on site created with Site Builder Explore Metaframe methods and events
Setting up custom sections
General information Iframe mini application Action mini application Button mini application
Setting up Wallet
General information Set up Xsolla Pay Create virtual currency packages in the Publisher Account Set up webhooks Manage virtual currency with API methods Testing How to implement the sale of Metaframe virtual currency in your UI
Setting up Backpack
General information Manage user Backpack Set up webhooks with item data
Setting up mobile version
General information How to implement transition of widget to the mobile layout
Launcher
Overview
Integration guide
Get started Create project Create launcher Configure launcher settings Configure game settings Configure content Upload game build Generate installer
Features
Web games distribution Binary patching In-game user authentication Deep links List of ignored files in Build Loader Tabs Game content delivery Offline mode Seamless web-to-game integration
How-tos
How to enable seamless authorization How to transfer user data via launcher installer How to send data to Google Analytics 4 How to connect additional games to the launcher How to integrate Launcher with Epic Games Store How to integrate launcher with Steam How to carry out maintenance of a game How to enable buying games in the launcher How to set up launcher installer name
Extensions
How to use Epic Online Services with Xsolla Login
References
Launcher system requirements
Managing catalog and LiveOps via canvas
Overview
Catalog management
General information Create group Create item Import and export the item catalog in JSON format Import item catalog from external platforms Import country-specific prices from CSV file
LiveOps campaign management
Create bonus promotion Create discount promotion Create promo code promotion Create personalized catalog
For payment providers
Self-integration
Overview Integration flow Implementation
Roadmap
Overview
Developers resources
References
Errors
Integration errors Payment errors Login errors Store errors
Supported currencies Supported countries Supported languages Supported browsers
Payment testing
Sandbox and production environments Test bank cards list
Payment in sandbox mode
Payment with bank cards in sandbox mode Payment via Apple Pay in sandbox mode Payment via PayPal in sandbox mode
Real payment testing API reference for sandbox
FAQs
Overview General questions Payment configuration User authentication Xsolla Launcher setup User acquisition
Communication with Xsolla via chat
Overview
Integration guide
Integration with Slack Integration with Discord Integration with Zendesk
Xsolla Partner Ecosystem
API and webhooks
Getting started Pay Station API Shop Builder API Login API Subscriptions API DDH API Webhooks
SDKs & libraries
Available SDKs and libraries Xsolla Mobile SDK
Headless checkout
Overview
Integration guide
Get started Create project in Publisher Account Install SDK Integrate SDK on application side Test payment process in sandbox mode Go live
Configure payment methods
How to get list of available payment methods How to set up payment with saved methods Bank cards Mobile payments E-wallets with redirect Google Pay Apple Pay QR code payment
References
SDK components Receiving payment method data Errors Styles Supported languages
SDK for Unity
Latest versionV 1V 0
Overview SDK reference documentation
Integration guide
Get started Create project in Publisher Account Set up basic Login project Install SDK Set up SDK Set up catalog and subscription plans Integrate SDK on application side Test payment process in sandbox mode Go live
BaaS integrations
How to use Pay Station in combination with PlayFab authentication How to use Pay Station in combination with Firebase authentication
Demo project
General information How to use snippets from demo project in your project How to use SDK to configure application UI
Authentication
General information Classic login via username/email and password Passwordless login Social login Authentication via application launcher Authentication via custom ID Silent authentication via publishing platform Xsolla Login widget
Catalog
General information Display item catalog in your application
Subscriptions
General information Subscription purchase scenario Subscription management scenario
Promotions
General information Coupons Promo codes Personalized offers Free items
Item purchase
General information Purchase in one click Purchase for virtual currency Purchase via shopping cart Track order status Payments via Steam
Player inventory
General information Display player inventory in your application Consume virtual items and currencies from player inventory
User account and attributes
General information User attributes User account Account linking
Application build guides
How to create an application build to run in a browser How to change built-in browser
Troubleshooting
Error occurred running Unity content on page of WebGL build The type or namespace name Input.System does not exist Error when calling authentication method Access has been blocked by CORS policy
How to migrate to SDK version 1.0.0 and higher How to migrate to SDK version 2.0.0 and higher
Ready-to-use store (Unity)
Overview
Module usage
Prerequisites Initialization
Customization and advanced settings
Additional parameters for OpenStore() Common customization scenarios
SDK for Windows
SDK for Unreal Engine
Latest versionV 0
Overview SDK reference documentation
Integration guide
Get started Create project in Publisher Account Set up basic Login project Install SDK Set up SDK Set up catalog and subscription plans Integrate SDK on application side Test payment process in sandbox mode Go live
BaaS integrations
How to use Pay Station in combination with PlayFab authentication
Demo project
General information How to use SDK to configure application UI
Authentication
General information Classic login via username/email and password Authentication via device ID Passwordless login Social login Authentication via application launcher Authentication via custom ID Silent authentication via publishing platform Xsolla Login widget
Catalog
General information Display item catalog in your application
Subscriptions
General information Subscription purchase scenario Subscription management scenario
Promotions
General information Coupons Promo codes Personalized offers Free items
Item purchase
General information Purchase in one click Purchase for virtual currency Purchase via shopping cart Purchase of single item Track order status
Player inventory
General information Display player inventory in your application Consume virtual items and currencies from player inventory
User account and attributes
General information User attributes User account Account linking
Application build guides
How to integrate SDKs in projects for Android applications
How to modify SDK
SDK for Cocos Creator
Overview
Integration guide
Get started Create project in Publisher Account Set up basic Login project Install SDK Initialize SDK Set up catalog and subscription plans Integrate SDK on application side Test payment process in sandbox mode Go live
Demo project
General information How to use snippets from demo project in your project
Authentication
General information Classic login via username/email and password Authentication via device ID Passwordless login Social login Authentication via custom ID Xsolla Login widget
Catalog
General information Display item catalog in your application
Promotions
General information Coupons Promo codes Personalized offers Free items
Subscriptions
General information Subscription purchase scenario Subscription management scenario
Item purchase
General information Purchase in one click Purchase for virtual currency Purchase via shopping cart Track order status
Player inventory
General information Display player inventory in your application Consume virtual items and currencies from player inventory
User account and attributes
General information User attributes User account Account linking
Troubleshooting
Access has been blocked by CORS policy
How to connect native Xsolla SDK for Android to your project How to connect native Xsolla SDK for iOS to your project
Extensions for BaaS
Overview Use Shop Builder with BaaS authorization Receive Xsolla webhooks
PHP
Overview Get started Install library Set up webhooks Recommended webhooks Troubleshooting

Launch campaign

The launching process depends on the campaign type:

Main campaign types

Service campaign types

At the moment, the opportunity to implement such campaigns is in the research stage.

Was this article helpful?
Thank you!
Is there anything we can improve? Message
We’re sorry to hear that
Please explain why this article wasn’t helpful to you. Message
Thank you for your feedback!
We’ll review your message and use it to help us improve your experience.

Useful links

Features How-tos Extensions
Last updated: December 12, 2025

Found a typo or other text error? Select the text and press Ctrl+Enter.

System status
All services operational
Partial outage
© 2006–2025 Xsolla Inc.
Report a problem
We always review our content. Your feedback helps us improve it.
Provide an email so we can follow up
Thank you for your feedback!
We couldn't send your feedback
Try again later or contact us at doc_feedback@xsolla.com.