Integration guide

BaaS integrations

Demo project

Authentication

Catalog

Subscriptions

Promotions

Item purchase

Player inventory

User account and attributes

Application build guides

Troubleshooting

How to use Pay Station in combination with Firebase authentication

If you have already implemented user authentication in your application using Firebase, you can generate a payment token on Firebase side and then pass it to the client side of the application to open the payment UI.

Using this integration option, you need to independently implement the logic for determining the user’s country and currency to pay for the purchase.

Integration flow:

Create a project.

Set up a catalog:
- Create an item catalog on Xsolla side. You can add items manually or import them from Google Play or PlayFab.
- Implement getting and displaying the catalog on the client side of the application using the SDK.

Set up an item purchase:
- Create an order with user and item data on the client side of the application using the Firebase Cloud Function.
- Implement the opening of the payment UI on the client side of your application using the SDK.

Set up an order status tracking.

To complete the integration and start accepting real payments, you need to sign a licensing agreement with Xsolla.

You can sign the licensing agreement at any integration step, but keep in mind that the review process can take up to 3 business days.

Use the sample application as an example to implement the combined use of Firebase authentication and Pay Station. The source code for the sample application is available on GitHub.

Create project

Sign up to Publisher Account

Publisher Account is the main tool to configure Xsolla features, as well as to work with analytics and transactions.

The data about the company and your application specified during registration will be used to create a draft licensing agreement with Xsolla and to generate recommendations on solutions that are suitable for you. You can change the data later, but providing the correct data when you sign up will speed up the process of signing the licensing agreement.

To sign up, go to Publisher Account and create an account.

The password from Publisher Account can consist of Latin letters, numerals, and special characters and must contain at least:

8 characters
one digit
one capital letter
one lowercase letter

To ensure password security, we recommend:

changing your password at least once every 90 days
using a new password that does not match the last 4 passwords on your account
using a unique password that does not match passwords used anywhere else
not storing your password where it is easily accessible
using password managers to store your password

Publisher account uses two-factor authentication and sends a confirmation code with each authentication attempt.

Create project in Publisher Account

If you have multiple applications, we recommend creating a separate project for each application. Based on the data specified during project creation, Xsolla generates recommendations on solutions that are suitable for you.

To create a new project:

Open Publisher Account.
In the side menu, click Create project.

Enter your project name in English (required).

After you’ve created the project, you can add additional languages and localized project names in the Project settings section.

Select one or several release platforms of your game (required).
Add a link to your game. If your game doesn’t have a website yet, add a link to the source that includes information about the game (required).
Select the game engine.
Select the monetization options you use or plan to use.
Specify if the game is already released. If the game hasn’t been released yet, specify the planned release date.
Click Create project. You will see a page with the Xsolla products recommended for you.

During the integration process, you need to provide the project ID that can be found in your Publisher Account next to the project name.

Set up catalog

Create items in Publisher Account

You need to create a catalog on Xsolla side. You can add items manually or import them from Google Play or PlayFab. When importing from Google Play, you can import a maximum of 100 items at a time.

These instructions provide steps for basic setup of a virtual item. Later, you can add other items to your catalog (virtual currency, bundles, game keys), create item groups, set up promotional campaigns, regional prices, etc.

To add a virtual item with basic settings to the catalog:

Open your project in Publisher Account.
Click Store in the side menu.
In the Virtual Items pane, click Connect.
In the drop-down menu, select Create item.

Set the basic settings of the item in the following fields:
- Image (optional)
- SKU (item unique ID)
- Item name
- Description (optional)

Specify item price:
1. Set the Price in real currency toggle to On.
2. In the Default currency field, change the currency (optional) and specify the item price.
3. If you changed the currency in the Default currency field, select the same currency in the Price in real currency field.

To ensure that the API calls for getting the catalog work correctly, make sure that the default currency and the list of currencies in which prices are specified match for all items.

Change the item status to Available.

Click Create item.

Display catalog on client side of application

Download the SDK from CDN or GitHub.
Unzip the package.
In the main menu, go to Assets > Import Package > Custom Package and select the downloaded SDK.
In the main menu, go to Window > Xsolla > Edit Settings.
Go to Inspector panel. In the Project ID field, specify the project ID that can be found in Publisher Account next to the name of your project.

