トークンを作成する

post/merchants/{merchant_id}/token

任意のユーザーパラメータを持つトークンを作成することができます。トークンを取得する際にこれらのパラメータを送信し、決済が成功した後にパラメータを受信します。トークンには、このドキュメントで説明されているか、ユーザーが事前定義したパラメータのみを含めることができます。

パラメータが間違った形式で送信された場合、またはタイプが間違っている場合、トークンは発行されません。JSON本文にエラーの説明が含まれる 422 HTTP コードを受け取ります。extended_messageでは、どのようなパラメータが不正に送信されたかという情報が表示されます。

通知

このAPIメソッドを呼び出した後に取得したトークンは、他のリクエストの認証にのみ使用することができます。サブスクリプション製品を統合した場合にのみ、このトークンを使用して決済UIを開くことができます。

SecuritybasicAuth

Request

path Parameters

merchant_id

required

integer

マーチャントID。

Request Body schema: application/json

object

custom_parametersオブジェクトのトークンに追加のパラメーターを渡して、不正防止フィルターを設定することができます。ドロップダウンリストには推奨パラメータが表示されます。決済ステーション説明書を参照してください。

active_date	string ISO 8601形式の最終閲覧日。
additional_verification	boolean プレイヤーがアカウント承認手続きを使用するかどうかを示します。
character_customized	boolean プレイヤーがキャラクターをカスタマイズしたかどうかを示します。
chat_activity	boolean プレイヤーがチャット機能を使用するかどうかを示します。
completed_tasks	integer 完了したタスクや目標の数。
forum_activity	boolean プレイヤーがフォーラム機能を使用するかどうかを示す。
items_used	boolean プレイヤーが購入したゲームアイテムを使用するかどうかを示します。
karma_points	integer プレイヤーのカルマ値。
last_change_password_date	string ISO 8601に沿ったパスワード最終更新日。
non_premium_currency	integer <float> 非プレミアム通貨の金額。
notifications_enabled	boolean プレイヤーが通知を有効化したかどうかを示します。
profile_completed	boolean プレイヤーがプロフィールに追加情報を入力したかどうかを示します。
profile_image_added	boolean プレイヤーがプロフィール画像をアップロードしたかどうかを示します。
pvp_activity	boolean プレイヤーが対人戦に参加するかどうかを示します。
registration_date	string ISO 8601形式のアカウント作成日。
session_time	string ISO 8601に沿った平均セッション時間。
social_networks_added	boolean プレイヤーがソーシャルメディアプロファイルを接続しているかを示します。
total_bans	integer チャットやフォーラムでプレイヤーが禁止された回数。
total_characters	integer ゲーム内のキャラクターの数。
total_clans	integer プレイヤーがメンバーになっているクランの数。
total_friends	integer 友達の数。
total_game_events	integer プレイヤーが参加したゲーム内イベントの数。
total_gifts	integer プレイヤーが送受信したゲーム内の贈り物の数。
total_hours	integer 合計ゲーム時間数。
total_inventory_value	integer <float> インベントリ総額（ゲーム内通貨）。
total_sum	integer <float> 総支払額。
tutorial_completed	boolean プレイヤーがゲームのチュートリアルを完了したかどうかを示します。
unlocked_achievements	integer 達成した実績の数。
user_level	integer プレイヤーのレベル、評判、またはランク。
win_rate	integer 勝率。

object

購入の詳細を含むオブジェクト。

object

サブスクリプションデータ（オブジェクト）。

available_plans	Array of strings 決済インターフェイスに表示するサブスクリプションプラン（配列）。
currency	string すべての計算で使用するサブスクリプションプランの通貨。
operation	string ユーザーのサブスクリプションプランに適用される操作の種類。サブスクリプションプランを変更する場合は、値`change_plan`を渡します。`purchase.subscription.plan_id`パラメーターに新しいプランIDを指定してください。
plan_id	string サブスクリプションプランの外部ID。これは、パブリッシャーアカウントのサブスクリプション > サブスクリプションプランセクションで確認できます。
product_id	string 製品ID。
trial_days	integer 試用期間（日）。

object

カスタムプロジェクト設定（オブジェクト）。

project_id

required

integer

ゲームのエクソラID。パブリッシャ―アカウントにあります。

currency

string

標準の決済通貨。ISO 42173文字通貨コード。

external_id

string

ゲーム内のトランザクションID。各ユーザーの支払いに対して一意でなければならなりません。

language

string

インターフェース言語。2文字の小文字言語コード。

mode

string

決済処理をテストするには、sandboxに設定します。この場合、https://sandbox-secure.xsolla.comを使用してテスト決済インターフェースにアクセスしてください。

payment_method

integer

決済方法のID。

payment_widget

string

支払いウィジェットです。paybycashまたはgiftcardが選択できます。このパラメータが設定されている場合、ユーザーはPay by CashまたはGift Cardsウィジェットにそれぞれリダイレクトされます。

