淘宝开放平台

请求地址：

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

名称	类型	是否必须	示例值	描述
user_id	Number	必须	1234567890	用户登录账号id
biz_type	String	必须	70	接入业务type
sub_biz_type	String	必须	0	接入业务子类型
biz_name	String	必须	GuiZi	接入业务名称

名称	类型	示例值	描述
status_code	String	errorCode	错误code
data	WithHoldResponse	response	data
└ sign_no String 123456 签约号 └ url String www.cainiao.com 签约链接 └ signed Boolean false 是否已经签约
is_success	Boolean	true	调用是否成功
status_message	String	errorMsg	错误msg

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
CainiaoNbpaymentServiceChecksignedwithholdRequest req = new CainiaoNbpaymentServiceChecksignedwithholdRequest();
req.setUserId(1234567890L);
req.setBizType("70");
req.setSubBizType("0");
req.setBizName("GuiZi");
CainiaoNbpaymentServiceChecksignedwithholdResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
CainiaoNbpaymentServiceChecksignedwithholdRequest req = new CainiaoNbpaymentServiceChecksignedwithholdRequest();
req.UserId = 1234567890L;
req.BizType = "70";
req.SubBizType = "0";
req.BizName = "GuiZi";
CainiaoNbpaymentServiceChecksignedwithholdResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new CainiaoNbpaymentServiceChecksignedwithholdRequest;
$req->setUserId("1234567890");
$req->setBizType("70");
$req->setSubBizType("0");
$req->setBizName("GuiZi");
$resp = $c->execute($req);

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=cainiao.nbpayment.service.checksignedwithhold' \
-d 'partner_id=apidoc' \
-d 'sign=A8CFCB23D2991DA614BEA72C8F9875D3' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-25+15%3A53%3A11' \
-d 'v=2.0' \
-d 'biz_name=GuiZi' \
-d 'biz_type=70' \
-d 'sub_biz_type=0' \
-d 'user_id=1234567890'

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

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

req.user_id=1234567890
req.biz_type="70"
req.sub_biz_type="0"
req.biz_name="GuiZi"
try:
	resp= req.getResponse()
	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,"cainiao.nbpayment.service.checksignedwithhold");
add_param(pRequest,"user_id","1234567890");
add_param(pRequest,"biz_type","70");
add_param(pRequest,"sub_biz_type","0");
add_param(pRequest,"biz_name","GuiZi");
pResponse = top_execute(pClient,pRequest,NULL);
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('cainiao.nbpayment.service.checksignedwithhold', {
	'user_id':'1234567890',
	'biz_type':'70',
	'sub_biz_type':'0',
	'biz_name':'GuiZi'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<cainiao_nbpayment_service_checksignedwithhold_response>
    <status_code>errorCode</status_code>
    <data>
        <sign_no>123456</sign_no>
        <url>www.cainiao.com</url>
        <signed>false</signed>
    </data>
    <is_success>true</is_success>
    <status_message>errorMsg</status_message>
</cainiao_nbpayment_service_checksignedwithhold_response>

{
    "cainiao_nbpayment_service_checksignedwithhold_response":{
        "status_code":"errorCode",
        "data":{
            "sign_no":"123456",
            "url":"www.cainiao.com",
            "signed":false
        },
        "is_success":true,
        "status_message":"errorMsg"
    }
}

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

cainiao.nbpayment.service.checksignedwithhold (检查用户是否签约了代扣协议)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