Xsolla-logo

部分退款Webhook POST

进行部分退款后，艾克索拉向Webhook URL发送一个partial_refund类型的Webhook并在其中包含已取消交易的详细信息。有关部分退款流程的详细信息请参阅这些[说明](https:/ /developers.xsolla.com/zh/doc/pay- station/features/refund/#pay_station_features_refund_how_it_works_partial_refund _flow)。

退款代码：

代码 退款理由 描述
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

交易ID。

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的三字母货币代码。

percent
integer <float>

直接预扣税税率。

object

带有用户支付相关数据的对象。

amount
integer <float>

金额。

currency
string

货币。符合ISO 4217的三字母货币代码。

object

支付系统佣金的大小。

amount
integer <float>

金额。

currency
string

货币。符合ISO 4217的三字母货币代码。

object

带有通过支付方式收费的金额相关数据的对象。

amount
integer <float>

金额。

currency
string

货币。符合ISO 4217的三字母货币代码。

object

带有支出详细信息的对象。

amount
integer <float>

金额。

currency
string

货币。符合ISO 4217的三字母货币代码。

payout_currency_rate
integer <float>

从支付币种到支出币种的汇率。

object

包含汇回本国费用数据的对象，该费用是第三方对艾克索拉收取的费用。

amount
integer <float>

金额。

currency
string

货币。符合ISO 4217的三字母货币代码。

object

销售税（对象；仅适用于美国和加拿大）。

amount
integer <float>

金额。

currency
string

货币。符合ISO 4217的三字母货币代码。

percent
integer <float>

销售税税率。

object

增值税大小（仅适用于欧盟）。

amount
integer <float>

金额。

currency
string

货币。符合ISO 4217的三字母货币代码。

percent
integer <float>

VAT税率。

object

计入艾克索拉余额的金额。

amount
integer <float>

金额。

currency
string

货币。符合ISO 4217的三字母货币代码。

object

艾克索拉费用（对象）。

amount
integer <float>

金额。

currency
string

货币。符合ISO 4217的三字母货币代码。

custom_parameters
object

您的自定义参数。

object

带有购买相关数据的对象。

required
object

带有总购买价格相关数据的对象。

amount
integer <float>

部分退款支付金额。

currency
string

货币。符合ISO 4217的三字母货币代码。

object

带有结账参数相关数据的对象。

amount
integer <float>

购买金额。

currency
string

货币。符合ISO 4217的三字母货币代码。

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。可以在发布商帐户中找到该ID。

object

用户详情（对象）。

id
required
string

用户ID。

country
string

用户所在国家/地区。使用ISO 3166-1 alpha-2 标准规定的2字母组合表示国家/地区。

email
string

用户电子邮件。

ip
string

用户 IP 地址。

name
string

用户名。

phone
string

用户电话号码（采用国际格式）。

zip
string

邮编。

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": {
    }
}