- Создание заказа со всеми товарами из текущей корзины
Catalog API (2.0.0)
- Version: 2.0.0
- Servers:
https://store.xsolla.com/api - Contact Us by Email
- Contact URL: https://xsolla.com/
- Required TLS version: 1.2
API каталога позволяет настраивать каталог внутриигровых товаров на стороне Xsolla и отображать каталог пользователям в вашем игровом магазине.
API позволяет вам управлять такими сущностями каталога, как:
- Виртуальные предметы — внутриигровые предметы, например оружие, скины, бустеры.
- Виртуальная валюта — виртуальные деньги, которые используются для приобретения виртуальных товаров. Пакеты виртуальной валюты — предустановленные наборы виртуальной валюты.
- Бандлы — комбинированные наборы виртуальных предметов, валюты или игровых ключей, продаваемые как единый артикул.
- Игровые ключи — ключи для игр и DLC, распространяемые через такие платформы, как Steam, или других DRM-провайдеров.
- Группы — логические группировки для организации и сортировки товаров в каталоге.
Методы API делятся на следующие группы:
Admin — методы для создания, обновления, удаления и настройки товаров и групп каталога. Для вызова требуется базовая HTTP-аутентификация с использованием учетных данных Личного кабинета. Не предназначены для построения витрин для конечных пользователей.Catalog — методы для получения товаров и построения витрин для конечных пользователей. Поддерживают опциональную аутентификацию с использованием JWT пользователя для возврата персонализированных данных, таких как пользовательские лимиты и активные промоакции.
Методы API требуют аутентификации либо от имени пользователя, либо от имени проекта. Тип используемой схемы аутентификации указан в блоке Безопасность в описании каждого метода.
Аутентификация с помощью JWT пользователя применяется, когда запрос выполняется из браузера, мобильного приложения или игры. По умолчанию используется XsollaLoginUserJWT. Подробная информация о создании токена приведена в документации Xsolla Login API.
The token is passed in the Authorization header in the following format: Authorization: Bearer <user_JWT>, where <user_JWT> is the user token. The token identifies the user and provides access to personalized data.
В качестве альтернативы вы можете использовать токен для открытия платежного интерфейса.
Базовая HTTP-аутентификация применяется при взаимодействии server-to-server, когда вызов API отправляется напрямую с вашего сервера, а не из браузера пользователя или мобильного приложения. Обычно применяется базовая HTTP-аутентификация с использованием ключа API.
Ключ API является конфиденциальным и не должен храниться или использоваться в клиентских приложениях.
При базовой серверной аутентификации все запросы к API должны содержать заголовок:
- для
basicAuth—Authorization: Basic <your_authorization_basic_key>, гдеyour_authorization_basic_key— это параproject_id:api_key, закодированная по стандарту Base64; - для
basicMerchantAuth—Authorization: Basic <your_authorization_basic_key>, гдеyour_authorization_basic_key— это параmerchant_id:api_key, закодированная по стандарту Base64.
Значения параметров вы можете найти в Личном кабинете:
merchant_idотображается:- В разделе Настройки компании > Компания.
- В адресной строке браузера на любой странице Личного кабинета. URL-адрес имеет вид:
https://publisher.xsolla.com/<merchant_id>.
project_idотображается:- В Личном кабинете рядом с названием проекта.
- В адресной строке браузера при работе с проектом в Личном кабинете. URL-адрес имеет вид:
https://publisher.xsolla.com/<merchant_id>/projects/<project_id>.
api_keyотображается в Личном кабинете только при создании и должен храниться на вашей стороне. Создать ключ можно в разделах:
Если необходимый метод API не включает в себя path-параметр
project_id, используйте для авторизации ключ API, который действует во всех проектах.Подробная информация о работе с ключами API приведена в справочнике API.
Для продажи корзины используется схема аутентификации AuthForCart, которая поддерживает два режима:
Аутентификация с помощью JWT пользователя. Токен передается в заголовке
Authorizationв следующем формате:Authorization: Bearer <user_JWT>, где<user_JWT>— токен пользователя. Токен идентифицирует пользователя и обеспечивает доступ к персонализированным данным. В качестве альтернативы вы можете использовать токен для открытия платежного интерфейса.Упрощенный режим без заголовка. Он применяется только для неавторизованных пользователей и может быть использована только для продажи игровых ключей. Вместо токена в запрос передаются заголовки:
x-unauthorized-idс ID запроса;x-userс email пользователя, закодированным в формате Base64.
Товары всех типов (виртуальные предметы, бандлы, виртуальная валюта, ключи) используют схожую структуру данных. Понимание базовой структуры упрощает работу с API и позволяет быстрее ориентироваться в документации.
В некоторых методах могут использоваться дополнительные поля, но они не изменяют базовую структуру.
Идентификация
merchant_id— ID компании в Личном кабинете;project_id— ID проекта в Личном кабинете;sku— артикул товара, уникальный в рамках проекта.
Отображение в каталоге
name— название;description— описание;image_url— ссылка на изображение;is_enabled— доступность товара;is_show_in_store— отображение в каталоге.
Подробнее об управлении доступностью товаров в каталоге – в документации.
Организация
type— тип товара, например, виртуальный предмет (virtual_item) или бандл (bundle);groups— группы, к которым относится товар;order— порядок отображения в каталоге.
Условия продажи
prices— цены в реальной или виртуальной валюте;limits— ограничения на покупку;periods— период доступности;regions— региональные ограничения.
Пример базовой структуры:
{
"attributes": [],
"bundle_type": "virtual_currency_package",
"content": [
{
"description": {
"en": "Main in-game currency"
},
"image_url": "https://.../image.png",
"name": {
"en": "Crystals",
"de": "Kristalle"
},
"quantity": 500,
"sku": "com.xsolla.crystal_2",
"type": "virtual_currency"
}
],
"description": {
"en": "Crystals x500"
},
"groups": [],
"image_url": "https://.../image.png",
"is_enabled": true,
"is_free": false,
"is_show_in_store": true,
"limits": {
"per_item": null,
"per_user": null,
"recurrent_schedule": null
},
"long_description": null,
"media_list": [],
"name": {
"en": "Medium crystal pack"
},
"order": 1,
"periods": [
{
"date_from": null,
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"prices": [
{
"amount": 20,
"country_iso": "US",
"currency": "USD",
"is_default": true,
"is_enabled": true
}
],
"regions": [],
"sku": "com.xsolla.crystal_pack_2",
"type": "bundle",
"vc_prices": []
}Xsolla API позволяет реализовать логику магазина внутриигровых товаров, включая получение каталога, управление корзиной, создание заказов и отслеживание их статусов. В зависимости от сценария интеграции методы API делятся на подразделы Admin и Catalog, которые используют разные схемы аутентификации.
Ниже приведен пример базового сценария настройки и работы магазина — от создания товаров до их продажи пользователю.
Создайте каталог товаров для вашего магазина, например, виртуальные предметы, бандлы или виртуальную валюту.
Примеры методов:
Настройте инструменты привлечения пользователей и монетизации, например скидки, бонусы, ежедневные награды или цепочки предложений.
Примеры методов:
Настройте отображение товаров магазина в вашем приложении.
Не используйте методы подраздела Admin для построения каталога пользователям — у таких методов заданы ограничения по частоте запросов, которые не рассчитаны на пользовательский трафик.
Примеры методов:
По умолчанию в методах получения каталога возвращаются товары, которые отображаются в магазине на момент запроса. Чтобы получить информацию о товарах, период отображения которых еще не наступил или уже истек, передайте параметр
"show_inactive_time_limited_items": 1 при запросе каталога.
Вы можете продавать товары за реальную валюту следующими способами:
- Быстрая покупка — продажа одного товара, но в любом количестве.
- Покупка корзины — пользователь наполняет корзину, добавляет и удаляет товары, изменяет количество в одном заказе.
Если товар оплачивается внутриигровой валютой, а не реальными деньгами, используйте метод Создание заказа с указанным товаром, приобретенным за виртуальную валюту. Платежный интерфейс открывать не нужно — списание происходит в момент вызова метода.
Если товар бесплатный, используйте метод Создание заказа с указанным бесплатным товаром или метод Создание заказа с помощью бесплатной корзины. Платежный интерфейс открывать не нужно — заказ сразу переходит в статус done.
Используйте клиентский метод создания заказа с указанным товаром – в ответе вы получите токен, который используется для открытия платежного интерфейса.
Информация о скидке доступна пользователю только в платежном интерфейсе. Использование промокодов не предусмотрено.
Наполнение и покупка корзины может осуществляться на клиенте или на сервере.
Наполнение и покупка корзины на клиенте
Самостоятельно реализуйте логику добавления и удаления товаров. Также необходимо учитывать, что до вызова метода наполнения корзины у вас не будет информации о том, какие акции будут применены при покупке. Это означает, что итоговая стоимость и сведения о добавленных бонусных предметах будут неизвестны.
Реализуйте следующую логику работы с корзиной:
- После наполнения корзины игроком используйте метод Наполнение корзины товарами для наполнения корзины. В ответе вернется текущая информация о выбранных товарах — цены до и после применения скидок, бонусные товары.
- Обновите содержимое корзины в соответствии с действиями пользователя:
- Для добавления товара или изменения его количества используйте метод Обновление товара в корзине по ID корзины.
- Для удаления товара используйте метод Удаление товара из корзины по ID корзины.
Если вы хотите получить актуальное состояние корзины, используйте метод Получение корзины текущего пользователя.
- Используйте метод покупки корзины Создание заказа со всеми товарами из текущей корзины. В ответе вернутся ID заказа и платежный токен. Заказу будет присвоен статус
new.
Наполнение и покупка корзины на сервере
Этот вариант наполнения корзины может занимать значительное время на настройку, поскольку каждое изменение корзины может сопровождаться вызовом большего количества методов API.
Реализуйте следующую логику работы с корзиной:
- После наполнения корзины игроком используйте методс Наполнение корзины товарамидля наполнения корзины. В ответе вернется текущая информация о выбранных товарах — цены до и после применения скидок, бонусные товары.
- Используйте метод покупки корзины Создание заказа со всеми товарами из текущей корзины. В ответе вернутся ID заказа и платежный токен. Заказу будет присвоен статус
new.
Используйте полученный токен для открытия платежного интерфейса в новом окне. Другие способы открытия платежного интерфейса описаны в документации.
| Действие | Эндпоинт |
|---|---|
| Открыть в боевом окружении. | https://secure.xsolla.com/paystation4/?token={token} |
| Открыть в тестовом окружении. | https://sandbox-secure.xsolla.com/paystation4/?token={token} |
Используйте тестовый режим (sandbox-режим) при разработке и тестировании — при совершении тестовой покупки с реальных счетов не списываются деньги. Для тестирования вы можете использовать тестовые банковские карты.
После проведения первого реального платежа в силу вступает строгая политика платежей в тестовом окружении. Проведение платежа в нем будет доступно только для пользователей, которые указаны в Личном кабинете в разделе Настройки компании > Пользователи.
Покупка виртуальной валюты и виртуальных предметов за реальную валюту возможна после подписания лицензионного договора с Xsolla. Для этого в Личном кабинете перейдите в Договоры и налоги > Договоры, заполните договор и дождитесь подтверждения согласования. Согласование может занять до 3 рабочих дней.
Для включения или отключения тестового режима вам необходимо изменить значение параметра sandbox в теле запроса методов быстрой покупки и покупки корзины. По умолчанию тестовый режим выключен.
Возможные статусы заказа: - new — заказ создан; - paid — оплата получена; - done — товар начислен; - canceled — заказ отменен; - expired — истек срок оплаты.
Отслеживайте статус одним из следующих способов:
- через настройку вебхуков на сервере вашего приложения;
- через простые запросы (short-polling);
- WebSocket API.
Методы API для запроса большого количества записей (например, для построения каталога) возвращают данные постранично. Пагинация — это механизм ограничения количества элементов, возвращаемых в одном ответе API, с возможностью последовательного получения следующих страниц.
Для управления количеством возвращаемых элементов используйте следующие параметры:
limit— количество элементов на странице;offset— номер элемента, с которого выполняется вывод на странице (нумерация ведется с 0);has_more— есть ли следующая страница;total_items_count— общее количество элементов.
Пример запроса:
GET /items?limit=20&offset=40Пример ответа:
{
"items": [...],
"has_more": true,
"total_items_count": 135
}Рекомендуется выполнять последовательные запросы до тех пор, пока в ответе не вернется has_more = false.
Дата и время передаются в формате ISO 8601.
Поддерживаются:
- смещение относительно UTC;
- значение
null, когда нет ограничения времени отображения предмета; - в отдельных полях используется Unix timestamp (в секундах).
Формат: YYYY-MM-DDTHH:MM:SS±HH:MM
Пример: 2026-03-16T10:00:00+03:00
Xsolla поддерживает локализацию пользовательских полей, таких как название и описание товаров. Локализованные значения передаются в виде объекта, в котором ключом является код языка. Полный список поддерживаемых языков приведен в документации.
Поддерживаемые поля
Локализация может быть задана для следующих параметров:
namedescriptionlong_description
Формат локали
Ключ локали может быть указан в одном из следующих форматов:
- двухбуквенный код языка:
en,ru - формат язык–страна:
en-US,ru-RU,de-DE
Примеры
Пример с двухбуквенным кодом языка:
{
"name": {
"en": "Starter Pack",
"ru": "Стартовый набор"
}
}Пример с форматом язык–страна:
{
"description": {
"en-US": "Premium bundle",
"de-DE": "Premium-Paket"
}
}При возникновении ошибки API возвращает HTTP-статус и тело ответа в формате JSON. Полный список ошибок в работе магазина приведен в документации.
Пример ответа:
{
"errorCode": 1102,
"errorMessage": "Validation error",
"statusCode": 422,
"transactionId": "c9e1a..."
}errorCode— код ошибки.errorMessage— краткое описание ошибки.statusCode— HTTP статус ответа.transactionId— ID запроса. Возвращается не во всех случаях.errorMessageExtended— дополнительные данные об ошибке, например параметры запроса. Возвращаются не во всех случаях.
Пример расширенного ответа:
{
"errorCode": 7001,
"errorMessage": "Chain not found",
"errorMessageExtended": {
"chain_id": "test_chain_id",
"project_id": "test_project_id",
"step_number": 2
},
"statusCode": 404
}Частые HTTP-статусы
400— некорректный запрос401— ошибка аутентификации403— недостаточно прав доступа404— ресурс не найден422— ошибка валидации данных429— превышено ограничение частоты запросов
Рекомендации
- Обрабатывайте HTTP-статус и тело ответа совместно.
- Используйте
errorCodeдля обработки ошибок, связанных с логикой работы приложения. - Используйте
transactionId, чтобы быстрее идентифицировать запросы при анализе ошибок.
Основная информация
С помощью виртуальных предметов и валюты вы можете построить внутриигровой магазин и настроить его отображение пользователям. Доступны следующие типы товаров:
- Виртуальные предметы — внутриигровые товары, например оружие, скины или бустеры. Продаются за реальные деньги или виртуальную валюту.
- Виртуальная валюта — внутриигровая валюта для покупки виртуальных предметов. Продается за реальные деньги или виртуальную валюту.
- Пакеты виртуальной валюты — фиксированное количество виртуальной валюты. Продается за реальные деньги или виртуальную валюту.
Для организации товаров в каталоге используются группы. Они позволяют логически объединять товары и управлять их отображением.
Используйте методы подраздела Admin для создания, обновления и удаления товаров.
Используйте методы подраздела Catalog для получения списков товаров и их отображения пользователям.
Не используйте методы подраздела Admin для построения каталога пользователям.
Метод Получение списка виртуальных предметов возвращает подробные данные о предметах, включая цены и атрибуты, и поддерживает пагинацию — используйте его для отображения страниц каталога в витрине магазина.
Метод Получение списка всех виртуальных предметов возвращает артикул, название и описание предмета, а также ID и название группы без пагинации — используйте его для поиска или индексирования на стороне клиента.
Для реализации покупок за виртуальную валюту используйте метод Создание заказа с указанным товаром, приобретенным за виртуальную валюту. Открывать платежный интерфейс не нужно — списание происходит в момент вызова метода.
Пример сценария покупки товара за виртуальную валюту:
Основная информация
Game keys are single-use unique alphanumeric codes that grant users access to a game or DLC on gaming platforms. You can sell game keys via a direct link, through the store UI, or via a widget. You can also configure regional restrictions to sell game keys in specific countries. For detailed information, refer to the Game keys packages section.
User authentication is not required to sell game keys — the keys are sent to the email the user specified at checkout. You can configure authentication to enable additional scenarios: personalization, purchase limits, or an entitlement system. For detailed information, refer to the How to set up authentication when selling game keys section.
Game key sales flow:
- Create a game using the Create game API call.
- Configure regional restrictions.
- Upload keys to a game key package using the Upload codes API call to make them available for purchase.
- Display the game catalog with prices for the user's region using the Get games list API call.
- Create an order. For a fast purchase, you can use the Create order with all items from current cart API call, passing the game key SKU. The response returns a token for opening the payment UI.
- Implement the opening of the payment UI to pay for the order.
To receive timely notifications about successful payments and deliver items to the user, set up order status tracking, for example, using webhooks. The keys are sent to the email the user specified at checkout, and the order moves to the done status.
Основная информация
Bundles are sets of items sold as a single unit. A bundle can include virtual items, virtual currency, virtual currency packages, game keys, and other bundles. Use bundles to create starter packs, seasonal offers, and special deals.
Use the following API call groups to work with bundles:
- Use API calls from the Admin subsection to create, update, delete bundles, and manage their visibility.
- Use API calls from the Catalog subsection to retrieve bundles.
Purchase limits are configured via the limits object when creating or updating a bundle. For more information, refer to the Limits overview. You can also configure regional restrictions to sell items in specific countries.
Bundle management scenario:
- Create a bundle using the Create bundle API call. To verify the created bundle, use the Get bundle API call. To retrieve all bundles in the project, use the Get list of bundles API call.
- If needed, use the Update bundle API call to modify the bundle content or settings.
- Implement bundle display logic in your storefront using the Get list of bundles, Get specified bundle, or Get list of bundles by specified group API call.
- Create an order using the Cart and payment section. For example, for a fast purchase you can use the Create order with specified item API call, passing the bundle SKU. The response contains a token for opening the payment UI.
- Implement opening the payment UI to pay for the order.
- Set up order status tracking, for example using webhooks, to promptly receive data on successfully paid items and grant them to the user.
Основная информация
Корзина — это механизм покупки, который позволяет объединять несколько товаров в одном заказе. Пользователь может купить товары любого типа в любом количестве за реальную валюту, а также использовать промокоды.
Корзина привязана к конкретному пользователю и хранится на стороне Xsolla. Вы можете идентифицировать корзину двумя способами: автоматически по JWT пользователя или по ID корзины (cart_id).
Управление корзиной доступно как на стороне клиента, так и на стороне сервера.
На стороне сервера вы можете наполнить корзину товарами, например при восстановлении сессии пользователя. На стороне клиента доступны следующие действия:
- получить корзину текущего пользователя или по ID корзины;
- наполнить корзину;
- обновить товары в корзине;
- удалить товары из корзины.
Для оплаты товаров из корзины используются клиентские и серверные методы создания заказа.
Сценарий использования корзины:
- Реализуйте интерфейс магазина, в котором пользователь будет выбирать товары.
- Когда пользователь выбирает товары в магазине, добавьте их в корзину, например с помощью метода Наполнение корзины товарами. В массиве items необходимо передать артикулы и количество необходимых товаров.
- Реализуйте интерфейс просмотра корзины. При переходе пользователя в корзину отобразите ее содержимое с помощью метода Получение корзины текущего пользователя. В ответе отобразится информация об итоговой цене товаров с учетом скидок, а также примененных акциях.
- Реализуйте открытие платежного интерфейса для оплаты заказа. Например, вы можете вызвать метод Создание заказа со всеми товарами из определенной корзины. В ответе вы получите токен для открытия платежного интерфейса.
- Настройте отслеживание статуса заказа, например с помощью вебхуков, чтобы своевременно получать данные об успешно оплаченных товарах и начислять их пользователю.
Примечание
Подробная информация о настройке продажи товаров в игре и онлайн приведена в руководстве по интеграции.
Жизненный цикл заказа
Понимание жизненного цикла заказа поможет вам при настройке его отслеживания, например, чтобы начислить товары пользователю после успешной оплаты.
Заказ переходит по следующим статусам:
| Статус | Описание | Примечание |
new | Заказ создан. Система ожидает подтверждение оплаты. | Описания статусов транзакций приведены в документации Pay Station API. |
paid | Заказ оплачен (транзакция перешла в статус done), и товар может быть начислен пользователю. | Пока заказ не оплачен, он находится в статусе new. |
done | Товар из заказа начислен пользователю. | — |
canceled | Пользователь оформил возврат платежа. | Заказ переходит в этот статус, когда статус транзакции меняется на refunded. |
expired | Если новый заказ включает в себя товар, промокод или акцию, на которые настроены ограничения, предыдущий неоплаченный заказ с этим же товаром переходит в статус expired. Пользователь может оплатить только последний созданный заказ. | Если пользователь пытается оплатить заказ, который находится в этом статусе, в платежном интерфейсе он увидит ошибку 2002 и не сможет совершить платеж. |
Примечание
Если в процессе оплаты заказ перешел в статус expired, но пользователь успешно завершил платеж, заказ переходит из статуса expired в paid. Это возможно только если при оплате такого заказа не будет превышен лимит на покупку товара.
Запрос
Используется для интеграции клиент-сервер. Создает заказ со всеми товарами из конкретной корзины и генерирует для него токен оплаты. Созданный заказ получает статус заказа new.
IP-адрес клиента используется для определения страны пользователя, которая затем используется для применения соответствующей валюты и доступных способов оплаты заказа.
Чтобы открыть платежный интерфейс в новом окне, воспользуйтесь следующей ссылкой: https://secure.xsolla.com/paystation4/?token={token}, где {token} — полученный токен.
Для целей тестирования используйте этот URL-адрес: https://sandbox-secure.xsolla.com/paystation4/?token={token}.
Поскольку этот метод использует IP-адрес для определения страны пользователя и валюты для заказа, важно использовать этот метод только на стороне клиента, а не на стороне сервера. Использование этого метода на стороне сервера может привести к неправильному определению валюты и повлиять на способы оплаты в Pay Station.
ID проекта. Вы можете найти этот параметр в Личном кабинете рядом с названием проекта, а также в адресной строке браузера при работе с проектом. URL-адрес имеет следующий формат: https://publisher.xsolla.com/<merchant_id>/projects/<project_id>.
Валюта, в которой указана стоимость заказа. Трехбуквенный код валюты в соответствии с ISO 4217. Подробную информацию о валютах, поддерживаемых Xsolla, смотрите в документации.
Создает заказ в тестовом окружении. Эта возможность доступна для пользователей, указанных в списке пользователей компании.
Параметры для настройки процесса оплаты и платежного интерфейса для пользователя.
Объект с настройками интерфейса.
Тема платежного интерфейса. Может принимать значения 63295a9a2e47fab76f7708e1 для светлой темы (по умолчанию) или 63295aab2e47fab76f7708e3 для темной темы. Вы также можете создать собственную тему и передать ID темы в этом параметре.
Объект с настройками интерфейса для настольной версии.
Объект с настройками хедера.
Если true, логотип будет отображаться в хедере. Чтобы загрузить изображение, откройте свой проект в Личном кабинете и перейдите в раздел Pay Station > Настройки.
Показывать ли в хедере описание покупки (purchase.description.value). По умолчанию true.
Внешний вид хедера. Может принимать значения compact (в хедере не будут показываться название игры и ID пользователя) или normal.
Платежный интерфейс в режиме Личного кабинета. Принимает значение user_account. Header содержит только навигационное меню Личного кабинета; исключается возможность выбора предмета и оплата покупки; режим Личного кабинета доступен только в desktop-режиме.
Объект с данными об учетной записи пользователя.
Страница Сохраненные платежные аккаунты.
Страница Мой аккаунт.
Страница Управление подписками.
Отключение перехода по внешним ссылкам. При нажатии на внешнюю ссылку отправляется событие external-link-open с помощью механизма postMessage. В параметре url передается адрес, по которому выполняется переход.
Отображается ли список способов оплаты, доступных в стране игрока, при открытии платежного интерфейса. Если передано значение false (по умолчанию), отображается способ оплаты, переданный в параметре settings.payment_method или способ, выбранный алгоритмом PayRank.
Осуществляется ли переход из встроенного браузера лаунчера (WebView) во внешний браузер для совершения покупки.
Передайте значение code, чтобы в платежном интерфейсе отображалось трехбуквенное обозначение валюты по ISO 4217. По умолчанию вместо трехбуквенного обозначения валюты отображается значок валюты.
Показывать ли предупреждение об обработке транзакции при наведении на значок × перед закрытием страницы оплаты. Если передано значение false или параметр не передан, предупреждение не показывается.
Расположение основных элементов платежного интерфейса. Вы можете открыть платежный интерфейс внутри вашей игры и/или поменять местами колонки с информацией о заказе и способах оплаты. Подробная информация представлена в инструкции по кастомизации.
Откроется ли проверка 3-D Secure в новом окне браузера. Если в вашей программе настройки применяется политика безопасности содержимого (CSP), установите значение true.
Отображение списка товаров в корзине при открытии мобильной версии платежного интерфейса. Если передано значение true, список отображается в развернутом виде. Если передано значение false (по умолчанию) или параметр не передан — список отображается в свернутом виде.
ID платежного метода. Влияет на отображение валюты в платежном интерфейсе, так как некоторые платежные методы могут поддерживать только определенные валюты.
Пользователь будет перенаправлен на данную страницу после совершения платежа. Параметры user_id, foreigninvoice, invoice_id и status будут автоматически добавлены к ссылке.
Статус платежа, при котором происходит перенаправление пользователя на return URL.
Задержка, по истечении которой пользователь будет автоматически перенаправлен на return URL.
Статус платежа, при котором появляется кнопка для возврата на return URL.
- https://store.xsolla.com/api/v2/project/{project_id}/payment/cart/{cart_id}
- Mock serverhttps://xsolla.redocly.app/_mock/ru/api/catalog/v2/project/{project_id}/payment/cart/{cart_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://store.xsolla.com/api/v2/project/44056/payment/cart/custom_id \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"sandbox": true,
"settings": {
"ui": {
"theme": "63295a9a2e47fab76f7708e1",
"desktop": {
"header": {
"is_visible": true,
"visible_logo": true,
"visible_name": true,
"visible_purchase": true,
"type": "normal",
"close_button": false
}
}
}
},
"custom_parameters": {
"character_id": "ingameUsername"
}
}'{ "order_id": 641, "token": "f4puMEFFDZcx9nv5HoNHIkPe9qghvBQo" }
Запрос
Используется для интеграции клиент-сервер. Создает заказ со всеми товарами из корзины и генерирует для него токен оплаты. Созданный заказ получает new статус заказа.
IP-адрес клиента используется для определения страны пользователя, которая затем используется для применения соответствующей валюты и доступных способов оплаты заказа.
Чтобы открыть платежный интерфейс в новом окне, воспользуйтесь следующей ссылкой: https://secure.xsolla.com/paystation4/?token={token}, где {token} — полученный токен.
Для целей тестирования используйте этот URL-адрес: https://sandbox-secure.xsolla.com/paystation4/?token={token}.
Поскольку этот метод использует IP-адрес для определения страны пользователя и валюты для заказа, важно использовать этот метод только на стороне клиента, а не на стороне сервера. Использование этого метода на стороне сервера может привести к неправильному определению валюты и повлиять на способы оплаты в Pay Station.
ID проекта. Вы можете найти этот параметр в Личном кабинете рядом с названием проекта, а также в адресной строке браузера при работе с проектом. URL-адрес имеет следующий формат: https://publisher.xsolla.com/<merchant_id>/projects/<project_id>.
Валюта, в которой указана стоимость заказа. Трехбуквенный код валюты в соответствии с ISO 4217. Подробную информацию о валютах, поддерживаемых Xsolla, смотрите в документации.
Создает заказ в тестовом окружении. Эта возможность доступна для пользователей, указанных в списке пользователей компании.
Параметры для настройки процесса оплаты и платежного интерфейса для пользователя.
Объект с настройками интерфейса.
Тема платежного интерфейса. Может принимать значения 63295a9a2e47fab76f7708e1 для светлой темы (по умолчанию) или 63295aab2e47fab76f7708e3 для темной темы. Вы также можете создать собственную тему и передать ID темы в этом параметре.
Объект с настройками интерфейса для настольной версии.
Объект с настройками хедера.
Если true, логотип будет отображаться в хедере. Чтобы загрузить изображение, откройте свой проект в Личном кабинете и перейдите в раздел Pay Station > Настройки.
Показывать ли в хедере описание покупки (purchase.description.value). По умолчанию true.
Внешний вид хедера. Может принимать значения compact (в хедере не будут показываться название игры и ID пользователя) или normal.
Платежный интерфейс в режиме Личного кабинета. Принимает значение user_account. Header содержит только навигационное меню Личного кабинета; исключается возможность выбора предмета и оплата покупки; режим Личного кабинета доступен только в desktop-режиме.
Объект с данными об учетной записи пользователя.
Страница Сохраненные платежные аккаунты.
Страница Мой аккаунт.
Страница Управление подписками.
Отключение перехода по внешним ссылкам. При нажатии на внешнюю ссылку отправляется событие external-link-open с помощью механизма postMessage. В параметре url передается адрес, по которому выполняется переход.
Отображается ли список способов оплаты, доступных в стране игрока, при открытии платежного интерфейса. Если передано значение false (по умолчанию), отображается способ оплаты, переданный в параметре settings.payment_method или способ, выбранный алгоритмом PayRank.
Осуществляется ли переход из встроенного браузера лаунчера (WebView) во внешний браузер для совершения покупки.
Передайте значение code, чтобы в платежном интерфейсе отображалось трехбуквенное обозначение валюты по ISO 4217. По умолчанию вместо трехбуквенного обозначения валюты отображается значок валюты.
Показывать ли предупреждение об обработке транзакции при наведении на значок × перед закрытием страницы оплаты. Если передано значение false или параметр не передан, предупреждение не показывается.
Расположение основных элементов платежного интерфейса. Вы можете открыть платежный интерфейс внутри вашей игры и/или поменять местами колонки с информацией о заказе и способах оплаты. Подробная информация представлена в инструкции по кастомизации.
Откроется ли проверка 3-D Secure в новом окне браузера. Если в вашей программе настройки применяется политика безопасности содержимого (CSP), установите значение true.
Отображение списка товаров в корзине при открытии мобильной версии платежного интерфейса. Если передано значение true, список отображается в развернутом виде. Если передано значение false (по умолчанию) или параметр не передан — список отображается в свернутом виде.
ID платежного метода. Влияет на отображение валюты в платежном интерфейсе, так как некоторые платежные методы могут поддерживать только определенные валюты.
Пользователь будет перенаправлен на данную страницу после совершения платежа. Параметры user_id, foreigninvoice, invoice_id и status будут автоматически добавлены к ссылке.
Статус платежа, при котором происходит перенаправление пользователя на return URL.
Задержка, по истечении которой пользователь будет автоматически перенаправлен на return URL.
Статус платежа, при котором появляется кнопка для возврата на return URL.
- https://store.xsolla.com/api/v2/project/{project_id}/payment/cart
- Mock serverhttps://xsolla.redocly.app/_mock/ru/api/catalog/v2/project/{project_id}/payment/cart
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://store.xsolla.com/api/v2/project/44056/payment/cart \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"sandbox": true,
"settings": {
"ui": {
"theme": "63295a9a2e47fab76f7708e1",
"desktop": {
"header": {
"is_visible": true,
"visible_logo": true,
"visible_name": true,
"visible_purchase": true,
"type": "normal",
"close_button": false
}
}
}
},
"custom_parameters": {
"character_id": "ingameUsername"
}
}'{ "order_id": 641, "token": "f4puMEFFDZcx9nv5HoNHIkPe9qghvBQo" }
Запрос
Используется для интеграции клиент-сервер. Создает заказ с указанным товаром и генерирует для него токен оплаты. Созданный заказ получает статус заказа new.
IP-адрес клиента используется для определения страны пользователя, которая затем используется для применения соответствующей валюты и доступных способов оплаты заказа.
Чтобы открыть платежный интерфейс в новом окне, воспользуйтесь следующей ссылкой: https://secure.xsolla.com/paystation4/?token={token}, где {token} — полученный токен.
Для целей тестирования используйте этот URL-адрес: https://sandbox-secure.xsolla.com/paystation4/?token={token}.
Поскольку этот метод использует IP-адрес для определения страны пользователя и валюты для заказа, важно использовать этот метод только на стороне клиента, а не на стороне сервера. Использование этого метода на стороне сервера может привести к неправильному определению валюты и повлиять на способы оплаты в Pay Station.
Этот метод использует JWT пользователя для авторизации.
Передайте токен в заголовке
Authorization в формате Bearer <user_JWT>. Подробная информация о JWT пользователя приведена в блоке Безопасность для этого метода.
ID проекта. Вы можете найти этот параметр в Личном кабинете рядом с названием проекта, а также в адресной строке браузера при работе с проектом. URL-адрес имеет следующий формат: https://publisher.xsolla.com/<merchant_id>/projects/<project_id>.
Валюта, в которой указана стоимость заказа. Трехбуквенный код валюты в соответствии с ISO 4217. Подробную информацию о валютах, поддерживаемых Xsolla, смотрите в документации.
Создает заказ в тестовом окружении. Эта возможность доступна для пользователей, указанных в списке пользователей компании.
Параметры для настройки процесса оплаты и платежного интерфейса для пользователя.
Объект с настройками интерфейса.
Тема платежного интерфейса. Может принимать значения 63295a9a2e47fab76f7708e1 для светлой темы (по умолчанию) или 63295aab2e47fab76f7708e3 для темной темы. Вы также можете создать собственную тему и передать ID темы в этом параметре.
Объект с настройками интерфейса для настольной версии.
Объект с настройками хедера.
Если true, логотип будет отображаться в хедере. Чтобы загрузить изображение, откройте свой проект в Личном кабинете и перейдите в раздел Pay Station > Настройки.
Показывать ли в хедере описание покупки (purchase.description.value). По умолчанию true.
Внешний вид хедера. Может принимать значения compact (в хедере не будут показываться название игры и ID пользователя) или normal.
Платежный интерфейс в режиме Личного кабинета. Принимает значение user_account. Header содержит только навигационное меню Личного кабинета; исключается возможность выбора предмета и оплата покупки; режим Личного кабинета доступен только в desktop-режиме.
Объект с данными об учетной записи пользователя.
Страница Сохраненные платежные аккаунты.
Страница Мой аккаунт.
Страница Управление подписками.
Отключение перехода по внешним ссылкам. При нажатии на внешнюю ссылку отправляется событие external-link-open с помощью механизма postMessage. В параметре url передается адрес, по которому выполняется переход.
Отображается ли список способов оплаты, доступных в стране игрока, при открытии платежного интерфейса. Если передано значение false (по умолчанию), отображается способ оплаты, переданный в параметре settings.payment_method или способ, выбранный алгоритмом PayRank.
Осуществляется ли переход из встроенного браузера лаунчера (WebView) во внешний браузер для совершения покупки.
Передайте значение code, чтобы в платежном интерфейсе отображалось трехбуквенное обозначение валюты по ISO 4217. По умолчанию вместо трехбуквенного обозначения валюты отображается значок валюты.
Показывать ли предупреждение об обработке транзакции при наведении на значок × перед закрытием страницы оплаты. Если передано значение false или параметр не передан, предупреждение не показывается.
Расположение основных элементов платежного интерфейса. Вы можете открыть платежный интерфейс внутри вашей игры и/или поменять местами колонки с информацией о заказе и способах оплаты. Подробная информация представлена в инструкции по кастомизации.
Откроется ли проверка 3-D Secure в новом окне браузера. Если в вашей программе настройки применяется политика безопасности содержимого (CSP), установите значение true.
Отображение списка товаров в корзине при открытии мобильной версии платежного интерфейса. Если передано значение true, список отображается в развернутом виде. Если передано значение false (по умолчанию) или параметр не передан — список отображается в свернутом виде.
ID платежного метода. Влияет на отображение валюты в платежном интерфейсе, так как некоторые платежные методы могут поддерживать только определенные валюты.
Пользователь будет перенаправлен на данную страницу после совершения платежа. Параметры user_id, foreigninvoice, invoice_id и status будут автоматически добавлены к ссылке.
Статус платежа, при котором происходит перенаправление пользователя на return URL.
Задержка, по истечении которой пользователь будет автоматически перенаправлен на return URL.
Статус платежа, при котором появляется кнопка для возврата на return URL.
- https://store.xsolla.com/api/v2/project/{project_id}/payment/item/{item_sku}
- Mock serverhttps://xsolla.redocly.app/_mock/ru/api/catalog/v2/project/{project_id}/payment/item/{item_sku}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://store.xsolla.com/api/v2/project/44056/payment/item/booster_mega_1 \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"sandbox": true,
"quantity": 5,
"promo_code": "discount_code",
"settings": {
"ui": {
"theme": "63295a9a2e47fab76f7708e1",
"desktop": {
"header": {
"is_visible": true,
"visible_logo": true,
"visible_name": true,
"visible_purchase": true,
"type": "normal",
"close_button": false
}
}
}
},
"custom_parameters": {
"character_id": "ingameUsername"
}
}'{ "order_id": 641, "token": "f4puMEFFDZcx9nv5HoNHIkPe9qghvBQo" }
Бесплатные товары
Используйте методы из этого подраздела для начисления бесплатных товаров пользователям.
Основная информация
Лимиты на покупку ограничивают количество товаров, доступных одному пользователю или всем пользователям. Вы также можете задавать периоды автоматического обновления лимитов.
Лимиты хранятся на стороне Xsolla и задаются на уровне конкретного товара в Личном кабинете или через объект limits в следующих методах API:
- Создание виртуального предмета
- Создание игры
- Создание виртуальной валюты
- Создание пакета виртуальной валюты
- Создание бандла
Информация о лимитах возвращается в объекте items.limits в методах получения каталога товаров:
- Получение списка виртуальных предметов
- Получение списка виртуальных валют
- Получение списка пакетов виртуальной валюты
- Получение списка бандлов
- Получение списка игр
Методы подраздела Управление из группы методов Лимиты позволяют получать информацию о текущем состоянии лимитов и изменять их для конкретного пользователя — например, сбрасывать счетчик после выполнения квеста или корректировать остаток вручную.
Подробная информация по настройке лимитов в каталоге приведена в разделе Лимиты на покупку товаров.