淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
onsite_refund_request	OnsiteRefundRequest	必须			交易退款请求
└ extend_params String 可选 {"ADDRESS":"123"} 业务扩展参数，json格式 └ operator_id String 必须 12345678 商户操作员编号 └ out_request_no String 必须 HZ01RF001 商户退款请求号。标识一次退款请求，同一笔交易多次退款需要保证唯一 └ refund_amount Number 必须 8888 退款金额。需要退款的金额，该金额不能大于订单金额（同一笔交易多次退款时累计退款金额不能超过订单金额），单位为分 └ refund_reason String 必须正常退款退款的原因说明 └ mj_shop_id String 必须 hzoa 喵街商户号 └ store_id String 必须 12345678 商户门店编号。可以是喵街内的商户门店ID，也可以是商户系统内自己的门店ID，其取值的含义由store_id_type定义 └ store_id_type String 必须 miaojie 商户门店编号的类型。取值：miaojie和out。如果取值为miaojie，则store_id的取值为商户门店在喵街中的编号；如果取值为out，则store_id的取值为商户自己的编号 └ terminal_id String 必须 NJ_T_001 商户机具终端编号 └ order_no String 必须 222222 订单号。可能为外部订单号，也可能为喵街订单号 └ app_id String 可选 2018050860091003 appId。兼容老退款 └ refund_source byte 必须 4 退款来源.1：商家退款，2：用户主动退款，3：过期退款，4：线下POS退款

名称	类型	示例值	描述
result	ResultDo		交易退款响应
data RefundResponse true data └ trade_no String 2015120100222 喵街交易凭证号。必然返回 └ out_trade_no String 10001 原支付请求的商户订单号。必然返回 └ out_request_no String 10001 外部退款流水号 └ refund_status String SUCCESS 退款状态。FAIL退款失败，REFUNDING表示退款请求中，SUCCESS退款成功 └ buyer_alipay_id String 2088101117955611 买家在支付宝的用户id └ refund_amount Number 10000 总退款金额。单位为人民币（分） fund_bill_list FundBillDo [] alipay_financeaccount 退款资金渠道列表 └ 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 错误码 └ err_msg String 错误信息 └ success Boolean true success

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaMosOnsiteTradeRefundRequest req = new AlibabaMosOnsiteTradeRefundRequest();
AlibabaMosOnsiteTradeRefundRequest.OnsiteRefundRequest obj1 = new AlibabaMosOnsiteTradeRefundRequest.OnsiteRefundRequest();
obj1.setExtendParams("{\"ADDRESS\":\"123\"}");
obj1.setOperatorId("12345678");
obj1.setOutRequestNo("HZ01RF001");
obj1.setRefundAmount(8888L);
obj1.setRefundReason("正常退款");
obj1.setMjShopId("hzoa");
obj1.setStoreId("12345678");
obj1.setStoreIdType("miaojie");
obj1.setTerminalId("NJ_T_001");
obj1.setOrderNo("222222");
obj1.setAppId("2018050860091003");
obj1.setRefundSource("4");
req.setOnsiteRefundRequest(obj1);
AlibabaMosOnsiteTradeRefundResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaMosOnsiteTradeRefundRequest req = new AlibabaMosOnsiteTradeRefundRequest();
AlibabaMosOnsiteTradeRefundRequest.OnsiteRefundRequestDomain obj1 = new AlibabaMosOnsiteTradeRefundRequest.OnsiteRefundRequestDomain();
obj1.ExtendParams = "{\"ADDRESS\":\"123\"}";
obj1.OperatorId = "12345678";
obj1.OutRequestNo = "HZ01RF001";
obj1.RefundAmount = 8888L;
obj1.RefundReason = "正常退款";
obj1.MjShopId = "hzoa";
obj1.StoreId = "12345678";
obj1.StoreIdType = "miaojie";
obj1.TerminalId = "NJ_T_001";
obj1.OrderNo = "222222";
obj1.AppId = "2018050860091003";
obj1.RefundSource = "4";
req.OnsiteRefundRequest_ = obj1;
AlibabaMosOnsiteTradeRefundResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaMosOnsiteTradeRefundRequest;
$onsite_refund_request = new OnsiteRefundRequest;
$onsite_refund_request->extend_params="{\"ADDRESS\":\"123\"}";
$onsite_refund_request->operator_id="12345678";
$onsite_refund_request->out_request_no="HZ01RF001";
$onsite_refund_request->refund_amount="8888";
$onsite_refund_request->refund_reason="正常退款";
$onsite_refund_request->mj_shop_id="hzoa";
$onsite_refund_request->store_id="12345678";
$onsite_refund_request->store_id_type="miaojie";
$onsite_refund_request->terminal_id="NJ_T_001";
$onsite_refund_request->order_no="222222";
$onsite_refund_request->app_id="2018050860091003";
$onsite_refund_request->refund_source="4";
$req->setOnsiteRefundRequest(json_encode($onsite_refund_request));
$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.refund' \
-d 'partner_id=apidoc' \
-d 'session=db4d1a94-f5f6-4d7c-823e-ebc589da9461' \
-d 'sign=4FC8348032BA70A88FCC2AA5F7FD724D' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-06-04+12%3A53%3A17' \
-d 'v=2.0' \
-d 'onsite_refund_request=null'

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

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

req.onsite_refund_request=""
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.refund");
add_param(pRequest,"onsite_refund_request","数据结构JSON示例");
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.refund', {
	'onsite_refund_request':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_mos_onsite_trade_refund_response>
    <result>
        <data>
            <trade_no>2015120100222</trade_no>
            <out_trade_no>10001</out_trade_no>
            <out_request_no>10001</out_request_no>
            <refund_status>SUCCESS</refund_status>
            <buyer_alipay_id>2088101117955611</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_refund_response>

{
    "alibaba_mos_onsite_trade_refund_response":{
        "result":{
            "data":{
                "trade_no":"2015120100222",
                "out_trade_no":"10001",
                "out_request_no":"10001",
                "refund_status":"SUCCESS",
                "buyer_alipay_id":"2088101117955611",
                "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"
	}
}

错误码	错误描述	解决方案
isv.REFUND_INVALID_PARAMS	退款操作,传入无效参数	请与API核对请求参数内容
isv.REFUND_AMOUNT_INVALID	退款操作,传入退款金额不等于订单消费总额	在退款金额中输入订单总金额
isp.REFUND_NOT_ALLOWED_ERROR	订单状态不允许退款	请检查订单的状态
isp.REFUND_CREATE_FAILED	退款交易创建操作失败	请稍后再试
isp.EXISTS_REFUNDING_ORDER	存在在途订单	请稍后再尝试退款
isv.REFUND_FAILED_STORE_NOMATCH	退款操作失败,退款的门店与订单的门店不一致	请重新检查退款的订单的门店信息

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

开放平台

喵街API

alibaba.mos.onsite.trade.refund (退款)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