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 Get subscription information

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 Loyalty program Reward system Clan reward system Referral program 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 Connecting analytics services

Sell game keys

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

Promotions

Play before you buy

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

Testing

Sandbox and production environments Test cards in sandbox mode Test PayPal in sandbox mode Test real payments Test cards list API reference for sandbox

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

Digital Distribution Hub Multi-game store

Products

Pay Station

In-Game Store

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

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

References

API reference SDKs Errors list Supported countries

Tutorials

Item catalog personalization

Subscriptions

Site Builder

Partner Network

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 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 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 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

SDKs

Metaframe

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

FAQs Launcher system requirements

Chat

Overview

Integration guide

Integration with Slack Integration with Discord Integration with Zendesk

API references

Pay Station API Login API IGS API Webhooks Subscriptions API DDH API

SDKs & libraries

Xsolla Mobile SDK

SDK for Unity (PC, web)

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

SDK for Unreal Engine

Overview SDK reference documentation

Integration guide

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

Extensions for BaaS

Overview Use In-Game Store with BaaS authorization Receive Xsolla webhooks

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

PHP

Overview Get started Install library Set up webhooks Recommended webhooks Troubleshooting

SDKs for Android

Overview SDK reference documentation

Get started Create project in Publisher Account Set up basic Login project Install library Initialize library

Store library

Get started Create project in Publisher Account Implement user authorization Set up catalog Install library Initialize library

Inventory library

Get started Create project in Publisher Account Implement user authorization Install library Initialize library

Payments library

Get started Create project in Publisher Account Implement user authorization Set up user redirection Install library Integrate SDK on application side Test payment process

Subscriptions library

Get started Create project in Publisher Account Implement user authorization Set up subscription plan Install library Initialize library Integrate SDK on application side Test subscription purchase in sandbox mode Go live

BaaS integrations

How to use Pay Station in combination with Firebase authentication

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

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

Headless checkout

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

SDKs for iOS

Overview

Get started Create project in Publisher Account Set up basic Login project Install library

Store library

Get started Create project in Publisher Account Implement user authorization Set up catalog Install library

Inventory library

Get started Create project in Publisher Account Implement user authorization Install library

Payments library

Get started Create project in Publisher Account Implement user authorization Set up user redirection Install library Integrate SDK on application side Test payment process

Subscriptions library

Get started Create project in Publisher Account Implement user authorization Set up subscription plan Install library Integrate SDK on application side Test subscription purchase in sandbox mode Go live

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

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

API reference

Webhooks

The following webhooks are provided for Pay Station:

What are webhooks

Learn what webhooks are, how they work, and when to use them.

API methods

The following API methods are provided for Pay Station:

Refund:
- Refund request
- Partial refund request

Testing:
- Request chargeback

API reference

Read more about API methods, including examples.

Thank you for your feedback!

We’ll review your message and use it to help us improve your experience.

Last updated: September 30, 2024

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

Contents

Webhooks
API methods

Your browser is not supported. Please try a different browser

Pay Station

API reference

Webhooks

API methods