淘宝开放平台 - 文档中心

请求地址：

环境	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_agree_refund_req_d_t_o	TopAgreeRefundReqDto	可选			逆向重试统一接口信息
└ change_refund_channel Boolean 可选 false 是不是替换退款渠道 └ dispute_id String 可选 1 退款单ID └ need_pos_bank_card_t0 Boolean 可选 false 是否需要银行卡T+0退款 └ operator_id String 可选 1 操作人Id └ operator_nick String 可选 1 操作人昵称 refund_channel_d_t_o_list TopRefundChannelDto [] 可选渠道信息 └ instrument_no String 可选 123 外部支付单号 └ max_refund_fee String 可选 1 最大可退款金额 └ online Boolean 可选 false 是否是线上支付 └ paid_fee String 可选 1 支付金额 └ refund_channel_code String 可选 1 退款通道编码 └ refund_channel_name String 可选 1 资金通道名称 └ refund_fee String 可选 1 请求退款金额 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 可选 1 支付时间 └ pay_type String 可选 1 支付类型 └ status String 可选 1 渠道退款状态 SUCCEEDED("SUCCEEDED", "成功"),FAILED("FAILED", "失败")，PROCESSING("PROCESSING", "处理中") └ total_refund_amount String 可选 1 该渠道的退款总金额 └ voucher Boolean 可选 false 是否是红包

