查询单笔退款(按商户退款单号)

更新时间:2024.11.04

提交退款申请后,通过调用该接口查询退款状态。


  1. 退款有一定延时,用零钱支付的退款20分钟内到账,银行卡支付的退款3个工作日后重新查询退款状态。

接口说明

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

请求方式:【GET】/v3/ecommerce/refunds/out-refund-no/{out_refund_no}

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

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

请求参数

Header HTTP头参数

Authorization  必填 string

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


Accept  必填 string

请设置为application/json


path 路径参数

out_refund_no  必填 string(64)

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


query 查询参数

sub_mchid  必填 string(32)

【二级商户号】微信支付分配给二级商户的商户号

请求示例

GET

1curl -X GET \
2  https://api.mch.weixin.qq.com/v3/ecommerce/refunds/out-refund-no/1217752501201407033233368018?sub_mchid=1900000109 \
3  -H "Authorization: WECHATPAY2-SHA256-RSA2048 mchid=\"1900000001\",..." \
4  -H "Accept: application/json" 
5

应答参数

200 OK

refund_id  必填 string(32)

【微信支付退款订单号】微信支付退款订单订单号


out_refund_no  必填 string(64)

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


transaction_id  必填 string(32)

【微信支付交易订单号】微信支付交易订单号


out_trade_no  必填 string(32)

【商户原交易订单号】返回的原交易订单号


channel  选填 string(16)

【退款渠道】ORIGINAL—原路退款
BALANCE—退回到余额
OTHER_BALANCE—原账户异常退到其他余额账户
OTHER_BANKCARD—原银行卡异常退到其他银行卡


user_received_account  选填 string(64)

【退款入账账户】取当前退款单的退款入账方
1)退回银行卡:
{银行名称}{卡类型}{卡尾号}
2)退回支付用户零钱:
支付用户零钱
3)退还商户:
商户基本账户
商户结算银行账户
4)退回支付用户零钱通:
支付用户零钱通
5)退回支付用户银行电子账户:支付用户银行电子账户
6)退回支付用户零花钱:支付用户零花钱
7)退回用户经营账户:用户经营账户
8)退回支付用户来华零钱包:支付用户来华零钱包
9)退回企业支付商户:企业支付商户


success_time  选填 string(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秒。


create_time  必填 string(64)

【退款创建时间】退款受理时间,遵循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秒。


status  必填 string(16)

【退款状态】退款状态:
SUCCESS—退款成功
CLOSED—退款关闭。
PROCESSING—退款处理中
ABNORMAL—退款异常,退款到银行发现用户的卡作废或者冻结了,导致原路退款银行卡失败,可前往商户平台(pay.weixin.qq.com)-交易中心,手动处理此笔退款。


amount  必填 object

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

属性

promotion_detail  选填 array[object]

【营销详情】优惠退款信息

属性

refund_account  选填 string(32)

【退款出资商户】REFUND_SOURCE_PARTNER_ADVANCE : 电商平台垫付
REFUND_SOURCE_SUB_MERCHANT : 二级商户,默认值
注意:申请退款时可能会出现暂未扣除退款资金的情况,此时不返回本字段,需继续查单确认。


funds_account  选填 string(32)

【资金账户】UNSETTLED : 未结算资金
AVAILABLE : 可用余额
UNAVAILABLE : 不可用余额
OPERATION : 运营户
BASIC : 基本账户(含可用余额和不可用余额)
ECNY_BASIC : 数字人民币基本账户

应答示例

200 OK

1{
2  "refund_id" : "1217752501201407033233368018",
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" : "2018-06-08T10:34:56+08:00",
9  "create_time" : "2018-06-08T10:34:56+08:00",
10  "status" : "SUCCESS",
11  "amount" : {
12    "refund" : 888,
13    "from" : [
14      {
15        "account" : "AVAILABLE",
16        "amount" : 444
17      }
18    ],
19    "payer_refund" : 888,
20    "discount_refund" : 888,
21    "currency" : "CNY",
22    "advance" : 888
23  },
24  "promotion_detail" : [
25    {
26      "promotion_id" : "109519",
27      "scope" : "SINGLE",
28      "type" : "DISCOUNT",
29      "amount" : 5,
30      "refund_amount" : 100
31    }
32  ],
33  "refund_account" : "REFUND_SOURCE_SUB_MERCHANT",
34  "funds_account" : "UNSETTLED"
35}
36

 

错误码

公共错误码

状态码

错误码

描述

解决方案

400

PARAM_ERROR

参数错误

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

400

INVALID_REQUEST

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

请参阅 接口规则

401

SIGN_ERROR

验证不通过

请参阅 签名常见问题

500

SYSTEM_ERROR

系统异常,请稍后重试

请稍后重试

业务错误码

状态码

错误码

描述

解决方案

400

INVALID_REQUEST

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

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

400

MCH_NOT_EXISTS

商户号不存在

请检查商户号是否正确

401

SIGN_ERROR

签名错误

请检查签名参数和方法是否都符合签名算法要求

403

NO_AUTH

没有退款权限

此状态代表退款申请失败,请检查是否有退这笔订单的权限

403

REQUEST_BLOCKED

请求受阻

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

404

RESOURCE_NOT_EXISTS

订单不存在

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

429

FREQUENCY_LIMITED

频率限制

该笔退款未受理,请降低频率后重试

500

SYSTEM_ERROR

接口返回错误

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

 

 

反馈
咨询
目录
置顶