微信小程序云开发SDK文档 微信支付·查询退款
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_id | 是 | String(32) | 1900000109 | 微信支付分配的子商户号 |
| 随机字符串 | nonce_str | 是 | String(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 | 微信退款单号 |
| 偏移量 | offset | 否 | Int | 15 | 偏移量，当部分退款次数超过10次时可使用，表示返回的查询结果从这个偏移量开始取记录 |
refund_id、out_refund_no、out_trade_no、transaction_id四个参数必填一个，如果同时存在优先级为： refund_id>out_refund_no>transaction_id>out_trade_no
返回值说明
| 字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
|---|---|---|---|---|---|
| 返回状态码 | returnCode | 是 | String(16) | SUCCESS | SUCCESS/FAIL |
| 返回信息 | returnMsg | 否 | String(128) | 签名失败 | 返回信息，如非空，为错误原因。如 签名失败、参数格式校验错误 |
以下字段在returnCode为SUCCESS的时候有返回
| 字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
|---|---|---|---|---|---|
| 业务结果 | result_code | 是 | String(16) | SUCCESS | SUCCESS/FAIL SUCCESS退款申请接收成功，结果通过退款查询接口查询 |
| 错误码 | err_code | 是 | String(32) | SYSTEMERROR | 错误码详见第6节 |
| 错误描述 | err_code_des | 是 | String(128) | 系统错误 | 结果信息描述 |
| 服务商的APPID | appid | 是 | String(32) | wxd678efh567hg6787 | 服务商商户的APPID |
| 商户号 | mch_id | 是 | String(32) | 1230000109 | 微信支付分配的商户号 |
| 小程序的APPID | sub_appid | 是 | String(32) | wx8888888888888888 | 微信分配的小程序ID |
| 子商户号 | 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 | 现金支付金额，单位为分，只能为整数，详见支付金额 |
| 退款笔数 | refund_count | 是 | Int | 1 | 当前返回退款笔数 |
| 商户退款单号 | out_refund_no_$n | 是 | String(64) | 1217752501201407033233368018 | 商户系统内部的退款单号，商户系统内部唯一，只能是数字、大小写字母_- |
| 微信退款单号 | refund_id_$n | 是 | String(32) | 1217752501201407033233368018 | 微信退款单号 |
| 退款渠道 | refund_channel_$n | 否 | String(16) | ORIGINAL | ORIGINAL—原路退款 BALANCE—退回到余额 OTHER_BALANCE—原账户异常退到其他余额账户 OTHER_BANKCARD—原银行卡异常退到其他银行卡 |
| 订单总退款次数 | total_refund_count | 否 | Int | 35 | 订单总共已发生的部分退款次数，当请求参数传入offset后有返回 |
| 申请退款金额 | refund_fee_$n | 是 | Int | 100 | 退款总金额,单位为分,可以做部分退款 |
| 退款金额 | settlement_refund_fee_$n | 否 | Int | 100 | 退款金额=申请退款金额-非充值代金券退款金额，退款金额<=申请退款金额 |
| 代金券类型 | coupon_type_$n_$m | 否 | String(8) | CASH | CASH--充值代金券 NO_CASH---非充值代金券 订单使用代金券时有返回（取值：CASH、NO_CASH）。$n为下标,$m为下标,从0开始编号，举例：coupon_type_$0_$1 |
| 总代金券退款金额 | coupon_refund_fee_$n | 否 | Int | 100 | 代金券退款金额<=退款金额，退款金额-代金券或立减优惠退款金额为现金，说明详见代金券或立减优惠 |
| 退款代金券使用数量 | coupon_refund_count_$n | 否 | Int | 1 | 退款代金券使用数量 ,$n为下标,从0开始编号 |
| 退款代金券ID | coupon_refund_id_$n_$m | 否 | String(20) | 10000 | 退款代金券ID, $n为下标，$m为下标，从0开始编号 |
| 单个代金券退款金额 | coupon_refund_fee_$n_$m | 否 | Int | 100 | 单个退款代金券支付金额, $n为下标，$m为下标，从0开始编号 |
| 退款状态 | refund_status_$n | 是 | String(16) | SUCCESS | 退款状态：SUCCESS—退款成功 REFUNDCLOSE—退款关闭。 PROCESSING—退款处理中 CHANGE—退款异常，退款到银行发现用户的卡作废或者冻结了，导致原路退款银行卡失败，可前往商户平台（pay.weixin.qq.com）-交易中心，手动处理此笔退款。$n为下标，从0开始编号。 |
| 退款资金来源 | refund_account_$n | 否 | String(30) | REFUND_SOURCE_RECHARGE_FUNDS | REFUND_SOURCE_RECHARGE_FUNDS---可用余额退款/基本账户 REFUND_SOURCE_UNSETTLED_FUNDS---未结算资金退款 $n为下标，从0开始编号。 |
| 退款入账账户 | refund_recv_accout_$n | 是 | String(64) | 招商银行信用卡0403 | 取当前退款单的退款入账方 1）退回银行卡： {银行名称}{卡类型}{卡尾号} 2）退回支付用户零钱: 支付用户零钱 3）退还商户: 商户基本账户 商户结算银行账户 4）退回支付用户零钱通: 支付用户零钱通 |
| 退款成功时间 | refund_success_time_$n | 否 | String(20) | 2016-07-25 15:26:26 | 退款成功时间，当退款状态为退款成功时有返回。$n为下标，从0开始编号。 |
错误码
| 名称 | 描述 | 原因 | 解决方案 |
|---|---|---|---|
| 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参数格式是否正确 |