淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
param_onsite_refund_request	OnsiteRefundRequest	可选			Nan
└ buyer_id Number 可选 1 Nan └ extend_params String 可选 1 Nan └ operator_id String 可选 1 Nan └ out_request_no String 可选 1 Nan └ out_trade_no String 必须 1 Nan └ parent_seller_id Number 可选 1 Nan └ refund_amount Number 必须 1 Nan └ refund_no Number 必须 1 Nan └ refund_post_fee Number 可选 11 Nan └ refund_reason String 必须 1 Nan └ refund_source 可选 1 Nan └ seller_id Number 可选 1 Nan └ store_id String 可选 1 Nan └ store_id_type String 可选 1 Nan └ terminal_id String 可选 1 Nan └ trade_no String 必须 1 订单号

名称	类型	描述
result	ResultDo	result
data OnsiteRefundResponse true data └ attributes String 1 attributes └ buyer_id Number 1 buyerId └ buyer_nick String 1 buyerNick └ buyer_tb_id Number 1 buyerTbId └ fund_change String 1 fundChange └ gmt_refund_pay Date 1 gmtRefundPay └ ingots_amount Number 1 ingotsAmount └ ingots_price Number 1 ingotsPrice └ out_refund_id String 1 outRefundId └ out_trade_no String 1 outTradeNo └ refund_buy_promotion_fee Number 1 refundBuyPromotionFee └ refund_fee Number 1 refundFee └ refund_fund_fee Number 1 refundFundFee └ refund_m_j_subsidy_fee Number 1 refundMJSubsidyFee └ refund_no Number 1 refundNo └ refund_post_fee Number 1 refundPostFee └ refund_reason String 1 refundReason └ refund_source byte 1 refundSource └ refund_status Number 1 refundStatus └ refund_store_marketing_fee Number 1 refundStoreMarketingFee └ seller_refund_fee Number 1 sellerRefundFee └ send_back_fee Number 1 sendBackFee └ store_name String 1 storeName └ trade_no String 1 tradeNo └ err_code Number 1 errCode └ err_msg String 1 errMsg extra Extra extra └ empty Boolean true empty └ failed Boolean true failed result_code ResultCode resultCode └ err_code Number 1 errCode └ err_level Number 1 errLevel └ err_msg String 1 errMsg └ err_name String 1 errName └ err_tip String 1 errTip └ success Boolean true success └ success Boolean true success
result	ResultDo	result
data OnsiteRefundResponse true data └ attributes String 1 attributes └ buyer_id Number 1 buyerId └ buyer_nick String 1 buyerNick └ buyer_tb_id Number 1 buyerTbId └ fund_change String 1 fundChange └ gmt_refund_pay Date 1 gmtRefundPay └ ingots_amount Number 1 ingotsAmount └ ingots_price Number 1 ingotsPrice └ out_refund_id String 1 outRefundId └ out_trade_no String 1 outTradeNo └ refund_buy_promotion_fee Number 1 refundBuyPromotionFee └ refund_fee Number 1 refundFee └ refund_fund_fee Number 1 refundFundFee └ refund_m_j_subsidy_fee Number 1 refundMJSubsidyFee └ refund_no Number 1 refundNo └ refund_post_fee Number 1 refundPostFee └ refund_reason String 1 refundReason └ refund_source byte 1 refundSource └ refund_status Number 1 refundStatus └ refund_store_marketing_fee Number 1 refundStoreMarketingFee └ seller_refund_fee Number 1 sellerRefundFee └ send_back_fee Number 1 sendBackFee └ store_name String 1 storeName └ trade_no String 1 tradeNo └ err_code Number 1 errCode └ err_msg String 1 errMsg extra Extra extra └ empty Boolean true empty └ failed Boolean true failed result_code ResultCode resultCode └ err_code Number 1 errCode └ err_level Number 1 errLevel └ err_msg String 1 errMsg └ err_name String 1 errName └ err_tip String 1 errTip └ success Boolean true success └ success Boolean true success

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaMjXlifeWalletOrderRefundRequest req = new AlibabaMjXlifeWalletOrderRefundRequest();
AlibabaMjXlifeWalletOrderRefundRequest.OnsiteRefundRequest obj1 = new AlibabaMjXlifeWalletOrderRefundRequest.OnsiteRefundRequest();
obj1.setBuyerId(1L);
obj1.setExtendParams("1");
obj1.setOperatorId("1");
obj1.setOutRequestNo("1");
obj1.setOutTradeNo("1");
obj1.setParentSellerId(1L);
obj1.setRefundAmount(1L);
obj1.setRefundNo(1L);
obj1.setRefundPostFee(11L);
obj1.setRefundReason("1");
obj1.setSellerId(1L);
obj1.setStoreId("1");
obj1.setStoreIdType("1");
obj1.setTerminalId("1");
obj1.setTradeNo("1");
req.setParamOnsiteRefundRequest(obj1);
AlibabaMjXlifeWalletOrderRefundResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaMjXlifeWalletOrderRefundRequest req = new AlibabaMjXlifeWalletOrderRefundRequest();
AlibabaMjXlifeWalletOrderRefundRequest.OnsiteRefundRequestDomain obj1 = new AlibabaMjXlifeWalletOrderRefundRequest.OnsiteRefundRequestDomain();
obj1.BuyerId = 1L;
obj1.ExtendParams = "1";
obj1.OperatorId = "1";
obj1.OutRequestNo = "1";
obj1.OutTradeNo = "1";
obj1.ParentSellerId = 1L;
obj1.RefundAmount = 1L;
obj1.RefundNo = 1L;
obj1.RefundPostFee = 11L;
obj1.RefundReason = "1";
obj1.SellerId = 1L;
obj1.StoreId = "1";
obj1.StoreIdType = "1";
obj1.TerminalId = "1";
obj1.TradeNo = "1";
req.ParamOnsiteRefundRequest_ = obj1;
AlibabaMjXlifeWalletOrderRefundResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaMjXlifeWalletOrderRefundRequest;
$param_onsite_refund_request = new OnsiteRefundRequest;
$param_onsite_refund_request->buyer_id="1";
$param_onsite_refund_request->extend_params="1";
$param_onsite_refund_request->operator_id="1";
$param_onsite_refund_request->out_request_no="1";
$param_onsite_refund_request->out_trade_no="1";
$param_onsite_refund_request->parent_seller_id="1";
$param_onsite_refund_request->refund_amount="1";
$param_onsite_refund_request->refund_no="1";
$param_onsite_refund_request->refund_post_fee="11";
$param_onsite_refund_request->refund_reason="1";
$param_onsite_refund_request->seller_id="1";
$param_onsite_refund_request->store_id="1";
$param_onsite_refund_request->store_id_type="1";
$param_onsite_refund_request->terminal_id="1";
$param_onsite_refund_request->trade_no="1";
$req->setParamOnsiteRefundRequest(json_encode($param_onsite_refund_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=alibaba.mj.xlife.wallet.order.refund' \
-d 'partner_id=apidoc' \
-d 'sign=4AB57B54B6FE51FEC16251CF6544053D' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-06-04+12%3A03%3A54' \
-d 'v=2.0' \
-d 'param_onsite_refund_request=null'

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

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

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

XML示例
JSON示例

<alibaba_mj_xlife_wallet_order_refund_response>
    <result>
        <data>
            <attributes>1</attributes>
            <buyer_id>1</buyer_id>
            <buyer_nick>1</buyer_nick>
            <buyer_tb_id>1</buyer_tb_id>
            <fund_change>1</fund_change>
            <gmt_refund_pay>1</gmt_refund_pay>
            <ingots_amount>1</ingots_amount>
            <ingots_price>1</ingots_price>
            <out_refund_id>1</out_refund_id>
            <out_trade_no>1</out_trade_no>
            <refund_buy_promotion_fee>1</refund_buy_promotion_fee>
            <refund_fee>1</refund_fee>
            <refund_fund_fee>1</refund_fund_fee>
            <refund_m_j_subsidy_fee>1</refund_m_j_subsidy_fee>
            <refund_no>1</refund_no>
            <refund_post_fee>1</refund_post_fee>
            <refund_reason>1</refund_reason>
            <refund_source>1</refund_source>
            <refund_status>1</refund_status>
            <refund_store_marketing_fee>1</refund_store_marketing_fee>
            <seller_refund_fee>1</seller_refund_fee>
            <send_back_fee>1</send_back_fee>
            <store_name>1</store_name>
            <trade_no>1</trade_no>
        </data>
        <err_code>1</err_code>
        <err_msg>1</err_msg>
        <extra>
            <empty>true</empty>
        </extra>
        <failed>true</failed>
        <result_code>
            <err_code>1</err_code>
            <err_level>1</err_level>
            <err_msg>1</err_msg>
            <err_name>1</err_name>
            <err_tip>1</err_tip>
            <success>true</success>
        </result_code>
        <success>true</success>
    </result>
    <result>
        <data>
            <attributes>1</attributes>
            <buyer_id>1</buyer_id>
            <buyer_nick>1</buyer_nick>
            <buyer_tb_id>1</buyer_tb_id>
            <fund_change>1</fund_change>
            <gmt_refund_pay>1</gmt_refund_pay>
            <ingots_amount>1</ingots_amount>
            <ingots_price>1</ingots_price>
            <out_refund_id>1</out_refund_id>
            <out_trade_no>1</out_trade_no>
            <refund_buy_promotion_fee>1</refund_buy_promotion_fee>
            <refund_fee>1</refund_fee>
            <refund_fund_fee>1</refund_fund_fee>
            <refund_m_j_subsidy_fee>1</refund_m_j_subsidy_fee>
            <refund_no>1</refund_no>
            <refund_post_fee>1</refund_post_fee>
            <refund_reason>1</refund_reason>
            <refund_source>1</refund_source>
            <refund_status>1</refund_status>
            <refund_store_marketing_fee>1</refund_store_marketing_fee>
            <seller_refund_fee>1</seller_refund_fee>
            <send_back_fee>1</send_back_fee>
            <store_name>1</store_name>
            <trade_no>1</trade_no>
        </data>
        <err_code>1</err_code>
        <err_msg>1</err_msg>
        <extra>
            <empty>true</empty>
        </extra>
        <failed>true</failed>
        <result_code>
            <err_code>1</err_code>
            <err_level>1</err_level>
            <err_msg>1</err_msg>
            <err_name>1</err_name>
            <err_tip>1</err_tip>
            <success>true</success>
        </result_code>
        <success>true</success>
    </result>
</alibaba_mj_xlife_wallet_order_refund_response>

{
    "alibaba_mj_xlife_wallet_order_refund_response":{
        "result":{
            "data":{
                "attributes":"1",
                "buyer_id":1,
                "buyer_nick":"1",
                "buyer_tb_id":1,
                "fund_change":"1",
                "gmt_refund_pay":"1",
                "ingots_amount":1,
                "ingots_price":1,
                "out_refund_id":"1",
                "out_trade_no":"1",
                "refund_buy_promotion_fee":1,
                "refund_fee":1,
                "refund_fund_fee":1,
                "refund_m_j_subsidy_fee":1,
                "refund_no":1,
                "refund_post_fee":1,
                "refund_reason":"1",
                "refund_source":"1",
                "refund_status":1,
                "refund_store_marketing_fee":1,
                "seller_refund_fee":1,
                "send_back_fee":1,
                "store_name":"1",
                "trade_no":"1"
            },
            "err_code":1,
            "err_msg":"1",
            "extra":{
                "empty":true
            },
            "failed":true,
            "result_code":{
                "err_code":1,
                "err_level":1,
                "err_msg":"1",
                "err_name":"1",
                "err_tip":"1",
                "success":true
            },
            "success":true
        },
        "result":{
            "data":{
                "attributes":"1",
                "buyer_id":1,
                "buyer_nick":"1",
                "buyer_tb_id":1,
                "fund_change":"1",
                "gmt_refund_pay":"1",
                "ingots_amount":1,
                "ingots_price":1,
                "out_refund_id":"1",
                "out_trade_no":"1",
                "refund_buy_promotion_fee":1,
                "refund_fee":1,
                "refund_fund_fee":1,
                "refund_m_j_subsidy_fee":1,
                "refund_no":1,
                "refund_post_fee":1,
                "refund_reason":"1",
                "refund_source":"1",
                "refund_status":1,
                "refund_store_marketing_fee":1,
                "seller_refund_fee":1,
                "send_back_fee":1,
                "store_name":"1",
                "trade_no":"1"
            },
            "err_code":1,
            "err_msg":"1",
            "extra":{
                "empty":true
            },
            "failed":true,
            "result_code":{
                "err_code":1,
                "err_level":1,
                "err_msg":"1",
                "err_name":"1",
                "err_tip":"1",
                "success":true
            },
            "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.mj.xlife.wallet.order.refund (电子钱包退卡)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