淘宝开放平台 - 文档中心

请求地址：

环境	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_top_query_refund_req_d_t_o	TopQueryRefundReqDto	可选			查询退款渠道入参
└ out_refund_order_id String 可选 123 外部退款单号 └ refund_fee String 可选 123 退款金额 └ retail_refund_type String 可选 123 退款类型 └ store_id String 可选 123 门店id └ tid String 可选 123 合同编号 top_query_refund_details TopQueryRefundDetail [] 可选子订单信息 └ sub_trade_order_id String 可选 123 子订单号 └ tid String 可选 123 子合同编号 └ trade_order_id String 可选 123 主订单号

名称	类型	示例值	描述
result	ResultDo	1	返回结果
data TopQueryRefundRspDto true 是否成功 exception_refund_channel_list TopExceptionRefundChannelDto [] 1 异常退款渠道 └ code String 1 渠道code └ name String 1 渠道名称 └ main_order_refund Boolean 是否只能整单退 └ max_refund_fee String 1 最大可退金额 └ out_refund_order_id String 123456 外部退款单号 └ tid String 123456 淘宝交易订单号 top_post_bank_card_d_t_o TopPostBankCardDto 银行卡失效信息 └ bank_card_t0 Boolean 银行卡是否T+0 └ need_pos_bank_card Boolean 是否需要展示银行卡选项 top_refund_channel_d_t_o_s TopRefundChannelDto [] 1 退款渠道信息 └ device_id String 设备id └ instrument_no String 1 支付宝平台支付流水号 └ max_refund_fee String 100 最大可退金额 └ online Boolean 1 支付类型 └ paid_fee String 100 支付金额 └ pay_detail_id String 交款明细id └ pay_time String 缴款时间 └ pay_type String 支付方式 └ refund_channel_code String CASH 退款渠道编码 └ refund_channel_name String 现金退款渠道名称 └ refund_fee String 100 可退金额 top_refund_channel_detail_d_t_o_s TopRefundChannelDetailDto [] 1 退款渠道信息 └ amount String 1 退款金额 └ channel_code String 1 退款渠道编码 └ channel_desc String 1 退款渠道描述 └ code String 1 退款渠道组成编码 └ device_id String 123 设备id └ instrument_no String 1 支付宝平台支付流水号 └ pay_time String 123 支付时间 └ pay_type String 123 支付方式 └ status String 1 渠道退款状态 SUCCEEDED("SUCCEEDED", "成功"),FAILED("FAILED", "失败")，PROCESSING("PROCESSING", "处理中") └ total_refund_amount String 1 该渠道的退款总金额 └ voucher Boolean 1 是否是红包 └ trade_order_id String 123456 淘宝交易订单号 └ err_code String SYS_ERROR 错误编码 └ err_msg String 系统异常错误提示文案 └ success Boolean true 调用是否成功

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
TmallNrtOrderRefundQueryRequest req = new TmallNrtOrderRefundQueryRequest();
TmallNrtOrderRefundQueryRequest.TopQueryRefundReqDto obj1 = new TmallNrtOrderRefundQueryRequest.TopQueryRefundReqDto();
obj1.setOutRefundOrderId("123");
obj1.setRefundFee("123");
obj1.setRetailRefundType("123");
obj1.setStoreId("123");
obj1.setTid("123");
List<TmallNrtOrderRefundQueryRequest.TopQueryRefundDetail> list3 = new ArrayList<TmallNrtOrderRefundQueryRequest.TopQueryRefundDetail>();
TmallNrtOrderRefundQueryRequest.TopQueryRefundDetail obj4 = new TmallNrtOrderRefundQueryRequest.TopQueryRefundDetail();
list3.add(obj4);
obj4.setSubTradeOrderId("123");
obj4.setTid("123");
obj1.setTopQueryRefundDetails(list3);
obj1.setTradeOrderId("123");
req.setParamTopQueryRefundReqDTO(obj1);
TmallNrtOrderRefundQueryResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
TmallNrtOrderRefundQueryRequest req = new TmallNrtOrderRefundQueryRequest();
TmallNrtOrderRefundQueryRequest.TopQueryRefundReqDtoDomain obj1 = new TmallNrtOrderRefundQueryRequest.TopQueryRefundReqDtoDomain();
obj1.OutRefundOrderId = "123";
obj1.RefundFee = "123";
obj1.RetailRefundType = "123";
obj1.StoreId = "123";
obj1.Tid = "123";
List<TmallNrtOrderRefundQueryRequest.TopQueryRefundDetailDomain> list3 = new List<TmallNrtOrderRefundQueryRequest.TopQueryRefundDetailDomain>();
TmallNrtOrderRefundQueryRequest.TopQueryRefundDetailDomain obj4 = new TmallNrtOrderRefundQueryRequest.TopQueryRefundDetailDomain();
list3.Add(obj4);
obj4.SubTradeOrderId = "123";
obj4.Tid = "123";
obj1.TopQueryRefundDetails= list3;
obj1.TradeOrderId = "123";
req.ParamTopQueryRefundReqDTO_ = obj1;
TmallNrtOrderRefundQueryResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new TmallNrtOrderRefundQueryRequest;
$param_top_query_refund_req_d_t_o = new TopQueryRefundReqDto;
$param_top_query_refund_req_d_t_o->out_refund_order_id="123";
$param_top_query_refund_req_d_t_o->refund_fee="123";
$param_top_query_refund_req_d_t_o->retail_refund_type="123";
$param_top_query_refund_req_d_t_o->store_id="123";
$param_top_query_refund_req_d_t_o->tid="123";
$top_query_refund_details = new TopQueryRefundDetail;
$top_query_refund_details->sub_trade_order_id="123";
$top_query_refund_details->tid="123";
$param_top_query_refund_req_d_t_o->top_query_refund_details = $top_query_refund_details;
$param_top_query_refund_req_d_t_o->trade_order_id="123";
$req->setParamTopQueryRefundReqDTO(json_encode($param_top_query_refund_req_d_t_o));
$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=tmall.nrt.order.refund.query' \
-d 'partner_id=apidoc' \
-d 'session=de18c048-4e1a-40bf-9e6b-adaf90d511db' \
-d 'sign=BB285EE13E4CC952495928289D94BDD1' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-15+14%3A42%3A42' \
-d 'v=2.0' \
-d 'param_top_query_refund_req_d_t_o=null'

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

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

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

