微信小程序云开发SDK文档 微信支付·查询退款

2020-07-27 14:27 更新

CloudPay.queryRefund()

支持端:云函数 2.0.2

查询退款

说明

提交退款申请后,通过调用该接口查询退款状态。退款有一定延时,用零钱支付的退款20分钟内到账,银行卡支付的退款3个工作日后重新查询退款状态。 注意:如果单个支付订单部分退款次数超过20次请使用退款单号查询* 分页查询*

当一个订单部分退款超过10笔后,商户用微信订单号或商户订单号调退款查询API查询退款时,默认返回前10笔和total_refund_count(退款单总笔数)。商户需要查询同一订单下超过10笔的退款单时,可传入订单号及offset来查询,微信支付会返回offset及后面的10笔,以此类推。当商户传入的offset超过total_refund_count,则系统会返回报错PARAM_ERROR。

举例:

一笔订单下的退款单有36笔,当商户想查询第25笔时,可传入订单号及offset=24,微信支付平台会返回第25笔到第35笔的退款单信息,或商户可直接传入退款单号查询退款

参数说明

字段名变量名必填类型示例值描述
子商户号sub_mch_idString(32)1900000109微信支付分配的子商户号
随机字符串nonce_strString(32)5K8264ILTKCH16CQ2502SI8ZNMTM67VS随机字符串,不长于32位。推荐随机数生成算法
微信订单号transaction_id四选一String(28)1217752501201407033233368018微信订单号查询的优先级是: refund_id > out_refund_no > transaction_id > out_trade_no
商户订单号out_trade_no四选一String(32)1217752501201407033233368018商户系统内部订单号,要求32个字符内,只能是数字、大小写字母_-
商户退款单号out_refund_no四选一String(64)1217752501201407033233368018商户系统内部的退款单号,商户系统内部唯一,只能是数字、大小写字母_-
微信退款单号refund_id四选一String(32)1217752501201407033233368018微信退款单号
偏移量offsetInt15偏移量,当部分退款次数超过10次时可使用,表示返回的查询结果从这个偏移量开始取记录

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

返回值说明

字段名变量名必填类型示例值描述
返回状态码returnCodeString(16)SUCCESSSUCCESS/FAIL
返回信息returnMsgString(128)签名失败返回信息,如非空,为错误原因。如 签名失败、参数格式校验错误

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

