申请退款

更新时间:2025.03.06
||

在交易完成后的一年内(以支付成功时间为起点+365天计算),若因用户或子商户(也叫特约商户)方面导致需进行订单退款,服务商可通过此接口将支付金额的全部或部分原路退还至用户。

注意:

1、一笔订单最多支持50次部分退款(若需多次部分退款,请更换商户退款单号并间隔1分钟后再次调用)。

2、在申请退款失败后进行重试时,请务必使用原商户退款单号,以避免因重复退款而导致的资金损失。

3、同一服务商商户号下,此接口调用成功的频率限制为150QPS,而调用失败报错时的频率限制为6QPS。

4、申请退款接口返回成功仅表示退款单已受理成功,具体的退款结果需依据退款结果通知查询退款的返回信息为准。

5、若一个月前的订单申请退款时返回报错“频率限制,1个月之前的订单请降低申请频率再重试”,请调整退款时间,再使用原参数进行重试。

接口说明

支持商户:【普通服务商】

请求方式:【POST】/v3/refund/domestic/refunds

请求域名:【主域名】https://api.mch.weixin.qq.com 使用该域名将访问就近的接入点

     【备域名】https://api2.mch.weixin.qq.com 使用该域名将访问异地的接入点 ,指引点击查看

请求参数
折叠全部参数

Header HTTP头参数

Authorization  必填 string

请参考签名认证生成认证信息


Accept  必填 string

请设置为application/json


Content-Type  必填 string

请设置为application/json


body  包体参数

sub_mchid  必填 string(32)

【子商户号】服务商下的子商户商户号,普通服务商使用特约商户进件生成,平台收付通服务商使用二级商户进件生成。


 transaction_id  必填   string(32)

【微信交易订单号】 微信支付分扣款单的唯一标识,非0元结单且支付分渠道扣款成功后支付成功回调查询支付分订单返回的收款信息明细collection.details中包含该字段。


 out_refund_no  必填   string(64)

【商户退款单号】 服务商系统内部的退款单号,服务商系统内部唯一,只能是数字、大小写字母_-|*@ ,同一商户退款单号多次请求只退一笔。不可超过64个字节数。


 reason  选填   string(80)

【退款原因】 若商户传入了退款原因,该字段将显示在用户接收到的退款消息通知中。
注意:若订单部分退款且退款金额≤1元,则不会在退款消息中体现退款原因。


notify_url  选填   string(256)

【退款结果回调url】
商户异步接收退款结果通知的回调地址,通知url必须为外网可访问的url,不能携带参数,如果申请退款参数中传了notify_url,则服务商平台上配置的退款回调地址将不会生效,优先回调当前传的这个地址。需按照notify-url填写注意事项规范填写。


 funds_account  选填   string

【退款资金来源】 若传递此参数则使用对应的资金账户退款。

可选取值:

  • AVAILABLE: 仅对旧资金流商户适用(请参考旧资金流介绍区分),传此枚举指定从可用余额账户出资,否则默认使用未结算资金退款。

  • UNSETTLED: 仅对出行预付押金退款适用,指定从未结算资金出资。


 amount  必填   object

【金额信息】 订单金额信息

属性

 refund  必填   integer

【退款金额】 退款金额,币种的最小单位,只能为整数,不能超过原订单支付金额。


 from  选填   array[object]

【退款出资账户及金额】申请退款时传的出资账户类型及出资金额。

属性

 account  必填   string(32)

【出资账户类型】 退款出资的账户类型。
可选取值:
AVAILABLE: 商户基本账户可用余额;
UNAVAILABLE: 商户基本账户分账冻结的不可用余额;


 amount  必填   integer

【出资金额】对应账户出资金额,单位为分


 total  必填   integer

【原订单金额】 原支付交易的订单总金额,单位为分,只能为整数。


 currency  选填   string(16)

【退款币种】  固定传CNY,代表人民币。


 goods_detail  选填   array[GoodsDetail]

【退款商品】 指定商品退款需要传此参数,其他场景无需传递

属性

 merchant_goods_id  必填   string(32)

【商户侧商品编码】 订单下单时传入的商户侧商品编码。


 wechatpay_goods_id   选填  string(32)

【微信侧商品编码】 订单下单时传入的微信侧商品编码(没有可不传)


 goods_name   选填  string(256)

