接口地址
接口链接:https://api.mch.weixin.qq.com/secapi/pay/refund
是否需要证书
请求需要双向证书。 详见证书使用
请求参数
字段名 变量名 必填 类型 示例值 描述
公众账号ID appid 是 String(32) wx8888888888888888 微信分配的公众账号ID(企业号corpid即为此appId)
商户号 mch_id 是 String(32) 1900000109 微信支付分配的商户号
设备号 device_info 否 String(32) 013467007045764 终端设备号
随机字符串 nonce_str 是 String(32) 5K8264ILTKCH16CQ2502SI8ZNMTM67VS 随机字符串,不长于32位。推荐随机数生成算法
签名 sign 是 String(32) C380BEC2BFD727A4B6845133519F3AD6 签名,详见签名生成算法
微信订单号 transaction_id 二选一 String(28) 1217752501201407033233368018 微信生成的订单号,在支付通知中有返回
商户订单号 out_trade_no String(32) 1217752501201407033233368018 商户侧传给微信的订单号
商户退款单号 out_refund_no 是 String(32) 1217752501201407033233368018 商户系统内部的退款单号,商户系统内部唯一,同一退款单号多次请求只退一笔
总金额 total_fee 是 Int 100 订单总金额,单位为分,只能为整数,详见支付金额
退款金额 refund_fee 是 Int 100 退款总金额,订单总金额,单位为分,只能为整数,详见支付金额
货币种类 refund_fee_type 否 String(8) CNY 货币类型,符合ISO 4217标准的三位字母代码,默认人民币:CNY,其他值列表详见货币类型
操作员 op_user_id 是 String(32) 1900000109 操作员帐号, 默认为商户号
举例如下:
wx2421b1c4370ec43b
10000100
6cefdb308e1e2e8aabd48cf79e546a02
10000100
1415701182
1415757673
1
1
FE56DD4AA85C0EECA82C35595A69E153
返回结果
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
---|---|---|---|---|---|
返回状态码 | 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 | 微信分配的公众账号ID |
商户号 | mch_id | 是 | String(32) | 1900000109 | 微信支付分配的商户号 |
设备号 | device_info | 否 | String(32) | 013467007045764 | 微信支付分配的终端设备号,与下单一致 |
随机字符串 | nonce_str | 是 | String(32) | 5K8264ILTKCH16CQ2502SI8ZNMTM67VS | 随机字符串,不长于32位 |
签名 | sign | 是 | String(32) | 5K8264ILTKCH16CQ2502SI8ZNMTM67VS | 签名,详见签名算法 |
微信订单号 | transaction_id | 是 | String(28) | 1217752501201407033233368018 | 微信订单号 |
商户订单号 | out_trade_no | 是 | String(32) | 1217752501201407033233368018 | 商户系统内部的订单号 |
商户退款单号 | out_refund_no | 是 | String(32) | 1217752501201407033233368018 | 商户退款单号 |
微信退款单号 | refund_id | 是 | String(28) | 1217752501201407033233368018 | 微信退款单号 |
退款渠道 | refund_channel | 否 | String(16) | ORIGINAL | ORIGINAL—原路退款 BALANCE—退回到余额 |
申请退款金额 | refund_fee | 是 | Int | 100 | 退款总金额,单位为分,可以做部分退款 |
退款金额 | settlement_refund_fee_$n | 是 | Int | 100 | 退款金额=申请退款金额-非充值代金券退款金额,退款金额<=申请退款金额 |
订单金额 | total_fee | 是 | Int | 100 | 订单总金额,单位为分,只能为整数,详见支付金额 |
应结订单金额 | settlement_total_fee | 是 | Int | 100 | 应结订单金额=订单金额-非充值代金券金额,应结订单金额<=订单金额。 |
订单金额货币种类 | fee_type | 否 | String(8) | CNY | 订单金额货币类型,符合ISO 4217标准的三位字母代码,默认人民币:CNY,其他值列表详见货币类型 |
现金支付金额 | cash_fee | 是 | Int | 100 | 现金支付金额,单位为分,只能为整数,详见支付金额 |
现金退款金额 | cash_refund_fee | 否 | Int | 100 | 现金退款金额,单位为分,只能为整数,详见支付金额 |
代金券类型 | coupon_type_$n | 否 | String(8) | CASH | CASH–充值代金券 NO_CASH—非充值代金券 订单使用代金券时有返回(取值:CASH、NO_CASH)。$n为下标,从0开始编号,举例:coupon_type_$0 |
代金券退款金额 | coupon_refund_fee_$n | 否 | Int | 100 | 代金券退款金额<=退款金额,退款金额-代金券或立减优惠退款金额为现金,说明详见代金券或立减优惠 |
退款代金券使用数量 | coupon_refund_count_$n | 否 | Int | 1 | 退款代金券使用数量 ,$n为下标,从0开始编号 |
退款代金券批次ID | coupon_refund_batch_id_$n_$m | 否 | String(20) | 100 | 退款代金券批次ID ,$n为下标,$m为下标,从0开始编号 |
退款代金券ID | coupon_refund_id_$n_$m | 否 | String(20) | 10000 | 退款代金券ID, $n为下标,$m为下标,从0开始编号 |
单个退款代金券支付金额 | coupon_refund_fee_$n_$m | 否 | Int | 100 | 单个退款代金券支付金额, $n为下标,$m为下标,从0开始编号 |
举例如下:
错误码
名称 | 描述 | 原因 | 解决方案 |
---|---|---|---|
SYSTEMERROR | 接口返回错误 | 系统超时 | 请用相同参数再次调用API |
USER_ACCOUNT_ABNORMAL | 退款请求失败 | 用户帐号异常或注销 | 此状态代表退款申请失败,商户可自行处理退款。 |
INVALID_TRANSACTIONID | 无效transaction_id | 请求参数未按指引进行填写 | 请求参数错误,检查原交易号是否存在或发起支付交易接口返回失败 |
PARAM_ERROR | 参数错误 | 请求参数未按指引进行填写 | 请求参数错误,请重新检查再调用退款申请 |
APPID_NOT_EXIST | APPID不存在 | 参数中缺少APPID | 请检查APPID是否正确 |
MCHID_NOT_EXIST | MCHID不存在 | 参数中缺少MCHID | 请检查MCHID是否正确 |
APPID_MCHID_NOT_MATCH | appid和mch_id不匹配 | appid和mch_id不匹配 | 请确认appid和mch_id是否匹配 |
REQUIRE_POST_METHOD | 请使用post方法 | 未使用post传递参数 | 请检查请求参数是否通过post方法提交 |
SIGNERROR | 签名错误 | 参数签名结果不正确 | 请检查签名参数和方法是否都符合签名算法要求 |
XML_FORMAT_ERROR | XML格式错误 | XML格式错误 | 请检查XML参数格式是否正确 |