# 退款

当支付取消时，艾克索拉会向Webhook URL发送带有refund类型的Webhook，其中包含已取消交易的详细信息。

Webhook重试机制取决于退款发起方：
* 若退款由您方发起，系统不会重新发送Webhook。无论对Webhook的响应如何，款项都将退还给用户。
* 若退款由第三方发起（如支付系统或艾克索拉客户支持团队），且Webhook响应返回5xx状态码，系统会按递增间隔重新发送Webhook。最多重试12次，时间范
  围为首次尝试后的48小时内。

有关退款流程的详细信息，请参阅相关说明。


注意
如满足以下所有条件，款项仍将退还给用户：退款由艾克索拉发起。Webhook响应返回4xx状态码，或在所有重试后未收到响应，或返回5xx状态码。


在发布商帐户中保
存Webhook URL时，还可以设置在Webhook中接收额外信息。


注：
如果是在2025年1月22日或之前注册的发布商帐户，可在项目的设置> Webhooks> 测试 > 付款> 高级设置部分中找到这些开关。




    
        开关
        描述
    


    
        显示通过保存的支付方式进行的交易的信息
        信息在Webhook的以下自定义参数中传递：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
        有同一张发票的重复交易。

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

  - `payment_details.country_wht.percent` (number)
    国家/地区预扣税税率(%)。

  - `payment_details.direct_wht` (object)
    直接预扣税。

  - `payment_details.direct_wht.percent` (number)
    直接预扣税税率。

  - `payment_details.payment` (object)
    带有用户支付相关数据的对象。

  - `payment_details.payment_method_fee` (object)
    支付系统佣金的大小。

  - `payment_details.payment_method_sum` (object)
    带有通过支付方式收费的金额相关数据的对象。

  - `payment_details.payout` (object)
    带有支出详细信息的对象。

  - `payment_details.payout_currency_rate` (string)
    从支付币种到支出币种的汇率。

  - `payment_details.repatriation_commission` (object)
    包含汇回本国费用数据的对象，该费用是第三方对艾克索拉收取的费用。

  - `payment_details.sales_tax` (object)
    销售税（对象；仅适用于美国和加拿大）。

  - `payment_details.sales_tax.percent` (number)
    销售税税率。

  - `payment_details.user_acquisition_fee` (object)
    从通过联盟网络和圈内达人完成的购买中扣除的用户获取费用总额（对象）。

  - `payment_details.user_acquisition_fee.percent` (number)
    用户获取费费率(%)。

  - `payment_details.vat` (object)
    增值税大小（仅适用于欧盟）。

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

  - `payment_details.xsolla_balance_sum` (object)
    计入艾克索拉余额的金额。

  - `payment_details.xsolla_fee` (object)
    艾克索拉费用（对象）。

  - `purchase` (object)
    带有购买相关数据的对象。

  - `purchase.checkout` (object)
    带有结账参数相关数据的对象。

  - `purchase.checkout.amount` (number)
    购买金额。

  - `purchase.subscription` (object)
    订阅详情（对象）。

  - `purchase.subscription.amount` (number)
    以实际货币表示的价格。

  - `purchase.subscription.date_create` (string)
    订阅的创建日期。符合 [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)标准规定的日期与时间。

  - `purchase.subscription.plan_id` (string)
    计划ID（如果计划通过API创建，则为外部ID）。

  - `purchase.subscription.subscription_id` (integer)
    艾克索拉数据库的订阅ID。

  - `purchase.subscription.tags` (array)
    计划标签。

  - `purchase.total` (object, required)
    带有总购买价格相关数据的对象。

  - `purchase.total.amount` (number)
    总购买金额。

  - `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)
    项目编号。您可以在您的[发布商帐户](https://publisher.xsolla.com/)项目名称旁边。

  - `transaction` (object, required)
    交易ID。

  - `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)
    用户所在国家/地区。使用[ISO 3166-1 alpha-2 标准](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)规定的2字母组合表示国家/地区。

  - `user.email` (string)
    用户电子邮件。

  - `user.id` (string, required)
    用户ID。

  - `user.ip` (string)
    用户 IP 地址。

  - `user.name` (string)
    用户名。

  - `user.phone` (string)
    用户电话号码（采用国际格式）。

  - `user.zip` (string)
    邮编。

## Response 400 fields (application/json):

  - `error` (object)

  - `error.code` (string)

  - `error.message` (string)


## Response 204 fields

## Response 500 fields