XML示例
JSON示例

<tmall_nrt_order_refund_query_response>
    <result>
        <data>
            <exception_refund_channel_list>
                <top_exception_refund_channel_dto>
                    <code>1</code>
                    <name>1</name>
                </top_exception_refund_channel_dto>
            </exception_refund_channel_list>
            <main_order_refund></main_order_refund>
            <max_refund_fee>1</max_refund_fee>
            <out_refund_order_id>123456</out_refund_order_id>
            <tid>123456</tid>
            <top_post_bank_card_d_t_o>
                <bank_card_t0></bank_card_t0>
                <need_pos_bank_card></need_pos_bank_card>
            </top_post_bank_card_d_t_o>
            <top_refund_channel_d_t_o_s>
                <top_refund_channel_dto>
                    <device_id></device_id>
                    <instrument_no>1</instrument_no>
                    <max_refund_fee>100</max_refund_fee>
                    <online>1</online>
                    <paid_fee>100</paid_fee>
                    <pay_detail_id></pay_detail_id>
                    <pay_time></pay_time>
                    <pay_type></pay_type>
                    <refund_channel_code>CASH</refund_channel_code>
                    <refund_channel_name>现金</refund_channel_name>
                    <refund_fee>100</refund_fee>
                    <top_refund_channel_detail_d_t_o_s>
                        <top_refund_channel_detail_dto>
                            <amount>1</amount>
                            <channel_code>1</channel_code>
                            <channel_desc>1</channel_desc>
                            <code>1</code>
                            <device_id>123</device_id>
                            <instrument_no>1</instrument_no>
                            <pay_time>123</pay_time>
                            <pay_type>123</pay_type>
                            <status>1</status>
                            <total_refund_amount>1</total_refund_amount>
                            <voucher>1</voucher>
                        </top_refund_channel_detail_dto>
                    </top_refund_channel_detail_d_t_o_s>
                </top_refund_channel_dto>
            </top_refund_channel_d_t_o_s>
            <trade_order_id>123456</trade_order_id>
        </data>
        <err_code>SYS_ERROR</err_code>
        <err_msg>系统异常</err_msg>
        <success>true</success>
    </result>
</tmall_nrt_order_refund_query_response>

{
    "tmall_nrt_order_refund_query_response":{
        "result":{
            "data":{
                "exception_refund_channel_list":{
                    "top_exception_refund_channel_dto":[
                        {
                            "code":"1",
                            "name":"1"
                        }
                    ]
                },
                "main_order_refund":,
                "max_refund_fee":"1",
                "out_refund_order_id":"123456",
                "tid":"123456",
                "top_post_bank_card_d_t_o":{
                    "bank_card_t0":,
                    "need_pos_bank_card":
                },
                "top_refund_channel_d_t_o_s":{
                    "top_refund_channel_dto":[
                        {
                            "device_id":"",
                            "instrument_no":"1",
                            "max_refund_fee":"100",
                            "online":1,
                            "paid_fee":"100",
                            "pay_detail_id":"",
                            "pay_time":"",
                            "pay_type":"",
                            "refund_channel_code":"CASH",
                            "refund_channel_name":"现金",
                            "refund_fee":"100",
                            "top_refund_channel_detail_d_t_o_s":{
                                "top_refund_channel_detail_dto":[
                                    {
                                        "amount":"1",
                                        "channel_code":"1",
                                        "channel_desc":"1",
                                        "code":"1",
                                        "device_id":"123",
                                        "instrument_no":"1",
                                        "pay_time":"123",
                                        "pay_type":"123",
                                        "status":"1",
                                        "total_refund_amount":"1",
                                        "voucher":1
                                    }
                                ]
                            }
                        }
                    ]
                },
                "trade_order_id":"123456"
            },
            "err_code":"SYS_ERROR",
            "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"
	}
}

错误码	错误描述	解决方案
A-APPLY-00-16-028-03	有退款中的退款单，不能再次申请退款CAN_NOT_ALLOW_APPLY_REFUND	需要先完成上一笔退款，才能发起下一笔

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

开放平台

零售终端API

tmall.nrt.order.refund.query (退款渠道查询)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