Xsolla-logo

無料カートで注文を作成するClient-side

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

無料カートのすべてのアイテムを含む注文を作成します。作成された注文はdoneという注文状況を取得します。

SecurityAuthForCart
Request
path Parameters
project_id
required
integer

プロジェクトID。このパラメータは、ドメインページのプロジェクト名の横にあります。

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

注文価格の通貨。3文字の通貨コードISO4217 規格詳細については、ドキュメントを参照してください。 Xsollaでサポートされている通貨

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に3 文字のISO 4217通貨コードが表示されます。 デフォルトでは、3文字の通貨コードの代わりに通貨記号が表示されます。

object

デスクトップ版のインターフェース設定。

object

ヘッダー設定。

close_button
boolean
Default: false

デスクトップ決済UIに閉じるボタンを表示するかどうか。このボタンは決済UIを閉じて、settings.return_urlパラメータで指定したURLにリダイレクトします。デフォルトはfalseです。

is_visible
boolean

決済インターフェースにヘッダーを表示するかどうかを示します。

type
string
Default: "normal"

ヘッダーを表示する方法。compact(プロジェクト名とユーザーIDを隠す)またはnormal(デフォルト)に指定できます。

Enum: "compact" "normal"
visible_logo
boolean

true の場合、ロゴはヘッダーに表示されます。画像をアップロードするには、Publisher Account でプロジェクトを開き、Pay Station > Settings セクション にアクセスしてください。

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

モバイル版の決済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

リンクを外部リソースにリダイレクトするかどうかを無効にします。外部リンクをクリックすると、external-link-openイベントがpostMessageメカニズムを介して送信されます。urlパラメータには、リダイレクト先のリンクのアドレスが渡されます。

is_show_close_widget_warning
boolean
Default: true

支払いページを閉じる前に、×アイコンの上にカーソルを置いたときに取引処理に関する警告を表示するかどうか。falseが渡された場合、またはパラメータが渡されなかった場合、警告は表示されません。

is_three_ds_independent_windows
boolean
Default: false

3-Dセキュアチェックを新しいブラウザウィンドウで開くかどうか。コンテンツセキュリティポリシー(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
}