On the client side of the application, add a UI to display the product catalog.
Implement requesting for an item catalog from Xsolla servers.

To get a list of virtual items, use the GetCatalog SDK method. You can also get information about catalog items using other SDK methods.

For a step-by-step tutorial on creating a catalog page, refer to Display of item catalog.

Set up item purchase

Create order using the Cloud Function

To create an order with user and item data on Xsolla side, add a Cloud Function to the project that uses the Create payment token for purchase API call. This call will return a payment token, which is required to open the payment UI and make a purchase.

Limitations:

You need to pass either the user country or the user’s IP address when requesting the payment token.
If you don’t pass the currency in the token, it is determined by the country.
If you pass the currency in the token, the user pays in this currency.

You need to first create and initialize a Firebase project, and activate user authentication using Firebase. For details on these steps, refer to the following Firebase instructions:

To add a Cloud Function to a project:

Install the Firebase CLI (Command-Line Interface). To do this, run the CLI command:

Copy

Full screen

Small screen

npm install -g firebase-tools

To link your project to the Firebase project, initialize the Firebase project by running the CLI command:

Copy

Full screen

Small screen

firebase init functions

Follow the installer’s instructions to configure the settings:
1. Select an existing codebase.
2. Specify JavaScript as the language for creating cloud functions.
3. Install dependencies.

Open functions/index.js and modify it:

Copy

Full screen

Small screen

// The Cloud Functions for Firebase SDK to create Cloud Functions and triggers.
const functions = require('firebase-functions/v1');

const projectId = <projectId>;
const apiKey = <apiKey>;

exports.getXsollaPaymentToken = functions.https.onRequest((req, res) => {

  const requestBody = req.body;
    if (!requestBody) {
      res.status(400).send('Request body is missing');
      return;
    }

  const userId = requestBody.data.uid;
  const email = requestBody.data.email;
  const sku = requestBody.data.sku;
  const returnUrl = requestBody.data.returnUrl;

  const payload = {
    user: {
      id: {value: userId},
      name: {
        value: email
      },
      email: {
        value: email
      },
      country: {
        value: 'US',
        allow_modify: false
      }
    },
    purchase: {
      items: [
        {
          sku: sku,
          quantity: 1
        }
      ]
    },
    sandbox: true,
    settings: {
      language: 'en',
      currency: 'USD',
      return_url: returnUrl,
      ui: {
        theme: '63295aab2e47fab76f7708e3'
      }
    }
  }

  let url = "https://store.xsolla.com/api/v3/project/" + projectId.toString() + "/admin/payment/token";

  fetch(
    url,
    {
      method: "POST",
      headers: {
        'Content-Type': 'application/json',
        Authorization: 'Basic ' + btoa(`${projectId}:${apiKey}`)
      },
      body: JSON.stringify(payload)
    },
  )
  .then(xsollaRes => {
    // Handle the response data
    if (xsollaRes.ok) {
      return xsollaRes.json();
    } else {
      throw new Error(`HTTP request failed with status ${xsollaRes.status} and statusText: ${xsollaRes.statusText}`)
    }
  })
  .then(data => {
    res.send(JSON.stringify(data));
  })
  .catch(error => {
    res.send("Error = " + error);
  });
});

exports.webhookFakeResponse = functions.https.onRequest((request, response) => {
  response.status(200).send()
})

In the script, specify the values for the variables:
- projectId — project ID that you can find in your Publisher Account next to the project name.

- apiKey — API key. It is shown in Publisher Account only once when it is created and must be stored on your side. You can create a new key in the following section:
  - Company settings > API keys
  - Project settings > API keys

To test the Cloud Function with the emulator, run the CLI command:

Copy

Full screen

Small screen

firebase emulators:start

After running the Cloud Function, you can call the following methods on the client side of your application:
- getXsollaPaymentToken — returns the payment token for opening the payment interface.
- webhookFakeResponse — sends the HTTP code 200 in response to the Payment webhook. The method doesn’t contain purchase validation logic: use it only for testing. For the full list of webhooks and general information about working with them, refer to the webhooks documentation.

