淘宝开放平台 - 文档中心

请求地址：

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://gw.api.taobao.com/router/rest	https://eco.taobao.com/router/rest

公共请求参数：

名称	类型	是否必须	描述
method	String	是	API接口名称。
app_key	String	是	TOP分配给应用的AppKey。
target_app_key	String	否	被调用的目标AppKey，仅当被调用的API为第三方ISV提供时有效。
sign_method	String	是	签名的摘要算法，可选值为：hmac，md5。
sign	String	是	API输入参数签名结果，签名算法介绍请点击这里。
session	String	否	用户登录授权成功后，TOP颁发给应用的授权信息，详细介绍请点击这里。当此API的标签上注明：“需要授权”，则此参数必传；“不需要授权”，则此参数不需要传；“可选授权”，则此参数为可选。
timestamp	String	是	时间戳，格式为yyyy-MM-dd HH:mm:ss，时区为GMT+8，例如：2015-01-01 12:00:00。淘宝API服务端允许客户端请求最大时间误差为10分钟。
format	String	否	响应格式。默认为xml格式，可选值：xml，json。
v	String	是	API协议版本，可选值：2.0。
partner_id	String	否	合作伙伴身份标识。
simplify	Boolean	否	是否采用精简JSON返回格式，仅当format=json时有效，默认值为：false。

名称	类型	是否必须	示例值	更多限制	描述
edi_alipay_trade_query_request	EdiAlipayTradeQueryRequest	可选			查询支付宝订单
└ trade_no String 可选 2014112611001004680 073956707 支付宝交易号，和商户订单号不能同时为空 └ query_options String [] 可选 trade_settle_info 查询选项，商户传入该参数可定制本接口同步响应额外返回的信息字段，数组格式。支持枚举如下：trade_settle_info：返回的交易结算信息，包含分账、补差等信息； fund_bill_list：交易支付使用的资金渠道； voucher_detail_list：交易支付时使用的所有优惠券信息； discount_goods_detail：交易支付所使用的单品券优惠的商品优惠信息； mdiscount_amount：商家优惠金额 └ out_trade_no String 可选 20150320010101001 订单支付时传入的商户订单号,和支付宝交易号不能同时为空。 trade_no,out_trade_no如果同时存在优先取trade_no └ org_pid String 可选 2088101117952222 银行间联模式下有用，其它场景请不要使用；双联通过该参数指定需要查询的交易所属收单机构的pid;

