微信支付 API
  1. API列表
微信支付 API
  • 文档说明
    • 阅读对象
    • 版本说明
  • 术语
    • 支付模式
    • 名词解释
  • 支付账户
    • 支付账户
  • 接口规则
    • 协议规则
    • 参数规定
    • 安全规范
    • 获取openid
  • JSAPI支付
    • 场景介绍
    • 案例介绍
    • 接入前准备
    • 开发指引
    • 获取微信版本号
    • JSAPI调起支付
    • 支付常见问题
  • API列表
    • 统一下单
      POST
    • 查询订单
      POST
    • 关闭订单
      POST
    • 申请退款
      POST
    • 查询退款
      POST
    • 下载交易账单
      POST
    • 下载资金账单
      POST
    • 支付结果通知
      POST
    • 交易保障
      POST
    • 退款结果通知
      POST
  • 最佳实践
    • 支付回调和查单实现指引
    • 支付验收指引
    • 网络排查指引
    • 最佳安全实践
    • 跨城冗灾方案
    • 回调通知注意事项
    • 专线商户Notify升级指引
    • 商户收银台H5大字号规范
    • 微信支付二维码规范
  • 运营规范
    • 运营规范
  • SDK与DEMO下载
    • SDK与DEMO下载
  1. API列表

申请退款

POST
/secapi/pay/refund

应用场景#

当交易发生之后一段时间内,由于买家或者卖家的原因需要退款时,卖家可以通过退款接口将支付款退还给买家,微信支付将在收到退款请求并且验证成功之后,按照退款规则将支付款按原路退到买家账号上。
注意:
1、交易时间超过一年的订单无法提交退款
2、微信支付退款支持单笔交易分多次退款,多次退款需要提交原支付订单的商户订单号和设置不同的退款单号。申请退款总金额不能超过订单金额。 一笔退款失败后重新提交,请不要更换退款单号,请使用原商户退款单号
3、请求频率限制:150qps,即每秒钟正常的申请退款请求次数不超过150次
4、每个支付订单的部分退款次数不能超过50次
5、如果同一个用户有多笔退款,建议分不同批次进行退款,避免并发退款导致退款失败
6、申请退款接口的返回仅代表业务的受理情况,具体退款是否成功,需要通过退款查询接口获取结果。
7、一个月之前的订单申请退款频率限制为:5000/min
8、同一笔订单多次退款的请求需相隔1分钟

状态机#

退款状态转变如下:
img

是否需要证书#

请求需要双向证书。 详见证书使用

错误码#

