# 一部返金

一部返金が行われた場合、エクソーラはpartial_refundタイプのウェブフックのウェブフックURLにキャンセルされたトランザクションの詳細を送信します
。返金プロセスの一部の詳細は、これらの説明を参照してください。

パブリッシャーアカウントにウェブフックURLを保存すると、ウェブフックで詳細情報を受信する権限を与えることができます。これを行うには、パブリッシャーアカウントの
プロジェクト設定&gt
; ウェブフック&gt; 詳細設定 セクションで次のトグルを「アクティブ」に設定します。


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

Endpoint: POST partial-refund
Version: 1.0

## Request fields (application/json):

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

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

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

  - `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.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.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.date` (string)
    返金日。

  - `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.date` (string)
    トランザクション日。

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

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

  - `transaction.id` (integer)
    トランザクション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
