Xsolla-logo

特定のカートの全アイテムを対象とした注文を作成する

post/v2/project/{project_id}/payment/cart/{cart_id}

特定のカートの全アイテムを対象とした注文を作成します。作成された注文は、new注文のステータスを取得します。

新しいウィンドウで決済UIを開くには、以下のリンク（https://secure.xsolla.com/paystation2/?access_token=ACCESS_TOKEN）を使用します。ACCESS_TOKENは受信したトークンです。

テスト用には、このURLを使用してください：https://sandbox-secure.xsolla.com/paystation2/?access_token=ACCESS_TOKEN。

SecurityAuthForCart
Request
path Parameters
project_id
required
integer

プロジェクトID。

Example: 44056
cart_id
required
string

カートID。

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

価格が表示される通貨（デフォルトはUSD）。ISO 4217に基づく3文字通貨コード。

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_id、foreigninvoice、invoice_idとstatusは、自動的にリンクに追加されます。

object

インターフェイス設定。

object

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

object

ヘッダー設定。

close_button
boolean
Default: false

デスクトップ版決済ステーションに閉じるボタンを表示する設定。このボタンは決済ステーションを閉じて、settings.return_urlパラメーターで指定された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です。

license_url
string

EULAへのリンク。

object
object
is_visible
required
boolean

モバイル版の決済インターフェースでフッターを非表示にするかどうかを示します。

object
close_button
required
boolean
Default: false

モバイル版決済ステーションに閉じるボタンを表示する設定。このボタンは決済ステーションを閉じて、settings.return_urlパラメーターで指定されたURLにユーザーをリダイレクトします。デフォルトはfalseです。

mode
any

ユーザーは、保存された決済方法を使用してのみ決済を行うことができます。saved_accountsに指定できます。

Value: "saved_accounts"
mode
string

ユーザーアカウントの決済インターフェース。user_accountのみに指定できます：ヘッダーにはユーザーアカウントのナビゲーションメニューのみが含まれています。ユーザーは商品を選択したり、決済を行うことはできません。このモードは、デスクトップ上でのみ使用できます。

Enum: "user_account" "without_purchase"
size
string

決済インターフェースのサイズ。に指定できます：

  • small：決済インターフェースの最小サイズです。ウィンドウサイズが厳密に制限されている場合は、この値を使用します（寸法：620 x 630）
  • medium：推奨サイズ。この値を使用して、ライトボックスに決済インターフェイスを表示します（寸法：740 x 760）
  • large：決済インターフェイスを新しいウィンドウまたはタブに表示するのに最適なサイズ（寸法：820 x 840）
Enum: "large" "medium" "small"
theme
string [ 1 .. 20 ] characters
Default: "default"

決済インターフェースのテーマ。default、default_darkまたdarkに指定できます。

Enum: "default" "default_dark" "dark"
object

ユーザーアカウントの詳細。

object

履歴サブメニュー。

enable
required
boolean
Default: false

サブメニューを表示するかどうかを示します。デフォルトではfalseです。

order
required
integer >= 1

メニュー内のサブメニューの位置。

object
Default: "Page **My account**."
enable
required
boolean
Default: false

サブメニューを表示するかどうかを示します。デフォルトではfalseです。

order
required
integer >= 1

メニュー内のサブメニューの位置。

object

お客様の決済アカウント サブメニュー。

enable
required
boolean
Default: false

サブメニューを表示するかどうかを示します。デフォルトではfalseです。

order
required
integer >= 1

メニュー内のサブメニューの位置。

object

サブスクリプションの管理 サブメニュー。

enable
required
boolean
Default: false

サブメニューを表示するかどうかを示します。デフォルトではfalseです。

order
required
integer >= 1

メニュー内のサブメニューの位置。

version
string
Default: "desktop"

デバイスタイプ。desktop（デフォルト）またはmobileに指定できます。

Enum: "desktop" "mobile"
object

ユーザーの配送データ。

country
required
string^[A-Z]{2}$
address1
required
string
address2
required
string
address3
required
string
state
required
string
first_name
required
string
last_name
required
string
city
required
string
postal_code
required
string
region
required
string
phone
required
string^\+
comment
string
email
string
object

選択された配送方法。フォーマットは、統合された配送業者によって異なります。

property name*
additional property
any
Responses
200

注文が正常に作成されました。

422

無効なカート。カートが存在し、空でなく、すべてのアイテムが無料でないことを確認してください。

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