淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
alitrip_order_id	String	必须	1000000001		飞猪订单号
refund_account_in_details	RefundAccountInDetail []	可选		最大列表长度：20	分账退款明细
└ alipay_account String 可选 123456789 收款账户支付宝ID 必传 └ alipay_account_id String 可选 xx@126.com 收款装好支付宝账号，注意和上面的支付宝ID 要对应好 └ refund_amount Number 可选 50 分为单位;退多少钱 └ refund_batch_no String 可选 A_124 退款批次号须唯一
refund_amount	Number	必须	100		退款金额（单位分）票金额
refund_batch_no	String	必须	A_124		批次号必须唯一，同一批次号只能退款一次（多账号分润的该值填写refundAccountInDetails中批次号的任意一个即可
refund_reason	String	可选	退款原因		退款原因
insurance_refund_details	InsuranceRefundDetail []	可选		最大列表长度：999	保险退款详情
tvm_insurance_infos TvmInsuranceInfo [] 可选退保信息退保信息 └ insure_price Number 可选 1000 保险价格 └ product_no String 可选 1231231abc 保险产品码 └ insure_price Number 可选 100 保险退款总金额 └ rider_cert_number String 可选证件号乘客证件号 └ rider_cert_type String 可选 01 证件类型：01：身份证，02：护照，03：港澳通行证，04：台湾通行证，05：港澳往返内地通行证，06：台湾往返内地通行证，07：港澳居民居住证 └ rider_name String 可选张三乘客姓名

