Xsolla-logo

一部返金Webhook POST

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

ウェブフックで詳細情報を受信する権限を与えることができます。これを行うには、アドミンページでのプロジェクト設定 > ウェブフック > 高度な設定セクションで以下のトグルをオンに設定します：

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

情報は、パラメータの以下のカスタムパラメータに渡されます：

  • 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 ゲームによってキャンセルが要求されました。
推奨事項：ブロックリストにユーザーを追加しません。
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
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

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

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

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 
curl -v 'https://your.hostname/your/uri' \
-X POST \
-d '{
        "notification_type": "partial_refund",
        "settings": {
          "project_id": 18404,
          "merchant_id": 2340
        },
        "purchase": {
            "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,
            "date": "2022-03-01 10:53:15"
        },
        "refund_details": {
            "author": "email@example.com",
            "date": "2022-03-01 10:56:48"
        },
        "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–2024 Xsolla Inc.