名称描述原因解决方案
SYSTEMERROR接口返回错误系统超时等请不要更换商户退款单号,请使用相同参数再次调用API。
BIZERR_NEED_RETRY退款业务流程错误,需要商户触发重试来解决并发情况下,业务被拒绝,商户重试即可解决请不要更换商户退款单号,请使用相同参数再次调用API。
TRADE_OVERDUE订单已经超过退款期限订单已经超过可退款的最大期限(支付后一年内可退款)请选择其他方式自行退款
ERROR业务错误申请退款业务发生错误该错误都会返回具体的错误原因,请根据实际返回做相应处理。
USER_ACCOUNT_ABNORMAL退款请求失败用户账号注销此状态代表退款申请失败,商户可自行处理退款。
INVALID_REQ_TOO_MUCH无效请求过多连续错误请求数过多被系统短暂屏蔽请检查业务是否正常,确认业务正常后请在1分钟后再来重试
NOTENOUGH余额不足商户可用退款余额不足此状态代表退款申请失败,商户可根据具体的错误提示做相应的处理。
INVALID_TRANSACTIONID无效transaction_id请求参数未按指引进行填写请求参数错误,检查原交易号是否存在或发起支付交易接口返回失败
PARAM_ERROR参数错误请求参数未按指引进行填写请求参数错误,请重新检查再调用退款申请
APPID_NOT_EXISTAPPID不存在参数中缺少APPID请检查APPID是否正确
MCHID_NOT_EXISTMCHID不存在参数中缺少MCHID请检查MCHID是否正确
ORDERNOTEXIST订单号不存在缺少有效的订单号请检查你的订单号是否正确且是否已支付,未支付的订单不能发起退款
REQUIRE_POST_METHOD请使用post方法未使用post传递参数请检查请求参数是否通过post方法提交
SIGNERROR签名错误参数签名结果不正确请检查签名参数和方法是否都符合签名算法要求
XML_FORMAT_ERRORXML格式错误XML格式错误请检查XML参数格式是否正确
FREQUENCY_LIMITED频率限制1个月之前的订单申请退款有频率限制该笔退款未受理,请降低频率后重试
NOAUTH异常IP请求不予受理请求ip异常如果是动态ip,请登录商户平台后台关闭ip安全配置; 如果是静态ip,请确认商户平台配置的请求ip 在不在配的ip列表里
CERT_ERROR证书校验错误请检查证书是否正确,证书是否过期或作废。请检查证书是否正确,证书是否过期或作废。
REFUND_FEE_MISMATCH订单金额或退款金额与之前请求不一致,请核实后再试订单金额或退款金额与之前请求不一致,请核实后再试订单金额或退款金额与之前请求不一致,请核实后再试
INVALID_REQUEST请求参数符合参数格式,但不符合业务规则此状态代表退款申请失败,商户可根据具体的错误提示做相应的处理。此状态代表退款申请失败,商户可根据具体的错误提示做相应的处理。
ORDER_NOT_READY订单处理中,暂时无法退款,请稍后再试订单处理中,暂时无法退款,请稍后再试订单处理中,暂时无法退款,请稍后再试
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST '/secapi/pay/refund' \
--header 'Content-Type: application/xml' \
--data-raw '<xml>
   <appid>wx2421b1c4370ec43b</appid>
   <mch_id>10000100</mch_id>
   <nonce_str>6cefdb308e1e2e8aabd48cf79e546a02</nonce_str>
   <out_refund_no>1415701182</out_refund_no>
   <out_trade_no>1415757673</out_trade_no>
   <refund_fee>1</refund_fee>
   <total_fee>1</total_fee>
   <transaction_id>4006252001201705123297353072</transaction_id>
   <sign>FE56DD4AA85C0EECA82C35595A69E153</sign>
</xml>'
响应示例响应示例
<xml>
   <return_code><![CDATA[SUCCESS]]></return_code>
   <return_msg><![CDATA[OK]]></return_msg>
   <appid><![CDATA[wx2421b1c4370ec43b]]></appid>
   <mch_id><![CDATA[10000100]]></mch_id>
   <nonce_str><![CDATA[NfsMFbUFpdbEhPXP]]></nonce_str>
   <sign><![CDATA[B7274EB9F8925EB93100DD2085FA56C0]]></sign>
   <result_code><![CDATA[SUCCESS]]></result_code>
   <transaction_id><![CDATA[1008450740201411110005820873]]></transaction_id>
   <out_trade_no><![CDATA[1415757673]]></out_trade_no>
   <out_refund_no><![CDATA[1415701182]]></out_refund_no>
   <refund_id><![CDATA[2008450740201411110000174436]]></refund_id>
   <refund_fee>1</refund_fee>
</xml>

请求参数

Body 参数application/xml
appid
string 
公众账号ID
必需
微信分配的公众账号ID(企业号corpid即为此appid)
mch_id
string 
商户号
必需
微信支付分配的商户号
nonce_str
string 
随机字符串
必需
随机字符串,不长于32位。推荐随机数生成算法
out_refund_no
string 
商户退款单号
必需
商户系统内部的退款单号,商户系统内部唯一,只能是数字、大小写字母_-|*@ ,同一退款单号多次请求只退一笔。
out_trade_no
string 
商户订单号
必需
商户系统内部订单号,要求32个字符内(最少6个字符),只能是数字、大小写字母_-|*且在同一个商户号下唯一。详见商户订单号 transaction_id、out_trade_no二选一,如果同时存在优先级:transaction_id> out_trade_no
refund_fee
string 
退款金额
必需
退款总金额,订单总金额,单位为分,只能为整数,详见支付金额
total_fee
string 
订单金额
必需
订单总金额,单位为分,只能为整数,详见支付金额
transaction_id
string 
微信支付订单号
必需
微信生成的订单号,在支付通知中有返回
sign
string 
签名
必需
签名,详见签名生成算法
sign_type
string 
签名类型
可选
签名类型,目前支持HMAC-SHA256和MD5,默认为MD5
refund_fee_type
string 
退款货币种类
可选
退款货币类型,需与支付一致,或者不填。符合ISO 4217标准的三位字母代码,默认人民币:CNY,其他值列表详见货币类型
refund_desc
string 
退款原因
可选
若商户传入,会在下发给用户的退款消息中体现退款原因 注意:若订单退款金额≤1元,且属于部分退款,则不会在退款消息中体现退款原因
refund_account
string 
退款资金来源
可选
仅针对老资金流商户使用 REFUND_SOURCE_UNSETTLED_FUNDS---未结算资金退款(默认使用未结算资金退款) REFUND_SOURCE_RECHARGE_FUNDS---可用余额退款
notify_url
string 
退款结果通知url
可选
异步接收微信支付退款结果通知的回调地址,通知URL必须为外网可访问的url,不允许带参数 公网域名必须为https,如果是走专线接入,使用专线NAT IP或者私有回调域名可使用http 如果参数中传了notify_url,则商户平台上配置的回调地址将不会生效。
示例

返回响应

🟢200成功
application/json
Body
return_code
string 
返回状态码
必需
SUCCESS/FAIL 此字段是通信标识,表示接口层的请求结果,并非退款状态。
return_msg
string 
返回信息
必需
当return_code为FAIL时返回信息为错误原因 ,例如 签名失败 参数格式校验错误
appid
string 
公众账号ID
必需
微信分配的公众账号ID
mch_id
string 
商户号
必需
微信支付分配的商户号
nonce_str
string 
随机字符串
必需
随机字符串,不长于32位
sign
string 
签名
必需
签名,详见签名算法
result_code
string 
业务结果
必需
SUCCESS/FAIL SUCCESS退款申请接收成功,结果通过退款查询接口查询 FAIL 提交业务失败
transaction_id
string 
微信支付订单号
必需
微信订单号
out_trade_no
string 
商户订单号
必需
商户系统内部订单号,要求32个字符内(最少6个字符),只能是数字、大小写字母_-|*且在同一个商户号下唯一。详见商户订单号
out_refund_no
string 
商户退款单号
必需
商户系统内部的退款单号,商户系统内部唯一,只能是数字、大小写字母_-|*@ ,同一退款单号多次请求只退一笔。
refund_id
string 
微信退款单号
必需
微信退款单号
refund_fee
string 
退款金额
必需
退款总金额,单位为分,可以做部分退款
err_code
string 
错误代码
可选
列表详见错误码列表
err_code_des
string 
错误代码描述
可选
结果信息描述
settlement_refund_fee
string 
应结退款金额
可选

去掉非充值代金券退款金额后的退款金额,退款金额=申请退款金额-非充值代金券退款金额,退款金额<=申请退款金额

total_fee
string 
标价金额
必需
订单总金额,单位为分,只能为整数,详见支付金额
settlement_total_fee 
string 
应结订单金额
可选

去掉非充值代金券金额后的订单总金额,应结订单金额=订单金额-非充值代金券金额,应结订单金额<=订单金额。

fee_type
string 
标价币种
可选
订单金额货币类型,符合ISO 4217标准的三位字母代码,默认人民币:CNY,其他值列表详见货币类型
cash_fee
string 
现金支付金额
必需
现金支付金额,单位为分,只能为整数,详见支付金额
cash_fee_type
string 
现金支付币种
可选
货币类型,符合ISO 4217标准的三位字母代码,默认人民币:CNY,其他值列表详见货币类型
cash_refund_fee
string 
现金退款金额
可选
现金退款金额,单位为分,只能为整数,详见支付金额
coupon_type_$n 
string 
代金券类型
可选
CASH--充值代金券 NO_CASH---非充值代金券 订单使用代金券时有返回(取值:CASH、NO_CASH)。$n为下标,从0开始编号,举例:coupon_type_0
coupon_refund_fee
string 
代金券退款总金额
可选

代金券退款金额<=退款金额,退款金额-代金券或立减优惠退款金额为现金,说明详见代金券或立减优惠

coupon_refund_fee_$n
string 
单个代金券退款金额
可选

代金券退款金额<=退款金额,退款金额-代金券或立减优惠退款金额为现金,说明详见代金券或立减优惠

coupon_refund_count
string 
退款代金券使用数量
可选
退款代金券使用数量
coupon_refund_id_$n
string 
退款代金券ID
可选
退款代金券ID, $n为下标,从0开始编号
上一页
关闭订单
下一页
查询退款
Built with