Xsolla-logoXsolla Developers
または
パブリッシャーアカウントへ

トークンを作成する(レガシー)

post/merchants/{merchant_id}/token

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

誤ったフォーマットで送られたパラメータや誤ったタイプのパラメータがある場合、トークンは発行されません。JSONボディにエラー内容を記載した 422 HTTPコードが表示されます。extended_messageで、 誤って送信された正確なパラメータの情報が表示されます。

SecuritybasicAuth
Request
path Parameters
merchant_id
required
integer

マーチャントID。

Request Body schema: application/json
object

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

object
Deprecated

チェックアウトの詳細(オブジェクト)。

amount
number <float>

購入金額。

currency
string

購入通貨。ISO 4217に準拠した3文字の通貨コード。

object
Deprecated

割引プロモーションコードまたは購入時のボーナスに関する情報(オブジェクト)。

hidden
boolean

決済インタフェースでプロモーションコードが入力されているフィールドを非表示にする。デフォルト設定ではfalse

value
string

プロモーションコードの値。

object
Deprecated

購入説明書。

Array of objects
Array
description
string

購入時のアイテムの説明。

image_url
string

アイテムアイコンへのリンク。

is_bonus
boolean

無料かボーナスで製品を入手可能にする。デフォルトはfalseです。

name
string

アイテム名。

object

アイテムの価格を持つオブジェクト。

amount
string

アイテムの価格。

amount_before_discount
string

割引前の商品価格。

quantity
integer

購入時のアイテム数。

value
string

一般購入の説明は決済UIおよびEメールのレシートに含めるようにします。各アイテムを個別に通す場合にはpurchase.description.items配列のパラメータを使用します。

object
Deprecated

贈り物の詳細(オブジェクト)。

Array of objects

フレンドのデータを配列。

Array
email
string

贈り物を受け取る人のメールアドレス。

id
string

贈り物の受取人のID。

name
string

贈り物の受取人のニックネーム。

giver_id
string

贈り主のID。

hide_giver_from_receiver
string

贈り主の情報を受取り側に公開するかどうか('true'がデフォルトです)既定はtrueです。

message
string

贈り主からのメッセージ。

object
Deprecated

ゲームキー。

Array of objects

ゲームキー。

Array
digital_content
string

パブリッシャ―アカウントに設定されたゲームのSKU。

drm
string

DRMプラットフォームはゲームの配布に使用できます。steamplaystationxboxuplayorigindrmfreegogepicgamesnintendo_eshopdiscord_game_storeoculusのいずれかを指定できます。パブリッシャーアカウントで必要なDRMを設定していることをご確認ください。トークンに渡されなかった場合は、決済インターフェースでユーザーが選択します。

Enum: "steam" "playstation" "xbox" "uplay" "origin" "drmfree" "gog" "epicgames" "nintendo_eshop" "discord_game_store" "oculus"
currency
string

すべての計算で使用する注文内のゲームキーの通貨。

object

アップグレードデータを持つオブジェクト。

id
integer

アップグレードID。

id_user_history
integer

エントリのIDで、ユーザーとパッケージのデータを含みます。

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
Deprecated

仮想通貨の詳細を含むオブジェクト。

currency
string

すべての計算で使用する仮想通貨パッケージの通貨。

quantity
number <float>

仮想通貨での購入金額。

object
Deprecated

購入時の仮想アイテムに関するデータを持つオブジェクト。

currency
string

すべての計算で使用する注文アイテムの通貨。

Array of objects
Array
amount
integer

アイテム数量。

available_groups
Array of strings

アイテムグループのID(配列)。決済インターフェースには、指定したグループ内のアイテムのみが含まれます。

sku
string

アイテムID。

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

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

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にリダイレクトされる決済状態。nonesuccessfulsuccessful_or_canсeled、またはanyのいずれかとなります。

Enum: "none" "successful" "successful_or_canceled" "any"
status_for_manual_redirection
string

リターンURLへのリダイレクトボタンが表示される決済状態。nonesuccessfulsuccessful_or_canсeled、またはanyのいずれかとなります。

Enum: "none" "successful" "successful_or_canceled" "any"
return_url
string

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

object

インタフェース設定(オブジェクト)。

object

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

object

ヘッダー設定。

close_button
boolean

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

close_button_icon
string

決済UIの「閉じる」ボタンのアイコン。

Enum: Description
arrow

決済UIヘッダーの左側にある「」アイコン。

cross

決済UIヘッダーの右側にある「×」アイコン。

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

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

is_independent_windows
boolean

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

is_prevent_external_link_open
boolean

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

license_url
string

EULAへのリンク。

object
object
is_visible
boolean

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

object
close_button
boolean

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

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

決済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。必ず既存のユーザー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_legaltrueの場合は、オブジェクトとその全パラメーターが必要です。

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 or null
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
{
  • "purchase": {
    },
  • "settings": {
    },
  • "user": {
    }
}
Response samples
application/json
{
  • "token": "eop57k1boA7nnYPtewZ6KEXJyJADEwRT"
}