淘宝开放平台 - 文档中心

请求地址：

环境	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。

名称	类型	是否必须	示例值	更多限制	描述
trade_no	String	可选	2013112011001004330000121536	最大长度：64	喵街交易流水号。与商户支付流水号两者至少要填写一个。如果均有，优先级为喵街交易流水号 > 商户支付流水号。
out_trade_no	String	可选	20150320010101001	最大长度：64	原支付请求的商户支付流水号。与喵街交易流水号两者至少要填写一个。如果均有，优先级为喵街交易流水号 > 商户支付流水号。
store_id_type	String	必须	out		商户ID类型，取值为miaojie或out
store_id	String	必须	HZ01		门店号或喵街商户ID

名称	类型	示例值	描述
onsite_trade_query_response	OnsiteTradeQueryResponse	onsiteTradeQueryResponse	查询结果对象。必然返回
└ buyer_nick String 59***5620 消费者在喵街的昵称，将用号屏蔽部分内容。必然返回 └ gmt_payment String 2015-11-27 15:45:57 消费者付款时间。在付款后才会返回，格式为 yyyy-MM-dd HH:mm:ss，时区是GMT+8 └ buyer_total_fund_fee Number 50000 消费者实付总额。单位：分 └ buyer_total_promotion_fee Number 38888 消费者优惠总额。消费者支付的营销渠道的总金额，单位为人民币（分）。一般来讲，是通过券／权益抵扣的总金额。消费者付款成功后，才返回此值 └ out_trade_no String 6823789339978248 原支付请求的商户支付流水号。必然返回 fund_bill_list FundBill [] 参见FundBill说明商户的实收资金渠道明细信息列表。 └ amount Number 9000 金额。单位为人民币（分）。必然返回 └ extend_params String [{"abc":"123"}] 业务扩展参数，json格式 └ sub_fund_channel String alipay_financeaccount 子资金渠道。必然返回。取值为支付宝红包：alipay_coupon 支付宝余额：alipay_account 支付宝集分宝：alipay_point 支付宝余额宝：alipay_financeaccount 蚂蚁花呗：alipay_pcredit 支付宝预付卡：alipay_pcard 喵街储值卡（经支付宝打款）：alipay_mj_vcard 喵街购物券（经支付宝打款）：alipay_mj_voucher 喵街补贴（经支付宝打款）：alipay_mj_subsidy 其它（经支付宝打款）：alipay_other └ fund_channel String alipay 打款类型。必然返回。取值为alipay，代表打款类型为支付宝（打款到商户的支付宝账号） └ store_total_marketing_fee Number 28888 商户总营销成本。商户在本次交易中的营销总成本，单位为人民币（分）。 └ store_total_received_fee Number 50000 商户实收总额。商户在本次交易中实收的总金额。单位：分 └ total_amount Number 88888 本次交易支付的订单金额，单位为人民币（分）。必然返回 └ trade_no String 2013112011001004330000121536 喵街交易流水号。必然返回 └ trade_status String WAIT_FOR_CONFIRM 交易目前所处的状态。必然返回。取值：WAIT_FOR_CONFIRM，待确认，此时不能申请退款，可以撤销；WAIT_BUYER_PAY，等待消费者付款，此时不能申请退款，可以撤销；TRADE_SUCCESS，付款成功，此时可以申请退款，可以撤销（自动申请退款）；TRADE_FINISHED，交易成功，此时可以申请退款，不可以撤销；TRADE_CLOSED，交易关闭，此时不能申请退款，不能撤销 └ extend_params String [{"abc":"123"}] 业务扩展参数，json格式 └ auth_code_source String MJ 码来源，取值：MJ、M_TAO、ALIPAY

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaMosOnsiteTradeQueryRequest req = new AlibabaMosOnsiteTradeQueryRequest();
req.setTradeNo("2013112011001004330000121536");
req.setOutTradeNo("20150320010101001");
req.setStoreIdType("out");
req.setStoreId("HZ01");
AlibabaMosOnsiteTradeQueryResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaMosOnsiteTradeQueryRequest req = new AlibabaMosOnsiteTradeQueryRequest();
req.TradeNo = "2013112011001004330000121536";
req.OutTradeNo = "20150320010101001";
req.StoreIdType = "out";
req.StoreId = "HZ01";
AlibabaMosOnsiteTradeQueryResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaMosOnsiteTradeQueryRequest;
$req->setTradeNo("2013112011001004330000121536");
$req->setOutTradeNo("20150320010101001");
$req->setStoreIdType("out");
$req->setStoreId("HZ01");
$resp = $c->execute($req, $sessionKey);

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=alibaba.mos.onsite.trade.query' \
-d 'partner_id=apidoc' \
-d 'session=63d0324d-3a88-417e-87b8-25472d81fee5' \
-d 'sign=376A6FFBB87B791CE1D67224E56BE14E' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-06-04+12%3A19%3A22' \
-d 'v=2.0' \
-d 'out_trade_no=20150320010101001' \
-d 'store_id=HZ01' \
-d 'store_id_type=out' \
-d 'trade_no=2013112011001004330000121536'

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

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