【商品名称】 订单下单时传入的商品名称。


 unit_price  必填   integer

【商品单价】 订单下单时传入的商品单价。


 refund_amount  必填   integer

【商品退款金额】 商品退款金额,单位为分


 refund_quantity  必填   integer

【商品退货数量】 对应商品的退货数量

 

请求示例

1curl -X POST \
2  https://api.mch.weixin.qq.com/v3/refund/domestic/refunds \
3  -H "Authorization: WECHATPAY2-SHA256-RSA2048 mchid=\"1900000001\",..." \
4  -H "Accept: application/json" \
5  -H "Content-Type: application/json" \
6  -d '{
7    "sub_mchid" : "1900000109",
8    "transaction_id" : "1217752501201407033233368018",
9    "out_refund_no" : "1217752501201407033233368018",
10    "reason" : "商品已售完",
11    "notify_url" : "https://weixin.qq.com",
12    "funds_account" : "AVAILABLE",
13    "amount" : {
14      "refund" : 888,
15      "from" : [
16        {
17          "account" : "AVAILABLE",
18          "amount" : 444
19        }
20      ],
21      "total" : 888,
22      "currency" : "CNY"
23    },
24    "goods_detail" : [
25      {
26        "merchant_goods_id" : "1217752501201407033233368018",
27        "wechatpay_goods_id" : "1001",
28        "goods_name" : "iPhone6s 16G",
29        "unit_price" : 528800,
30        "refund_amount" : 528800,
31        "refund_quantity" : 1
32      }
33    ]
34  }'

应答参数
折叠全部参数

200 OK

 refund_id  必填   string(32)

【微信支付退款订单号】申请退款受理成功时,该笔退款单在微信支付侧生成的唯一标识,由数字组成,50或52开头。


 out_refund_no  必填   string(64)

【商户退款单号】 服务商申请退款时传的服务商系统内部退款单号。


transaction_id  必填 string(32)

【微信交易订单号】 微信支付分扣款单的唯一标识,非0元结单且支付分渠道扣款成功后支付成功回调查询支付分订单返回的收款信息明细collection.details中包含该字段。
transaction_id和out_trade_no二选一填写,建议商户都通过transaction_id申请退款。


out_trade_no  必填 string(32)

【商户订单号】 支付分轮询扣款时生成的商户订单号。


channel  必填 string

【退款渠道】 订单退款渠道
以下枚举:

  • ORIGINAL: 原路退款

  • BALANCE: 退回到余额

  • OTHER_BALANCE: 原账户异常退到其他余额账户

  • OTHER_BANKCARD: 原银行卡异常退到其他银行卡(发起异常退款成功后返回)


user_received_account  必填 string(64)

【退款入账账户】 取当前退款单的退款入账方,有以下几种情况:
1)退回银行卡:{银行名称}{卡类型}{卡尾号}
2)退回支付用户零钱:支付用户零钱
3)退还商户:商户基本账户商户结算银行账户
4)退回支付用户零钱通:支付用户零钱通
5)退回支付用户银行电子账户:支付用户银行电子账户
6)退回支付用户零花钱:支付用户零花钱
7)退回用户经营账户:用户经营账户
8)退回支付用户来华零钱包:支付用户来华零钱包
9)退回企业支付商户:企业支付商户
10)退回支付用户小金罐:支付用户小金罐
11)退回支付用户分付:支付用户分付
12)退回微银通:{银行名称}微银通


success_time  选填 string(64)

【退款成功时间】

1、定义:退款成功的时间,该字段在退款状态status为SUCCESS(退款成功)时返回。

2、格式遵循rfc3339标准格式:yyyy-MM-DDTHH:mm:ss+TIMEZONEyyyy-MM-DD 表示年月日;T 字符用于分隔日期和时间部分;HH:mm:ss 表示具体的时分秒;TIMEZONE 表示时区(例如,+08:00 对应东八区时间,即北京时间)。

示例:2015-05-20T13:29:35+08:00 表示北京时间2015年5月20日13点29分35秒。


create_time  必填 string(64)

【退款创建时间】

1、定义:提交退款申请成功,微信受理退款申请单的时间。

2、格式遵循rfc3339标准格式:yyyy-MM-DDTHH:mm:ss+TIMEZONEyyyy-MM-DD 表示年月日;T 字符用于分隔日期和时间部分;HH:mm:ss 表示具体的时分秒;TIMEZONE 表示时区(例如,+08:00 对应东八区时间,即北京时间)。

