Xsolla-logo

Создание заказа с указанным товаром

post/v2/project/{project_id}/payment/item/{item_sku}

Используется для интеграции клиент-сервер. Создает заказ с указанным товаром и генерирует для него токен оплаты. Созданный заказ получает статус заказа new.

IP-адрес клиента используется для определения страны пользователя, которая затем используется для применения соответствующей валюты и доступных способов оплаты заказа.

Чтобы открыть пользовательский интерфейс оплаты в новом окне, воспользуйтесь следующей ссылкой: https://secure.xsolla.com/paystation4/?token={token}, где {token} — полученный токен.

Для целей тестирования используйте этот URL-адрес: https://sandbox-secure.xsolla.com/paystation4/?token={token}.

Примечание

Поскольку этот метод использует IP-адрес для определения страны пользователя и выбора валюты для заказа, важно использовать этот метод только на стороне клиента, а не на стороне сервера. Использование этого метода на стороне сервера может привести к неправильному определению валюты и повлиять на способы оплаты в Pay Station.
SecurityXsollaLoginUserJWT
Request
path Parameters
project_id
required
integer

ID проекта. Вы можете найти этот параметр в Личном кабинете рядом с названием проекта.

Example: 44056
item_sku
required
string

Артикул товара.

Example: booster_mega_1
Request Body schema: application/json
currency
string

Валюта, в которой отображаются цены (по умолчанию — доллары США). Трехбуквенный код валюты в соответствии с ISO 4217.

custom_parameters
object [ 1 .. 200 ] properties

Дополнительные пользовательские параметры проекта.

locale
string

Язык ответа.

promo_code
string

Погашает промокод при оплате.

quantity
integer >= 1
Default: 1

Количество товара.

sandbox
boolean
Default: false

Создает заказ в тестовом окружении. Эта возможность доступна для пользователей, указанных в списке пользователей компании.

object

Параметры для настройки процесса оплаты и платежного интерфейса для пользователя.

payment_method
integer >= 1

ID способа оплаты.

object
delay
integer

Задержка, по истечении которой пользователь будет автоматически перенаправлен на return URL.

redirect_button_caption
string

Локализованные надписи на кнопке редиректа.

redirect_conditions
string

Статус платежа, при котором происходит перенаправление пользователя на return URL.

Enum: "none" "successful" "successful_or_canceled" "any"
status_for_manual_redirection
string

Статус платежа, при котором появляется кнопка для возврата на return URL.

Enum: "none" "vc" "successful" "successful_or_canceled" "any"
return_url
string <uri> <= 1000 characters

Пользователь будет перенаправлен на данную страницу после совершения платежа. Параметры user_id, foreigninvoice, invoice_id и status будут автоматически добавлены к ссылке.

object

Объект с настройками интерфейса.

currency_format
string

Передайте значение code, чтобы в платежном интерфейсе отображалось трехбуквенное обозначение валюты по ISO 4217. По умолчанию вместо трехбуквенного обозначения валюты отображается значок валюты.

object

Объект с настройками интерфейса для настольной версии.

object

Объект с настройками хедера.

close_button
boolean
Default: false

Показывать ли кнопку Закрыть в платежном интерфейсе. Нажатие на кнопку закрывает платежный интерфейс и перенаправляет пользователя на адрес, указанный в параметре settings.return_url. false по умолчанию.

is_visible
boolean

Показывать ли хедер в платежном интерфейсе.

type
string
Default: "normal"

Внешний вид хедера. Может принимать значения compact (в хедере не будут показываться название игры и ID пользователя) или normal.

Enum: "compact" "normal"
visible_logo
boolean

Если true, в хедере будет отображаться ваш логотип (необходимо сначала прислать файл с логотипом аккаунт-менеджеру).

visible_name
boolean

Показывать ли в хедере название проекта.

visible_purchase
boolean
Default: true

Показывать ли в хедере описание покупки (purchase.description.value). По умолчанию true.

object
visible_virtual_currency_balance
boolean
Default: true

