商户可使用该接口查询自已通过 trade.refund 提交的退款请求是否执行成功。
公共请求参数
参数 | 类型 | 是否必选 | 最大长度 | 描述 | 示例值 |
app_id | String | 必选 | 32 | 小程序 id | 2014072300007148 |
method | String | 必选 | 128 | 接口名称 | trade.refund.query |
format | String | 可选 | 40 | 仅支持 JSON | JSON |
charset | String | 必选 | 10 | 请求使用的编码格式,如 utf-8,gbk,gb2312 等 | utf-8 |
sign_type | String | 必选 | 10 | 商户生成签名字符串所使用的签名算法类型,目前支持 RSA2 和 RSA,推荐使用 RSA2 | RSA2 |
sign | String | 必选 | 344 | 商户请求参数的签名串,详见签名 | 详见示例 |
timestamp | String | 必选 | 19 | 发送请求的时间,格式 | 2014-07-24 03:07:50 |
version | String | 必选 | 3 | 调用的接口版本,固定为:1.0 | 1.0 |
biz_content | String | 必选 | 请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递,具体参照各产品快速接入文档 |
业务请求参数
参数 | 类型 | 是否必选 | 最大长度 | 描述 | 示例值 |
out_request_no | String | 必选 | 64 | 退款请求号。 请求退款接口时,传入的退款请求号,如果在退款请求时未传入,则该值为创建交易时的商户订单号 | HZ01RF001 |
trade_no | String | 可选 | 64 | 平台交易号。 和商户订单号不能同时为空 | 2021081722001419121412730660 |
out_trade_no | String | 可选 | 64 | 商户订单号。 订单支付时传入的商户订单号,和平台交易号不能同时为空。 trade_no,out_trade_no 如果同时存在优先取 trade_no | 2014112611001004680073956707 |
常见请求示例
默认示例:
curl 'https://xxx/gateway.do?charset=UTF-8&method=trade.refund.query&format=json&sign=${sign}&app_id=${appid}&version=1.0&sign_type=RSA2×tamp=${now}' \
-F 'biz_content={
"trade_no":"2021081722001419121412730660",
"out_trade_no":"2014112611001004680073956707",
"out_request_no":"HZ01RF001"
}'
本示例仅供参考。
公共响应参数
参数 | 类型 | 是否必选 | 最大长度 | 描述 | 示例值 |
code | String | 必选 | - | 网关返回码 | 40004 |
msg | String | 必选 | - | 网关返回码描述 | Business Failed |
sub_code | String | 可选 | - | 业务返回码,参见具体的 API 接口文档 | ACQ.TRADE_HAS_SUCCESS |
sub_msg | String | 可选 | - | 业务返回码描述,参见具体的 API 接口文档 | 交易已被支付 |
sign | String | 必选 | - | 签名 | DZXh8eeTuAHoYE3w1J+POiPhfDxOYBfUNn1lkeT/V7P4zJdyojWEa6IZs6Hz0yDW5Cp/viufUb5I0/V5WENS3OYR8zRedqo6D+fUTdLHdc+EFyCkiQhBxIzgngPdPdfp1PIS7BdhhzrsZHbRqb7o4k3Dxc+AAnFauu4V6Zdwczo= |
业务响应参数
参数 | 类型 | 是否必选 | 最大长度 | 描述 | 示例值 |
out_trade_no | String | 可选 | 64 | 商户订单号 | 20150423001001 |
trade_no | String | 可选 | 64 | Payme 交易号 | 2015042321001004720200028594 |
out_request_no | String | 可选 | 64 | 本笔退款对应的退款请求号 | |
total_amount | String | 可选 | 11 | 该笔退款所对应的交易的订单金额。单位根据业务自行定义。 | 100.20 |
refund_amount | String | 可选 | 11 | 本次退款请求,对应的退款金额。单位根据业务自行定义。 | 12.33 |
refund_status | String | 必选 | 32 | 退款状态。 枚举值:
说明 如果退款查询发起时间早于退款时间,或者间隔退款发起时间太短,可能出现退款查询时还没处理成功,后面又处理成功的情况,建议商户在退款发起后间隔 10 秒以上再发起退款查询请求。 | REFUND_SUCCESS |
响应示例
{
"trade_refund_query_response": {
"code": "10000",
"msg": "Success",
"trade_no": "2014112611001004680073956707",
"out_trade_no": "20150320010101001",
"out_request_no": "20150320010101001",
"total_amount": "100.20",
"refund_amount": "12.33",
"refund_status": "REFUND_SUCCESS"
},
"sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}