Xsolla-logo

支払いWebhook POST

ユーザーが決済を完了したときに送信。支払いの詳細を含む。

Request
Request Body schema: application/json
notification_type
required
string

通知の種類。

required
object

トランザクションの詳細（オブジェクト）。

agreement
integer

契約ID

dry_run
integer

テストトランザクション。パラメータは、テストトランザクションの場合は1つの値を持ち、もしくはトランザクションが実際の場合は送信されません。

external_id
string

トランザクション外部ID。

id
integer

トランザクションID。

payment_date
string

支払日。

payment_method
integer

決済方法のID。

payment_method_name
string

決済方法の名前。

payment_method_order_id
string

決済システムの決済ID。

required
object

支払詳細（オブジェクト）。

object

直接源泉徴収税。

amount
integer <float>

金額。

currency
string

通貨。ISO 4217に基づく3文字の通貨コード。

percent
integer <float>

直接源泉徴収税率。

object

ユーザー（オブジェクト）によって支払われた金額。

amount
integer <float>

金額。

currency
string

通貨。ISO 4217に基づく3文字の通貨コード。

object

決済システム料金。

amount
integer <float>

金額。

currency
string

通貨。ISO 4217に基づく3文字の通貨コード。

object

決済システムから振り込まれた金額。

amount
integer <float>

金額。

currency
string

通貨。ISO 4217に基づく3文字の通貨コード。

object

配当の詳細（オブジェクト）。

amount
integer <float>

金額。

currency
string

通貨。ISO 4217に基づく3文字の通貨コード。

payout_currency_rate
integer <float>

決済と配当間の為替レート。

object

本国送金費用のデータ付きオブジェクト。サードパーティがエクソラに課します。

amount
integer <float>

金額。

currency
string

通貨。ISO 4217に基づく3文字の通貨コード。

object

売上税（オブジェクト；米国とカナダのみ）。

amount
integer <float>

金額。

currency
string

通貨。ISO 4217に基づく3文字の通貨コード。

percent
integer <float>

消費税率。

object

VATの詳細（オブジェクト；EUのみ）。

amount
integer <float>

金額。

currency
string

通貨。ISO 4217に基づく3文字の通貨コード。

percent
integer <float>

消費税率。

object

エクソラの残高から振り込まれた金額。

amount
integer <float>

金額。

currency
string

通貨。ISO 4217に基づく3文字の通貨コード。

object

エクソラ料金（オブジェクト）。

amount
integer <float>

金額。

currency
string

通貨。ISO 4217に基づく3文字の通貨コード。

custom_parameters
object

カスタムパラメータ。

object

購入内容（オブジェクト）。

required
object

購入（オブジェクト）の合計価格。

amount
integer <float>

支払額合計。

currency
string

通貨。ISO 4217に基づく3文字の通貨コード。

object

チェックアウトの詳細（オブジェクト）。

amount
integer <float>

購入金額。

currency
string

通貨。ISO 4217に基づく3文字の通貨コード。

object

クーポンの詳細（オブジェクト；サブスクリプションの作成時にクーポンが使用された場合）。

campaign_code
string

キャンペーンコード。

coupon_code
string

クーポンコードです。

object

贈り物の詳細（オブジェクト）。

giver_id
string

贈り主のID。

hide_giver_from_receiver
string

贈り主の情報を受取り側に公開するかどうか。

message
string

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

receiver_email
string

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

receiver_id
string

贈り物の受取人のID。

object
Deprecated

ゲームキー（配列）。

amount
integer <float>
Deprecated

値段。

currency
string
Deprecated

通貨。ISO 4217に基づく3文字の通貨コード。

digital_content
string
Deprecated

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

drm
string
Deprecated

ゲームを配信するために使用するDRMプラットフォーム。パブリッシャーアカウントで、必要なDRMプラットフォームを構成したことを確認してください。

Enum: "steam" "playstation" "xbox" "uplay" "origin" "drmfree" "gog" "epicgames" "nintendo_eshop" "discord_game_store" "oculus"
object
Deprecated

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

amount
integer <float>
Deprecated

現金通貨での価格。

currency
string
Deprecated

通貨。ISO 4217に基づく3文字の通貨コード。

object
Deprecated

パッケージ（ユーザーのアップグレード元）のデータを持つオブジェクト。

DRM
string
Deprecated

ゲームのDRMプラットフォーム。

digital_content
string
Deprecated

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

object
Deprecated

パッケージ（ユーザーのアップグレード先）のデータを持つオブジェクト。

DRM
string
Deprecated

ゲームのDRMプラットフォーム。

digital_content
string
Deprecated

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

Array of objects

このトランザクションに適用されるプロモーション。

Array
id
integer

プロモーションID。

technical_name
string

プロモーションの名称。

object

サブスクリプションの詳細（オブジェクト）。

amount
integer <float>

現金通貨での価格。

currency
string

通貨。ISO 4217に基づく3文字の通貨コード。

date_create
string

サブスクリプション作成日。日付時刻表記は、ISO 8601形式。

date_next_charge
string

次の請求日。日付時刻表記は、ISO 8601形式。

plan_id
string

プランID（プランがAPIを使用して作成された場合は外部）。

product_id
string

製品ID（アクセストークンで送信された場合）。

subscription_id
integer

エクソラデータベースのサブスクリプションID。

tags
Array of strings

プランのタグ。

object
Deprecated

購入する仮想通貨（オブジェクト）。

amount
integer <float>
Deprecated

現金通貨での価格。

currency
string
Deprecated

通貨。ISO 4217に基づく3文字の通貨コード。

name
string
Deprecated

仮想通貨名。

quantity
integer <float>
Deprecated

数量。

sku
string
Deprecated

仮想通貨パッケージSKU（仮想通貨パッケージに設定されている場合）。

object
Deprecated

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

amount
integer <float>
Deprecated

購入金額。

currency
string
Deprecated

通貨。ISO 4217に基づく3文字の通貨コード。

Array of objects
Deprecated
Array
amount
integer <float>
Deprecated

アイテム数量。

sku
string
Deprecated

アイテムID。

object

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

merchant_id
integer

マーチャントID。

project_id
integer

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

object

ユーザーの詳細（オブジェクト）。

id
required
string

ユーザーID。

country
string

ユーザーの国。2文字の国コード（大文字）は、ISO 3166-1 alpha-2に従って使用されます。

email
string

ユーザーのEメール。

ip
string

ユーザーIP。

name
string

ユーザー名

phone
string

ユーザーの電話。

zip
string

Zipまたは郵便番号。

Responses
204

処理の成功を示すために戻ります。

400

提供された情報（たとえば、必要なパラメーターの欠落、認可の失敗など。）にエラーが発生した場合に戻ります。

500

リターンはサーバーに一時的なエラーが発生したことを示します。

Request samples
application/json
{
  • "custom_parameters": { },
  • "notification_type": "string",
  • "payment_details": {
    },
  • "purchase": {
    },
  • "settings": {
    },
  • "transaction": {
    },
  • "user": {
    }
}
Response samples
application/json
{
  • "error": {
    }
}