Tip
Integrate Xsolla Mobile SDK to enable In-App Payments across mobile platforms within and outside of stores in a platform-compliant way, powered by Pay Station with over 700 payment methods.
Interested in new ways to extend the reach of payment options while staying compliant with platform requirements? Learn more about Xsolla Mobile SDK that brings the power of Xsolla Pay Station onto mobile stores!
The SDK makes it easier to integrate Xsolla products into your Unity project by providing out-of-the-box data structures and methods for working with Xsolla API.
After integration, you can use:
- Login for authenticating users and managing the friend system and user account.
- In-Game Store for managing in-game purchases and player inventory in your application.
- Pay Station for setting up payments.
- Subscriptions to provide users with access to a package of services under specified conditions (subscription cost and duration).
Learn more about supported features →
To start with the SDK, you need to install this asset and set up a project in Xsolla Publisher Account.
- OAuth 2.0 protocol-based authentication.
- Classic login (username/email and password).
- Social login.
- Social login on the user’s device via a social network client (Google, Facebook, WeChat, and QQ).
- Login via a launcher (Steam or Xsolla Launcher).
- Login via a device ID.
- Passwordless login via a one-time code or a link sent via SMS or email.
- Xsolla Login widget that currently supports classic, social, and passwordless login. The widget opens in the built-in browser and can’t be used for native social login.
- User attributes to manage additional information.
- Cross-platform account linking.
- Secure Xsolla storage for user data. Alternatively, you can connect PlayFab, Firebase, or your custom storage.
INFO: You can also manage user accounts and access rights via Xsolla Publisher Account.
- Virtual currency:
- Sell virtual currency in any amount or in packages (for real money or other virtual currency).
- Sell hard currency (for real money only).
- Virtual items:
- Set up a catalog of in-game items.
- Sell virtual items for real and virtual currency.
- Bundles:
- Sell bundles for real or virtual currency.
- Promotional campaigns:
- Reward users with virtual currency packages, game keys, or virtual items for coupons.
- Give users bonuses or apply a discount on items in the cart with promo codes.
INFO: You can add items in the catalog or manage campaigns with discounts, coupons, and promo codes via Xsolla Publisher Account.
- Selling subscriptions.
- Subscription renewal and cancelation.
- Subscription management from a user’s dashboard.
INFO: You can add and manage subscription plans via Xsolla Publisher Account.
- Sell items in one click or via the shopping cart.
- Provide users with a convenient payment UI. Main features:
- 700+ payment methods in 200+ countries, including bank cards, digital wallets, mobile payments, cash kiosks, gift cards, and special offers.
- 130+ currencies.
- UI localized into 20+ languages.
- Desktop and mobile versions.
INFO: Xsolla Publisher Account provides you with purchase analytics, transaction history, and other statistics.
- Get and verify an inventory.
- Consume items according to the game logic.
- Consume virtual currency according to the in-game logics (for example, when opening a location or purchasing level for some currency).
- Synchronize all purchases and premium rewards of the user across all platforms.
- 64-bit OS
- Windows 7 SP1 and later
- macOS 10.12 and later
- The version of Unity not earlier than 2019.4.19f1
- Android
- iOS
- macOS
- Windows 64-bit
Additionally, the asset supports creating WebGL build to run your application in a browser.
The SDK uses Google Mobile Services and doesn’t support builds for devices without Google Mobile Services, such as Huawei.
NOTE: We recommend you use the Mono compiler for desktop platforms as it’s compatible with the provided in-game browser. If you use other browser solutions, you can use the IL2CPP compiler instead. You can use either Mono or IL2CPP compilers to create game builds for Android.
NOTE: Only the latest version of the SDK is available through CDN. If you need a different version, you can download it from GitHub.
- Unzip the package.
- In the Unity editor, go to Assets > Import Package > Custom Package in the main menu and select the SDK.
- Follow the integration guide to configure project on Xsolla side.
NOTE:
For the package manager to work correctly, git client should be installed. For detailed information about the prerequisites for using the package manager, refer to the Unity documentation.
- Open your Unity project or create a new one.
- In the main menu, click Window > Package Manager.
- Add a package as a dependence:
a. Click the + icon and select Add package from git URL.
b. Specify the git repository URL:
https://github.com/xsolla/store-unity-sdk.git?path=Assets/Xsolla. c. Click Add and wait for the import to finish.
To send requests to Xsolla servers and receive responses, the SDK provides the XsollaAuth, XsollaCatalog, XsollaCart, and XsollaOrders classes. If you want to implement your own logic for buying items or inventory management, and don’t want to write boilerplate code for API calls, these classes are a good place to start.
Follow the step-by-step tutorials to get started with basic SDK features.
Explore code reference documentation to learn more about SDK methods.
The issue appears when using External Dependency Manager on Unity version 2020.1.0f1 and later.
When building the application, an error message is displayed:
Assembly 'Packages/com.google.external-dependency-manager/ExternalDependencyManager/Editor/Google.IOSResolver_v1.2.161.dll' will not be loaded due to errors:
Unable to resolve reference 'UnityEditor.iOS.Extensions.Xcode'. Is the assembly missing or incompatible with the current platform?
Reference validation can be disabled in the Plugin Inspector.
Issue status: Fixed in 0.6.4.5.
Install iOS Build Support module from Unity Hub.
The issue may appear when logging in WebGL build. The following error message is displayed:
See details on cause of the issue on Unity Issue Tracker.
Issue status: Won’t fix.
- Open Unity project.
- Click Edit > Project Settings in the main menu.
- In the Player section, go to the WebGL build settings tab.
- Go to the Other Settings section.
- Uncheck Strip engine code box.
- Go to the Publishing Settings section.
- Check the Decompression Fallback box.
- Create a new WebGL build.
Xsolla offers the necessary tools to help you build and grow your gaming business, including personalized support at every stage. The terms of payment are determined by the contract that you can sign via Publisher Account.
The cost of using all Xsolla products is 5% of the amount you receive for the sale of the game and in-game goods via Xsolla Pay Station. If you don’t use Xsolla Pay Station in your application, but use other products, contact your Account Manager to clarify the terms and conditions.
Explore legal information that helps you work with Xsolla.
See the LICENSE file.