Enum: "paybycash" "giftcard"

object

リダイレクトポリシーの設定（オブジェクト）。

autoredirect_from_status_page	boolean ステータスページから自動的にリダイレクトするかどうか。
delay	integer ユーザーがリターンURLに自動的にリダイレクトされるまでの遅延時間（秒）。
manual_redirection_action	string 決済ステーション動作はユーザーが「閉じる」ボタンや「ゲームに戻る」ボタンをクリックすることによって引き起こされます。`redirect`（デフォルト）と`postmessage`にすることができます。`redirect`に設定すると、ユーザーはトークンで渡された、またはパブリッシャーアカウントで指定されたURLにリダイレクトされます。`postmessage`に設定すると、ユーザーは他のページにリダイレクトされません。「閉じる」アイコンをクリックすると、`close`イベントが開始され、「ゲームに戻る」をクリックすると、`return`イベントが開始されます。 Enum: "redirect" "postmessage"
redirect_button_caption	string 手動リダイレクト用のボタンのテキスト。
redirect_conditions	string ユーザーがリターンURLにリダイレクトされる決済状態。`none`、`successful`、`successful_or_canсeled`、または`any`のいずれかとなります。 Enum: "none" "successful" "successful_or_canceled" "any"
status_for_manual_redirection	string リターンURLへのリダイレクトボタンが表示される決済状態。`none`、`successful`、`successful_or_canсeled`、または`any`のいずれかとなります。 Enum: "none" "successful" "successful_or_canceled" "any"

return_url

string

ページを使用して決済後にユーザーをリダイレクトします。パラメーターuser_id、foreigninvoice、invoice_idとstatusは、自動的にリンクに追加されます。

object

インタフェース設定（オブジェクト）。

object

メニュー設定（オブジェクト）。

object

サブスクリプションプランのサブメニュー（オブジェクト）。

hidden	boolean サブメニューを表示するかどうかを示します。
order	integer メニュー内のサブメニューの位置。

object

仮想通貨サブメニュー。

custom_amount	boolean ユーザーが任意の数の仮想通貨を決済インターフェースに入力できるかどうかを示します。
hidden	boolean サブメニューを表示するかどうかを示します。
order	integer メニュー内のサブメニューの位置。

object

仮想アイテムサブメニュー。

hidden	boolean サブメニューを表示するかどうかを示します。
order	integer メニュー内のサブメニューの位置。
selected_group	string 仮想アイテムタブを開いた後に表示するグループ。
selected_item	string 仮想アイテムタブを開いた後に表示されるアイテム（アイテムSKU）。

object

デスクトップバージョン（オブジェクト）のインターフェース設定。

object

ヘッダー設定（オブジェクト）。

close_button	boolean デスクトップ版決済ステーションに閉じるボタンを表示する設定。このボタンは決済ステーションを閉じて、`settings.return_url`パラメーターで指定されたURLにユーザーをリダイレクトします。デフォルトは`false`です。
is_visible	boolean 決済インターフェースにヘッダーを表示するかどうかを示します。
type	string ヘッダーを表示する方法。`compact`（プロジェクト名とユーザーIDを隠す）または`normal`（既定）に指定できます。 Enum: "compact" "normal"
visible_logo	boolean `true`の場合、ヘッダーにはあなたのロゴが表示されます（最初にあなたのアカウントマネージャーに画像を提供してください）。
visible_name	boolean ヘッダーにプロジェクト名を表示するかどうかを示します。
visible_purchase	boolean ヘッダーに購入説明（`purchase.description.value`）を表示するか示します。デフォルトは`true`です。

object

サブスクリプションプラン（オブジェクト）の一覧の設定。

description	string 決済インターフェースの利用可能なサブスクリプションプランの一覧上に表示されるテキスト。
display_local_price	boolean `true`の場合、ユーザーの現地通貨が購読プランに設定されている通貨と異なる場合、ユーザーは両方の価格を見ることができます。1つは現地通貨で、もう1つは基本通貨で表示されます。
layout	string テンプレートの一覧。`list`（既定）または`grid`に指定できます。 Enum: "list" "grid"

object

仮想通貨（オブジェクト）の一覧の設定。

button_with_price	boolean `true`の場合は、価格がボタンに表示されます。`false`の場合は、価格はボタンの左側に表示されます。既定では`false`です。
description	string 決済インターフェースの一覧の上に表示するテキスト。

object

仮想アイテム（オブジェクト）の一覧の設定。

button_with_price	boolean `true`の場合は、価格がボタンに表示されます。`false`の場合は、価格はボタンの左側に表示されます。既定では`false`です。
layout	string テンプレートの一覧。`list`（既定）または`grid`に指定できます。 Enum: "list" "grid"
view	string 縦方向または横方向のメニューに仮想アイテムのグループを表示しましょう。`horizontal_navigation`あるいは`vertical_navigation`（既定）にできます。 Enum: "horizontal_navigation" "vertical_navigation"