To call methods locally, use the https://localhost:5001/{firebase-project-id}/us-central1/getXsollaPaymentToken and https://localhost:5001/{firebase-project-id}/us-central1/webhookFakeResponse URLs, where {firebase-project-id} is the Firebase project ID (Firebase console > Project Settings > Project ID).

To deploy the Cloud Function in production, run the CLI command:

Copy

Full screen

Small screen

firebase deploy --only functions

Once deployed in production, you can call methods via the https://us-central1-{firebase-project-id}.cloudfunctions.net/getXsollaPaymentToken and https://us-central1-{firebase-project-id}.cloudfunctions.net/webhookFakeResponse URLs, where {firebase-project-id} is the Firebase project ID (Firebase console > Project Settings > Project ID). For details on running the feature in production, refer to the Firebase documentation.

Create order and open the payment UI in Unity project

Open your Unity project.
Make changes to the page controller script:
1. Add the MakeCloudFunctionRequest method to call cloud function. To call the getXsollaPaymentToken method, provide one of the following URLs, where {firebase-project-id} is the Firebase project ID (Firebase console > Project Settings > Project ID):

1. - for local access — https://localhost:5001/{firebase-project-id}/us-central1/getXsollaPaymentToken
  - for access in the production — https://us-central1-{firebase-project-id}.cloudfunctions.net/getXsollaPaymentToken

Copy

Full screen

Small screen

IEnumerator MakeCloudFunctionRequest(string sku)
   {
       string url = "https://localhost:5001/{firebase-project-id}/us-central1/getXsollaPaymentToken";

       using (UnityWebRequest webRequest = UnityWebRequest.Get(url))
       {
           var userData = new UserData()
           {
               data = new UserData.Data() {
                   uid = user.UserId,
                   email = user.Email,
                   sku = sku,
                   returnUrl = "app://xpayment.com.xsolla.unitysample"
               }
           };

           byte[] data = System.Text.Encoding.UTF8.GetBytes(JsonUtility.ToJson(userData, true));
           UploadHandlerRaw upHandler = new UploadHandlerRaw(data);
           upHandler.contentType = "application/json";
           webRequest.uploadHandler = upHandler;
           webRequest.method = "POST";
           yield return webRequest.SendWebRequest();

           if (webRequest.result != UnityWebRequest.Result.Success)
           {
               Debug.LogError("Error: " + webRequest.error);
           }
           else
           {
               var paymentToken = "";
               XsollaWebBrowser.OpenPurchaseUI(
                       paymentToken,
                       false);
               Debug.Log("Response: " + webRequest.downloadHandler.text);
           }
       }
   }

1. Add Cloud Function callback on buy button click:

Copy

Full screen

Small screen

private void OnItemsRequestSuccess(StoreItems storeItems)
    {
        foreach (var storeItem in storeItems.items)
        {
            var widgetGo = Instantiate(WidgetPrefab, WidgetsContainer, false);
            var widget = widgetGo.GetComponent<StoreItemWidget>();

            widget.BuyButton.onClick.AddListener(() =>
            {
                StartCoroutine(MakeCloudFunctionRequest(storeItem.sku));
            });

            widget.NameText.text = storeItem.name;
            widget.DescriptionText.text = storeItem.description;

            if (storeItem.price != null)
            {
                var realMoneyPrice = storeItem.price;
                widget.PriceText.text = $"{realMoneyPrice.amount} {realMoneyPrice.currency}";
            }

            ImageLoader.LoadSprite(storeItem.image_url, sprite => widget.IconImage.sprite = sprite);
        }
    }

You can use the test project as an implementation example. The source code for the Unity project is available on GitHub.

Example page controller script:

Copy

Full screen

Small screen

using Firebase.Extensions;
using System;
using System.Collections;
using UnityEngine;
using UnityEngine.Networking;
using UnityEngine.UI;
using Xsolla.Catalog;
using Xsolla.Core;

[Serializable]
public class UserData
{
    public Data data;

    [Serializable]
    public class Data
    {
        public string uid;
        public string email;
        public string sku;
        public string returnUrl;
    }
}

public class FirebaseExamplePage : MonoBehaviour
{
    public GameObject LoginContainer;
    public GameObject StoreItemsContainer;

