Если у вас нет своего сервера или вы используете логику обработки покупок на стороне клиента, вы можете использовать следующие способы:

1. WebSocket API.
2. Простые запросы (Short-polling).

Получение статуса заказа на стороне клиента с помощью веб-сокет-соединения

Решение предусматривает использование веб-сокетов для получения статусов заказа без получения подробной информации о самом заказе. Этот способ является предпочтительным: между клиентом (например, вашим сайтом или мобильным приложением) и сервером Xsolla устанавливается только одно подключение, поэтому нет дополнительной нагрузки ни на клиент, ни на сервер.

Выполните следующие действия:

1. Для того чтобы веб-сокет-сервер Xsolla и ваш клиент могли идентифицировать сообщения со статусом заказа, создайте соединение:

const client = new Centrifuge(
connectionURL,
{
data: {
  user_external_id: user_external_id,
  auth: auth,
  project_id: project_id
}
}
)
connectionURL - wss://ws-store.xsolla.com/connection/websocket
auth - user JWT token

2. Чтобы получать новые сообщения о статусах заказов, подпишитесь на события с помощью функции client.on:

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

3. Установите соединение:

client.connect()

4. Чтобы получать историю изменений статусов заказов, подключите метод API history method.

client.on('subscribed', function (ctx) {
   client.history(ctx.channel, { limit: -1, since: { offset: 0 }, reverse: false }).then(function (resp) {
resp.publications.forEach((ctx) => {
   /handle the status
});

   }, function (err) {
       //handle the status
   });
});

Пример тела сообщения:

{
order_id: 59614241,
status: 'new'
}

Возможны следующие статусы заказа:

• New — заказ создан и еще не оплачен.
• Paid — заказ оплачен.
• Done — заказ полностью доставлен (в том числе отправлены все чеки, выполнены доставки на стороне Xsolla, внешних платформ и т.д.).
• Canceled — заказ отменен, оплата возвращена пользователю.

Рекомендации при работе с веб-сокетами:

• Установите максимальное время ожидания ответча через веб-сокет — 5 минут.
• Устанавливайте соединение при открытии платежного интерфейса.
• Прерывайте соединение после получения финального статуса заказа: Canceled или Done.
• По истечении времени жизни веб-сокета или при возникновении проблем с соединением используйте простые запросы.

  Простые запросы (short-polling)

  Чтобы получить детальную информацию о товарах в заказе после перехода в нужный статус, используйте API-метод Получение заказа.

  Примечание

  Используется периодический опрос статуса заказа — простой HTTP-запрос, который получает текущий статус заказа, а также информацию по нему. Рекомендуемая задержка между запросами — 3 секунды.

Метод XsollaCatalog.Purchase инкапсулирует в себе несколько методов отслеживания статуса заказа. Механизм отслеживания подробно описан в документации SDK для Unity.

Дополнительно вы можете реализовать обработку статуса и содержимого заказа, которые передаются в функцию обратного вызова onSuccess метода покупки.

C помощью SDK вы можете отслеживать статус заказа следующими способами:

• подписаться на изменение статуса заказа;
• запрашивать статус заказа.

Подписка на изменение статуса заказа

Чтобы подписаться на изменения статуса заказа, используйте метод SDK getOrderStatus из библиотеки Store. Передайте в метод следующие параметры:

• listener — объект слушателя типа OrderStatusListener;
• orderId — ID заказа, полученный в результате покупки через корзину, покупки в один клик или покупки за виртуальную валюту.

Справочная документация SDK

Узнайте больше о методах SDK и их параметрах.

Пример вызова метода XStore.getOrderStatus:

XStore.getOrderStatus(object : OrderStatusListener() {

               override fun  onStatusUpdate(status: OrderResponse.Status) {

                   if(status == OrderResponse.Status.DONE) {

                       Log.d("MainActivity", "Success")

                   }

               }

               override fun  onFailure() {

                   Log.d("MainActivity", "Failure")

               }

           }, orderId)

Мы рекомендуем вызывать метод XStore.getOrderStatus вместе с открытием платежного интерфейса.

Этот метод инкапсулирует в себя несколько методов отслеживания статуса заказа. Отслеживание выполняется по следующему алгоритму:

1. Устанавливается веб-сокет-соединение.
2. Если соединение установлено и статус заказа изменен на done или cancel, отслеживание прекращается. Если не удалось установить веб-сокет-соединение либо в ответе приходят некорректные данные, статус заказа отслеживается с помощью short-polling.
3. Отслеживание статуса заказа продолжается с помощью short-polling. Раз в 3 секунды отправляется простой HTTP-запрос статуса заказа. Отслеживание прекращается, когда статус заказа изменится на done или cancel.

Запрос статуса заказа

Для запроса текущего статуса платежной транзакции вызовите метод getOrder из библиотеки Store, передав в него следующие параметры:

• orderId — ID заказа, который был получен при покупке товара.

• callback — обработчик, вызываемый после успешного получения информации о заказе. При создании обработчика используйте интерфейс GetStatusCallback и реализуйте методы onSuccess и onError.

• callback — обработчик, вызываемый после успешного получения информации о заказе. При создании обработчика используйте интерфейс GetStatusCallback и реализуйте методы onSuccess и onError.

Пример:

XPayments.getStatus(<token>, <isSandbox>, object : GetStatusCallback {
            override fun onSuccess(data: InvoicesDataResponse?) {
                Log.d(TAG, "onSuccess is fired. Result data = $data")
            }

           override fun onError(throwable: Throwable?, errorMessage: String?) {
                Log.d(TAG, "onError is fired. ErrorMessage = $errorMessage")
            }

})

Для запроса статуса и содержимого заказа вызовите метод SDK CheckPendingOrder, передав в него следующие параметры:

• AccessToken — платежный токен, который был получен при покупке товара.
• OrderId — ID заказа, который был получен при покупке товара.
• SuccessCallback — обработчик, вызываемый после успешной проверки заказа. В ответе будет получен статус заказа.
• ErrorCallback — обработчик, вызываемый в случае ошибки при выполнении запроса.
• bIsUserInvolvedToPayment — участвует ли пользователь в процессе оплаты. Передайте значение true для покупки за реальную валюту, ffalse — для бесплатной покупки товара и покупки за виртуальную валюту.

Механизм отслеживания подробно описан в документации SDK для Unreal Engine.

Для запроса статуса и содержимого заказа вызовите метод SDK CheckOrder, передав в него следующие параметры:

• AccessToken — платежный токен, который был получен при покупке товара.
• OrderId — ID заказа, который был получен при покупке товара.
• SuccessCallback — обработчик, вызываемый после успешной проверки заказа. В ответе будет получен статус заказа.
• ErrorCallback — обработчик, вызываемый в случае ошибки при выполнении запроса.