# 微信支付 - 申请退款

该接口方法需要安装 小程序微信支付能力，如未安装需要前往安装才可以使用

# 接口英文名

wxpay_refund

注意：该接口仅支持在服务端调用

# 调用方式

# 1. 使用云函数在服务端调用申请退款接口

模板已内置了云函数代码，可以直接在微信开发者工具中下载到本地修改后使用。 也可以手动创建云函数来完成，点击在线代码示例，可以查看云函数示例代码。

• 下载模板云函数代码到本地

打开微信开发者工具界面，在cloudfunctions目录点击右键，选择同步云函数列表，同步模板中的云函数wxpayFunctions到本地；然后在云函数wxpayFunctions目录右键，选择下载，即可下载模板内置的云函数代码到本地。如下图所示：

• 编辑下单云函数

修改云函数wxpayFunctions下的wxpay_refund/index.js代码，参数更新为业务实际参数。云函数编辑后，需要重新部署。

# 2. 小程序端调用云函数申请退款

小程序端调用云函数时，需要先在小程序端初始化云能力。修改app.js，在 App的 onLaunch 生命周期方法中添加云能力初始化代码，参数传入用户的云开发环境ID。

App({
  onLaunch: function () {
    wx.cloud.init({
      // env 参数决定接下来小程序发起的云开发调用（wx.cloud.xxx）会默认请求到哪个云环境的资源
      env: '{%TCB_ENV_ID%}',
      // 是否在将用户访问记录到用户管理中，在控制台中可见，默认为false
      traceUser: false,
    });
  },
});

小程序中调用步骤 1 中的云函数，查询订单。

// 小程序代码
wx.cloud.callFunction({
  // 云函数名称
  name: 'wxpayFunctions',
  data: {
    // 调用云函数中的申请退款方法
    type: 'wxpay_refund',
    // 业务其他参数...
  },
  success: (res) => {
    console.log('申请退款结果: ', res);
  },
});

# 3. 接收并处理退款通知（可选）

如果插件配置中配置了接收退款通知的回调函数，则可以在自定义的云函数中接收到退款通知，通知中包含了订单详细支付信息，商户可自行处理并存储。

# 退款结果通知

模板wxpay可配置接收退款通知的回调函数，目前支持配置商户当前云开发环境下的一个或多个(以英文逗号,分隔)云函数，模板会将支付通知消息下发给商户配置的云函数，商户可以在云函数中对消息进行处理。

注意 商户接收并处理消息时，如果微信收到应答不是成功或超时，则认为通知失败，会通过一定的策略定期重新发起通知，尽可能提高通知的成功率，但不保证通知最终能成功。

• 同样的通知可能会多次发送给商户系统。商户系统必须能够正确处理重复的通知。 推荐的做法是，当商户系统收到通知进行处理时，先检查对应业务数据的状态，并判断该通知是否已经处理。如果未处理，则再进行处理；如果已处理，则直接返回结果成功。
• 如果在所有通知频率后没有收到微信侧回调。商户应调用查询退款接口确认订单状态。

通知规则 如果微信收到商户的应答不符合规范或超时，则认为通知失败，会通过一定的策略定期重新发起通知，尽可能提高通知的成功率，但不保证通知最终能成功（通知频率为15s/15s/30s/3m/10m/20m/30m/30m/30m/60m/3h/3h/3h/6h/6h - 总计 24h4m）

商户通知应答

• 返回的包体包含字段 code 值为 SUCCESS，标识商户接收消息通知成功；
• 除成功包体外的其他响应格式，视为商户接收消息失败；
• 如果商户配置了多个接收消息通知的云函数，则所有函数都返回成功包体，才视为接收消息成功；否则，微信重试时会重复通知到所有的云函数。

# 更多说明

错误码请参考申请退款

# 入参:

# 出参: