企业内部开发
基础
连接微信
办公
会议
会议统计管理
企业内部开发
服务端API
小程序接入对外收款
退款
查询退款
查询退款
最后更新:2023/02/07
提交退款申请后,通过调用该接口查询退款状态。
注意
● 退款有一定延时,用零钱支付的退款20分钟内到账,银行卡支付的退款3个工作日后重新查询退款状态。

 

请求方式:POST(HTTPS)
请求地址:https://qyapi.weixin.qq.com/cgi-bin/miniapppay/get_refund_detail?access_token=ACCESS_TOKEN

请求包体:

{
  "mchid" : "xxx",
  "out_refund_no" : "xxx"
}

参数说明:

参数名变量类型[长度限制]必填描述
商户号mchidstring[1,32]企业微信分配的商户号。
示例值:1900000109
商户退款单号out_refund_nostring[1,64]商户系统内部的退款单号,商户系统内部唯一,只能是数字、大小写字母_-|*@,同一退款单号多次请求只退一笔。
示例值:1217752501201407033233368018

 

返回结果:

{
	"out_refund_no": "1217752501201407033233368018",
	"out_trade_no": "1217752501201407033233368018",
	"channel": "ORIGINAL",
	"user_received_account": "招商银行信用卡0403",
	"success_time": "2018-06-08T10:34:56+08:00",
	"create_time": "2018-06-08T10:34:56+08:00",
	"status": "SUCCESS",
	"amount": {
		"refund": 888,
		"payer_refund": 888,
		"discount_refund": 888,
		"currency": "CNY"
	},
   "errcode": 0,
   "errmsg": "ok"
}

参数说明:

参数名变量类型[长度限制]必填描述
微信退款单号refund_idstring[1,32]微信支付退款订单号。
示例值:1217752501201407033233368018
商户退款单号out_refund_nostring[1,64]商户系统内部的退款单号,商户系统内部唯一,同一退款单号多次请求只退一笔。
示例值:1217752501201407033233368018
微信订单号transaction_idstring[1,32]微信支付交易订单号。
示例值: 1217752501201407033233368018
商户订单号out_trade_nostring[1,32]返回的原交易订单号。
示例值: 1217752501201407033233368018
退款渠道channelstring[1,16]ORIGINAL:原路退款
BALANCE:退回到余额
OTHER_BALANCE:原账户异常退到其他余额账户
OTHER_BANKCARD:原银行卡异常退到其他银行卡
示例值: ORIGINAL
退款入账账户user_received_accountstring[1,64]取当前退款单的退款入账方。
退回银行卡:{银行名称}{卡类型}{卡尾号}
退回支付用户零钱:支付用户零钱
退还商户:商户基本账户、商户结算银行账户
退回支付用户零钱通:支付用户零钱通
示例值: 招商银行信用卡0403
退款成功时间success_timestring[1,64]退款成功时间,退款状态status为SUCCESS(退款成功)时,返回该字段。遵循rfc3339标准格式,格式为yyyy-MM-DDTHH:mm:ss+TIMEZONE,yyyy-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如:2015-05-20T13:29:35+08:00表示,北京时间2015年5月20日13点29分35秒。
示例值: 2018-06-08T10:34:56+08:00
退款创建时间create_timestring[1,64]1、退款受理时间,遵循rfc3339标准格式,格式为yyyy-MM-DDTHH:mm:ss+TIMEZONE,yyyy-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如:2015-05-20T13:29:35+08:00表示,北京时间2015年5月20日13点29分35秒。
2、当退款状态为退款成功时返回此字段。
示例值:2018-06-08T10:34:56+08:00
退款状态statusstring[1,16]退款状态,枚举值:
SUCCESS:退款成功
CLOSE:退款关闭
PROCESSING:退款处理中
ABNORMAL:退款异常,退款到银行发现用户的卡作废或者冻结了,导致原路退款银行卡失败
示例值:SUCCESS
退款金额信息amountobject订单退款金额信息,详见Amount。
营销详情promotion_detailarray优惠退款信息,discount_refund>0时,返回该字段,详见 PromotionDetail

 

Amount说明:

参数名变量类型[长度限制]必填描述
退款金额refundint退款金额,币种的最小单位,只能为整数,不能超过原订单支付金额。
示例值:888
用户退款金额payer_refundint退款给用户的金额,不包含所有优惠券金额。
示例值:888
优惠退款金额discount_refundint优惠券的退款金额,原支付单的优惠按比例退款。
示例值:888
退款币种currencystring[1,18]符合ISO 4217标准的三位字母代码,目前只支持人民币:CNY 。
示例值: CNY

PromotionDetail说明:

参数名变量类型[长度限制]必填描述
券IDpromotion_idstring[1,32]券或者立减优惠id。
优惠范围scopestring[1,32]枚举值:
GLOBAL:全场代金券
SINGLE:单品优惠
优惠类型typestring[1,32]枚举值:
COUPON:充值型代金券,商户需要预先充值营销经费
DISCOUNT:免充值型优惠券,商户不需要预先充值营销经费
优惠券面额amountint用户享受优惠的金额(优惠券面额=微信出资金额+商家出资金额+其他出资方金额 )。
优惠退款金额refund_amountint代金券退款金额<=退款金额,退款金额-代金券或立减优惠退款金额为现金,说明详见《代金券或立减优惠》 。
上一篇申请退款
下一篇概述
    本节内容
服务端API
基础
连接微信
办公
会议
会议统计管理
客户端API
小程序
基础
连接微信
办公
WECOM-JSSDK
JS-SDK
基础
连接微信
办公
更新日志
联系我们