查询支付结果接口说明
<h1>alipay.trade.query(统一收单线下交易查询)</h1>
<p>该接口提供所有支付宝支付订单的查询,商户可以通过该接口主动查询订单状态,完成下一步的业务逻辑。 需要调用查询接口的情况: 当商户后台、网络、服务器等出现异常,商户系统最终未接收到支付通知; 调用支付接口后,返回系统错误或未知交易状态情况; 调用alipay.trade.pay,返回INPROCESS的状态; 调用alipay.trade.cancel之前,需确认支付状态;</p>
<h2>公共参数</h2>
<h3>公共请求参数</h3>
<table>
<thead>
<tr>
<th>参数</th>
<th>类型</th>
<th>是否必填</th>
<th>最大长度</th>
<th>描述</th>
<th>示例值</th>
</tr>
</thead>
<tbody>
<tr>
<td>app_id</td>
<td>String</td>
<td>是</td>
<td>32</td>
<td>支付宝分配给开发者的应用ID</td>
<td>2014072300007148</td>
</tr>
<tr>
<td>method</td>
<td>String</td>
<td>是</td>
<td>128</td>
<td>接口名称</td>
<td>alipay.trade.query</td>
</tr>
<tr>
<td>format</td>
<td>String</td>
<td>否</td>
<td>40</td>
<td>仅支持JSON</td>
<td>JSON</td>
</tr>
<tr>
<td>charset</td>
<td>String</td>
<td>是</td>
<td>10</td>
<td>请求使用的编码格式,如utf-8,gbk,gb2312等</td>
<td>utf-8</td>
</tr>
<tr>
<td>sign_type</td>
<td>String</td>
<td>是</td>
<td>10</td>
<td>商户生成签名字符串所使用的签名算法类型,目前支持RSA2和RSA,推荐使用RSA2</td>
<td>RSA2</td>
</tr>
<tr>
<td>sign</td>
<td>String</td>
<td>是</td>
<td>344</td>
<td>商户请求参数的签名串,详见<a href="https://doc.open.alipay.com/docs/doc.htm?treeId=291&articleId=105974&docType=1">签名</a></td>
<td>详见示例</td>
</tr>
<tr>
<td>timestamp</td>
<td>String</td>
<td>是</td>
<td>19</td>
<td>发送请求的时间,格式"yyyy-MM-dd HH:mm:ss"</td>
<td>2014-07-24 03:07:50</td>
</tr>
<tr>
<td>version</td>
<td>String</td>
<td>是</td>
<td>3</td>
<td>调用的接口版本,固定为:1.0</td>
<td>1.0</td>
</tr>
<tr>
<td>app_auth_token</td>
<td>String</td>
<td>否</td>
<td>40</td>
<td>详见<a href="https://doc.open.alipay.com/doc2/detail.htm?treeId=216&articleId=105193&docType=1">应用授权概述</a></td>
<td></td>
</tr>
<tr>
<td>biz_content</td>
<td>String</td>
<td>是</td>
<td></td>
<td>请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递,具体参照各产品快速接入文档</td>
<td></td>
</tr>
</tbody>
</table>
<h2>请求参数</h2>
<table>
<thead>
<tr>
<th>参数</th>
<th>类型</th>
<th>是否必填</th>
<th>最大长度</th>
<th>描述</th>
<th>示例值</th>
</tr>
</thead>
<tbody>
<tr>
<td>out_trade_no</td>
<td>String</td>
<td>特殊可选</td>
<td>64</td>
<td>订单支付时传入的商户订单号,和支付宝交易号不能同时为空。 trade_no,out_trade_no如果同时存在优先取trade_no</td>
<td>20150320010101001</td>
</tr>
<tr>
<td>trade_no</td>
<td>String</td>
<td>特殊可选</td>
<td>64</td>
<td>支付宝交易号,和商户订单号不能同时为空</td>
<td>2014112611001004680 073956707</td>
</tr>
<tr>
<td>org_pid</td>
<td>String</td>
<td>可选</td>
<td>16</td>
<td>银行间联模式下有用,其它场景请不要使用; 双联通过该参数指定需要查询的交易所属收单机构的pid;</td>
<td>2088101117952222</td>
</tr>
<tr>
<td>query_options</td>
<td>String[]</td>
<td>可选</td>
<td>10</td>
<td>查询选项,商户通过上送该字段来定制查询返回信息</td>
<td>TRADE_SETTLE_INFO</td>
</tr>
</tbody>
</table>
<h2>公共响应参数</h2>
<table>
<thead>
<tr>
<th>参数</th>
<th>类型</th>
<th>是否必填</th>
<th>最大长度</th>
<th>描述</th>
<th>示例值</th>
</tr>
</thead>
<tbody>
<tr>
<td>code</td>
<td>String</td>
<td>是</td>
<td>-</td>
<td>网关返回码,<a href="https://doc.open.alipay.com/docs/doc.htm?treeId=291&articleId=105806&docType=1">详见文档</a></td>
<td>40004</td>
</tr>
<tr>
<td>msg</td>
<td>String</td>
<td>是</td>
<td>-</td>
<td>网关返回码描述,<a href="https://doc.open.alipay.com/docs/doc.htm?treeId=291&articleId=105806&docType=1">详见文档</a></td>
<td>Business Failed</td>
</tr>
<tr>
<td>sub_code</td>
<td>String</td>
<td>否</td>
<td>-</td>
<td>业务返回码,参见具体的API接口文档</td>
<td>ACQ.TRADE_HAS_SUCCESS</td>
</tr>
<tr>
<td>sub_msg</td>
<td>String</td>
<td>否</td>
<td>-</td>
<td>业务返回码描述,参见具体的API接口文档</td>
<td>交易已被支付</td>
</tr>
<tr>
<td>sign</td>
<td>String</td>
<td>是</td>
<td>-</td>
<td>签名,<a href="https://doc.open.alipay.com/docs/doc.htm?treeId=291&articleId=106074&docType=1">详见文档</a></td>
<td>DZXh8eeTuAHoYE3w1J+POiPhfDxOYBfUNn1lkeT/V7P4zJdyojWEa6IZs6Hz0yDW5Cp/viufUb5I0/V5WENS3OYR8zRedqo6D+fUTdLHdc+EFyCkiQhBxIzgngPdPdfp1PIS7BdhhzrsZHbRqb7o4k3Dxc+AAnFauu4V6Zdwczo=</td>
</tr>
</tbody>
</table>
<h2>响应参数</h2>
<table>
<thead>
<tr>
<th>参数</th>
<th>类型</th>
<th>是否必填</th>
<th>最大长度</th>
<th>描述</th>
<th>示例值</th>
</tr>
</thead>
<tbody>
<tr>
<td>trade_no</td>
<td>String</td>
<td>必填</td>
<td>64</td>
<td>支付宝交易号</td>
<td>2013112011001004330000121536</td>
</tr>
<tr>
<td>out_trade_no</td>
<td>String</td>
<td>必填</td>
<td>64</td>
<td>商家订单号</td>
<td>6823789339978248</td>
</tr>
<tr>
<td>buyer_logon_id</td>
<td>String</td>
<td>必填</td>
<td>100</td>
<td>买家支付宝账号</td>
<td>159****5620</td>
</tr>
<tr>
<td>trade_status</td>
<td>String</td>
<td>必填</td>
<td>32</td>
<td>交易状态:WAIT_BUYER_PAY(交易创建,等待买家付款)、TRADE_CLOSED(未付款交易超时关闭,或支付完成后全额退款)、TRADE_SUCCESS(交易支付成功)、TRADE_FINISHED(交易结束,不可退款)</td>
<td>TRADE_CLOSED</td>
</tr>
<tr>
<td>total_amount</td>
<td>Price</td>
<td>必填</td>
<td>11</td>
<td>交易的订单金额,单位为元,两位小数。该参数的值为支付时传入的total_amount</td>
<td>88.88</td>
</tr>
<tr>
<td>trans_currency</td>
<td>String</td>
<td>选填</td>
<td>8</td>
<td>标价币种,该参数的值为支付时传入的trans_currency,支持英镑:GBP、港币:HKD、美元:USD、新加坡元:SGD、日元:JPY、加拿大元:CAD、澳元:AUD、欧元:EUR、新西兰元:NZD、韩元:KRW、泰铢:THB、瑞士法郎:CHF、瑞典克朗:SEK、丹麦克朗:DKK、挪威克朗:NOK、马来西亚林吉特:MYR、印尼卢比:IDR、菲律宾比索:PHP、毛里求斯卢比:MUR、以色列新谢克尔:ILS、斯里兰卡卢比:LKR、俄罗斯卢布:RUB、阿联酋迪拉姆:AED、捷克克朗:CZK、南非兰特:ZAR、人民币:CNY、新台币:TWD。当trans_currency 和 settle_currency 不一致时,trans_currency支持人民币:CNY、新台币:TWD</td>
<td>TWD</td>
</tr>
<tr>
<td>settle_currency</td>
<td>String</td>
<td>选填</td>
<td>8</td>
<td>订单结算币种,对应支付接口传入的settle_currency,支持英镑:GBP、港币:HKD、美元:USD、新加坡元:SGD、日元:JPY、加拿大元:CAD、澳元:AUD、欧元:EUR、新西兰元:NZD、韩元:KRW、泰铢:THB、瑞士法郎:CHF、瑞典克朗:SEK、丹麦克朗:DKK、挪威克朗:NOK、马来西亚林吉特:MYR、印尼卢比:IDR、菲律宾比索:PHP、毛里求斯卢比:MUR、以色列新谢克尔:ILS、斯里兰卡卢比:LKR、俄罗斯卢布:RUB、阿联酋迪拉姆:AED、捷克克朗:CZK、南非兰特:ZAR</td>
<td>USD</td>
</tr>
<tr>
<td>settle_amount</td>
<td>Price</td>
<td>选填</td>
<td>11</td>
<td>结算币种订单金额</td>
<td>2.96</td>
</tr>
<tr>
<td>pay_currency</td>
<td>Price</td>
<td>选填</td>
<td>8</td>
<td>订单支付币种</td>
<td>CNY</td>
</tr>
<tr>
<td>pay_amount</td>
<td>String</td>
<td>选填</td>
<td>11</td>
<td>支付币种订单金额</td>
<td>8.88</td>
</tr>
<tr>
<td>settle_trans_rate</td>
<td>String</td>
<td>选填</td>
<td>11</td>
<td>结算币种兑换标价币种汇率</td>
<td>30.025</td>
</tr>
<tr>
<td>trans_pay_rate</td>
<td>String</td>
<td>选填</td>
<td>11</td>
<td>标价币种兑换支付币种汇率</td>
<td>0.264</td>
</tr>
<tr>
<td>buyer_pay_amount</td>
<td>Price</td>
<td>选填</td>
<td>11</td>
<td>买家实付金额,单位为元,两位小数。该金额代表该笔交易买家实际支付的金额,不包含商户折扣等金额</td>
<td>8.88</td>
</tr>
<tr>
<td>point_amount</td>
<td>Price</td>
<td>选填</td>
<td>11</td>
<td>积分支付的金额,单位为元,两位小数。该金额代表该笔交易中用户使用积分支付的金额,比如集分宝或者支付宝实时优惠等</td>
<td>10</td>
</tr>
<tr>
<td>invoice_amount</td>
<td>Price</td>
<td>选填</td>
<td>11</td>
<td>交易中用户支付的可开具发票的金额,单位为元,两位小数。该金额代表该笔交易中可以给用户开具发票的金额</td>
<td>12.11</td>
</tr>
<tr>
<td>send_pay_date</td>
<td>Date</td>
<td>选填</td>
<td>32</td>
<td>本次交易打款给卖家的时间</td>
<td>2014-11-27 15:45:57</td>
</tr>
<tr>
<td>receipt_amount</td>
<td>String</td>
<td>选填</td>
<td>11</td>
<td>实收金额,单位为元,两位小数。该金额为本笔交易,商户账户能够实际收到的金额</td>
<td>15.25</td>
</tr>
<tr>
<td>store_id</td>
<td>String</td>
<td>选填</td>
<td>32</td>
<td>商户门店编号</td>
<td>NJ_S_001</td>
</tr>
<tr>
<td>terminal_id</td>
<td>String</td>
<td>选填</td>
<td>32</td>
<td>商户机具终端编号</td>
<td>NJ_T_001</td>
</tr>
<tr>
<td>fund_bill_list</td>
<td>TradeFundBill</td>
<td>必填</td>
<td></td>
<td>交易支付使用的资金渠道</td>
<td></td>
</tr>
<tr>
<td>└fund_channel</td>
<td>String</td>
<td>必填</td>
<td>32</td>
<td>交易使用的资金渠道,详见 <a href="https://doc.open.alipay.com/doc2/detail?treeId=26&articleId=103259&docType=1">支付渠道列表</a></td>
<td>ALIPAYACCOUNT</td>
</tr>
<tr>
<td>└bank_code</td>
<td>String</td>
<td>可选</td>
<td>10</td>
<td>银行卡支付时的银行代码</td>
<td>CEB</td>
</tr>
<tr>
<td>└amount</td>
<td>Price</td>
<td>必填</td>
<td>32</td>
<td>该支付工具类型所使用的金额</td>
<td>10</td>
</tr>
<tr>
<td>└real_amount</td>
<td>Price</td>
<td>可选</td>
<td>11</td>
<td>渠道实际付款金额</td>
<td>11.21</td>
</tr>
<tr>
<td>store_name</td>
<td>String</td>
<td>选填</td>
<td>512</td>
<td>请求交易支付中的商户店铺的名称</td>
<td>证大五道口店</td>
</tr>
<tr>
<td>buyer_user_id</td>
<td>String</td>
<td>必填</td>
<td>16</td>
<td>买家在支付宝的用户id</td>
<td>2088101117955611</td>
</tr>
<tr>
<td>charge_amount</td>
<td>String</td>
<td>选填</td>
<td>11</td>
<td>该笔交易针对收款方的收费金额; 默认不返回该信息,需与支付宝约定后配置返回;</td>
<td>8.88</td>
</tr>
<tr>
<td>charge_flags</td>
<td>String</td>
<td>选填</td>
<td>64</td>
<td>费率活动标识,当交易享受活动优惠费率时,返回该活动的标识; 默认不返回该信息,需与支付宝约定后配置返回; 可能的返回值列表: 蓝海活动标识:bluesea_1</td>
<td>bluesea_1</td>
</tr>
<tr>
<td>settlement_id</td>
<td>String</td>
<td>选填</td>
<td>64</td>
<td>支付清算编号,用于清算对账使用; 只在银行间联交易场景下返回该信息;</td>
<td>2018101610032004620239146945</td>
</tr>
<tr>
<td>trade_settle_info</td>
<td>TradeSettleInfo</td>
<td>选填</td>
<td></td>
<td>返回的交易结算信息,包含分账、补差等信息</td>
<td></td>
</tr>
<tr>
<td>└trade_settle_detail_list</td>
<td>TradeSettleDetail[]</td>
<td>可选</td>
<td>10</td>
<td>交易结算明细信息</td>
<td></td>
</tr>
<tr>
<td>└operation_type</td>
<td>String</td>
<td>必填</td>
<td>32</td>
<td>结算操作类型。包含replenish、replenish_refund、transfer、transfer_refund等类型</td>
<td>replenish</td>
</tr>
<tr>
<td>└operation_serial_no</td>
<td>String</td>
<td>可选</td>
<td>64</td>
<td>商户操作序列号。商户发起请求的外部请求号。</td>
<td>2321232323232</td>
</tr>
<tr>
<td>└operation_dt</td>
<td>Date</td>
<td>必填</td>
<td>32</td>
<td>操作日期</td>
<td>2019-05-16 09:59:17</td>
</tr>
<tr>
<td>└trans_out</td>
<td>String</td>
<td>可选</td>
<td>32</td>
<td>转出账号</td>
<td>208811****111111</td>
</tr>
<tr>
<td>└trans_in</td>
<td>String</td>
<td>可选</td>
<td>32</td>
<td>转入账号</td>
<td>208811****111111</td>
</tr>
<tr>
<td>└amount</td>
<td>Price</td>
<td>必填</td>
<td>11</td>
<td>实际操作金额,单位为元,两位小数。该参数的值为分账或补差或结算时传入</td>
<td>10.00</td>
</tr>
<tr>
<td>auth_trade_pay_mode</td>
<td>String</td>
<td>选填</td>
<td>64</td>
<td>预授权支付模式,该参数仅在信用预授权支付场景下返回。信用预授权支付:CREDIT_PREAUTH_PAY</td>
<td>CREDIT_PREAUTH_PAY</td>
</tr>
<tr>
<td>buyer_user_type</td>
<td>String</td>
<td>选填</td>
<td>18</td>
<td>买家用户类型。CORPORATE:企业用户;PRIVATE:个人用户。</td>
<td>PRIVATE</td>
</tr>
<tr>
<td>mdiscount_amount</td>
<td>String</td>
<td>选填</td>
<td>11</td>
<td>商家优惠金额</td>
<td>88.88</td>
</tr>
<tr>
<td>discount_amount</td>
<td>String</td>
<td>选填</td>
<td>11</td>
<td>平台优惠金额</td>
<td>88.88</td>
</tr>
<tr>
<td>buyer_user_name</td>
<td>String</td>
<td>选填</td>
<td>128</td>
<td>买家名称; 买家为个人用户时为买家姓名,买家为企业用户时为企业名称; 默认不返回该信息,需与支付宝约定后配置返回;</td>
<td>菜鸟网络有限公司</td>
</tr>
<tr>
<td>subject</td>
<td>String</td>
<td>选填</td>
<td>256</td>
<td>订单标题; 只在间连场景下返回;</td>
<td>Iphone6 16G</td>
</tr>
<tr>
<td>body</td>
<td>String</td>
<td>选填</td>
<td>1000</td>
<td>订单描述; 只在间连场景下返回;</td>
<td>Iphone6 16G</td>
</tr>
<tr>
<td>alipay_sub_merchant_id</td>
<td>String</td>
<td>选填</td>
<td>32</td>
<td>间连商户在支付宝端的商户编号; 只在间连场景下返回;</td>
<td>2088301372182171</td>
</tr>
<tr>
<td>ext_infos</td>
<td>String</td>
<td>选填</td>
<td>1024</td>
<td>交易额外信息,特殊场景下与支付宝约定返回。 json格式。</td>
<td>{"action":"cancel"}</td>
</tr>
</tbody>
</table>
<h2>请求示例</h2>
<ul>
<li> <a href="https://opendocs.alipay.com/apis/#">java</a> </li>
<li> <a href="https://opendocs.alipay.com/apis/#">c#</a> </li>
<li> <a href="https://opendocs.alipay.com/apis/#">php</a> </li>
<li> <a href="https://opendocs.alipay.com/apis/#">http</a> </li>
</ul>
<pre><code class="language-js">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\"," +
"\"org_pid\":\"2088101117952222\"," +
" \"query_options\":[" +
" \"TRADE_SETTLE_INFO\"" +
" ]" +
" }");
AlipayTradeQueryResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}</code></pre>
<h2>响应示例</h2>
<ul>
<li> <a href="https://opendocs.alipay.com/apis/#">json</a> </li>
<li> <a href="https://opendocs.alipay.com/apis/#">xml</a> </li>
</ul>
<pre><code class="language-js">{
"alipay_trade_query_response": {
"code": "10000",
"msg": "Success",
"trade_no": "2013112011001004330000121536",
"out_trade_no": "6823789339978248",
"buyer_logon_id": "159****5620",
"trade_status": "TRADE_CLOSED",
"total_amount": 88.88,
"trans_currency": "TWD",
"settle_currency": "USD",
"settle_amount": 2.96,
"pay_currency": 1,
"pay_amount": "8.88",
"settle_trans_rate": "30.025",
"trans_pay_rate": "0.264",
"buyer_pay_amount": 8.88,
"point_amount": 10,
"invoice_amount": 12.11,
"send_pay_date": "2014-11-27 15:45:57",
"receipt_amount": "15.25",
"store_id": "NJ_S_001",
"terminal_id": "NJ_T_001",
"fund_bill_list": [
{
"fund_channel": "ALIPAYACCOUNT",
"bank_code": "CEB",
"amount": 10,
"real_amount": 11.21
}
],
"store_name": "证大五道口店",
"buyer_user_id": "2088101117955611",
"charge_amount": "8.88",
"charge_flags": "bluesea_1",
"settlement_id": "2018101610032004620239146945",
"trade_settle_info": {
"trade_settle_detail_list": [
{
"operation_type": "replenish",
"operation_serial_no": "2321232323232",
"operation_dt": "2019-05-16 09:59:17",
"trans_out": "208811****111111",
"trans_in": "208811****111111",
"amount": 10
}
]
},
"auth_trade_pay_mode": "CREDIT_PREAUTH_PAY",
"buyer_user_type": "PRIVATE",
"mdiscount_amount": "88.88",
"discount_amount": "88.88",
"buyer_user_name": "菜鸟网络有限公司",
"subject": "Iphone6 16G",
"body": "Iphone6 16G",
"alipay_sub_merchant_id": "2088301372182171",
"ext_infos": "{\"action\":\"cancel\"}"
},
"sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}</code></pre>
<h2>异常示例</h2>
<ul>
<li> <a href="https://opendocs.alipay.com/apis/#">json</a> </li>
</ul>
<pre><code class="language-js">{
"alipay_trade_query_response": {
"code": "20000",
"msg": "Service Currently Unavailable",
"sub_code": "isp.unknow-error",
"sub_msg": "系统繁忙"
},
"sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}</code></pre>
<h2>业务错误码</h2>
<p><a href="https://opendocs.alipay.com/open/common/105806"><strong>公共错误码</strong></a></p>
<table>
<thead>
<tr>
<th>错误码</th>
<th>错误描述</th>
<th>解决方案</th>
</tr>
</thead>
<tbody>
<tr>
<td>ACQ.SYSTEM_ERROR</td>
<td>系统错误</td>
<td>重新发起请求</td>
</tr>
<tr>
<td>ACQ.INVALID_PARAMETER</td>
<td>参数无效</td>
<td>检查请求参数,修改后重新发起请求</td>
</tr>
<tr>
<td>ACQ.TRADE_NOT_EXIST</td>
<td>查询的交易不存在</td>
<td>检查传入的交易号</td>
</tr>
</tbody>
</table>