General information

You can use the Backpack as an auxiliary tool when selling items or giving out free items in promotional campaigns to create interest in new projects or increase current user loyalty.

With Backpack, users can store information about the items they purchased or received for free. When receiving items, users don’t need to use their game ID or go to the game from the distributor site — they can keep items in the Backpack and redeem them later.

All items purchased or received for free on the distributor website are available to the user in the Metaframe widget or Xsolla Wallet.

User flow

Receiving free item

  1. The user visits the distribution or game site.
  2. The user clicks the button to receive the item. The appearance and copy of the button are completely determined by the site developer.
  3. The user logs in with the Xsolla account in the Metaframe widget.
  4. The user receives the item.
  5. Information about the received item is transferred to the Backpack.
  6. In the Metaframe widget or Xsolla Wallet, the user opens the Backpack section and selects the item.
  7. The user receives the item. Depending on the settings, the user can receive the item in one of the following ways:

    • The user enters their ID from the game that the item corresponds to, and clicks Receive item. Backpack first sends to the game a webhook to validate user ID, and then a webhook with item data. The game processes the webhook and grants the item to the user's game account.
    • User links Backpack with game platform account (e.g., Steam) and clicks Receive item. Backpack first sends to the game a webhook to validate user ID from game platform, and then a webhook with item data. The game processes the webhook and grants the item to the user's game account.

Note
If the user has previously linked a gaming platform account to Backpack, they won’t need to link again. To receive an item in the game, user only need to click Receive item.

    • The user copies the promotional code for the item or game key and enters it in the game or service that the item corresponds to.
    • To receive the Metaframe virtual currency package, the user clicks Receive item. Virtual currency is automatically granted in the Metframe inside games that the virtual currency corresponds to.

Item purchase

  1. The user visits the distribution or game site.
  2. The user logs in with the Xsolla account in the Metaframe widget.
  3. The user selects the item.
  4. The user selects the option to move the item to the Backpack.
  5. The user purchases the item.
  6. In the Metaframe widget or Xsolla Wallet, the user opens the Backpack section and selects the item.
  7. The user receives the item. Depending on the settings, the user can receive the item in one of the following ways:

    • The user enters their ID from the game that the item corresponds to, and clicks Receive item. Backpack first sends to the game a webhook to validate user ID, and then a webhook with item data. The game processes the webhook and grants the item to the user's game account.
    • User links Backpack with game platform account (e.g., Steam) and clicks Receive item. Backpack first sends to the game a webhook to validate user ID from game platform, and then a webhook with item data. The game processes the webhook and grants the item to the user's game account.

Note
If the user has previously linked a gaming platform account to Backpack, they won’t need to link again. To receive an item in the game, user only need to click Receive item.

    • The user copies the promo code for the item or game key and enters it in the game or service that the item corresponds to.
    • To receive the Metaframe virtual currency package, the user clicks Receive item. Virtual currency is automatically granted in the Metframe inside games that the virtual currency corresponds to.

Integration flow

  1. Integrate Metaframe.
  2. Add the Backpack section to the widget:
    1. Open your project in Publisher Account.
    2. In the side menu, click Metaframe.
    3. In the Backpack panel, click the Enable backpack toggle.
  3. Add information about games from which items can be stored in Backpack. To do this, use the Create game API method.
  4. Implement the logic for adding items to the user’s Backpack.
  5. Set up webhooks with item data.
Notice

Receiving webhooks with item data is necessary for item receipt when the user:

  • enters their game ID in Backpack

  • links a gaming platform account (e.g., Steam) to Backpack

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.
Last updated: October 9, 2024

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

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!