    public InputField EmailInputField;
    public InputField PasswordInputField;
    public Button LoginButton;
    public Button RegisterButton;

    public Transform WidgetsContainer;
    public GameObject WidgetPrefab;

    protected Firebase.Auth.FirebaseAuth auth;
    Firebase.Auth.FirebaseUser user = null;

    Firebase.DependencyStatus dependencyStatus = Firebase.DependencyStatus.UnavailableOther;

    public virtual void Start()
    {
        Firebase.FirebaseApp.CheckAndFixDependenciesAsync().ContinueWithOnMainThread(task => {
            dependencyStatus = task.Result;
            if (dependencyStatus == Firebase.DependencyStatus.Available)
            {
                InitializeFirebase();
            }
            else
            {
                Debug.LogError(
                  "Could not resolve all Firebase dependencies: " + dependencyStatus);
            }
        });
    }

    protected void InitializeFirebase()
    {
        StoreItemsContainer.SetActive(false);

        Debug.Log("Setting up Firebase Auth");
        auth = Firebase.Auth.FirebaseAuth.DefaultInstance;
        auth.StateChanged += AuthStateChanged;
        RegisterButton.onClick.AddListener(() =>
        {
            auth.CreateUserWithEmailAndPasswordAsync(EmailInputField.text, PasswordInputField.text).ContinueWith(task =>
            {
                if (task.IsCanceled)
                {
                    Debug.LogError("CreateUserWithEmailAndPasswordAsync was canceled.");
                    return;
                }
                if (task.IsFaulted)
                {
                    Debug.LogError("CreateUserWithEmailAndPasswordAsync encountered an error: " + task.Exception);
                    return;
                }

                Firebase.Auth.AuthResult result = task.Result;
                Debug.LogFormat("Firebase user created successfully: {0} ({1})",
                    result.User.DisplayName, result.User.UserId);
            });
        });

        LoginButton.onClick.AddListener(() =>
        {
            auth.SignInWithEmailAndPasswordAsync(EmailInputField.text, PasswordInputField.text).ContinueWith(task =>
            {
                if (task.IsCanceled)
                {
                    Debug.LogError("SignInWithEmailAndPasswordAsync was canceled.");
                    return;
                }
                if (task.IsFaulted)
                {
                    Debug.LogError("SignInWithEmailAndPasswordAsync encountered an error: " + task.Exception);
                    return;
                }

                Firebase.Auth.AuthResult result = task.Result;
                Debug.LogFormat("Firebase user logged in successfully: {0} ({1})",
                    result.User.DisplayName, result.User.UserId);
            });
        });
    }

    void AuthStateChanged(object sender, System.EventArgs eventArgs)
    {
        Firebase.Auth.FirebaseAuth senderAuth = sender as Firebase.Auth.FirebaseAuth;
        if (senderAuth == auth && senderAuth.CurrentUser != user)
        {
            bool signedIn = user != senderAuth.CurrentUser && senderAuth.CurrentUser != null;
            if (!signedIn && user != null)
            {
                Debug.Log("Signed out " + user.UserId);
            }
            user = senderAuth.CurrentUser;
            if (signedIn)
            {
                Debug.Log("AuthStateChanged Signed in " + user.UserId);
                LoadCatalog();
            }
        }
    }

    void OnDestroy()
    {
        if (auth != null)
        {
            auth.SignOut();
            auth.StateChanged -= AuthStateChanged;
            auth = null;
        }
    }
    private void LoadCatalog()
    {
        LoginContainer.SetActive(false);
        StoreItemsContainer.SetActive(true);
        XsollaCatalog.GetCatalog(OnItemsRequestSuccess, OnError);
    }

