查询退款(押金)

更新时间:2024.11.18

应用场景

提交退款申请后,通过调用该接口查询退款状态。退款有一定延时,用零钱支付的退款20分钟内到账,银行卡支付的退款3个工作日后重新查询退款状态;

接口规则

请求Url

https://api.mch.weixin.qq.com/deposit/refundquery

是否需要证书

请求方式

post

签名方式

HMAC-SHA256

请求参数

名称

变量名

必填

类型

示例值

描述

服务商应用ID

appid

String(32)

wx8888888888888888

服务商商户的APPID

商户号

mch_id

String(32)

1900000109

服务商商户的商户号

子商户应用ID

sub_appid

String(32)

wx8888888888888888

微信分配的子商户APPID,如需在支付完成后获取sub_openid则此参数必传。

子商户号

sub_mch_id

String(32)

1900000109

服务商通过进件后获得的特约商户号

随机字符串

nonce_str

String(32)

5K8264ILTKCH16CQ2502SI8ZNMTM67VS

随机字符串,不长于32位。推荐随机数生成算法

签名

sign

String(32)

C370BEC2BFD727A4B6845133519F3AD6

签名,详见签名生成算法

签名类型

sign_type

String(32)

HMAC-SHA256

签名类型,仅支持HMAC-SHA256

商户退款单号

out_refund_no

二选一

String(64)

1217752501201407033233367018

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

微信退款单号

refund_id

String(32)

1217752501201407033233367018

refund_id、out_refund_no两个参数必填一个,如果同时存在优先级为:
refund_id>out_refund_no

举例如下:

1<xml>
2  <appid>wx2421b1c4370ec43b</appid>
3  <mch_id>10000100</mch_id>
4  <nonce_str>0b9f35f484df17a732e537c37708d1d0</nonce_str>
5  <out_refund_no></out_refund_no>
6  <sub_mch_id>1900000109</sub_mch_id>
7  <sign>66FFB727015F450D167EF38CCC549521</sign>
8  <sign_type> HMAC-SHA256</sign_type>
9</xml>

返回结果

名称

变量名

必填

类型

示例值

描述

返回状态码

return_code

String(16)

SUCCESS

SUCCESS/FAIL

返回信息

return_msg

String(128)

签名失败

返回信息,如非空,为错误原因
签名失败
参数格式校验错误

以下字段在return_code为SUCCESS的时候有返回:

名称

变量名

必填

类型

示例值

描述

业务结果

result_code

String(16)

SUCCESS

SUCCESS/FAIL
SUCCESS退款申请接收成功,结果通过退款查询接口查询
FAIL

错误码

err_code

String(32)

SYSTEMERROR

错误码详见本接口错误码说明

错误描述

err_code_des

String(128)

系统错误

结果信息描述

服务商应用ID

appid

String(32)

wx8888888888888888

服务商商户的APPID

商户号

mch_id

String(32)

1900000109

服务商商户的商户号

子商户应用ID

sub_appid

String(32)

wx8888888888888888

微信分配的子商户APPID,如需在支付完成后获取sub_openid则此参数必传。

子商户号

sub_mch_id

String(32)

1900000109

服务商通过进件后获得的特约商户号

随机字符串

nonce_str

String(32)

5K8264ILTKCH16CQ2502SI8ZNMTM67VS

随机字符串,不长于32位

签名

sign

String(32)

C380BEC2BFD727A4B6845133519F3AD6

签名,详见签名算法

微信订单号

transaction_id

String(32)

1217752501201407033233368018

微信订单号

商户订单号

out_trade_no

String(32)

1217752501201407033233368018

商户系统内部订单号,要求32个字符内,只能是数字、大小写字母_-|*@ ,且在同一个商户号下唯一。

订单金额

total_fee

int

100

订单总金额,单位为分,只能为整数,详见支付金额

应结订单金额

settlement_total_fee

int

100

当订单使用了免充值型优惠券后返回该参数,应结订单金额=订单金额-免充值优惠券金额。

货币种类

fee_type

String(8)

CNY

订单金额货币类型,符合ISO 4217标准的三位字母代码,默认人民币:CNY,其他值列表详见货币类型

现金支付金额

cash_fee

int

100