示例:2015-05-20T13:29:35+08:00 表示北京时间2015年5月20日13点29分35秒。


status  必填 string

【退款状态】退款单的退款处理状态。

  • SUCCESS: 退款成功

  • CLOSED: 退款关闭

  • PROCESSING: 退款处理中

  • ABNORMAL: 退款异常,退款到银行发现用户的卡作废或者冻结了,导致原路退款银行卡失败,可前往服务商平台-交易中心,手动处理此笔退款,可参考: 退款异常的处理


funds_account  必填 string

【资金账户】 退款所使用资金对应的资金账户类型

  • UNSETTLED: 未结算资金

  • AVAILABLE: 可用余额

  • UNAVAILABLE: 不可用余额

  • OPERATION: 运营账户

  • BASIC: 基本账户(含可用余额和不可用余额)

  • ECNY_BASIC: 数字人民币基本账户


amount  必填 object

【退款金额】订单退款金额信息

属性

total  必填 integer

【订单金额】 订单总金额,单位为分


refund  必填 integer

【退款金额】退款金额,单位为分,只能为整数,可以做部分退款,不能超过原订单支付金额。


from  选填 array[object]

【退款出资账户及金额】 退款出资的账户类型及金额信息,若此接口请求时未传该参数,则不会返回。

属性

account  必填 string

【出资账户类型】退款出资的账户类型。
可选取值:
AVAILABLE: 商户基本账户可用余额;
UNAVAILABLE: 商户基本账户分账冻结的不可用余额;
注:多条from中的account不能重复。


amount  必填 integer

【出资金额】 对应账户出资金额,单位为分。注:多条from中的amount之和需等于申请退款金额。


payer_total  必填 integer

【用户实际支付金额】用户现金支付金额,整型,单位为分,例如10元订单用户使用了2元全场代金券,则该金额为用户实际支付的8元。


payer_refund  必填 integer

【用户退款金额】 指用户实际收到的现金退款金额,数据类型为整型,单位为分。例如在一个10元的订单中,用户使用了2元的全场代金券,若商户申请退款5元,则用户将收到4元的现金退款(即该字段所示金额)和1元的代金券退款。
注:部分退款用户无法继续使用代金券,只有在订单全额退款且代金券未过期的情况下,且全场券属于银行立减金用户才能继续使用代金券。
详情参考含优惠退款说明


settlement_refund  必填 integer

【应结退款金额】 去掉免充值代金券退款金额后的退款金额,整型,单位为分,例如10元订单用户使用了2元全场代金券(一张免充值1元 + 一张预充值1元),商户申请退款5元,则该金额为 退款金额5元 - 0.5元免充值代金券退款金额 = 4.5元。


settlement_total  必填 integer

【应结订单金额】去除免充值代金券金额后的订单金额,整型,单位为分,例如10元订单用户使用了2元全场代金券(一张免充值1元 + 一张预充值1元),则该金额为 订单金额10元 - 免充值代金券金额1元 = 9元。


discount_refund  必填 integer

【优惠退款金额】 申请退款后用户收到的代金券退款金额,整型,单位为分,例如10元订单用户使用了2元全场代金券,商户申请退款5元,用户收到的是4元现金 + 1元代金券退款金额(该字段) 。


currency  必填 string(16)

【货币类型】 固定返回:CNY(人民币)


refund_fee  选填 integer

【手续费退款金额】 订单退款时退还的手续费金额,整型,单位为分,例如一笔100元的订单收了0.6元手续费,商户申请退款50元,该金额为等比退还的0.3元手续费。


promotion_detail  选填 array[object]

【优惠退款详情】 订单各个代金券的退款详情,订单使用了代金券且代金券发生退款时返回。

属性

promotion_id  必填 string(32)

【券ID】代金券id,单张代金券的编号


scope  必填 string

【优惠范围】优惠活动中代金券的适用范围,分为两种类型:
GLOBAL:全场代金券-以订单整体可优惠的金额为优惠门槛的代金券;
SINGLE:单品优惠-以订单中具体某个单品的总金额为优惠门槛的代金券


type  必填 string

