使用指定商品创建订单

使用指定商品创建订单Client-side

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

用于客户端到服务器的集成。使用指定商品创建订单并为其生成支付令牌。创建的订单得到new订单状态。

客户端IP用于确定用户所在的国家/地区，然后用于为订单应用相应的货币和可用的支付方式。

要在新窗口中打开支付UI，请使用以下链接：https://secure.xsolla.com/paystation4/?token={token} ，其中{token}是收到的令牌。

如要进行测试，请使用以下URL：https://sandbox-secure.xsolla.com/paystation4/?token={token}。

注：

由于此方法使用IP来确定用户所在的国家/地区并为订单选择货币，因此必须从客户端而不是从服务器端使用此方法。从服务器端使用此方法可能会导致货币判断错误并影响支付中心中可用的支付方式。

SecurityXsollaLoginUserJWT

Request

path Parameters

project_id required	integer 项目编号。您可以在您的发布商帐户项目名称旁边。 Example: 44056
item_sku required	string Item SKU. Example: booster_mega_1

Request Body schema: application/json

currency

string

订单价格货币。每笔订单的三个字母的货币代码ISO 4217。请查看文档以获取有关Xsolla 支持的货币。

custom_parameters

object [ 1 .. 200 ] properties

项目特定参数。

locale

string

响应语言。

promo_code

string

随支付兑换促销码活动代码。

quantity

integer >= 1

Default: 1

商品数量。

sandbox

boolean

Default: false

在沙盒模式下创建订单。该选项适用于公司用户列表中指定的那些用户。

object

为用户配置支付流程和支付UI的设置。

payment_method

integer >= 1

支付方式ID，它决定支付界面显示的货币，因为有些支付方式可能只支持某些特定的货币。

object

delay	integer 经过指定延迟时间后自动将用户重定向到返回URL。
redirect_button_caption	string 本地化的重定向按钮文字。
redirect_conditions	string 触发将用户重定向到返回URL的支付状态。 Enum: "none" "successful" "successful_or_canceled" "any"
status_for_manual_redirection	string 触发显示重定向按钮的支付状态，用户单击该按钮后将被重定向到返回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以在支付UI中显示三字母的ISO 4217货币代码。默认显示货币符号而不是三字母货币代码。

object

桌面版本的界面设置。

object

页眉设置。

close_button	boolean Default: false 是否在桌面支付UI中显示关闭按钮。该按钮将关闭支付UI并将用户重定向到`settings.return_url`参数中指定的URL。默认为`false`。
is_visible	boolean 页眉在支付UI上是否可见。
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

此元素是否可在支付UI上隐藏。

is_cart_open_by_default

boolean

Default: false

打开支付UI移动版本时购物车商品列表的显示方式。如为true，列表以扩展视图显示。如为false（默认）或未传入此参数，列表以折叠视图显示。

is_independent_windows

boolean

Default: false

是否将用户从嵌入式启动器浏览器(WebView)跳转到其默认的浏览器来进行购买。

is_payment_methods_list_mode

boolean

Default: false

打开支付UI时是否显示在该用户所在国家/地区可用的支付方式。如为false（默认），将显示在settings.payment_method参数中传入的支付方式或PayRank算法选择的支付方式。

is_prevent_external_link_open

boolean

Default: false

是否禁用将链接重定向至外部资源。点击外部链接时，将通过postMessage机制发送external-link-open事件。重定向链接的地址在url参数中传递。

is_show_close_widget_warning

boolean

Default: true

关闭支付页面前鼠标悬停在×图标时是否显示交易正在处理中的警告。如传入false，或未传入参数，则不显示警告。

is_three_ds_independent_windows

boolean

Default: false

是否在新浏览器窗口中打开3-D Secure检查。如使用内容安全政策(CSP)，请传入true。

layout

string

支付UI主要元素的位置。您可以在游戏内打开支付UI和/或交换订单信息和支付方式信息列的位置。详细信息请参阅自定义说明。

Enum: "embed" "column_reverse" "embed_column_reverse"

object

close_button

boolean

Default: false

是否在移动支付UI中显示关闭按钮。该按钮将关闭支付UI并将用户重定向到settings.return_url参数中指定的URL。

mode

string

支付UI的界面模式。只能是user_account。请注意，页眉仅包含用户帐户的导航菜单，而没有用于选择产品或进行付款的任何选项。“用户帐户”仅在桌面模式下可用。

Value: "user_account"

theme

string

Default: "63295a9a2e47fab76f7708e1"

支付UI主题。可以是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": {"character_id": "ingameUsername"
},
"promo_code": "discount_code",
"quantity": 5,
"sandbox": true,
"settings": {"ui": {"desktop": {"header": {"close_button": false,
"is_visible": true,
"type": "normal",
"visible_logo": true,
"visible_name": true,
"visible_purchase": true
}
},
"theme": "63295a9a2e47fab76f7708e1"
}
}
}

Response samples

application/json

{"order_id": 641,
"token": "f4puMEFFDZcx9nv5HoNHIkPe9qghvBQo"
}