Xsolla-logo
  • 文档
  • 创建帐户

使用免费购物车创建订单

post/v2/project/{project_id}/free/cart

使用免费购物车中的所有商品创建一个订单。创建的订单将具有done的订单状态。

SecurityAuthForCart
Request
path Parameters
project_id
required
integer

项目编号。您可以在您的发布商帐户项目名称旁边。

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

表示价格的货币(默认为美元)。符合ISO 4217的三字母货币代码。

custom_parameters
object [ 1 .. 200 ] properties

项目特定参数。

locale
string

响应语言。

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_idforeigninvoiceinvoice_idstatus会被自动添加到此链接。

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,标题中将显示Logo(请先把Logo文件提供给您的项目经理)。

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
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

成功创建免费订单。

422

购物车无效。请检查购物车是否存在,内容不能为空,并且其中的所有商品均非免费。

Request samples
application/json
{
  • "custom_parameters": {
    },
  • "sandbox": true,
  • "settings": {
    }
}
Response samples
application/json
{
  • "order_id": 641
}