【优惠类型】代金券资金类型,优惠活动中代金券的结算资金类型,分为两种类型:
CASH:预充值-带有结算资金的代金券,会随订单结算给订单收款商户;
NOCASH:免充值-不带有结算资金的代金券,无资金结算给订单收款商户。


amount  必填 integer

【代金券面额】 代金券优惠的金额


refund_amount  必填 integer

【优惠退款金额】 代金券退款的金额


goods_detail  选填 array[object]

【退款商品】 申请退款时填写的退款商品信息


merchant_goods_id  必填 string(32)

【商户侧商品编码】 申请退款的商户侧商品编码。


wechatpay_goods_id   选填 string(32)

【微信侧商品编码】 申请退款的微信侧商品编码。(申请退款时没传则不返回)


goods_name   选填 string(256)

【商品名称】 申请退款的商品名称。(申请退款时没传则不返回)


unit_price  必填 integer

【商品单价】 申请退款的商品单价。


refund_amount  必填 integer

【商品退款金额】 申请退款的商品退款金额。


refund_quantity  必填 integer

【商品退货数量】 申请退款的商品退货数量。

 

应答示例

200 OK

1{
2  "refund_id" : "50000000382019052709732678859",
3  "out_refund_no" : "1217752501201407033233368018",
4  "transaction_id" : "1217752501201407033233368018",
5  "out_trade_no" : "1217752501201407033233368018",
6  "channel" : "ORIGINAL",
7  "user_received_account" : "招商银行信用卡0403",
8  "success_time" : "2020-12-01T16:18:12+08:00",
9  "create_time" : "2020-12-01T16:18:12+08:00",
10  "status" : "SUCCESS",
11  "funds_account" : "UNSETTLED",
12  "amount" : {
13    "total" : 100,
14    "refund" : 100,
15    "from" : [
16      {
17        "account" : "AVAILABLE",
18        "amount" : 444
19      }
20    ],
21    "payer_total" : 90,
22    "payer_refund" : 90,
23    "settlement_refund" : 100,
24    "settlement_total" : 100,
25    "discount_refund" : 10,
26    "currency" : "CNY",
27    "refund_fee" : 100
28  },
29  "promotion_detail" : [
30    {
31      "promotion_id" : "109519",
32      "scope" : "GLOBAL",
33      "type" : "COUPON",
34      "amount" : 5,
35      "refund_amount" : 100,
36      "goods_detail" : [
37        {
38          "merchant_goods_id" : "1217752501201407033233368018",
39          "wechatpay_goods_id" : "1001",
40          "goods_name" : "iPhone6s 16G",
41          "unit_price" : 528800,
42          "refund_amount" : 528800,
43          "refund_quantity" : 1
44        }
45      ]
46    }
47  ]
48}

 

错误码

公共错误码

状态码

错误码

描述

解决方案

400

PARAM_ERROR

参数错误

请根据错误提示正确传入参数

400

INVALID_REQUEST

HTTP 请求不符合微信支付 APIv3 接口规则

请参阅 接口规则

401

SIGN_ERROR

验证不通过

请参阅 签名常见问题

500

SYSTEM_ERROR

系统异常,请稍后重试

请稍后重试

业务错误码

状态码

错误码

描述

解决方案

400

INVALID_REQUEST

请求参数符合参数格式,但不符合业务规则

此状态代表退款申请失败,商户可根据具体的错误提示做相应的处理。

401

SIGN_ERROR

签名错误

请检查签名参数和方法是否都符合签名算法要求,参考:如何生成签名

403

NOT_ENOUGH

余额不足

此状态代表退款申请失败,商户账户余额不足。

403

USER_ACCOUNT_ABNORMAL

退款请求失败

此状态代表退款申请失败,商户可自行处理退款。

404

MCH_NOT_EXISTS

MCHID不存在

请检查商户号是否正确,商户号获取方式请参考服务商模式开发必要参数说明

404

RESOURCE_NOT_EXISTS

订单号不存在

请检查你的订单号是否正确且是否已支付,未支付的订单不能发起退款

429

FREQUENCY_LIMITED

频率限制

该笔退款为受理中,请调用查单接口确认或降低频率原单重试,重试请勿更换单号

500

SYSTEM_ERROR

系统超时

请不要更换商户退款单号,请使用相同参数再次调用API。

 

 

 

元宝AI
反馈
目录
置顶