淘宝开放平台

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
refund_param	RefundReq	必须			入参
└ agent_id Number 必须 12345 代理商id └ agent_order_id String 必须 234agbc 代理商订单号 └ apply_id Number 必须 13445 退票申请单号 └ charge_fee Number 可选 500 手续费(单位分) └ fail_code String 可选 sys-error 退票失败码 └ fail_reason String 可选不可退退票失败原因 └ refund_fee Number 可选 1000 应退额(单位分) └ status Boolean 必须 true 退票成功标志 └ tp_order_id Number 必须 124324 平台订单号

名称	类型	示例值	描述
result	ResultSet	result	接口返回对象
└ error_code String sys-error errorCode └ error_msg String 系统异常 errorMsg └ module Boolean true 接口成功/失败

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlitripRailTradeRefundRequest req = new AlitripRailTradeRefundRequest();
AlitripRailTradeRefundRequest.RefundReq obj1 = new AlitripRailTradeRefundRequest.RefundReq();
obj1.setAgentId(12345L);
obj1.setAgentOrderId("234agbc");
obj1.setApplyId(13445L);
obj1.setChargeFee(500L);
obj1.setFailCode("sys-error");
obj1.setFailReason("不可退");
obj1.setRefundFee(1000L);
obj1.setStatus(true);
obj1.setTpOrderId(124324L);
req.setRefundParam(obj1);
AlitripRailTradeRefundResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlitripRailTradeRefundRequest req = new AlitripRailTradeRefundRequest();
AlitripRailTradeRefundRequest.RefundReqDomain obj1 = new AlitripRailTradeRefundRequest.RefundReqDomain();
obj1.AgentId = 12345L;
obj1.AgentOrderId = "234agbc";
obj1.ApplyId = 13445L;
obj1.ChargeFee = 500L;
obj1.FailCode = "sys-error";
obj1.FailReason = "不可退";
obj1.RefundFee = 1000L;
obj1.Status = true;
obj1.TpOrderId = 124324L;
req.RefundParam_ = obj1;
AlitripRailTradeRefundResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlitripRailTradeRefundRequest;
$refund_param = new RefundReq;
$refund_param->agent_id="12345";
$refund_param->agent_order_id="234agbc";
$refund_param->apply_id="13445";
$refund_param->charge_fee="500";
$refund_param->fail_code="sys-error";
$refund_param->fail_reason="不可退";
$refund_param->refund_fee="1000";
$refund_param->status="true";
$refund_param->tp_order_id="124324";
$req->setRefundParam(json_encode($refund_param));
$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=alitrip.rail.trade.refund' \
-d 'partner_id=apidoc' \
-d 'session=b693f6ac-fca0-4f6e-a9fd-fe24bc52586b' \
-d 'sign=1B7328B65EF3DFF314389CF2422A4127' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-03-05+10%3A17%3A40' \
-d 'v=2.0' \
-d 'refund_param=null'

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

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

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

XML示例
JSON示例

<alitrip_rail_trade_refund_response>
    <result>
        <error_code>sys-error</error_code>
        <error_msg>系统异常</error_msg>
        <module>true</module>
    </result>
</alitrip_rail_trade_refund_response>

{
    "alitrip_rail_trade_refund_response":{
        "result":{
            "error_code":"sys-error",
            "error_msg":"系统异常",
            "module":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

alitrip.rail.trade.refund (退票接口)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