If you have no server or you implement the logic for purchase processing on the client side, you can use the following ways:

1. WebSocket API.
2. Short-polling.

3. Xsolla event API.

Get an order status on the client side using WebSocket API

The solution uses websockets to obtain order statuses without obtaining detailed information about the order. This method is preferable: only one connection is created between the client (for example, your website or mobile application) and the Xsolla server, so there is no additional load on either the client or the server.

Complete the following steps:

1. To allow the Xsolla websocket server and your client to identify order status messages, create a connection:

 1const client = new Centrifuge(
 2connectionURL,
 3{
 4data: {
 5  user_external_id: user_external_id,
 6  auth: auth,
 7  project_id: project_id
 8}
 9}
10)
11connectionURL - wss://ws-store.xsolla.com/connection/websocket
12auth - user JWT token

2. To receive new messages about order statuses, subscribe to events using the client.on function:

1client.on('publication', (ctx) => {
2   //handle the status
3});

3. Trigger actual connection establishment:

1client.connect()

4. To receive the history of changes in order statuses, connect the API history method.

 1client.on('subscribed', function (ctx) {
 2   client.history(ctx.channel, { limit: -1, since: { offset: 0 }, reverse: false }).then(function (resp) {
 3resp.publications.forEach((ctx) => {
 4   /handle the status
 5});
 6
 7   }, function (err) {
 8       //handle the status
 9   });
10});

Message body example:

1{
2order_id: 59614241,
3status: 'new'
4}

The following order statuses are possible:

• New — order was created but not paid
• Paid — order is paid
• Done — order has been delivered (all receipts sent, deliveries made on Xsolla’s side, external platforms, etc.)
• Canceled — order is canceled and payment refunded to a user

Websocket usage recommendations:

• The maximum waiting time for a response via websocket is 5 minutes.
• The connection should be established when opening the payment interface.
• The connection should be aborted once the final order status is received, either Canceled or Done.
• If the websocket’s lifespan expires or if there are any issues with the connection, use short-polling.

Short-polling

To get detailed information about items in the order after switching to the status, call the Get order API.

Xsolla event API

Overview

The Xsolla event API allows you to use the GetUpdates service to receive and handle payment information directly from your application client without using webhooks on your server. Use this integration option if you want to speed up and simplify your integration by eliminating the need to set up and maintain your own server to process payment webhooks.

Interaction between your game and Xsolla:

How to set it up

To receive events from Xsolla via API:

1. In your project Publisher Account, go to the Project settings > Webhooks section.
2. Click Use API. Settings are saved automatically.

3. From the application client, send a request to https://getupdate.xsolla.com/events to get payment information. Refer to the API references for detailed information. In the response, you will receive payment data in the same format as the Payment webhook.
4. If the payment is successful, grant the purchase to the user.

API reference

Get unprocessed event list for user

1GET https://getupdate.xsolla.com/events

Security: Bearer User JWT token

Response sample:

 1{
 2  "events": [
 3   {
 4     "id": 49, // event_id
 5     "status": 0,
 6     "created_at": "2025-04-03T21:21:27Z",
 7     "data": {
 8       "notification_type": "payment",
 9       "purchase": {
10         "order": {
11           "id": 000000001,
12           "lineitems": [
13             {
14               "quantity": 1,
15               "sku": "skill"
16             }
17           ]
18         }
19       },
20       ...
21     }
22   }
23 ]
24}

Mark event as processed

1POST https://getupdate.xsolla.com/events/<event_id>/processed

event_id is the events.id parameter obtained from the response to the Get unprocessed event list for user API call.

Security: Bearer User JWT token

The XsollaCatalog.Purchase method encapsulates several methods for tracking order status. The tracking mechanism is detailed in the documentation of SDK for Unity (PC, web).

Additionally, you can implement the handling of the order status and content, which are passed to the onSuccess callback function of the purchase method.

You can track the order status using the CheckPendingOrder SDK method. Pass the following parameters to the method:

• AccessToken — the payment token, which was received when purchasing the item.
• OrderId — the order ID, which was received when purchasing the item.
• SuccessCallback — the successful payment callback.
• ErrorCallback — the request error callback.
• bIsUserInvolvedToPayment — whether the user is involved in the payment process. Pass true for purchasing with real currency, and false for free item purchasing and purchasing with virtual currency.

The tracking mechanism is detailed in the documentation of enterprise-level SDK for Unreal Engine.

To request the status and content of an order, call the CheckOrder SDK method, passing the following parameters to it:

• AccessToken — the payment token, which was received when purchasing the item.
• OrderId — the order ID, which was received when purchasing the item.
• SuccessCallback — the callback for successful order checking. The response contains the order status.
• ErrorCallback — the request error callback.