该接口提供所有支付订单的查询,商户可以通过该接口主动查询订单状态,完成下一步的业务逻辑。
需要调用查询接口的情况:
当商户后台、网络、服务器等出现异常,商户系统最终未接收到支付结果;
调用支付接口后,返回系统错误或未知交易状态情况;
调用 trade.pay,返回 INPROCESS 的状态;
调用 trade.cancel 之前,需确认支付状态。
公共请求参数
参数 | 类型 | 是否必选 | 最大长度 | 描述 | 示例值 |
app_id | String | 必选 | 32 | 小程序 id | 2014072300007148 |
method | String | 必选 | 128 | 接口名称 | trade.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_trade_no | String | 可选 | 64 | 订单支付时传入的商户订单号,和平台交易号不能同时为空。 trade_no,out_trade_no 如果同时存在优先取 trade_no | 20150320010101001 |
trade_no | String | 可选 | 64 | 平台交易号,和商户订单号不能同时为空 | 2014112611001004680 073956707 |
常见请求示例
默认示例:
curl 'https://xxx/gateway.do?charset=UTF-8&method=trade.query&format=json&sign=${sign}&app_id=${appid}&version=1.0&sign_type=RSA2×tamp=${now}' \
-F 'biz_content={
"out_trade_no":"20150320010101001",
"trade_no":"2014112611001004680 073956707"
}'
本示例仅供参考。
公共响应参数
参数 | 类型 | 是否必选 | 最大长度 | 描述 | 示例值 |
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_status | String | 必选 | 32 | 交易状态:
| TRADE_CLOSED |
total_amount | String | 必选 | 11 | 交易的订单金额,单位为元,两位小数。该参数的值为支付时传入的 total_amount | 88.88 |
buyer_open_id | String | 必选 | 128 | 买家用户唯一标识 | 01501o8f93I3nJAGB1jG4ONxtxV25DCN3Gec3uggnC4CJU0 |
subject | String | 必选 | 256 | 订单标题 | iphone6 16G |
trade_no | String | 可选 | 64 | Payme 交易号。 在未生成真实交易时,不返回,需要商户多次调用该接口或支付通知,获取最终的交易号 | - |
send_pay_date | String | 必选 | 32 | 本次交易打款给卖家的时间 | 2014-11-27 15:45:57 |
响应示例
{
"trade_query_response": {
"code": "10000",
"msg": "Success",
"trade_no": "2013112011001004330000121536",
"out_trade_no": "6823789339978248",
"trade_status": "TRADE_CLOSED",
"total_amount": "88.88",
"send_pay_date": "2014-11-27 15:45:57",
"buyer_open_id": "01501o8f93I3nJAGB1jG4ONxtxV25DCN3Gec3uggnC4CJU0",
"subject": "iphone6 16G"
},
"sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}