名称	类型	示例值	描述
data	EdiAlipayTradeQueryResponse		支付订单查询响应
└ trade_no String 2013112011001004330000121536 支付宝交易号 └ out_trade_no String 6823789339978248 商家订单号 └ buyer_logon_id String 159**5620 买家支付宝账号 └ trade_status String TRADE_CLOSED 交易状态：WAIT_BUYER_PAY（交易创建，等待买家付款）、TRADE_CLOSED（未付款交易超时关闭，或支付完成后全额退款）、TRADE_SUCCESS（交易支付成功）、TRADE_FINISHED（交易结束，不可退款） └ total_amount String 88.88 交易的订单金额，单位为元，两位小数。该参数的值为支付时传入的total_amount └ trans_currency String CNY 标价币种，该参数的值为支付时传入的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 └ settle_currency String USD 订单结算币种，对应支付接口传入的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 └ settle_amount String 15.96 结算币种订单金额 └ pay_currency String CNY 订单支付币种 └ pay_amount String 8.88 支付币种订单金额 └ settle_trans_rate String 30.025 结算币种兑换标价币种汇率 └ trans_pay_rate String 0.264 标价币种兑换支付币种汇率 └ buyer_pay_amount String 8.88 买家实付金额，单位为元，两位小数。该金额代表该笔交易买家实际支付的金额，不包含商户折扣等金额 └ point_amount String 10 积分支付的金额，单位为元，两位小数。该金额代表该笔交易中用户使用积分支付的金额，比如集分宝或者支付宝实时优惠等 └ invoice_amount String 12.11 交易中用户支付的可开具发票的金额，单位为元，两位小数。该金额代表该笔交易中可以给用户开具发票的金额 └ send_pay_date Date 2014-11-27 15:45:57 本次交易打款给卖家的时间 └ receipt_amount String 15.25 实收金额，单位为元，两位小数。该金额为本笔交易，商户账户能够实际收到的金额 └ store_id String NJ_S_001 商户门店编号 └ terminal_id String NJ_S_001 商户机具终端编号 fund_bill_list TradeFundBillDTO [] 交易支付使用的资金渠道。只有在签约中指定需要返回资金明细，或者入参的query_options中指定时才返回该字段信息 └ fund_channel String ALIPAYACCOUNT 交易使用的资金渠道，详见https://opendocs.alipay.com/open/common/103259 └ amount String 10 该支付工具类型所使用的金额 └ real_amount String 11.21 渠道实际付款金额 └ bank_code String 208811111111 银行卡支付时的银行代码 └ fund_type String DEBIT_CARD 渠道所使用的资金类型,目前只在资金渠道(fund_channel)是银行卡渠道(BANKCARD)的情况下才返回该信息(DEBIT_CARD:借记卡,CREDIT_CARD:信用卡,MIXED_CARD:借贷合一卡) └ store_name String 证大五道口店请求交易支付中的商户店铺的名称 └ buyer_user_id String 买家在支付宝的用户id 2088101117955611 └ charge_amount String 8.88 该笔交易针对收款方的收费金额；默认不返回该信息，需与支付宝约定后配置返回； └ charge_flags String bluesea_1 费率活动标识。当交易享受特殊行业或活动费率时，返回该场景的标识。具体场景如下： trade_special_00：订单优惠费率； industry_special_on_00：线上行业特殊费率0； industry_special_on_01：线上行业特殊费率1； industry_special_00：线下行业特殊费率0； industry_special_01：线下行业特殊费率1； bluesea_1：蓝海活动优惠费率标签；注：只在机构间联模式下返回，其它场景下不返回该字段 └ settlement_id String 2018101610032004620239146945 支付清算编号，用于清算对账使用；只在银行间联交易场景下返回该信息 trade_settle_info TradeSettleInfoDTO 返回的交易结算信息，包含分账、补差等信息。只有在query_options中指定时才返回该字段信息。 trade_settle_detail_list TradeSettleDetailDTO [] 交易结算明细信息 └ operation_type String replenish 结算操作类型。有以下几种类型： replenish(补差)、replenish_refund(退补差)、transfer(分账)、transfer_refund(退分账)、settle(结算)、settle_refund(退结算)、on_settle(待结算)。 └ operation_serial_no String 2321232323232 商户操作序列号 └ operation_dt Date 2019-05-16 09:59:17 操作日期 └ trans_out Date 208811111111 转出账号 └ trans_in String 208811**111111 转入账号 └ amount String 10.00 实际操作金额，单位为元，两位小数。该参数的值为分账或补差或结算时传入 └ auth_trade_pay_mode String CREDIT_PREAUTH_PAY 预授权支付模式，该参数仅在信用预授权支付场景下返回。信用预授权支付：CREDIT_PREAUTH_PAY └ buyer_user_type String PRIVATE 买家用户类型。CORPORATE:企业用户；PRIVATE:个人用户。 └ mdiscount_amount String 88.88 商家优惠金额 └ discount_amount String 88.88 平台优惠金额 └ subject String Iphone6 16G 订单标题；只在银行间联交易场景下返回该信息； └ body String Iphone6 16G 订单描述；只在银行间联交易场景下返回该信息； └ alipay_sub_merchant_id String 2088301372182171 间连商户在支付宝端的商户编号；只在间连场景下返回； └ ext_infos String {"action":"cancel"} 交易额外信息，特殊场景下与支付宝约定返回。 json格式。 └ industry_sepc_detail String 行业特殊信息行业特殊信息（例如在医保卡支付业务中，向用户返回医疗信息）。 └ alipay_store_id String NJ_S_001 支付宝店铺编号 └ buyer_user_name String 张三买家名称；买家为个人用户时为买家姓名，买家为企业用户时为企业名称；默认不返回该信息，需与支付宝约定后配置返回； └ discount_goods_detail String promotion 10 本次交易支付所使用的单品券优惠的商品优惠信息。只有在query_options中指定时才返回该字段信息。 voucher_detail_list VoucherDetailDTO [] 本交易支付时使用的所有优惠券信息 └ amount String 18.88 优惠券面额，它应该会等于商家出资加上其他出资方出资 └ id String 20183314556667 优惠券id └ memo String 无门槛优惠券优惠券备注信息 └ merchant_contribute String 12.00 商家出资（特指发起交易的商家出资金额） └ name String 全场9折优惠券券名称 └ other_contribute String 6.88 其他出资方出资金额，可能是支付宝，可能是品牌商，或者其他方，也可能是他们的一起出资 other_contribute_detail ContributeDetailDTO [] 出资方明细 └ contribute_amount String 1.23 出资方金额 └ contribute_type String 支付宝平台出资出资方类型，如品牌商出资、支付宝平台出资等 └ purchase_ant_contribute String 2.88 如果使用的这张券是用户购买的，则该字段代表用户在购买这张券时平台优惠的金额 └ purchase_buyer_contribute String 5.88 如果使用的这张券是用户购买的，则该字段代表用户在购买这张券时用户实际付款的金额 └ purchase_merchant_contribute String 1.88 如果使用的这张券是用户购买的，则该字段代表用户在购买这张券时商户优惠的金额 └ template_id String 2314455566 券模板id └ type String ALIPAY_ITEM_VOUCHER 券类型，如： ALIPAY_FIX_VOUCHER - 全场代金券 ALIPAY_DISCOUNT_VOUCHER - 折扣券 ALIPAY_ITEM_VOUCHER - 单品优惠券 ALIPAY_CASH_VOUCHER - 现金抵价券 ALIPAY_BIZ_VOUCHER - 商家全场券注：不排除将来新增其他类型的可能，商家接入时注意兼容性避免硬编码

