淘宝开放平台

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
req	CreatSettleEventShortOutReq	必须			请求参数
└ src_alipay_id String 必须 2088021729346862 支付宝pid └ src_alipay_email String 可选 jzxls001qianliu@alitest.xyz 支付宝邮箱 └ src_store_id Number 必须 123456 被扣佣的卖场或摊位id └ pay_store_id Number 必须 123456 线下发生交易时的摊位id └ biz_order_id Number 必须 2619443881620499220 天猫交易主订单号 └ pay_detail_id Number 必须 6000000499305606 支付明细单号 └ amount Number 必须 1 扣取金额，单位分 └ desc String 可选描述内容描述 └ scene String 必须 DOORVERS_MC_COMMISSION 扣费场景 └ tp_out_id String 必须 654321 外部正向结算唯一id

名称	类型	示例值	描述
result	ResultDo		返回结果
data CreatSettleEventShortOutResp 接口返回model └ out_biz_id String A_B 天猫唯一标识 └ create_date String 202310 创建月份 └ src_alipay_id String 2088021729346862 支付宝pid └ src_store_id Number 1087414062 被扣款的卖场或摊位id └ pay_store_id Number 1087413097 线下发生交易时的摊位id └ biz_order_id Number 3557324054002646321 天猫交易订单号 └ pay_detail_id Number 6000000527362256 交易明细单号 └ amount Number 1 扣取金额，单位分 └ desc String 描述 desc └ scene String DOORVERS_MC_COMMISSION 扣费场景 └ tp_out_id String 123 外部正向分成唯一id └ reason String 原因汇金受理失败原因 └ status Number 2 分账单状态，受理成功2，受理失败 └ accept_time Date 1696848170791 受理时间 └ err_code String error 错误码 └ success Boolean true 是否成功 └ err_msg String 接口异常错误描述

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
TmallNrtSettleEventCreatRequest req = new TmallNrtSettleEventCreatRequest();
TmallNrtSettleEventCreatRequest.CreatSettleEventShortOutReq obj1 = new TmallNrtSettleEventCreatRequest.CreatSettleEventShortOutReq();
obj1.setSrcAlipayId("2088021729346862");
obj1.setSrcAlipayEmail("jzxls001qianliu@alitest.xyz");
obj1.setSrcStoreId(123456L);
obj1.setPayStoreId(123456L);
obj1.setBizOrderId(2619443881620499220L);
obj1.setPayDetailId(6000000499305606L);
obj1.setAmount(1L);
obj1.setDesc("描述内容");
obj1.setScene("DOORVERS_MC_COMMISSION");
obj1.setTpOutId("654321");
req.setReq(obj1);
TmallNrtSettleEventCreatResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
TmallNrtSettleEventCreatRequest req = new TmallNrtSettleEventCreatRequest();
TmallNrtSettleEventCreatRequest.CreatSettleEventShortOutReqDomain obj1 = new TmallNrtSettleEventCreatRequest.CreatSettleEventShortOutReqDomain();
obj1.SrcAlipayId = "2088021729346862";
obj1.SrcAlipayEmail = "jzxls001qianliu@alitest.xyz";
obj1.SrcStoreId = 123456L;
obj1.PayStoreId = 123456L;
obj1.BizOrderId = 2619443881620499220L;
obj1.PayDetailId = 6000000499305606L;
obj1.Amount = 1L;
obj1.Desc = "描述内容";
obj1.Scene = "DOORVERS_MC_COMMISSION";
obj1.TpOutId = "654321";
req.Req_ = obj1;
TmallNrtSettleEventCreatResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new TmallNrtSettleEventCreatRequest;
$req = new CreatSettleEventShortOutReq;
$req->src_alipay_id="2088021729346862";
$req->src_alipay_email="jzxls001qianliu@alitest.xyz";
$req->src_store_id="123456";
$req->pay_store_id="123456";
$req->biz_order_id="2619443881620499220";
$req->pay_detail_id="6000000499305606";
$req->amount="1";
$req->desc="描述内容";
$req->scene="DOORVERS_MC_COMMISSION";
$req->tp_out_id="654321";
$req->setReq(json_encode($req));
$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.settle.event.creat' \
-d 'partner_id=apidoc' \
-d 'session=78f9b3ef-492b-4559-bdfc-ce785e7ea5ff' \
-d 'sign=E65BFFCF45268EBF430B0659710432F8' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-22+16%3A27%3A33' \
-d 'v=2.0' \
-d 'req=null'

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

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

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

XML示例
JSON示例

<tmall_nrt_settle_event_creat_response>
    <result>
        <data>
            <out_biz_id>A_B</out_biz_id>
            <create_date>202310</create_date>
            <src_alipay_id>2088021729346862</src_alipay_id>
            <src_store_id>1087414062</src_store_id>
            <pay_store_id>1087413097</pay_store_id>
            <biz_order_id>3557324054002646321</biz_order_id>
            <pay_detail_id>6000000527362256</pay_detail_id>
            <amount>1</amount>
            <desc>描述</desc>
            <scene>DOORVERS_MC_COMMISSION</scene>
            <tp_out_id>123</tp_out_id>
            <reason>原因</reason>
            <status>2</status>
            <accept_time>1696848170791</accept_time>
        </data>
        <err_code>error</err_code>
        <success>true</success>
        <err_msg>接口异常</err_msg>
    </result>
</tmall_nrt_settle_event_creat_response>

{
    "tmall_nrt_settle_event_creat_response":{
        "result":{
            "data":{
                "out_biz_id":"A_B",
                "create_date":"202310",
                "src_alipay_id":"2088021729346862",
                "src_store_id":1087414062,
                "pay_store_id":1087413097,
                "biz_order_id":3557324054002646321,
                "pay_detail_id":6000000527362256,
                "amount":1,
                "desc":"描述",
                "scene":"DOORVERS_MC_COMMISSION",
                "tp_out_id":"123",
                "reason":"原因",
                "status":2,
                "accept_time":"1696848170791"
            },
            "err_code":"error",
            "success":true,
            "err_msg":"接口异常"
        }
    }
}

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.settle.event.creat (创建正向结算请求)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