一部返金

一部返金Webhook POST

支払いがキャンセルされたときに送信されます。支払いの詳細が含まれています。レシピの返金プロセスの詳細をご覧ください。

返金コード：

コード	理由	説明
1	Cancellation by the user request / the game request	パブリッシャーアカウントからキャンセルが開始されました。
3	Integration error	エクソラとゲームの統合に関する問題推奨事項：ブロックリストにユーザーを追加しません。
5	Test payment	テストトランザクション後にキャンセル処理が実行されます。推奨事項：ブロックリストにユーザーを追加しません。
7	Fraud notification from PS	決済システムで支払いが拒否されました。決済システムで不正の可能性が検出されました。推奨事項：ユーザーをブロックリストに追加してください。
9	Cancellation by the user request	ユーザは何らかの理由でゲームや購入に満足していませんでした。推奨事項：ブロックリストにユーザーを追加しません。
10	Cancellation by the game request	ゲームによってキャンセルが要求されました。推奨事項：ブロックリストにユーザーを追加しません。

Request

Request Body schema: application/json

notification_type

required

string

通知の種類。

required

object

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

agreement	integer 契約ID
date	string トランザクション日。
dry_run	integer テストトランザクション。パラメータは、テストトランザクションの場合は1つの値を持ち、もしくはトランザクションが実際の場合は送信されません。
external_id	string トランザクション外部ID。
id	integer トランザクション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

Deprecated

ゲームキー（配列）。

object

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

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。

object

Deprecated

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

amount	integer <float> Deprecated 現金通貨での価格。
currency	string Deprecated 通貨。ISO 4217に基づく3文字の通貨コード。
name	string Deprecated 仮想通貨名。
quantity	integer <float> Deprecated 数量。

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

払い戻しの詳細（オブジェクト）。

author

string

返金イニシエーター。フィールド値は、次の表に従って渡されます：

返金イニシエーター	フィールド値
ゲーム（API経由）。	API
パブリッシャーアカウントのユーザー（自動返金）。	ユーザーのメールアドレス
パブリッシャーアカウントユーザー（エクソラカスタマーサポートの支援を受けて)。	support@xsolla.com
エクソラ（エクソラカスタマーサポートの支援を受けて）。	support@xsolla.com

code

integer

コードID。

date

string

返金日。

reason

string

返金の理由。

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

Payload
CURL
PHP
HTTP

application/json

{"custom_parameters": { },
"notification_type": "string",
"payment_details": {"direct_wht": {"amount": 0,
"currency": "string",
"percent": 0
},
"payment": {"amount": 0,
"currency": "string"
},
"payment_method_fee": {"amount": 0,
"currency": "string"
},
"payment_method_sum": {"amount": 0,
"currency": "string"
},
"payout": {"amount": 0,
"currency": "string"
},
"payout_currency_rate": 0,
"repatriation_commission": {"amount": 0,
"currency": "string"
},
"sales_tax": {"amount": 0,
"currency": "string",
"percent": 0
},
"vat": {"amount": 0,
"currency": "string",
"percent": 0
},
"xsolla_balance_sum": {"amount": 0,
"currency": "string"
},
"xsolla_fee": {"amount": 0,
"currency": "string"
}
},
"purchase": {"checkout": {"amount": 0,
"currency": "string"
},
"pin_codes": {"upgrade": {"amount": 0,
"currency": "string",
"digital_content_from": {"DRM": "string",
"digital_content": "string"
},
"digital_content_to": {"DRM": "string",
"digital_content": "string"
}
}
},
"total": {"amount": 0,
"currency": "string"
},
"virtual_currency": {"amount": 0,
"currency": "string",
"name": "string",
"quantity": 0
},
"virtual_items": {"amount": 0,
"currency": "string",
"items": [{"amount": 0,
"sku": "string"
}
]
}
},
"refund_details": {"author": "string",
"code": 0,
"date": "string",
"reason": "string"
},
"settings": {"merchant_id": 0,
"project_id": 0
},
"transaction": {"agreement": 0,
"date": "string",
"dry_run": 0,
"external_id": "string",
"id": 0
},
"user": {"country": "string",
"email": "string",
"id": "string",
"ip": "string",
"name": "string",
"phone": "string",
"zip": "string"
}
}

Response samples

application/json

{"error": {"code": "INCORRECT_AMOUNT",
"message": "Incorrect amount"
}
}