DOCSEARCHbyAlgolia
Submit Docs

Xsolla Developer Documentation

website·Indexed 40 days ago

https://developers.xsolla.com/

Tools and services for global video game commerce, featuring comprehensive guides on Web Shop creation, item catalog management via API and JSON, user authentication, and promotional tools like discounts, bonus offers, and personalization.

Tokens
525.2K
Snippets
1K
Records
3.4K
Agent score
65%

What's inside Xsolla

  1. Overview of email and phone number collection in Xsolla Login

    Xsolla Login automatically saves contact information (email and phone number) provided by users during registration or login. This data is stored in the Xsolla database. Note that some methods may not provide all details: passwordless login only captures the specific detail used for the confirmation code, and some social network providers may not share the user's email address.

  2. Overview of Xsolla Promo Codes

    Promo codes are marketing tools used to boost purchase conversion rates and average order values. When a promo code is applied, users can receive a discount on the entire purchase, a discount on specific items, or bonus items such as virtual currency packages, game keys, virtual items, or bundles.

    Key capabilities include:

    • Flexible bonus configuration (single or combined bonus types).
    • Total redemption limits per campaign.
    • Per-user redemption limits per campaign.
    • Regional restrictions for campaigns and linked items.
    • Multiple generation of promo codes.

    Critical Limitations:

    • Only one promo code can be applied per purchase.
    • Users must complete a payment to receive the discount or bonus item.
    • Discounts apply only to real currency prices; they do not apply to prices specified in virtual currency.
    • If a promo code contains a bonus item with a regional restriction, users from restricted regions cannot redeem the promo code at all.
    • Game keys are delivered via email or the entitlement system; if keys run out, the promo code becomes unredeemable.

  3. Overview of Xsolla Free Items

    Free items are virtual items, bundles, or virtual currency packages that users can acquire without spending real or virtual currency. They are only available to authorized users; unauthorized users can view the catalog but cannot order them. Developers can limit the giveaway of unique items to prevent users from acquiring duplicates.

  4. Overview of Xsolla Item Catalog capabilities

    The Xsolla item catalog allows developers to organize and manage virtual goods with the following capabilities:

    • Organization: Create groups to categorize items.
    • Item Types: Support for virtual currency, virtual items, and bundles.
    • Data Portability: Import and export catalogs using JSON format or import from external platforms.
    • Pricing Flexibility:
      • Set prices in both real and virtual currencies for the same item.
      • Create free virtual items and bundles (note: virtual currency cannot be free).
      • Configure regional pricing.
    • Availability Control:
      • Limit the quantity of items available for purchase (excluding virtual currency).
      • Set display time limits for items in the store (excluding virtual currency).
      • Mark items as unavailable for direct purchase; these items can remain hidden from the catalog but still be delivered as bonuses or as part of a bundle.

  5. Overview of Xsolla Virtual Items

    Virtual items are non-physical in-game assets (e.g., skins, potions, weapons) that users can purchase with real or virtual currency or receive as bonuses.

    Key capabilities include:

    • Flexible Pricing: Support for real currency, virtual currency, or free items.
    • Regional Control: Ability to restrict sales in specific regions and automatic detection of user country/currency.
    • Availability Management: Control over item display time, purchase limits per user, and the ability to hide items from the catalog while keeping them available in bundles or as bonuses.

  6. Overview of the Xsolla Reward System

    The Reward system incentivizes users to make real-currency purchases in the store. Users earn value points for purchases, which allow them to progress through a reward chain.

    Key components include:

    • Reward Chains: Sequences of up to 31 steps. Each step requires a specific number of value points to unlock a reward. Chains can be Individual, Clan-based, or Personalized (targeted to specific authorized users).
    • Value Points: The currency used to track progress. There are individual and clan value points. Clan balances are the sum of all members' balances.
    • Rewards: Each step in a chain can grant 1 to 10 rewards. Supported reward types include virtual items, virtual currency, virtual currency packages, and bundles.

  7. Overview of the Xsolla Entitlement System

    The Entitlement System is a digital content ownership system used to track and manage games purchased or pre-ordered by users. It links digital content to a user's account, serving as a single entry point for partners distributing DRM-free games without relying on external platforms like Steam. Key features include granting ownership rights for DRM-free games, supporting pre-orders, retrieving a list of owned games, and manual game key activation.

  8. Overview of Xsolla Virtual Currency

    Virtual currency is used to purchase virtual goods and manage game economy balance or monetization. It supports two primary selling models:

    1. Any amount: Allows users to specify the exact amount of currency they wish to purchase. This requires a client-side input field for the user to enter the amount.
    2. Packages: Predefined amounts of currency sold as a single unit. Packages can have a custom price that differs from the standard unit price of the currency.

    Key Constraints:

    • Only one type of virtual currency can be included per package.
    • The amount of virtual currency in a package must be an integer.
    • Discount campaigns, promo codes, and coupons must use virtual currency packages; arbitrary amounts are only permitted in bonus campaigns.

  9. Overview of Xsolla Cocos SDK Item Purchase

    The Xsolla Cocos SDK enables item purchases from a catalog via a single click or a shopping cart. The payment UI is powered by the Pay Station product. Payment methods and general settings are managed within the Xsolla Publisher Account (or specific game account types) under the Payments section.

    Key Constraint: Item purchase is available to authorized users only. Users must be authenticated using SDK methods before they can make purchases.

  10. Overview of Xsolla Payment Attribution

    Payment attribution allows you to identify which content creator referred a user who made a purchase. This ensures creators receive correct campaign payouts and allows for performance tracking and analytics in the Partner Network. Attribution is driven by a unique 32-character tracking_id appended to the destination URL when a user clicks a creator's personal link. If a user makes a purchase without a tracking_id, the payment cannot be attributed to a traffic source and will be excluded from performance reports and payout calculations.

  11. Overview of Xsolla Web Shop subscription sales

    Xsolla Web Shop allows selling subscriptions directly via a web interface, bypassing app stores to provide better control over subscription terms, regional payment integration, and reduced third-party fees.

    Management is split between two interfaces:

    • Publisher Account: Used by the merchant to create/configure plans per currency, set trial and grace periods, view subscribed users, and manage subscription statuses.
    • Web Shop: Used by signed-in customers to manage their active subscriptions via a 'Manage plan' button, where they can view details, renew, or cancel.

  12. Overview of Xsolla Daily Rewards

    Daily rewards motivate users to log into a store daily to receive free items. User authentication must be enabled for the system to function; unauthenticated users can view the reward chain but cannot claim items.

    Supported reward types include:

    • Virtual items
    • Virtual currency
    • Virtual currency packages
    • Bundles

    Note: Personalization rules, purchase limits, scheduled availability (start/end dates), and promotions/discounts are ignored for items used in daily reward chains.