现金支付金额,单位为分,只能为整数,详见支付金额

商户退款单号

out_refund_no

String(64)

1217752501201407033233368018

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

微信退款单号

refund_id

String(32)

1217752501201407033233368018

微信退款单号

退款渠道

refund_channel

String(16)

ORIGINAL

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

申请退款金额

refund_fee

int

100

退款总金额,单位为分,可以做部分退款

退款金额

settlement_refund_fee

int

100

退款金额=申请退款金额-非充值代金券退款金额,退款金额<=申请退款金额

退款状态

refund_status

String(16)

SUCCESS

退款状态:
SUCCESS—退款成功
REFUNDCLOSE—退款关闭。
PROCESSING—退款处理中
CHANGE—退款异常,退款到银行发现用户的卡作废或者冻结了,导致原路退款银行卡失败,可前往商户平台-交易中心,手动处理此笔退款。$n为下标,从0开始编号。

退款资金来源

refund_account

String(30)

REFUND_SOURCE_RECHARGE_FUNDS

REFUND_SOURCE_RECHARGE_FUNDS---可用余额退款/基本账户
REFUND_SOURCE_UNSETTLED_FUNDS---未结算资金退款

退款入账账户

refund_recv_accout

String(64)

招商银行信用卡0403

取当前退款单的退款入账方
1)退回银行卡:{银行名称}{卡类型}{卡尾号}

2)退回支付用户零钱:支付用户零钱

3)退还商户:商户基本账户、商户结算银行账户

4)退回支付用户零钱通:支付用户零钱通

5)退回用户经营账户:用户经营账户

6)退回支付用户银行电子账户:支付用户银行电子账户

7)退回支付用户零花钱:支付用户零花钱

8)退回支付用户来华零钱包:支付用户来华零钱包

9)退回企业支付商户:企业支付商户

退款成功时间

refund_success_time

String(20)

2016-07-25 15:26:26

退款成功时间,当退款状态为退款成功时有返回。

举例:

1<xml>
2    <appid><![CDATA[wx2421b1c4370ec43b]]></appid>
3    <mch_id><![CDATA[10000100]]></mch_id>
4    <nonce_str><![CDATA[TeqClE3i0mvn3DrK]]></nonce_str>
5    <out_refund_no_0><![CDATA[1415701182]]></out_refund_no_0>
6    <out_trade_no><![CDATA[1415757673]]></out_trade_no>
7    <refund_count>1</refund_count>
8    <refund_fee_0>1</refund_fee_0>
9    <_0><![CDATA[2008450740201411110000174436]]></_0>
10    <refund_status_0><![CDATA[PROCESSING]]></refund_status_0>
11    <result_code><![CDATA[SUCCESS]]></result_code>
12    <return_code><![CDATA[SUCCESS]]></return_code>
13    <return_msg><![CDATA[OK]]></return_msg>
14    <sign><![CDATA[1F2841558E233C33ABA71A961D27561C]]></sign>
15    <transaction_id><![CDATA[1008450740201411110005820873]]></transaction_id>
16</xml>

错误码列表

名称

描述

原因

解决方案

SYSTEMERROR

接口返回错误

系统超时

请尝试再次掉调用API。

REFUNDNOTEXIST

退款订单查询失败

订单号错误或订单状态不正确

请检查订单号是否有误以及订单状态是否正确,如:未支付、已支付未退款

INVALID_TRANSACTIONID

无效transaction_id

请求参数未按指引进行填写

请求参数错误,检查原交易号是否存在或发起支付交易接口返回失败

PARAM_ERROR

参数错误

请求参数未按指引进行填写

请求参数错误,请检查参数再调用退款申请

APPID_NOT_EXIST

APPID不存在

参数中缺少APPID

请检查APPID是否正确

MCHID_NOT_EXIST

MCHID不存在

参数中缺少MCHID

请检查MCHID是否正确

REQUIRE_POST_METHOD

请使用post方法

未使用post传递参数 

请检查请求参数是否通过post方法提交

SIGNERROR

签名错误

参数签名结果不正确

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

XML_FORMAT_ERROR

XML格式错误

XML格式错误

请检查XML参数格式是否正确

 

更多技术问题
技术咨询
反馈
咨询
目录
置顶