req.trade_no="2013112011001004330000121536"
req.out_trade_no="20150320010101001"
req.store_id_type="out"
req.store_id="HZ01"
try:
	resp= req.getResponse(sessionkey)
	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,"alibaba.mos.onsite.trade.query");
add_param(pRequest,"trade_no","2013112011001004330000121536");
add_param(pRequest,"out_trade_no","20150320010101001");
add_param(pRequest,"store_id_type","out");
add_param(pRequest,"store_id","HZ01");
pResponse = top_execute(pClient,pRequest,sessionKey);
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('alibaba.mos.onsite.trade.query', {
	'trade_no':'2013112011001004330000121536',
	'out_trade_no':'20150320010101001',
	'store_id_type':'out',
	'store_id':'HZ01'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_mos_onsite_trade_query_response>
    <onsite_trade_query_response>
        <buyer_nick>59****5620</buyer_nick>
        <gmt_payment>2015-11-27 15:45:57</gmt_payment>
        <buyer_total_fund_fee>50000</buyer_total_fund_fee>
        <buyer_total_promotion_fee>38888</buyer_total_promotion_fee>
        <out_trade_no>6823789339978248</out_trade_no>
        <fund_bill_list>
            <fund_bill>
                <amount>9000</amount>
                <extend_params>[{&quot;abc&quot;:&quot;123&quot;}]</extend_params>
                <sub_fund_channel>alipay_financeaccount</sub_fund_channel>
                <fund_channel>alipay</fund_channel>
            </fund_bill>
        </fund_bill_list>
        <store_total_marketing_fee>28888</store_total_marketing_fee>
        <store_total_received_fee>50000</store_total_received_fee>
        <total_amount>88888</total_amount>
        <trade_no>2013112011001004330000121536</trade_no>
        <trade_status>WAIT_FOR_CONFIRM</trade_status>
        <extend_params>[{&quot;abc&quot;:&quot;123&quot;}]</extend_params>
        <auth_code_source>MJ</auth_code_source>
    </onsite_trade_query_response>
</alibaba_mos_onsite_trade_query_response>

{
    "alibaba_mos_onsite_trade_query_response":{
        "onsite_trade_query_response":{
            "buyer_nick":"59****5620",
            "gmt_payment":"2015-11-27 15:45:57",
            "buyer_total_fund_fee":50000,
            "buyer_total_promotion_fee":38888,
            "out_trade_no":"6823789339978248",
            "fund_bill_list":{
                "fund_bill":[
                    {
                        "amount":9000,
                        "extend_params":"[{\"abc\":\"123\"}]",
                        "sub_fund_channel":"alipay_financeaccount",
                        "fund_channel":"alipay"
                    }
                ]
            },
            "store_total_marketing_fee":28888,
            "store_total_received_fee":50000,
            "total_amount":88888,
            "trade_no":"2013112011001004330000121536",
            "trade_status":"WAIT_FOR_CONFIRM",
            "extend_params":"[{\"abc\":\"123\"}]",
            "auth_code_source":"MJ"
        }
    }
}

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"
	}
}

错误码	错误描述	解决方案
isp.TRADE_ORDER_NOT_FOUND	交易订单未找到	检查参数是否正确
isp.SYSTEM_ERROR	系统异常	ISV需要间隔2秒重试不超过10次。如果仍然异常，则需联系喵街技术支付人员检查。
isv.INVALID_PARAMETER	无效参数。	ISV开发人员需检查参数是否正确。
isp.QUERY_TRADE_FAIL	查询交易时出现异常	ISV需要间隔2秒重试不超过10次。如果仍然异常，则需联系喵街技术支付人员检查。

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

开放平台

喵街API

alibaba.mos.onsite.trade.query (新商场当面付交易查询)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