阿里安全开放平台-阿里聚安全

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
order_no	String	可选	222222		订单号。可能为外部订单号，也可能为喵街订单号
out_request_no	String	必须	HZ01RF001	最大长度：64	退款外部流水号

名称	类型	示例值	描述
result	ResultDo		result
data OnsiteRefundResponse true data └ trade_no String 2014112611001004680073956707 订单号 └ out_trade_no String 20150320010101001 外部订单号 └ out_request_no String 20150320010101001 外部退款流水号 └ refund_status String REFUND_PROCESSING 退款状态。FAIL退款失败，REFUNDING表示退款请求中，SUCCESS退款成功 └ buyer_alipay_id String buyerAlipayId └ refund_amount Number 10000 本次退款请求，对应的退款金额（分） fund_bill_list FundBillDo [] fundBillList └ amount Number 10000 金额。单位为人民币（分）。必然返回 └ extend_params String [{"abc":"123"}] 业务扩展参数，json格式 └ sub_fund_channel String 子资金渠道。必然返回。取值为支付宝红包：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，代表打款类型为支付宝（打款到商户的支付宝账号） └ auth_code_source String MJ 授权码来源。MJ：喵街，M_TAO：手淘，ALIPAY：支付宝 └ buyer_nick String 消费者喵街昵称 └ err_code Number errCode └ err_msg String errMsg └ success Boolean true success

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaMosOnsiteTradeQueryrefundRequest req = new AlibabaMosOnsiteTradeQueryrefundRequest();
req.setOrderNo("222222");
req.setOutRequestNo("HZ01RF001");
AlibabaMosOnsiteTradeQueryrefundResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaMosOnsiteTradeQueryrefundRequest req = new AlibabaMosOnsiteTradeQueryrefundRequest();
req.OrderNo = "222222";
req.OutRequestNo = "HZ01RF001";
AlibabaMosOnsiteTradeQueryrefundResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaMosOnsiteTradeQueryrefundRequest;
$req->setOrderNo("222222");
$req->setOutRequestNo("HZ01RF001");
$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.queryrefund' \
-d 'partner_id=apidoc' \
-d 'session=81b59400-594b-4bae-981e-d7f4fe177e96' \
-d 'sign=B554EEFFCF973A358D6F18A04ADF292E' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-23+17%3A14%3A35' \
-d 'v=2.0' \
-d 'order_no=222222' \
-d 'out_request_no=HZ01RF001'

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

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

req.order_no="222222"
req.out_request_no="HZ01RF001"
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.queryrefund");
add_param(pRequest,"order_no","222222");
add_param(pRequest,"out_request_no","HZ01RF001");
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.queryrefund', {
	'order_no':'222222',
	'out_request_no':'HZ01RF001'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_mos_onsite_trade_queryrefund_response>
    <result>
        <data>
            <trade_no>2014112611001004680073956707</trade_no>
            <out_trade_no>20150320010101001</out_trade_no>
            <out_request_no>20150320010101001</out_request_no>
            <refund_status>REFUND_PROCESSING</refund_status>
            <buyer_alipay_id></buyer_alipay_id>
            <refund_amount>10000</refund_amount>
            <fund_bill_list>
                <fund_bill_do>
                    <amount>10000</amount>
                    <extend_params>[{&quot;abc&quot;:&quot;123&quot;}]</extend_params>
                    <sub_fund_channel></sub_fund_channel>
                    <fund_channel>alipay</fund_channel>
                </fund_bill_do>
            </fund_bill_list>
            <auth_code_source>MJ</auth_code_source>
            <buyer_nick></buyer_nick>
        </data>
        <err_code></err_code>
        <err_msg></err_msg>
        <success>true</success>
    </result>
</alibaba_mos_onsite_trade_queryrefund_response>

{
    "alibaba_mos_onsite_trade_queryrefund_response":{
        "result":{
            "data":{
                "trade_no":"2014112611001004680073956707",
                "out_trade_no":"20150320010101001",
                "out_request_no":"20150320010101001",
                "refund_status":"REFUND_PROCESSING",
                "buyer_alipay_id":"",
                "refund_amount":10000,
                "fund_bill_list":{
                    "fund_bill_do":[
                        {
                            "amount":10000,
                            "extend_params":"[{\"abc\":\"123\"}]",
                            "sub_fund_channel":"",
                            "fund_channel":"alipay"
                        }
                    ]
                },
                "auth_code_source":"MJ",
                "buyer_nick":""
            },
            "err_code":,
            "err_msg":"",
            "success":true
        }
    }
}

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下载

喵街API

alibaba.mos.onsite.trade.queryrefund (退款查询)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ

用户导航

用户反馈

用户反馈

用户反馈