JAVA
.NET
PHP
CURL
Python
C/C++
NodeJS

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
TmallLuxuryStageEdiAlipayTradeQueryRequest req = new TmallLuxuryStageEdiAlipayTradeQueryRequest();
TmallLuxuryStageEdiAlipayTradeQueryRequest.EdiAlipayTradeQueryRequest obj1 = new TmallLuxuryStageEdiAlipayTradeQueryRequest.EdiAlipayTradeQueryRequest();
obj1.setTradeNo("2014112611001004680 073956707");
obj1.setQueryOptions("trade_settle_info");
obj1.setOutTradeNo("20150320010101001");
obj1.setOrgPid("2088101117952222");
req.setEdiAlipayTradeQueryRequest(obj1);
TmallLuxuryStageEdiAlipayTradeQueryResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
TmallLuxuryStageEdiAlipayTradeQueryRequest req = new TmallLuxuryStageEdiAlipayTradeQueryRequest();
TmallLuxuryStageEdiAlipayTradeQueryRequest.EdiAlipayTradeQueryRequestDomain obj1 = new TmallLuxuryStageEdiAlipayTradeQueryRequest.EdiAlipayTradeQueryRequestDomain();
obj1.TradeNo = "2014112611001004680 073956707";
obj1.QueryOptions = "trade_settle_info";
obj1.OutTradeNo = "20150320010101001";
obj1.OrgPid = "2088101117952222";
req.EdiAlipayTradeQueryRequest_ = obj1;
TmallLuxuryStageEdiAlipayTradeQueryResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new TmallLuxuryStageEdiAlipayTradeQueryRequest;
$edi_alipay_trade_query_request = new EdiAlipayTradeQueryRequest;
$edi_alipay_trade_query_request->trade_no="2014112611001004680 073956707";
$edi_alipay_trade_query_request->query_options="trade_settle_info";
$edi_alipay_trade_query_request->out_trade_no="20150320010101001";
$edi_alipay_trade_query_request->org_pid="2088101117952222";
$req->setEdiAlipayTradeQueryRequest(json_encode($edi_alipay_trade_query_request));
$resp = $c->execute($req);

curl -X POST 'http://gw.api.taobao.com/router/rest' \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'app_key=12129701' \
-d 'format=json' \
-d 'method=tmall.luxury.stage.edi.alipay.trade.query' \
-d 'partner_id=apidoc' \
-d 'sign=0FAB83B0701488A048F89CFA17E951C2' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-28+02%3A13%3A51' \
-d 'v=2.0' \
-d 'edi_alipay_trade_query_request=null'

# -*- coding: utf-8 -*-
import top.api

req=top.api.TmallLuxuryStageEdiAlipayTradeQueryRequest(url,port)
req.set_app_info(top.appinfo(appkey,secret))

req.edi_alipay_trade_query_request="数据结构示例JSON格式"
try:
	resp= req.getResponse()
	print(resp)
except Exception,e:
	print(e)