名称	类型	示例值	描述
result	ResultDo	1	返回结果
data TopSubmitRefundRspDto true 是否成功 └ out_refund_order_id String 1 外部退款单号 └ refund_fee String 1 退款金额 └ refund_order_id String 1 退款单号 └ refund_time String 1 退款时间 result_channel_list TopRefundChannelDetailDto [] 1 退款渠道信息 └ amount String 1 退款金额 └ channel_code String 1 渠道编码 └ channel_desc String 1 渠道描述 └ code String 1 退款渠道组成编码 └ device_id String 1 设备号 └ instrument_no String 1 支付宝平台支付流水号 └ pay_time String 1 支付时间 └ pay_type String 1 支付类型 └ status String 1 渠道退款状态 SUCCEEDED("SUCCEEDED", "成功"),FAILED("FAILED", "失败")，PROCESSING("PROCESSING", "处理中") └ total_refund_amount String 1 该渠道的退款总金额 └ voucher Boolean 1 是否是红包 └ tid String 1 合同编号 └ trade_order_id String 1 主交易单号 └ err_code String 1 错误编码 └ err_msg String 1 错误描述 └ success Boolean true 调用是否成功

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
TmallNrtOrderRefundAgreeRequest req = new TmallNrtOrderRefundAgreeRequest();
TmallNrtOrderRefundAgreeRequest.TopAgreeRefundReqDto obj1 = new TmallNrtOrderRefundAgreeRequest.TopAgreeRefundReqDto();
obj1.setChangeRefundChannel(false);
obj1.setDisputeId("1");
obj1.setNeedPosBankCardT0(false);
obj1.setOperatorId("1");
obj1.setOperatorNick("1");
List<TmallNrtOrderRefundAgreeRequest.TopRefundChannelDto> list3 = new ArrayList<TmallNrtOrderRefundAgreeRequest.TopRefundChannelDto>();
TmallNrtOrderRefundAgreeRequest.TopRefundChannelDto obj4 = new TmallNrtOrderRefundAgreeRequest.TopRefundChannelDto();
list3.add(obj4);
obj4.setInstrumentNo("123");
obj4.setMaxRefundFee("1");
obj4.setOnline(false);
obj4.setPaidFee("1");
obj4.setRefundChannelCode("1");
obj4.setRefundChannelName("1");
obj4.setRefundFee("1");
List<TmallNrtOrderRefundAgreeRequest.TopRefundChannelDetailDto> list7 = new ArrayList<TmallNrtOrderRefundAgreeRequest.TopRefundChannelDetailDto>();
TmallNrtOrderRefundAgreeRequest.TopRefundChannelDetailDto obj8 = new TmallNrtOrderRefundAgreeRequest.TopRefundChannelDetailDto();
list7.add(obj8);
obj8.setAmount("1");
obj8.setChannelCode("1");
obj8.setChannelDesc("1");
obj8.setCode("1");
obj8.setDeviceId("123");
obj8.setInstrumentNo("1");
obj8.setPayTime("1");
obj8.setPayType("1");
obj8.setStatus("1");
obj8.setTotalRefundAmount("1");
obj8.setVoucher(false);
list5.setTopRefundChannelDetailDTOS(list7);
obj1.setRefundChannelDTOList(list3);
req.setParamTopAgreeRefundReqDTO(obj1);
TmallNrtOrderRefundAgreeResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
TmallNrtOrderRefundAgreeRequest req = new TmallNrtOrderRefundAgreeRequest();
TmallNrtOrderRefundAgreeRequest.TopAgreeRefundReqDtoDomain obj1 = new TmallNrtOrderRefundAgreeRequest.TopAgreeRefundReqDtoDomain();
obj1.ChangeRefundChannel = false;
obj1.DisputeId = "1";
obj1.NeedPosBankCardT0 = false;
obj1.OperatorId = "1";
obj1.OperatorNick = "1";
List<TmallNrtOrderRefundAgreeRequest.TopRefundChannelDtoDomain> list3 = new List<TmallNrtOrderRefundAgreeRequest.TopRefundChannelDtoDomain>();
TmallNrtOrderRefundAgreeRequest.TopRefundChannelDtoDomain obj4 = new TmallNrtOrderRefundAgreeRequest.TopRefundChannelDtoDomain();
list3.Add(obj4);
obj4.InstrumentNo = "123";
obj4.MaxRefundFee = "1";
obj4.Online = false;
obj4.PaidFee = "1";
obj4.RefundChannelCode = "1";
obj4.RefundChannelName = "1";
obj4.RefundFee = "1";
List<TmallNrtOrderRefundAgreeRequest.TopRefundChannelDetailDtoDomain> list6 = new List<TmallNrtOrderRefundAgreeRequest.TopRefundChannelDetailDtoDomain>();
TmallNrtOrderRefundAgreeRequest.TopRefundChannelDetailDtoDomain obj7 = new TmallNrtOrderRefundAgreeRequest.TopRefundChannelDetailDtoDomain();
list6.Add(obj7);
obj7.Amount = "1";
obj7.ChannelCode = "1";
obj7.ChannelDesc = "1";
obj7.Code = "1";
obj7.DeviceId = "123";
obj7.InstrumentNo = "1";
obj7.PayTime = "1";
obj7.PayType = "1";
obj7.Status = "1";
obj7.TotalRefundAmount = "1";
obj7.Voucher = false;
obj4.TopRefundChannelDetailDTOS= list6;
obj1.RefundChannelDTOList= list3;
req.ParamTopAgreeRefundReqDTO_ = obj1;
TmallNrtOrderRefundAgreeResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new TmallNrtOrderRefundAgreeRequest;
$param_top_agree_refund_req_d_t_o = new TopAgreeRefundReqDto;
$param_top_agree_refund_req_d_t_o->change_refund_channel="false";
$param_top_agree_refund_req_d_t_o->dispute_id="1";
$param_top_agree_refund_req_d_t_o->need_pos_bank_card_t0="false";
$param_top_agree_refund_req_d_t_o->operator_id="1";
$param_top_agree_refund_req_d_t_o->operator_nick="1";
$refund_channel_d_t_o_list = new TopRefundChannelDto;
$refund_channel_d_t_o_list->instrument_no="123";
$refund_channel_d_t_o_list->max_refund_fee="1";
$refund_channel_d_t_o_list->online="false";
$refund_channel_d_t_o_list->paid_fee="1";
$refund_channel_d_t_o_list->refund_channel_code="1";
$refund_channel_d_t_o_list->refund_channel_name="1";
$refund_channel_d_t_o_list->refund_fee="1";
$top_refund_channel_detail_d_t_o_s = new TopRefundChannelDetailDto;
$top_refund_channel_detail_d_t_o_s->amount="1";
$top_refund_channel_detail_d_t_o_s->channel_code="1";
$top_refund_channel_detail_d_t_o_s->channel_desc="1";
$top_refund_channel_detail_d_t_o_s->code="1";
$top_refund_channel_detail_d_t_o_s->device_id="123";
$top_refund_channel_detail_d_t_o_s->instrument_no="1";
$top_refund_channel_detail_d_t_o_s->pay_time="1";
$top_refund_channel_detail_d_t_o_s->pay_type="1";
$top_refund_channel_detail_d_t_o_s->status="1";
$top_refund_channel_detail_d_t_o_s->total_refund_amount="1";
$top_refund_channel_detail_d_t_o_s->voucher="false";
$refund_channel_d_t_o_list->top_refund_channel_detail_d_t_o_s = $top_refund_channel_detail_d_t_o_s;
$param_top_agree_refund_req_d_t_o->refund_channel_d_t_o_list = $refund_channel_d_t_o_list;
$req->setParamTopAgreeRefundReqDTO(json_encode($param_top_agree_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.agree' \
-d 'partner_id=apidoc' \
-d 'session=52c47c58-4a97-4b71-a59c-63cabc78735e' \
-d 'sign=314BCCB6D28112E1556A8AA255BB96F0' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-15+15%3A11%3A39' \
-d 'v=2.0' \
-d 'param_top_agree_refund_req_d_t_o=null'

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

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

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

XML示例
JSON示例

<tmall_nrt_order_refund_agree_response>
    <result>
        <data>
            <out_refund_order_id>1</out_refund_order_id>
            <refund_fee>1</refund_fee>
            <refund_order_id>1</refund_order_id>
            <refund_time>1</refund_time>
            <result_channel_list>
                <top_refund_channel_detail_dto>
                    <amount>1</amount>
                    <channel_code>1</channel_code>
                    <channel_desc>1</channel_desc>
                    <code>1</code>
                    <device_id>1</device_id>
                    <instrument_no>1</instrument_no>
                    <pay_time>1</pay_time>
                    <pay_type>1</pay_type>
                    <status>1</status>
                    <total_refund_amount>1</total_refund_amount>
                    <voucher>1</voucher>
                </top_refund_channel_detail_dto>
            </result_channel_list>
            <tid>1</tid>
            <trade_order_id>1</trade_order_id>
        </data>
        <err_code>1</err_code>
        <err_msg>1</err_msg>
        <success>true</success>
    </result>
</tmall_nrt_order_refund_agree_response>

{
    "tmall_nrt_order_refund_agree_response":{
        "result":{
            "data":{
                "out_refund_order_id":"1",
                "refund_fee":"1",
                "refund_order_id":"1",
                "refund_time":"1",
                "result_channel_list":{
                    "top_refund_channel_detail_dto":[
                        {
                            "amount":"1",
                            "channel_code":"1",
                            "channel_desc":"1",
                            "code":"1",
                            "device_id":"1",
                            "instrument_no":"1",
                            "pay_time":"1",
                            "pay_type":"1",
                            "status":"1",
                            "total_refund_amount":"1",
                            "voucher":1
                        }
                    ]
                },
                "tid":"1",
                "trade_order_id":"1"
            },
            "err_code":"1",
            "err_msg":"1",
            "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

tmall.nrt.order.refund.agree (同意退款请求)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