トークンを作成する

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	number <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	number <float> インベントリ総額（ゲーム内通貨）。
total_sum	number <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

ユーザーの決済プロセスと決済UIを構成するための設定。

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

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

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

決済後にユーザーがリダイレクトされるページのURL。リダイレクトの構成の詳細については、説明文書を参照してください。

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

currency_format

string

codeに設定すると、決済UIに3 文字のISO 4217通貨コードが表示されます。デフォルトでは、3文字の通貨コードの代わりに通貨記号が表示されます。

object

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

object

ヘッダー設定。

close_button	boolean 決済UIに閉じるボタンを表示するかどうか。このボタンは決済UIを閉じて、`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つは基本通貨で表示されます。

object

visible_virtual_currency_balance

boolean

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

is_cart_open_by_default

boolean

モバイル版の決済UIを開いた時のカート内のアイテムリストの表示。trueの場合、リストは拡張ビューで表示されます。false（デフォルト）またはパラメータが渡されない場合、リストは折りたたまれたビューで表示されます。

is_independent_windows

boolean

埋め込みランチャーのブラウザ（WebView）から、ユーザーのデフォルトのブラウザにリダイレクトして購入させるかどうか。デフォルトではfalseです。

is_payment_methods_list_mode

boolean

決済UIを開く際に、ユーザーの国で利用可能な決済方法のリストを表示するかどうか。falseの場合（デフォルト）、settings.payment_methodパラメータで渡された決済方法、またはPayRankアルゴリズムで選択された方法が表示されます。

is_prevent_external_link_open

boolean

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

is_show_close_widget_warning

boolean

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

is_three_ds_independent_windows

boolean

3-Dセキュアチェックを新しいブラウザウィンドウで開くかどうか。デフォルトではfalseです。コンテンツセキュリティポリシー（CSP）を使用している場合は、trueを渡します。

layout

string

決済UIの主要要素の位置。ゲーム内で決済UIを開いたり、注文や決済方法に関する情報の列を入れ替えたりすることができます。詳細については、カスタマイズに関する説明を参照してください。

Enum: "embed" "column_reverse" "embed_column_reverse"

object

close_button

boolean

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

mode

string

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

theme

string

決済UIのテーマ。ライトテーマ（デフォルト）の場合は63295a9a2e47fab76f7708e1、ダークテーマの場合は63295aab2e47fab76f7708e3を指定できます。カスタムテーマを作成して、そのIDをこのパラメータに渡すこともできます。

Enum: "63295a9a2e47fab76f7708e1" "63295aab2e47fab76f7708e3"

object

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

object

マイアカウント ページ。

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

object

保存したメソッドセクション。

enable

boolean

決済方法の編集ページに移動する決済UIに鉛筆アイコンを表示するかどうかを指定します。デフォルトはtrueです。

object

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

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

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 = 32 characters

一意のユーザー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"
}