# 払い戻し

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

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

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


注意
以下の条件がすべて満たされている場合でも、支払いはユーザーに返金されます：返金はエクソーラによって開始されました。ウェーブフックに対する応答として、4xxステータスコードが返された、またはすべての再試行後に応答がなかった、あるいは5xxステータスコードが返された場合。


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


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




    
        トグル
        説明
    


    
        保存された決済方法による取引に関する情報を表示する
        情報は、ウェブフックの以下のカスタムパラメータに渡されます：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 – AFS reject
        エクソーラの不正決済防止システムが不正の可能性を検知したため、トランザクションが拒否されました。
    
    
        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
        Potential fraud – friendly fraud
        正当なカード所有者が、自身のトランザクションに対して異議申し立てを行いました。
    
    
        13
        Duplicate
        同じインボイスのトランザクションが重複しています。
    
    
        21
        Potential fraud – BIN attack
        1つまたは複数のBINから盗まれたカードのバッチ。主な指標は、短期間のうちに特定のBIN範囲を共有する試行が急増することであり、多くの場合、列挙されたカード番号が含まれます。
    
    
        22
        Potential fraud – monetization fraud
        盗まれたカードを使用して、転売を目的とした取引可能アイテムを購入しました。
    
    
        23
        Potential fraud – low-scale card fraud
        1つまたは複数のBINから盗まれたカード。BIN攻撃ほど広範囲かつ組織的なものではありません（返金コード21）。
    
    
        24
        Potential fraud – regional price abuse
        地域別価格の悪用、またはキーの転売の不正行為。ユーザーが場所や決済方法を偽装して地域別価格を悪用し、安価にアイテムを入手して、より高価な市場で転売する行為。
    
    
        25
        Potential fraud – partner or PS exploit
        認証情報の窃取およびアカウントの乗っ取り。カードの直接的な不正利用ではなく、パートナー側または決済システムの合意アカウントや統合設定を悪用した行為。
    
    
        26
        Potential fraud – not definable
        不正行為が確認されたが、正確な攻撃タイプを特定するための証拠が不十分なもの。
    
    
        27
        Fraud notification from PS – linked transactions
        決済システムの不正報告において、当該トランザクション自体は指定されていなかったが、共有のカードやデバイスを介して、不正行為に関連する理由で返金されたトランザクションと関連があるもの。

Endpoint: POST refund
Version: 1.0