pTopRequest pRequest = alloc_top_request();
pTopResponse pResponse = NULL;
pTaobaoClient pClient = alloc_taobao_client(url, appkey, appsecret);
set_api_name(pRequest,"tmall.luxury.stage.edi.alipay.trade.query");
add_param(pRequest,"edi_alipay_trade_query_request","数据结构JSON示例");
pResponse = top_execute(pClient,pRequest,NULL);
printf("ret code:%d\n",pResponse->code);
if(pResponse->code == 0){
	pTopResponseIterator ite = init_response_iterator(pResponse);
	pResultItem pResultItem = alloc_result_item();
	while(parseNext(ite, pResultItem) == 0){
		printf("%s:%s\n",pResultItem->key,pResultItem->value);
	}
	destroy_response_iterator(ite);
	destroy_result_item(pResultItem);
}
destroy_top_request(pRequest);
destroy_top_response(pResponse);
destroy_taobao_client(pClient);

TopClient = require('./topClient').TopClient;
var client = new TopClient({
	'appkey': 'appkey',
	'appsecret': 'secret',
	'REST_URL': 'http://gw.api.taobao.com/router/rest'
});

client.execute('tmall.luxury.stage.edi.alipay.trade.query', {
	'edi_alipay_trade_query_request':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<tmall_luxury_stage_edi_alipay_trade_query_response>
    <data>
        <trade_no>2013112011001004330000121536</trade_no>
        <out_trade_no>6823789339978248</out_trade_no>
        <buyer_logon_id>159****5620</buyer_logon_id>
        <trade_status>TRADE_CLOSED</trade_status>
        <total_amount>88.88</total_amount>
        <trans_currency>CNY</trans_currency>
        <settle_currency>USD</settle_currency>
        <settle_amount>15.96</settle_amount>
        <pay_currency>CNY</pay_currency>
        <pay_amount>8.88</pay_amount>
        <settle_trans_rate>30.025</settle_trans_rate>
        <trans_pay_rate>0.264</trans_pay_rate>
        <buyer_pay_amount>8.88</buyer_pay_amount>
        <point_amount>10</point_amount>
        <invoice_amount>12.11</invoice_amount>
        <send_pay_date>2014-11-27 15:45:57</send_pay_date>
        <receipt_amount>15.25</receipt_amount>
        <store_id>NJ_S_001</store_id>
        <terminal_id>NJ_S_001</terminal_id>
        <fund_bill_list>
            <trade_fund_bill_d_t_o>
                <fund_channel>ALIPAYACCOUNT</fund_channel>
                <amount>10</amount>
                <real_amount>11.21</real_amount>
                <bank_code>208811****111111</bank_code>
                <fund_type>DEBIT_CARD</fund_type>
            </trade_fund_bill_d_t_o>
        </fund_bill_list>
        <store_name>证大五道口店</store_name>
        <buyer_user_id>买家在支付宝的用户id</buyer_user_id>
        <charge_amount>8.88</charge_amount>
        <charge_flags>bluesea_1</charge_flags>
        <settlement_id>2018101610032004620239146945</settlement_id>
        <trade_settle_info>
            <trade_settle_detail_list>
                <trade_settle_detail_d_t_o>
                    <operation_type>replenish</operation_type>
                    <operation_serial_no>2321232323232</operation_serial_no>
                    <operation_dt>2019-05-16 09:59:17</operation_dt>
                    <trans_out>208811****111111</trans_out>
                    <trans_in>208811****111111</trans_in>
                    <amount>10.00</amount>
                </trade_settle_detail_d_t_o>
            </trade_settle_detail_list>
        </trade_settle_info>
        <auth_trade_pay_mode>CREDIT_PREAUTH_PAY</auth_trade_pay_mode>
        <buyer_user_type>PRIVATE</buyer_user_type>
        <mdiscount_amount>88.88</mdiscount_amount>
        <discount_amount>88.88</discount_amount>
        <subject>Iphone6 16G</subject>
        <body>Iphone6 16G</body>
        <alipay_sub_merchant_id>2088301372182171</alipay_sub_merchant_id>
        <ext_infos>{&quot;action&quot;:&quot;cancel&quot;}</ext_infos>
        <industry_sepc_detail>行业特殊信息</industry_sepc_detail>
        <alipay_store_id>NJ_S_001</alipay_store_id>
        <buyer_user_name>张三</buyer_user_name>
        <discount_goods_detail>promotion 10</discount_goods_detail>
        <voucher_detail_list>
            <voucher_detail_d_t_o>
                <amount>18.88</amount>
                <id>20183314556667</id>
                <memo>无门槛优惠券</memo>
                <merchant_contribute>12.00</merchant_contribute>
                <name>全场9折优惠券</name>
                <other_contribute>6.88</other_contribute>
                <other_contribute_detail>
                    <contribute_detail_d_t_o>
                        <contribute_amount>1.23</contribute_amount>
                        <contribute_type>支付宝平台出资</contribute_type>
                    </contribute_detail_d_t_o>
                </other_contribute_detail>
                <purchase_ant_contribute>2.88</purchase_ant_contribute>
                <purchase_buyer_contribute>5.88</purchase_buyer_contribute>
                <purchase_merchant_contribute>1.88</purchase_merchant_contribute>
                <template_id>2314455566</template_id>
                <type>ALIPAY_ITEM_VOUCHER</type>
            </voucher_detail_d_t_o>
        </voucher_detail_list>
    </data>
</tmall_luxury_stage_edi_alipay_trade_query_response>

{
    "tmall_luxury_stage_edi_alipay_trade_query_response":{
        "data":{
            "trade_no":"2013112011001004330000121536",
            "out_trade_no":"6823789339978248",
            "buyer_logon_id":"159****5620",
            "trade_status":"TRADE_CLOSED",
            "total_amount":"88.88",
            "trans_currency":"CNY",
            "settle_currency":"USD",
            "settle_amount":"15.96",
            "pay_currency":"CNY",
            "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_S_001",
            "fund_bill_list":{
                "trade_fund_bill_d_t_o":[
                    {
                        "fund_channel":"ALIPAYACCOUNT",
                        "amount":"10",
                        "real_amount":"11.21",
                        "bank_code":"208811****111111",
                        "fund_type":"DEBIT_CARD"
                    }
                ]
            },
            "store_name":"证大五道口店",
            "buyer_user_id":"买家在支付宝的用户id",
            "charge_amount":"8.88",
            "charge_flags":"bluesea_1",
            "settlement_id":"2018101610032004620239146945",
            "trade_settle_info":{
                "trade_settle_detail_list":{
                    "trade_settle_detail_d_t_o":[
                        {
                            "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.00"
                        }
                    ]
                }
            },
            "auth_trade_pay_mode":"CREDIT_PREAUTH_PAY",
            "buyer_user_type":"PRIVATE",
            "mdiscount_amount":"88.88",
            "discount_amount":"88.88",
            "subject":"Iphone6 16G",
            "body":"Iphone6 16G",
            "alipay_sub_merchant_id":"2088301372182171",
            "ext_infos":"{\"action\":\"cancel\"}",
            "industry_sepc_detail":"行业特殊信息",
            "alipay_store_id":"NJ_S_001",
            "buyer_user_name":"张三",
            "discount_goods_detail":"promotion 10",
            "voucher_detail_list":{
                "voucher_detail_d_t_o":[
                    {
                        "amount":"18.88",
                        "id":"20183314556667",
                        "memo":"无门槛优惠券",
                        "merchant_contribute":"12.00",
                        "name":"全场9折优惠券",
                        "other_contribute":"6.88",
                        "other_contribute_detail":{
                            "contribute_detail_d_t_o":[
                                {
                                    "contribute_amount":"1.23",
                                    "contribute_type":"支付宝平台出资"
                                }
                            ]
                        },
                        "purchase_ant_contribute":"2.88",
                        "purchase_buyer_contribute":"5.88",
                        "purchase_merchant_contribute":"1.88",
                        "template_id":"2314455566",
                        "type":"ALIPAY_ITEM_VOUCHER"
                    }
                ]
            }
        }
    }
}

XML示例
JSON示例

<error_response>
    <code>50</code>
    <msg>Remote service error</msg>
    <sub_code>isv.invalid-parameter</sub_code>
    <sub_msg>非法参数</sub_msg>
</error_response>

{
	"error_response":{
		"msg":"Remote service error",
		"code":50,
		"sub_msg":"非法参数",
		"sub_code":"isv.invalid-parameter"
	}
}

错误码	错误描述	解决方案

API测试工具错误码查询工具 SDK下载

开放平台

天猫奢品独立市场

tmall.luxury.stage.edi.alipay.trade.query (天猫奢品独立市场EDI支付宝查询支付订单)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