    private void OnItemsRequestSuccess(StoreItems storeItems)
    {

        foreach (var storeItem in storeItems.items)
        {
            var widgetGo = Instantiate(WidgetPrefab, WidgetsContainer, false);
            var widget = widgetGo.GetComponent<StoreItemWidget>();

            if(widget != null)
            {
                widget.NameText.text = storeItem.name;
                widget.DescriptionText.text = storeItem.description;

                widget.BuyButton.onClick.AddListener(() =>
                {
                    StartCoroutine(MakeCloudFunctionRequest(storeItem.sku));
                });

                if (storeItem.price != null)
                {
                    var realMoneyPrice = storeItem.price;
                    widget.PriceText.text = $"{realMoneyPrice.amount} {realMoneyPrice.currency}";
                }

                ImageLoader.LoadSprite(storeItem.image_url, sprite => widget.IconImage.sprite = sprite);
            }
        }
    }
    IEnumerator MakeCloudFunctionRequest(string sku)
    {
        string url = "https://localhost:5001/{firebase-project-id}/us-central1/getXsollaPaymentToken";

        using (UnityWebRequest webRequest = UnityWebRequest.Get(url))
        {
            var userData = new UserData()
            {
                data = new UserData.Data() {
                    uid = user.UserId,
                    email = user.Email,
                    sku = sku,
                    returnUrl = "app://xpayment.com.xsolla.unitysample"
                }
            };

            byte[] data = System.Text.Encoding.UTF8.GetBytes(JsonUtility.ToJson(userData, true));
            UploadHandlerRaw upHandler = new UploadHandlerRaw(data);
            upHandler.contentType = "application/json";
            webRequest.uploadHandler = upHandler;
            webRequest.method = "POST";
            yield return webRequest.SendWebRequest();

            if (webRequest.result != UnityWebRequest.Result.Success)
            {
                Debug.LogError("Error: " + webRequest.error);
            }
            else
            {
                string responseJson = webRequest.downloadHandler.text;
                var responseData = JsonUtility.FromJson<OrderData>(responseJson);

                var paymentToken = responseData.token;
                int orderId = responseData.order_id;

                XsollaWebBrowser.OpenPurchaseUI(
                        paymentToken,
                        false);
                Debug.Log("Response: " + webRequest.downloadHandler.text);
            }
        }
    }

    private void OnError(Error error)
    {
        Debug.LogError($"Error: {error.errorMessage}");
    }
}

Set up order status tracking

Tracking the order status is required to ensure that the payment was successful and to grant items to the user.

Get order status on client side

The order tracking logic is included in the GetXsollaPaymentToken method. To process a successful purchase, you need to pass a function that is called when order status changes to done.

The AddOrderForTracking SDK method is used for tracking. For detailed information about how the method works, refer to Track order status.

Get order status on server side

The SDK allows you to track the order status on the client side of your application. However, we recommend setting up the Payment webhook handler to receive order information in the back end of your application. This allows you to implement additional validation of completed purchases

For the full list of webhooks and general information about working with them, refer to the webhooks documentation.

To configure webhooks on Xsolla side:

Open your project in Publisher Account.
Click Project settings in the side menu and go to the Webhooks section.
In the Webhook server field, enter the URL to which Xsolla will send webhooks.

For testing, you can specify https://us-central1-{firebase-project-id}.cloudfunctions.net/webhookFakeResponse, where {firebase-project-id} is the Firebase project ID (Firebase console > Project Settings > Project ID). In this case, Firebase simulates successful processing of the webhook. For a real project, you need to add purchase validation logic.

To test webhooks, you can also choose any dedicated site, such as webhook.site, or a platform, such as ngrok.

Copy and save the value from the Secret key field. This key is generated by default and is used to sign webhooks. If you want to change it, click the update icon.
Click Enable webhooks.

Thank you for your feedback!

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

Last updated: October 3, 2024

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

Contents

Create project
Sign up to Publisher Account
Create project in Publisher Account
Set up catalog
Create items in Publisher Account
Display catalog on client side of application
Set up item purchase
Create order using the Cloud Function
Create order and open the payment UI in Unity project
Set up order status tracking
Get order status on client side
Get order status on server side

Your browser is not supported. Please try a different browser

Popular articles

Or choose frequently asked ones:

Answer based on the following sources:

Leave us some feedback (optional)

Leave us some feedback (optional)

Enterprise-level SDK for Unity

How to use Pay Station in combination with Firebase authentication

Create project

Sign up to Publisher Account

Create project in Publisher Account

Set up catalog

Create items in Publisher Account

Display catalog on client side of application

Set up item purchase

Create order using the Cloud Function

Create order and open the payment UI in Unity project

Set up order status tracking

Get order status on client side

Get order status on server side