Должен ли этот элемент быть видимым в интерфейсе оплаты.

is_cart_open_by_default
boolean
Default: false

Отображение списка товаров в корзине при открытии мобильной версии платежного интерфейса. Если передано значение true, список отображается в развернутом виде. Если передано значение false (по умолчанию) или параметр не передан — список отображается в свернутом виде.

is_independent_windows
boolean
Default: false

Осуществляется ли переход из встроенного браузера лаунчера (WebView) во внешний браузер для совершения покупки.

is_payment_methods_list_mode
boolean
Default: false

Отображается ли список способов оплаты, доступных в стране игрока, при открытии платежного интерфейса. ​​Если передано значение false (по умолчанию), отображается способ оплаты, переданный в параметре settings.payment_method или способ, выбранный алгоритмом PayRank.

is_prevent_external_link_open
boolean
Default: false

Отключение перехода по внешним ссылкам. При нажатии на внешнюю ссылку отправляется событие external-link-open с помощью механизма postMessage. В параметре url передается адрес, по которому выполняется переход.

is_show_close_widget_warning
boolean
Default: true

Показывать ли предупреждение об обработке транзакции при наведении на значок × перед закрытием страницы оплаты. Если передано значение false или параметр не передан, предупреждение не показывается.

is_three_ds_independent_windows
boolean
Default: false

Открывать ли проверку 3-D Secure в новом окне браузера. Передайте значение true, если вы используете политику безопасности сайтов (Content Security Policy (CSP)).

layout
string

Расположение основных элементов платежного интерфейса. Вы можете открыть платежный интерфейс внутри вашей игры и/или поменять местами колонки с информацией о заказе и способах оплаты. Подробная информация представлена в инструкции по кастомизации.

Enum: "embed" "column_reverse" "embed_column_reverse"
object
object
close_button
boolean
Default: false

Показывать ли кнопку Закрыть в платежном интерфейсе. Нажатие на кнопку закрывает платежный интерфейс и перенаправляет пользователя на адрес, указанный в параметре settings.return_url.

mode
string

Платежный интерфейс в режиме Личного кабинета. Принимает значение user_account. Header содержит только навигационное меню Личного кабинета; исключается возможность выбора предмета и оплата покупки; режим Личного кабинета доступен только в desktop-режиме.

Value: "user_account"
theme
string
Default: "63295a9a2e47fab76f7708e1"

Тема платежного интерфейса. Может принимать значения 63295a9a2e47fab76f7708e1 для светлой темы (по умолчанию) или 63295aab2e47fab76f7708e3 для темной темы. Вы также можете создать собственную тему и передать ID темы в этом параметре.

Enum: "63295a9a2e47fab76f7708e1" "63295aab2e47fab76f7708e3"
object

Объект с данными об учетной записи пользователя.

object

Страница Мой аккаунт.

enable
required
boolean
Default: false

Показывать ли вкладку в меню. По умолчанию false.

order
required
integer >= 1

Расположение раздела в раскрывающемся меню в платежном интерфейсе.

object

Страница Сохраненные платежные аккаунты.

enable
required
boolean
Default: false

Показывать ли вкладку в меню. По умолчанию false.

object

Страница Управление подписками.

enable
required
boolean
Default: false

Показывать ли вкладку в меню. По умолчанию false.

order
required
integer >= 1

Расположение раздела в раскрывающемся меню в платежном интерфейсе.

Responses
200

Заказ успешно создан.

404

Товар или купон не найден. Убедитесь, что используемые данные верны.

422

Недопустимая ошибка.

Request samples
application/json
{
  • "custom_parameters": {
    },
  • "promo_code": "discount_code",
  • "quantity": 5,
  • "sandbox": true,
  • "settings": {
    }
}
Response samples
application/json
{
  • "order_id": 641,
  • "token": "f4puMEFFDZcx9nv5HoNHIkPe9qghvBQo"
}
System statusAll services operational

Privacy Settings

Privacy PolicyEnd User License Agreement© 2006–2024 Xsolla Inc.