字段名变量名必填类型示例值描述
业务结果result_codeString(16)SUCCESSSUCCESS/FAIL
SUCCESS退款申请接收成功,结果通过退款查询接口查询
错误码err_codeString(32)SYSTEMERROR错误码详见第6节
错误描述err_code_desString(128)系统错误结果信息描述
服务商的APPIDappidString(32)wxd678efh567hg6787服务商商户的APPID
商户号mch_idString(32)1230000109微信支付分配的商户号
小程序的APPIDsub_appidString(32)wx8888888888888888微信分配的小程序ID
子商户号sub_mch_idString(32)1900000109微信支付分配的子商户号
随机字符串nonce_strString(32)5K8264ILTKCH16CQ2502SI8ZNMTM67VS随机字符串,不长于32位
签名signString(32)C380BEC2BFD727A4B6845133519F3AD6签名,详见签名算法
微信订单号transaction_idString(32)1217752501201407033233368018微信订单号
商户订单号out_trade_noString(32)1217752501201407033233368018商户系统内部订单号,要求32个字符内,只能是数字、大小写字母_-
订单金额total_feeInt100订单总金额,单位为分,只能为整数,详见支付金额
应结订单金额settlement_total_feeInt100当订单使用了免充值型优惠券后返回该参数,应结订单金额=订单金额-免充值优惠券金额。
货币种类fee_typeString(8)CNY订单金额货币类型,符合ISO 4217标准的三位字母代码,默认人民币:CNY,其他值列表详见货币类型
现金支付金额cash_feeInt100现金支付金额,单位为分,只能为整数,详见支付金额
退款笔数refund_countInt1当前返回退款笔数
商户退款单号out_refund_no_$nString(64)1217752501201407033233368018商户系统内部的退款单号,商户系统内部唯一,只能是数字、大小写字母_-
微信退款单号refund_id_$nString(32)1217752501201407033233368018微信退款单号
退款渠道refund_channel_$nString(16)ORIGINALORIGINAL—原路退款
BALANCE—退回到余额
OTHER_BALANCE—原账户异常退到其他余额账户
OTHER_BANKCARD—原银行卡异常退到其他银行卡
订单总退款次数total_refund_countInt35订单总共已发生的部分退款次数,当请求参数传入offset后有返回
申请退款金额refund_fee_$nInt100退款总金额,单位为分,可以做部分退款
退款金额settlement_refund_fee_$nInt100退款金额=申请退款金额-非充值代金券退款金额,退款金额<=申请退款金额
代金券类型coupon_type_$n_$mString(8)CASHCASH--充值代金券
NO_CASH---非充值代金券
订单使用代金券时有返回(取值:CASH、NO_CASH)。$n为下标,$m为下标,从0开始编号,举例:coupon_type_$0_$1
总代金券退款金额coupon_refund_fee_$nInt100代金券退款金额<=退款金额,退款金额-代金券或立减优惠退款金额为现金,说明详见代金券或立减优惠
退款代金券使用数量coupon_refund_count_$nInt1退款代金券使用数量 ,$n为下标,从0开始编号
退款代金券IDcoupon_refund_id_$n_$mString(20)10000退款代金券ID, $n为下标,$m为下标,从0开始编号
单个代金券退款金额coupon_refund_fee_$n_$mInt100单个退款代金券支付金额, $n为下标,$m为下标,从0开始编号
退款状态refund_status_$nString(16)SUCCESS退款状态:SUCCESS—退款成功
REFUNDCLOSE—退款关闭。
PROCESSING—退款处理中
CHANGE—退款异常,退款到银行发现用户的卡作废或者冻结了,导致原路退款银行卡失败,可前往商户平台(pay.weixin.qq.com)-交易中心,手动处理此笔退款。$n为下标,从0开始编号。
退款资金来源refund_account_$nString(30)REFUND_SOURCE_RECHARGE_FUNDSREFUND_SOURCE_RECHARGE_FUNDS---可用余额退款/基本账户
REFUND_SOURCE_UNSETTLED_FUNDS---未结算资金退款
$n为下标,从0开始编号。
退款入账账户refund_recv_accout_$nString(64)招商银行信用卡0403取当前退款单的退款入账方
1)退回银行卡:
{银行名称}{卡类型}{卡尾号}
2)退回支付用户零钱:
支付用户零钱

3)退还商户:
商户基本账户
商户结算银行账户
4)退回支付用户零钱通:
支付用户零钱通
退款成功时间refund_success_time_$nString(20)2016-07-25 15:26:26退款成功时间,当退款状态为退款成功时有返回。$n为下标,从0开始编号。

错误码

名称描述原因解决方案
SYSTEMERROR接口返回错误系统超时请尝试再次掉调用API。
REFUNDNOTEXIST退款订单查询失败订单号错误或订单状态不正确请检查订单号是否有误以及订单状态是否正确,如:未支付、已支付未退款
INVALID_TRANSACTIONID无效transaction_id请求参数未按指引进行填写请求参数错误,检查原交易号是否存在或发起支付交易接口返回失败
PARAM_ERROR参数错误请求参数未按指引进行填写请求参数错误,请检查参数再调用退款申请
APPID_NOT_EXISTAPPID不存在参数中缺少APPID请检查APPID是否正确
MCHID_NOT_EXISTMCHID不存在参数中缺少MCHID请检查MCHID是否正确
REQUIRE_POST_METHOD请使用post方法未使用post传递参数请检查请求参数是否通过post方法提交
SIGNERROR签名错误参数签名结果不正确请检查签名参数和方法是否都符合签名算法要求
XML_FORMAT_ERRORXML格式错误XML格式错误请检查XML参数格式是否正确


以上内容是否对您有帮助:
前端课程
在线笔记
App下载
App下载

扫描二维码

下载编程狮App

公众号
微信公众号

编程狮公众号

意见反馈
返回顶部