## Request fields (application/json):

  - `custom_parameters` (object)
    カスタムパラメータ。

  - `notification_type` (string, required)
    通知タイプ。

  - `payment_details` (object, required)
    支払明細（オブジェクト）。

  - `payment_details.country_wht` (object)
    国境を越えた取引により特定の国で適用される源泉徴収費用に関するデータを含むオブジェクト。

  - `payment_details.country_wht.amount` (number)
    金額。

  - `payment_details.country_wht.currency` (string)
    通貨。[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)に基づく3文字の通貨コード。

  - `payment_details.country_wht.percent` (number)
    源泉徴収コスト率の割合。

  - `payment_details.direct_wht` (object)
    直接源泉徴収税。

  - `payment_details.direct_wht.amount` (number)
    金額。

  - `payment_details.direct_wht.currency` (string)
    通貨。[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)に基づく3文字の通貨コード。

  - `payment_details.direct_wht.percent` (number)
    直接源泉徴収税率。

  - `payment_details.payment` (object)
    ユーザー（オブジェクト）によって支払われた金額。

  - `payment_details.payment.amount` (number)
    金額。

  - `payment_details.payment.currency` (string)
    通貨。[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)に基づく3文字の通貨コード。

  - `payment_details.payment_method_fee` (object)
    決済システム料金。

  - `payment_details.payment_method_fee.amount` (number)
    金額。

  - `payment_details.payment_method_fee.currency` (string)
    通貨。[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)に基づく3文字の通貨コード。

  - `payment_details.payment_method_sum` (object)
    決済システムから振り込まれた金額。

  - `payment_details.payment_method_sum.amount` (number)
    金額。

  - `payment_details.payment_method_sum.currency` (string)
    通貨。[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)に基づく3文字の通貨コード。

  - `payment_details.payout` (object)
    配当の詳細（オブジェクト）。

  - `payment_details.payout.amount` (number)
    金額。

  - `payment_details.payout.currency` (string)
    通貨。[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)に基づく3文字の通貨コード。

  - `payment_details.payout_currency_rate` (string)
    決済と配当間の為替レート。

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

  - `payment_details.repatriation_commission.amount` (number)
    金額。

  - `payment_details.repatriation_commission.currency` (string)
    通貨。[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)に基づく3文字の通貨コード。

  - `payment_details.sales_tax` (object)
    売上税（オブジェクト；米国とカナダのみ）。

  - `payment_details.sales_tax.amount` (number)
    金額。

  - `payment_details.sales_tax.currency` (string)
    通貨。[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)に基づく3文字の通貨コード。

  - `payment_details.sales_tax.percent` (number)
    消費税率。

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

  - `payment_details.user_acquisition_fee.amount` (number)
    金額。

  - `payment_details.user_acquisition_fee.currency` (string)
    通貨。[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)に基づく3文字の通貨コード。

  - `payment_details.user_acquisition_fee.percent` (number)
    顧客獲得料率（%）。

  - `payment_details.vat` (object)
    VATの詳細（オブジェクト；EUのみ）。

  - `payment_details.vat.amount` (number)
    金額。

  - `payment_details.vat.currency` (string)
    通貨。[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)に基づく3文字の通貨コード。

  - `payment_details.vat.percent` (number)
    消費税率。

  - `payment_details.xsolla_balance_sum` (object)
    エクソラの残高から振り込まれた金額。

  - `payment_details.xsolla_balance_sum.amount` (number)
    金額。

  - `payment_details.xsolla_balance_sum.currency` (string)
    通貨。[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)に基づく3文字の通貨コード。

  - `payment_details.xsolla_fee` (object)
    エクソラ料金（オブジェクト）。

  - `payment_details.xsolla_fee.amount` (number)
    金額。

  - `payment_details.xsolla_fee.currency` (string)
    通貨。[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)に基づく3文字の通貨コード。

  - `purchase` (object)
    購入内容（オブジェクト）。

  - `purchase.checkout` (object)
    チェックアウトの詳細（オブジェクト）。

  - `purchase.checkout.amount` (number)
    購入金額。

  - `purchase.checkout.currency` (string)
    通貨。[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)に基づく3文字の通貨コード。

  - `purchase.subscription` (object)
    サブスクリプションの詳細（オブジェクト）。

  - `purchase.subscription.amount` (number)
    現金通貨での価格。

  - `purchase.subscription.currency` (string)
    通貨。[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)に基づく3文字の通貨コード。

  - `purchase.subscription.date_create` (string)
    サブスクリプション作成日。日付時刻表記は、[ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)形式。

  - `purchase.subscription.plan_id` (string)
    プランID（プランがAPIを使用して作成された場合は外部）。

  - `purchase.subscription.subscription_id` (integer)
    エクソラデータベースのサブスクリプションID。

  - `purchase.subscription.tags` (array)
    プランのタグ。

  - `purchase.total` (object, required)
    購入（オブジェクト）の合計価格。

  - `purchase.total.amount` (number)
    支払額合計。

  - `purchase.total.currency` (string)
    通貨。[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)に基づく3文字の通貨コード。

  - `refund_details` (object)
    返金の詳細（オブジェクト）。

  - `refund_details.author` (string)
    返金イニシエーター。フィールド値は、次の表に従って渡されます：


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

  - `refund_details.code` (integer)
    コードID。

  - `refund_details.reason` (string)
    返金の理由。

  - `settings` (object)
    カスタムプロジェクト設定（オブジェクト）。

  - `settings.merchant_id` (integer)
    マーチャントID。

  - `settings.project_id` (integer)
    プロジェクトID。このパラメータは、[ドメインページ](https://publisher.xsolla.com/)のプロジェクト名の横にあります。

  - `transaction` (object, required)
    トランザクションの詳細（オブジェクト）。

  - `transaction.agreement` (integer)
    契約ID

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

  - `transaction.external_id` (string)
    トランザクション外部ID。

  - `transaction.id` (integer)
    トランザクションID。

  - `transaction.payment_method_order_id` (string)
    決済システムの決済ID。

  - `user` (object)
    ユーザーの詳細（オブジェクト）。

  - `user.country` (string)
    ユーザーの国。2文字の国コード（大文字）は、[ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)に従って使用されます。

  - `user.email` (string)
    ユーザーのEメール。

  - `user.id` (string, required)
    ユーザーID。

  - `user.ip` (string)
    ユーザーIP。

  - `user.name` (string)
    ユーザー名。

  - `user.phone` (string)
    ユーザーの電話。

  - `user.zip` (string)
    Zipまたは郵便番号。

## Response 400 fields (application/json):

  - `error` (object)

  - `error.code` (string)

  - `error.message` (string)


## Response 204 fields

## Response 500 fields
