Get started

This integration option allows you to take advantage of Xsolla Pay Station if you use a third-party backend solution.

After integrating Xsolla SDKs, you can use Xsolla Pay Station for processing in-game purchases in combination with other BaaS providers responsible for game logic.

Currently, Xsolla provides integration with PlayFab services.

Requirements

System requirements

  • 64-bit OS
  • Windows 7 and higher
  • macOS 10.13.6 and higher
  • XCode 11.1 and higher (for macOS)
  • Visual Studio 2017 and higher
  • Unreal Engine 4.25 and higher

Target OS

  • iOS
  • Android
  • macOS
  • Windows 64-bit
Note
To modify the SDK for your application specifics, follow the SDK modification instruction.

Charge policy

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 can be signed 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 the Xsolla Pay Station. If you do not use the Xsolla Pay Station in your application, but use other products, contact your Account Manager to clarify the terms and conditions.

Prerequisites

Before integrating the Payments UE4 SDK with the PlayFab service, follow these steps:

  1. Install the plugin.
  2. Install the demo project of integration of the Payments UE4 SDK with PlayFab service.
  3. Set up the project in your Publisher Account.
  4. Set up a project in PlayFab.

Install the plugin

  1. Download the Epic Games Launcher.
  2. Create a new UE4 project.
  3. Download the plugin from Unreal Engine Marketplace or GitHub.

Install the demo project

To install a demo project, download it from GitHub.

After installing the demo project, launch the demo map showing the joint use of the Payments UE4 SDK with the PlayFab service.

Set up the project in your Publisher Account

  1. Register an Xsolla Publisher Account.
  2. Configure a Publisher Account project that is automatically created after the previous step:
    1. Click My game in the Projects block and go to Project settings.
    2. In setup mode, specify a Project name and click Save.

    1. Go to Integration settings and check that the Integrate Commerce API toggle is set to Off.

    1. Select the PlayFab integration option.
    2. Click Save.

During the integration process, you will need the following parameters:

  • Merchant ID found in Publisher Account > Project settings > Webhooks.

  • API key found in Publisher Account > Company settings > API key.

  • Project ID found in Publisher Account > Project settings > Project ID.

Set up the project in PlayFab

  1. Create a PlayFab account.
  2. Set up a project created automatically after registration:
    1. Click the ⚙ icon to the right of the My Game project to open the menu. Click Edit title info.
    2. Specify Name and click Save title.

  1. Go to the project settings and click Add-ons.
  2. Select the Xsolla add-on in the Monetization section.
  3. Click Install Xsolla.
  4. Specify an email to receive notifications, Merchant ID, Project ID, and API key and enable the I agree to the Xsolla Terms and Conditions option.
  5. Indicate whether you want to use the sandbox mode when processing payments (this setting can be changed later).
  6. Click Install Xsolla.

PlayFab must approve a new add-on. The PlayFab team will send you a message to the specified email when it happens.

During the integration process you will need a Title ID. You can find it in the project settings in Title Settings > API Features section or in the address bar of the browser when navigating to the project settings.

Demo

We provide Demo_Login demo map to demonstrate the integration of the Payments UE4 SDK with the PlayFab service. It is available in the Content Browser > Content > Maps folder. Use it as an example.

By default, the demo uses parameters of preset PlayFab and Publisher Account projects.

Default values for the demo:

KeyValue
Title ID2915B
Usernamexsolla
Passwordxsolla
Merchant ID136551
Project ID58866

Limitations:

  • Demo supports the purchase of individual items only. Shopping cart is not available.
  • A nonconsumable item may exist in more than one instance in the inventory.

Integration flow

To integrate the Payments UE4 SDK with PlayFab:

  1. Set up a product catalog in PlayFab, add items to the catalog. For the next steps of integration, you will need the Item ID of the created goods.
  2. Add a script to receive a payment token.
  3. Set up webhooks.

  1. Set up the Virtual Items module in your Publisher Account.
  2. Set up virtual currency packages in your in-game store (optional).
  3. Set up the plugin for your UE4 project.
  4. Set up events processing.

After the integration is complete, test the payment process.

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.

Continue reading