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

払い戻しWebhook POST

支払いがキャンセルされると、エクソーラはキャンセルされた取引の詳細を、refundタイプのウェブフックとしてウェブフックURLに送信します。

ウェブフックの再試行メカニズムは、誰が返金を開始したかによって異なります：

  • 返金がお客様側で開始された場合、ウェブフックは再送されません。ウェブフックへの応答に関係なく、支払いはユーザーに返金されます。
  • 返金がサードパーティ（例：決済システム、またはエクソーラカスタマーサポートチームなど）によって開始され、かつウェブフックへの応答として5xxステータスコード が返された場合、ウェブフックは間隔を空けながら再送されます。最大再試行回数は、最初の試行から48時間以内に12回です。

返金プロセスに関する詳細な情報は、こちらの説明.をご参照ください。

注意

以下の条件がすべて満たされている場合でも、支払いはユーザーに返金されます：

  • 返金はエクソーラによって開始されました。
  • ウェーブフックに対する応答として、4xxステータスコードが返された、またはすべての再試行後に応答がなかった、あるいは5xxステータスコードが返された場合。

パブリッシャーアカウン トでウェブフックURLを保存すると、ウェブフックで追加情報を受信するように設定することもできます。

注意

2025年1月22日以前にパブリッシャーアカウントに登録した場合は、プロジェクトで設定 > ウェブフック > テスト > 決済ソリューション > 詳細設定セクションでトグルを見つけます。

トグル 説明
保存された決済方法による取引に関する情報を表示する

情報は、ウェブフックの以下のカスタムパラメータに渡されます：

  • saved_payment_method:
    • 0 — 保存された決済方法は使用されませんでした
    • 1 — 決済方法は現在の支払い時に保存されました
    • 2 — 保存された決済方法は使用されませんでした
  • payment_type:
    • 1 — 一回払い
    • 2 — 定期支払い

返金コード：

コード 理由 説明
1 Cancellation by the user request / the game request パブリッシャーアカウントからキャンセルが開始されました。
2 Chargeback トランザクションのチャージバックが要求されました。
3 Integration error エクソラとゲームの統合に関する問題
推奨事項：ブロックリストにユーザーを追加しません。
4 Potential fraud 不正の疑いがあります。
推奨事項: ユーザーをブロックリストに追加してください。
5 Test payment テストトランザクション後にキャンセル処理が実行されます。
推奨事項：ブロックリストにユーザーを追加しません。
6 User invoice expired 請求書の期限が切れました（後払いモデルで使用）。
7 Fraud notification from PS 決済システムで支払いが拒否されました。決済システムで不正の可能性が検出されました。
推奨事項：ユーザーをブロックリストに追加してください。
8 Cancellation by the PS request 決済システムによってキャンセルが要求されました。
推奨事項：ブロックリストにユーザーを追加しません。
9 Cancellation by the user request ユーザは何らかの理由でゲームや購入に満足していませんでした。
推奨事項：ブロックリストにユーザーを追加しません。
10 Cancellation by the game request ゲームによってキャンセルが要求されました。
推奨事項：ブロックリストにユーザーを追加しません。
11 Account holder called to report fraud アカウント所有者がトランザクションを行わなかったと述べています。
12 Friendly fraud フレンドリー詐欺が報告されました。
13 Duplicate 同じインボイスのトランザクションが重複しています。
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_method_order_id
string

決済システムの決済ID。

required
object

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

object

国境を越えた取引により特定の国に課せられる源泉徴収税（オブジェクト）。

amount
number <float>

金額。

currency
string

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

percent
number <float>

直接源泉徴収税率（%）。

object

直接源泉徴収税。

amount
number <float>

金額。

currency
string

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

percent
number <float>

直接源泉徴収税率。

object

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

amount
number <float>

金額。

currency
string

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

object

決済システム料金。

amount
number <float>

金額。

currency
string

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

object

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

amount
number <float>

金額。

currency
string

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

object

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

amount
number <float>

金額。

currency
string

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

payout_currency_rate
string

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

object

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

amount
number <float>

金額。

currency
string

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

object

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

amount
number <float>

金額。

currency
string

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

percent
number <float>

消費税率。

object

アフィリエイトネットワークやインフルエンサー経由での購入から差し引かれた顧客獲得料の総額（オブジェクト）。

amount
number <float>

金額。

currency
string

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

percent
number <float>

顧客獲得料率（%）。

object

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

amount
number <float>

金額。

currency
string

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

percent
number <float>

消費税率。

object

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

amount
number <float>

金額。

currency
string

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

object

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

amount
number <float>

金額。

currency
string

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

custom_parameters
object

カスタムパラメータ。

object

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

required
object

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

amount
number <float>

支払額合計。

currency
string

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

object

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

amount
number <float>

購入金額。

currency
string

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

object

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

amount
number <float>

現金通貨での価格。

currency
string

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

date_create
string

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

plan_id
string

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

subscription_id
integer

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

tags
Array of strings

プランのタグ。

object

返金の詳細（オブジェクト）。

author
string

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

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

コードID。

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 
curl -v 'https://your.hostname/your/uri' \
-X POST \
-d '{
        "notification_type": "refund",
        "settings": {
          "project_id": 18404,
          "merchant_id": 2340
        },
        "purchase": {
            "subscription": {
                "plan_id": "b5dac9c8",
                "subscription_id": "10",
                "date_create": "2014-09-22T19:25:25+04:00",
                "currency": "USD",
                "amount": 9.99
            },
            "checkout": {
                "currency": "USD",
                "amount": 50
            },
            "total":{
                "currency": "USD",
                "amount": 200
            }
        },
        "user": {
            "ip": "127.0.0.1",
            "phone": "18777976552",
            "email": "email@example.com",
            "id": "1234567",
            "name": "John Smith",
            "country": "US"
        },
        "transaction": {
            "id": 1,
            "external_id": 1,
            "dry_run": 1,
            "agreement": 1
        },
        "refund_details": {
            "code": 4,
            "reason": "Potential fraud"
        },
        "payment_details": {
            "sales_tax": {
                "currency": "USD",
                "amount": 0
            },
            "direct_wht": {
                "currency": "USD",
                "amount": 0.70
            },
            "xsolla_fee": {
                "currency": "USD",
                "amount": "10"
            },
            "payout": {
                "currency": "USD",
                "amount": "200"
            },
            "payment_method_fee": {
                "currency": "USD",
                "amount": "20"
            },
            "payment": {
                "currency": "USD",
                "amount": "230"
            },
            "repatriation_commission": {
                "currency": "USD",
                "amount": 10
            }
        }
    }
}'
Response samples
application/json
{
  • "error": {
    }
}
System statusAll services operational

Privacy Settings

Privacy PolicyEnd User License Agreement© 2006–2025 Xsolla Inc.