该接口提供所有支付宝支付订单的查询,商户可以通过该接口主动查询订单状态,完成下一步的业务逻辑。 需要调用查询接口的情况: 当商户后台、网络、服务器等出现异常,商户系统最终未接收到支付通知; 调用支付接口后,返回系统错误或未知交易状态情况; 调用alipay.trade.pay,返回INPROCESS的状态; 调用alipay.trade.cancel之前,需确认支付状态;
| 环境 | HTTPS请求地址 |
|---|---|
| 正式环境 | https://openapi.alipay.com/gateway.do |
| 参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
|---|---|---|---|---|---|
| app_id | String | 是 | 32 | 支付宝分配给开发者的应用ID | 2014072300007148 |
| method | String | 是 | 128 | 接口名称 | alipay.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 | 发送请求的时间,格式"yyyy-MM-dd HH:mm:ss" | 2014-07-24 03:07:50 |
| version | String | 是 | 3 | 调用的接口版本,固定为:1.0 | 1.0 |
| app_auth_token | String | 否 | 40 | 详见应用授权概述 | |
| biz_content | String | 是 | - | 请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递,具体参照各产品快速接入文档 |
| 参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
|---|---|---|---|---|---|
| out_trade_no | String | 特殊可选 | 64 | 订单支付时传入的商户订单号,和支付宝交易号不能同时为空。
trade_no,out_trade_no如果同时存在优先取trade_no |
20150320010101001 |
| trade_no | String | 特殊可选 | 64 | 支付宝交易号,和商户订单号不能同时为空 | 2014112611001004680 073956707 |
| 参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
|---|---|---|---|---|---|
| code | String | 是 | - | 网关返回码,详见文档 | 40004 |
| msg | String | 是 | - | 网关返回码描述,详见文档 | Business Failed |
| sub_code | String | 否 | - | 业务返回码,详见文档 | ACQ.TRADE_HAS_SUCCESS |
| sub_msg | String | 否 | - | 业务返回码描述,详见文档 | 交易已被支付 |
| sign | String | 是 | - | 签名,详见文档 | DZXh8eeTuAHoYE3w1J+POiPhfDxOYBfUNn1lkeT/V7P4zJdyojWEa6IZs6Hz0yDW5Cp/viufUb5I0/V5WENS3OYR8zRedqo6D+fUTdLHdc+EFyCkiQhBxIzgngPdPdfp1PIS7BdhhzrsZHbRqb7o4k3Dxc+AAnFauu4V6Zdwczo= |
| 参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
|---|---|---|---|---|---|
| trade_no | String | 必填 | 64 | 支付宝交易号 | 2013112011001004330000121536 |
| out_trade_no | String | 必填 | 64 | 商家订单号 | 6823789339978248 |
| buyer_logon_id | String | 必填 | 100 | 买家支付宝账号 | 159****5620 |
| trade_status | String | 必填 | 32 | 交易状态:WAIT_BUYER_PAY(交易创建,等待买家付款)、TRADE_CLOSED(未付款交易超时关闭,或支付完成后全额退款)、TRADE_SUCCESS(交易支付成功)、TRADE_FINISHED(交易结束,不可退款) | TRADE_CLOSED |
| total_amount | Price | 必填 | 11 | 交易的订单金额,单位为元,两位小数。该参数的值为支付时传入的total_amount | 88.88 |
| receipt_amount | String | 选填 | 11 | 实收金额,单位为元,两位小数。该金额为本笔交易,商户账户能够实际收到的金额 | 15.25 |
| buyer_pay_amount | Price | 选填 | 11 | 买家实付金额,单位为元,两位小数。该金额代表该笔交易买家实际支付的金额,不包含商户折扣等金额 | 8.88 |
| point_amount | Price | 选填 | 11 | 积分支付的金额,单位为元,两位小数。该金额代表该笔交易中用户使用积分支付的金额,比如集分宝或者支付宝实时优惠等 | 10 |
| invoice_amount | Price | 选填 | 11 | 交易中用户支付的可开具发票的金额,单位为元,两位小数。该金额代表该笔交易中可以给用户开具发票的金额 | 12.11 |
| send_pay_date | Date | 选填 | 32 | 本次交易打款给卖家的时间 | 2014-11-27 15:45:57 |
| store_id | String | 选填 | 32 | 商户门店编号 | NJ_S_001 |
| terminal_id | String | 选填 | 32 | 商户机具终端编号 | NJ_T_001 |
| fund_bill_list | TradeFundBill [] | 必填 | - | 交易支付使用的资金渠道 | |
|
|||||
| store_name | String | 选填 | 512 | 请求交易支付中的商户店铺的名称 | 证大五道口店 |
| buyer_user_id | String | 必填 | 16 | 买家在支付宝的用户id | 2088101117955611 |
| buyer_user_type | String | 选填 | 18 | 买家用户类型。CORPORATE:企业用户;PRIVATE:个人用户。 | PRIVATE |
| mdiscount_amount | String | 选填 | 11 | 商家优惠金额 | 88.88 |
| discount_amount | String | 选填 | 11 | 平台优惠金额 | 88.88 |
AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
AlipayTradeQueryRequest request = new AlipayTradeQueryRequest();
request.setBizContent("{" +
"\"out_trade_no\":\"20150320010101001\"," +
"\"trade_no\":\"2014112611001004680 073956707\"" +
" }");
AlipayTradeQueryResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}
{
"alipay_trade_query_response":{
"msg":"Success",
"store_id":"NJ_S_001",
"code":"10000",
"mdiscount_amount":"88.88",
"discount_amount":"88.88",
"send_pay_date":"2014-11-27 15:45:57",
"buyer_user_id":"2088101117955611",
"invoice_amount":12.11,
"fund_bill_list":[
{
"bank_code":"CEB",
"real_amount":11.21,
"amount":10,
"fund_channel":"ALIPAYACCOUNT"
}
],
"out_trade_no":"6823789339978248",
"total_amount":88.88,
"trade_status":"TRADE_CLOSED",
"buyer_user_type":"PRIVATE",
"trade_no":"2013112011001004330000121536",
"store_name":"证大五道口店",
"buyer_logon_id":"159****5620",
"receipt_amount":"15.25",
"point_amount":10,
"buyer_pay_amount":8.88,
"terminal_id":"NJ_T_001"
},
"sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}
{
"alipay_trade_query_response":{
"msg":"Service Currently Unavailable",
"code":"20000",
"sub_msg":"系统繁忙",
"sub_code":"isp.unknow-error"
},
"sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}
| 错误码 | 错误描述 | 解决方案 |
|---|---|---|
| ACQ.SYSTEM_ERROR | 系统错误 | 重新发起请求 |
| ACQ.INVALID_PARAMETER | 参数无效 | 检查请求参数,修改后重新发起请求 |
| ACQ.TRADE_NOT_EXIST | 查询的交易不存在 | 检查传入的交易号是否正确,修改后重新发起请求 |