名称	类型	示例值	描述
result_code	String	9999	errorCode 错误码
result_msg	String	退款失败	errorMsg 错误信息
is_success	Boolean	是否成功	success true 成功 false 失败

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
BusTvmrefundorderSetRequest req = new BusTvmrefundorderSetRequest();
req.setAlitripOrderId("1000000001");
List<BusTvmrefundorderSetRequest.RefundAccountInDetail> list2 = new ArrayList<BusTvmrefundorderSetRequest.RefundAccountInDetail>();
BusTvmrefundorderSetRequest.RefundAccountInDetail obj3 = new BusTvmrefundorderSetRequest.RefundAccountInDetail();
list2.add(obj3);
obj3.setAlipayAccount("123456789");
obj3.setAlipayAccountId("xx@126.com");
obj3.setRefundAmount(50L);
obj3.setRefundBatchNo("A_124");
req.setRefundAccountInDetails(list2);
req.setRefundAmount(100L);
req.setRefundBatchNo("A_124");
req.setRefundReason("退款原因");
List<BusTvmrefundorderSetRequest.InsuranceRefundDetail> list5 = new ArrayList<BusTvmrefundorderSetRequest.InsuranceRefundDetail>();
BusTvmrefundorderSetRequest.InsuranceRefundDetail obj6 = new BusTvmrefundorderSetRequest.InsuranceRefundDetail();
list5.add(obj6);
List<BusTvmrefundorderSetRequest.TvmInsuranceInfo> list9 = new ArrayList<BusTvmrefundorderSetRequest.TvmInsuranceInfo>();
BusTvmrefundorderSetRequest.TvmInsuranceInfo obj10 = new BusTvmrefundorderSetRequest.TvmInsuranceInfo();
list9.add(obj10);
obj10.setInsurePrice(1000L);
obj10.setProductNo("1231231abc");
list7.setTvmInsuranceInfos(list9);
obj6.setInsurePrice(100L);
obj6.setRiderCertNumber("证件号");
obj6.setRiderCertType("01");
obj6.setRiderName("张三");
req.setInsuranceRefundDetails(list5);
BusTvmrefundorderSetResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
BusTvmrefundorderSetRequest req = new BusTvmrefundorderSetRequest();
req.AlitripOrderId = "1000000001";
List<BusTvmrefundorderSetRequest.RefundAccountInDetailDomain> list2 = new List<BusTvmrefundorderSetRequest.RefundAccountInDetailDomain>();
BusTvmrefundorderSetRequest.RefundAccountInDetailDomain obj3 = new BusTvmrefundorderSetRequest.RefundAccountInDetailDomain();
list2.Add(obj3);
obj3.AlipayAccount = "123456789";
obj3.AlipayAccountId = "xx@126.com";
obj3.RefundAmount = 50L;
obj3.RefundBatchNo = "A_124";
req.RefundAccountInDetails_ = list2;
req.RefundAmount = 100L;
req.RefundBatchNo = "A_124";
req.RefundReason = "退款原因";
List<BusTvmrefundorderSetRequest.InsuranceRefundDetailDomain> list5 = new List<BusTvmrefundorderSetRequest.InsuranceRefundDetailDomain>();
BusTvmrefundorderSetRequest.InsuranceRefundDetailDomain obj6 = new BusTvmrefundorderSetRequest.InsuranceRefundDetailDomain();
list5.Add(obj6);
List<BusTvmrefundorderSetRequest.TvmInsuranceInfoDomain> list8 = new List<BusTvmrefundorderSetRequest.TvmInsuranceInfoDomain>();
BusTvmrefundorderSetRequest.TvmInsuranceInfoDomain obj9 = new BusTvmrefundorderSetRequest.TvmInsuranceInfoDomain();
list8.Add(obj9);
obj9.InsurePrice = 1000L;
obj9.ProductNo = "1231231abc";
obj6.TvmInsuranceInfos= list8;
obj6.InsurePrice = 100L;
obj6.RiderCertNumber = "证件号";
obj6.RiderCertType = "01";
obj6.RiderName = "张三";
req.InsuranceRefundDetails_ = list5;
BusTvmrefundorderSetResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new BusTvmrefundorderSetRequest;
$req->setAlitripOrderId("1000000001");
$refund_account_in_details = new RefundAccountInDetail;
$refund_account_in_details->alipay_account="123456789";
$refund_account_in_details->alipay_account_id="xx@126.com";
$refund_account_in_details->refund_amount="50";
$refund_account_in_details->refund_batch_no="A_124";
$req->setRefundAccountInDetails(json_encode($refund_account_in_details));
$req->setRefundAmount("100");
$req->setRefundBatchNo("A_124");
$req->setRefundReason("退款原因");
$insurance_refund_details = new InsuranceRefundDetail;
$tvm_insurance_infos = new TvmInsuranceInfo;
$tvm_insurance_infos->insure_price="1000";
$tvm_insurance_infos->product_no="1231231abc";
$insurance_refund_details->tvm_insurance_infos = $tvm_insurance_infos;
$insurance_refund_details->insure_price="100";
$insurance_refund_details->rider_cert_number="证件号";
$insurance_refund_details->rider_cert_type="01";
$insurance_refund_details->rider_name="张三";
$req->setInsuranceRefundDetails(json_encode($insurance_refund_details));
$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=taobao.bus.tvmrefundorder.set' \
-d 'partner_id=apidoc' \
-d 'session=c22d1001-f920-442e-8ce0-58127ebb24ae' \
-d 'sign=BC694AB144E0AB55466BD25E50378795' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-27+22%3A13%3A01' \
-d 'v=2.0' \
-d 'alitrip_order_id=1000000001' \
-d 'insurance_refund_details=%E4%BF%9D%E9%99%A9%E9%80%80%E6%AC%BE%E8%AF%A6%E6%83%85' \
-d 'refund_account_in_details=null' \
-d 'refund_amount=100' \
-d 'refund_batch_no=A_124' \
-d 'refund_reason=%E9%80%80%E6%AC%BE%E5%8E%9F%E5%9B%A0'

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

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

req.alitrip_order_id="1000000001"
req.refund_account_in_details=""
req.refund_amount=100
req.refund_batch_no="A_124"
req.refund_reason="退款原因"
req.insurance_refund_details="保险退款详情"
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,"taobao.bus.tvmrefundorder.set");
add_param(pRequest,"alitrip_order_id","1000000001");
add_param(pRequest,"refund_account_in_details","数据结构JSON示例");
add_param(pRequest,"refund_amount","100");
add_param(pRequest,"refund_batch_no","A_124");
add_param(pRequest,"refund_reason","退款原因");
add_param(pRequest,"insurance_refund_details","数据结构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('taobao.bus.tvmrefundorder.set', {
	'alitrip_order_id':'1000000001',
	'refund_account_in_details':'数据结构JSON示例',
	'refund_amount':'100',
	'refund_batch_no':'A_124',
	'refund_reason':'退款原因',
	'insurance_refund_details':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<bus_tvmrefundorder_set_response>
    <result_code>9999</result_code>
    <result_msg>退款失败</result_msg>
    <is_success>是否成功</is_success>
</bus_tvmrefundorder_set_response>

{
    "bus_tvmrefundorder_set_response":{
        "result_code":"9999",
        "result_msg":"退款失败",
        "is_success":是否成功
    }
}

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

开放平台

综合交通-商家对接

taobao.bus.tvmrefundorder.set (线下自助机逆向退款接口)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