object

visible_virtual_currency_balance

boolean

この要素を決済インターフェースで非示にできるかどうかを示します。既定ではtrueです。

is_prevent_external_link_open

boolean

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

license_url

string

EULAへのリンク。

object

is_visible

boolean

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

object

close_button

boolean

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

mode

string

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

Value: "saved_accounts"

mode

string

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

size

string

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

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

Enum: "small" "medium" "large"

theme

string

決済インターフェースのテーマ。default（既定）またはdefault_darkに指定できます。

Enum: "default" "default_dark"

object

ユーザーアカウントの詳細（オブジェクト）。

object

履歴セクション。

enable	boolean セクションを表示させるかどうか。デフォルト値は`false`です。
order	integer ドロップダウンリストにおけるセクションの位置。

object

マイアカウント ページ。

enable	boolean セクションを表示させるかどうか。デフォルト値は`false`です。
order	integer ドロップダウンリストにおけるセクションの位置。

object

決済アカウントセクション。

enable	boolean 決済UIでドロップダウンリストにセクションを表示するかどうかを指定します。デフォルト値は`true`です。このパラメータを渡さない場合は、セクションが表示されます。
order	integer 決済UIのドロップダウンリストにおけるセクションの位置。

object

サブスクリプションの管理セクション。

enable	boolean セクションを表示させるかどうか。デフォルト値は`false`です。
order	integer ドロップダウンリストにおけるセクションの位置。

version

string

デバイスの種類。desktop（既定）またはmobileに指定できます。

Enum: "desktop" "mobile"

object

ユーザー詳細。

required

object

value

required

string

ユーザーID。

age

integer

ユーザーの年齢。

attributes

object

キー値ペアの有効なJSONセットとして表される、アイテムリストをフィルタリングするためのユーザー属性。

object

allow_modify	boolean ユーザーが決済UIで国を変更できるかどうか。トークンに`country.value`が渡された場合、デフォルトでは`false`となります。
value	string ユーザーの国。2文字の国コード（大文字）は、ISO 3166-1 alpha-2 standardに従って使用されます。

object <= 100 characters

user.emailオブジェクトは、不正対策モデルの構築に不可欠な要素であり、受け入れ率の向上に貢献します。それは、エクソラと決済システムの両方の要件です。パラメータが渡されない場合は、決済ページにメール入力の必須項目が表示されます。ユーザーは、パラメータに渡された、または決済ページで入力された電子メールに購入領収書を受け取ります。

value required	string ユーザーのメールアドレス。RFC 822で規定された書式を厳密に守らなければなりません。
allow_modify	boolean 決済UIでユーザーが自分のメールアドレスを入力できるかどうか。`user.email.value`パラメータがトークンで渡される場合、値はデフォルトで`false`です。

is_legal

boolean

ユーザーが法人かを示します。

object

法人情報を含むオブジェクトです。user.is_legalがtrueの場合は、オブジェクトとその全パラメーターが必要です。

address	string 最後まで記載した法的住所です。
country	string 設立国。ISO 3166-1 alpha-2に従って大文字2文字の国コードを使用します。
name	string 法人のフルネームです。
vat_id	string 納税者個別のID。

object

allow_modify	boolean 決済UIでユーザーが自分の名前を入力できるかどうか。`user.name.value`パラメータがトークンで渡される場合、値はデフォルトで`false`です。
value	string ユーザーのスクリーン名。

object

value

string

ユーザーの電話番号。

object

value

string

ユーザーを一意に識別し、ユーザーに知られているパラメーター（電子メール、スクリーン名など）。ユーザーがゲームストア外で購入することを可能にします（例えば、電子キオスクを介して）。

object

value

string

Steam ID。

object

value

string

固有の追跡ID（マーケティングキャンペーンで使用）。

object

トラフィック属性（オブジェクト）。

utm_campaign	string カタカナ表記、または英語に翻訳されたキャンペーンのタイトル。
utm_content	string キャンペーンのコンテンツ。
utm_medium	string トラフィックチャネル（コンテンツ広告、メディア広告、Eメールリストなど）。
utm_source	string トラフィックソース。
utm_term	string キャンペーンキーワード。設定すると、統計は特定の検索クエリではなく広告ターゲティングに使用されるキーワードに基づきます。Googleアナリティクスでは、指定された`utm_term`は一般検索語句レポートの一部です。

Responses

200

作成済み。

422

処理不可能なエンティティー。

Request samples

application/json

{"settings": {"currency": "USD",
"language": "en",
"project_id": 16184,
"ui": {"size": "medium"
}
},
"user": {"email": {"value": "email@example.com"
},
"id": {"value": "user_2"
},
"name": {"value": "John Smith"
}
}
}

Response samples

application/json

{"token": "eop57k1boA7nnYPtewZ6KEXJyJADEwRT"
}