退款查询API
业务功能
提交退款申请后,通过调用该接口查询退款状态。
测试url:
http://47.95.131.62:8080/api/v1/pay/wx/refundquery
请求参数(O-非必传 ,M-必传):
参数 | 参数名称 | 类型 | 参数说明 | 样例 | 可空 |
---|---|---|---|---|---|
refund_no | 退款订单号 | String | refund_no和 out_refund_no和channel_trade_no必传其中一个,三个都传则以refund_no为准,推荐使用refund_no | O | |
out_refund_no | 服务商退款订单号 | String | 服务商退款订单号 | 161018121614000624679888 | O |
channel_trade_no | 凭证条码订单号 | String | 凭证条码订单号(v1.24增加) | 161018121614000624679888 | O |
请求示例:
{
"accessid": "cpostest",
"refund_no": "WX200324161500830790814539",
"sign": "435C210FABE137252082CB7B287E03DD"
}
返回参数:
参数 | 参数名称 | 类型 | 参数说明 | 样例 | 可空 |
---|---|---|---|---|---|
refund_amount | 退款金额 | String | 退款金额,以元为单位 | 100 | M |
total_amount | 订单金额 | String | 订单总金额,以元为单位 | 100 | M |
rate | 费率 | String | M | ||
fee | 手续费 | String | M | ||
refund_status | 退款状态 | String | 退款结果:
1:成功(退款申请接收成功,退款的到账时间以实际为准); 2:失败(退款申请失败,错误原因参考status_msg); 3:结果未知(退款申请处理结果未知,请调用退款查询接口获取退款结果状态) |
M | |
refund_no | 退款订单号 | String | SaaS平台的退款订单编号 | M | |
out_refund_no | 服务商退款订单号 | String | 服务商退款订单号 | 161018121614000624679888 | M |
channel_trade_no | 凭证条码订单号 | String | 凭证条码订单号(v1.24增加) | 161018121614000624679888 | M |
error_code | 错误码 | String | O | ||
error_msg | 错误消息 | String | O | ||
refunded_amount | 已退款金额 | String | 已退款金额(v1.30增加) | M | |
remanent_amount | 剩余可退款金额 | String | 剩余可退款金额(v1.30增加) | M | |
fee_subsidy_party | 手续费原补贴方 | String | 手续费原补贴方 | O | |
orig_fee_subsidy_amount | 原交易手续费补贴金额 | String | 原交易手续费补贴金额 | 原交易手续费补贴金额 | C |
refunded_subsidy_amount | 已退手续费补贴金额 | String | 已退手续费补贴金额 | 已退手续费补贴金额 | C |
remanent_subsidy_amount | 剩余未退手续费补贴金额 | String | 剩余未退手续费补贴金额 | 剩余未退手续费补贴金额 | C |
real_fee_subsidy_amount | 本次手续费实际退补金额 | String | 本次手续费实际退补金额 | C | |
attach | 微信原生参数 | JSON | O |
微信原生参数:attach
参数 | 参数名称 | 类型 | 参数说明 | 样例 | 可空 |
---|---|---|---|---|---|
result_code | 业务结果 | String | SUCCESS/FAIL | SUCCESS | M |
err_code | 错误代码 | String | SYSTEMERROR | O | |
err_code_des | 错误代码描述 | String | 错误返回的信息描述 | 系统错误 | O |
sub_appid | 子商户公众账号id | String | 调用接口提交的子商户公众账号ID | wx8888888888888888 | O |
sub_mch_id | 子商户号 | String | 调用接口提交的子商户号 | 1900000109 | M |
nonce_str | 随机字符串 | String | 网联返回的随机字符串 | M | |
sign | 签名 | String | 网联返回的签名 | M | |
out_refund_no | 商户退款单号 | String | 商户系统内部的退款单号,商户系统内部唯一,只能是数字、大小写字母同一退款单号多次请求只退一笔 | M | |
refund_id | 微信退款单号 | String | M | ||
refund_fee | 退款金额 | String | 退款总金额,单位为分,可以做部分退款 | M | |
refund_fee_type | 退款货币种类 | String | CNY | M | |
cash_refund_fee | 现金退款金额 | String | 现金退款金额,单位为分,只能为整数 | M | |
coupon_refund_fee | 代金券退款总金额 | String | O | ||
refund_detail | 优惠退款详情 | JSONArray | [{“amount”:100,”promotion_id”:”21796722069”,”type”:”COUPON”,”scope”:”GLOBAL”,”refund_amount”:100}] | O |
优惠退款详情:refund_detail
参数 | 参数名称 | 类型 | 参数说明 | 样例 | 可空 |
---|---|---|---|---|---|
promotion_id | 券ID | String | 券或者立减优惠id | 109519 | M |
scope | 优惠范围 | String | GLOBAL-全场代金券 SINGLE-单品优惠 |
SINGLE | O |
type | 优惠类型 | String | COUPON-代金券,需要走结算资金的充值型代金券,(境外商户券币种与支付币种一致) DISCOUNT-优惠券,不走结算资金的免充 值型优惠券,(境外商户券币种与标价币种一致) |
DISCOUNT | O |
amount | 优惠券面额 | String | 用户享受优惠的金额 | 5 | O |
返回示例:
{
"total_amount": "1.00",
"refund_no": "WX200324161500830790814539",
"channel_trade_no": "010820032416151297557MC",
"out_refund_no": "200324847290000004766",
"refund_amount": "-0.50",
"refund_status": 1,
"remanent_amount": "0.00",
"refunded_amount": "1.00",
"return_code": 10000,
"sign": "565EE8ACDA9E8506E288C21B64D6B40F"
}
文档更新时间: 2025-02-11 10:30 作者:admin