alipay.trade.query(统一收单线下交易查询)

该接口提供所有支付宝支付订单的查询,商户可以通过该接口主动查询订单状态,完成下一步的业务逻辑。 需要调用查询接口的情况: 当商户后台、网络、服务器等出现异常,商户系统最终未接收到支付通知; 调用支付接口后,返回系统错误或未知交易状态情况; 调用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
org_pid String 可选 16 银行间联模式下有用,其它场景请不要使用;
双联通过该参数指定需要查询的交易所属收单机构的pid;
2088101117952222

响应参数

参数 类型 是否必填 最大长度 描述 示例值
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
trans_currency String 选填 8 标价币种,该参数的值为支付时传入的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 TWD
settle_currency String 选填 8 订单结算币种,对应支付接口传入的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 USD
settle_amount Price 选填 11 结算币种订单金额 2.96
pay_currency Price 选填 8 订单支付币种 CNY
pay_amount String 选填 11 支付币种订单金额 8.88
settle_trans_rate String 选填 11 结算币种兑换标价币种汇率 30.025
trans_pay_rate String 选填 11 标价币种兑换支付币种汇率 0.264
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
receipt_amount String 选填 11 实收金额,单位为元,两位小数。该金额为本笔交易,商户账户能够实际收到的金额 15.25
store_id String 选填 32 商户门店编号 NJ_S_001
terminal_id String 选填 32 商户机具终端编号 NJ_T_001
fund_bill_list TradeFundBill 必填 交易支付使用的资金渠道
fund_channel String 必填 32 交易使用的资金渠道,详见 支付渠道列表 ALIPAYACCOUNT
amount Price 必填 32 该支付工具类型所使用的金额 10
real_amount Price 可选 11 渠道实际付款金额 11.21
store_name String 选填 512 请求交易支付中的商户店铺的名称 证大五道口店
buyer_user_id String 必填 16 买家在支付宝的用户id 2088101117955611
charge_amount String 选填 11 该笔交易针对收款方的收费金额;
默认不返回该信息,需与支付宝约定后配置返回;
8.88
charge_flags String 选填 64 费率活动标识,当交易享受活动优惠费率时,返回该活动的标识;
默认不返回该信息,需与支付宝约定后配置返回;
可能的返回值列表:
蓝海活动标识:bluesea_1
bluesea_1
settlement_id String 选填 64 支付清算编号,用于清算对账使用;
只在银行间联交易场景下返回该信息;
2018101610032004620239146945
auth_trade_pay_mode String 选填 64 预授权支付模式,该参数仅在信用预授权支付场景下返回。信用预授权支付:CREDIT_PREAUTH_PAY CREDIT_PREAUTH_PAY
buyer_user_type String 选填 18 买家用户类型。CORPORATE:企业用户;PRIVATE:个人用户。 PRIVATE
mdiscount_amount String 选填 11 商家优惠金额 88.88
discount_amount String 选填 11 平台优惠金额 88.88
buyer_user_name String 选填 128 买家名称;
买家为个人用户时为买家姓名,买家为企业用户时为企业名称;
默认不返回该信息,需与支付宝约定后配置返回;
菜鸟网络有限公司

请求示例

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\"" +
"  }");
AlipayTradeQueryResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

{
    "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",
                "amount": 10,
                "real_amount": 11.21
            }
        ],
        "store_name": "证大五道口店",
        "buyer_user_id": "2088101117955611",
        "charge_amount": "8.88",
        "charge_flags": "bluesea_1",
        "settlement_id": "2018101610032004620239146945",
        "auth_trade_pay_mode": "CREDIT_PREAUTH_PAY",
        "buyer_user_type": "PRIVATE",
        "mdiscount_amount": "88.88",
        "discount_amount": "88.88",
        "buyer_user_name": "菜鸟网络有限公司"
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

异常示例

{
    "alipay_trade_query_response": {
        "code": "20000",
        "msg": "Service Currently Unavailable",
        "sub_code": "isp.unknow-error",
        "sub_msg": "系统繁忙"
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

业务错误码

公共错误码

错误码错误描述解决方案
ACQ.SYSTEM_ERROR 系统错误 重新发起请求
ACQ.INVALID_PARAMETER 参数无效 检查请求参数,修改后重新发起请求
ACQ.TRADE_NOT_EXIST 查询的交易不存在 检查传入的交易号是否正确,修改后重新发起请求
onlineServer