淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
tp_request	DebtQueryRequest	必须			借据明细列表查询请求
└ encrypt_id_card String 必须 006a2bbe878b09935679a3c22eb8e2329c 身份标识 └ scene String 必须 VISIT 访问场景

名称	类型	示例值	描述
top_result	TopResult		topResult
└ success Boolean true 是否成功 └ result_code String SUCCESS 结果码 └ result_msg String 成功结果说明 data DebtCaseDto [] 响应结果 └ case_id String CASE_001 债务单据标识 └ original_institution_name String 招商银行初始机构名称 └ original_unified_credit_code String 123456789012345678 初始机构统一社会信用代码 └ current_institution_name String 招商银行当前机构名称 └ current_unified_credit_code String 123456789012345678 当前机构统一社会信用代码 └ outstanding_amount String 10000 应还金额，元 └ debt_amount String 10000 债务本金，元 └ principal_and_interest_amount String 12000 本息金额，元 └ penalty_interest_amount String 3000 罚息金额，元 └ debt_start_date String 2023-01-15 债务起始日 └ debt_due_date String 2024-01-15 债务还款日 └ annual_interest_rate String 0.08 年化利率，如: 0.08 └ interest_calculation_method String EQUAL_PRINCIPAL_AND_INTEREST 还款计息方式 └ overdue_days Number 30 逾期天数 └ has_relief_plan Boolean true 是否有纾困方案 relief_plan_details ReliefPlanDetailDto [] 纾困方案详情 └ plan_id String PLAN_001 方案ID └ plan_type Number 1 方案类型 plan_tags PlanTagDto [] 方案标签列表 └ title String 最省钱标签名 └ extra String {} 标签扩展字段JSON └ recommended Boolean true 是否推荐方案 └ outstanding_amount String 800 待还款金额，元 └ handling_fee String 200 手续费，元 └ discount_rate String 0.1 折扣比例 └ delay_days Number 60 延期期限 └ new_repay_date String 2025-12-31 新还款日 └ principal_reduction String 9000 本金减免，元 └ interest_reduction String 2000 利息减免，元 └ late_fee_reduction String 3000 滞纳金减免，元 └ down_payment_ratio String 0.1 首付比例 └ installment_count Number 6 分期期数 └ repayment_amount_per_installment String 180 单期还款金额，元 └ first_repayment_grace_days Number 8 首次还款宽限期 └ monthly_repayment_grace_days Number 3 每月还款宽限期 └ relief_plan_expiry_date String 2025-12-31 方案有效期 └ negotiable Boolean true 是否支持协商 └ case_status Number 1 纾困状态 └ out_user_id String 123456 外部用户ID └ app_id String 123456789 小程序APP ID └ relief_performance_status Number 1 纾困状态扩展

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AuctionZcReliefDebtQueryRequest req = new AuctionZcReliefDebtQueryRequest();
AuctionZcReliefDebtQueryRequest.DebtQueryRequest obj1 = new AuctionZcReliefDebtQueryRequest.DebtQueryRequest();
obj1.setEncryptIdCard("006a2bbe878b09935679a3c22eb8e2329c");
obj1.setScene("VISIT");
req.setTpRequest(obj1);
AuctionZcReliefDebtQueryResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AuctionZcReliefDebtQueryRequest req = new AuctionZcReliefDebtQueryRequest();
AuctionZcReliefDebtQueryRequest.DebtQueryRequestDomain obj1 = new AuctionZcReliefDebtQueryRequest.DebtQueryRequestDomain();
obj1.EncryptIdCard = "006a2bbe878b09935679a3c22eb8e2329c";
obj1.Scene = "VISIT";
req.TpRequest_ = obj1;
AuctionZcReliefDebtQueryResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AuctionZcReliefDebtQueryRequest;
$tp_request = new DebtQueryRequest;
$tp_request->encrypt_id_card="006a2bbe878b09935679a3c22eb8e2329c";
$tp_request->scene="VISIT";
$req->setTpRequest(json_encode($tp_request));
$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=taobao.auction.zc.relief.debt.query' \
-d 'partner_id=apidoc' \
-d 'sign=07B6561B6CAC86A744ACAF43933266AE' \
-d 'sign_method=hmac' \
-d 'timestamp=2026-09-19+01%3A25%3A05' \
-d 'v=2.0' \
-d 'tp_request=null'

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

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

req.tp_request=""
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,"taobao.auction.zc.relief.debt.query");
add_param(pRequest,"tp_request","数据结构JSON示例");
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',
	'url': 'http://gw.api.taobao.com/router/rest'
});

client.execute('taobao.auction.zc.relief.debt.query', {
	'tp_request':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<auction_zc_relief_debt_query_response>
    <top_result>
        <success>true</success>
        <result_code>SUCCESS</result_code>
        <result_msg>成功</result_msg>
        <data>
            <debt_case_dto>
                <case_id>CASE_001</case_id>
                <original_institution_name>招商银行</original_institution_name>
                <original_unified_credit_code>123456789012345678</original_unified_credit_code>
                <current_institution_name>招商银行</current_institution_name>
                <current_unified_credit_code>123456789012345678</current_unified_credit_code>
                <outstanding_amount>10000</outstanding_amount>
                <debt_amount>10000</debt_amount>
                <principal_and_interest_amount>12000</principal_and_interest_amount>
                <penalty_interest_amount>3000</penalty_interest_amount>
                <debt_start_date>2023-01-15</debt_start_date>
                <debt_due_date>2024-01-15</debt_due_date>
                <annual_interest_rate>0.08</annual_interest_rate>
                <interest_calculation_method>EQUAL_PRINCIPAL_AND_INTEREST</interest_calculation_method>
                <overdue_days>30</overdue_days>
                <has_relief_plan>true</has_relief_plan>
                <relief_plan_details>
                    <relief_plan_detail_dto>
                        <plan_id>PLAN_001</plan_id>
                        <plan_type>1</plan_type>
                        <plan_tags>
                            <plan_tag_dto>
                                <title>最省钱</title>
                                <extra>{}</extra>
                            </plan_tag_dto>
                        </plan_tags>
                        <recommended>true</recommended>
                        <outstanding_amount>800</outstanding_amount>
                        <handling_fee>200</handling_fee>
                        <discount_rate>0.1</discount_rate>
                        <delay_days>60</delay_days>
                        <new_repay_date>2025-12-31</new_repay_date>
                        <principal_reduction>9000</principal_reduction>
                        <interest_reduction>2000</interest_reduction>
                        <late_fee_reduction>3000</late_fee_reduction>
                        <down_payment_ratio>0.1</down_payment_ratio>
                        <installment_count>6</installment_count>
                        <repayment_amount_per_installment>180</repayment_amount_per_installment>
                        <first_repayment_grace_days>8</first_repayment_grace_days>
                        <monthly_repayment_grace_days>3</monthly_repayment_grace_days>
                    </relief_plan_detail_dto>
                </relief_plan_details>
                <relief_plan_expiry_date>2025-12-31</relief_plan_expiry_date>
                <negotiable>true</negotiable>
                <case_status>1</case_status>
                <out_user_id>123456</out_user_id>
                <app_id>123456789</app_id>
                <relief_performance_status>1</relief_performance_status>
            </debt_case_dto>
        </data>
    </top_result>
</auction_zc_relief_debt_query_response>

{
    "auction_zc_relief_debt_query_response":{
        "top_result":{
            "success":true,
            "result_code":"SUCCESS",
            "result_msg":"成功",
            "data":{
                "debt_case_dto":[
                    {
                        "case_id":"CASE_001",
                        "original_institution_name":"招商银行",
                        "original_unified_credit_code":"123456789012345678",
                        "current_institution_name":"招商银行",
                        "current_unified_credit_code":"123456789012345678",
                        "outstanding_amount":"10000",
                        "debt_amount":"10000",
                        "principal_and_interest_amount":"12000",
                        "penalty_interest_amount":"3000",
                        "debt_start_date":"2023-01-15",
                        "debt_due_date":"2024-01-15",
                        "annual_interest_rate":"0.08",
                        "interest_calculation_method":"EQUAL_PRINCIPAL_AND_INTEREST",
                        "overdue_days":30,
                        "has_relief_plan":true,
                        "relief_plan_details":{
                            "relief_plan_detail_dto":[
                                {
                                    "plan_id":"PLAN_001",
                                    "plan_type":1,
                                    "plan_tags":{
                                        "plan_tag_dto":[
                                            {
                                                "title":"最省钱",
                                                "extra":"{}"
                                            }
                                        ]
                                    },
                                    "recommended":true,
                                    "outstanding_amount":"800",
                                    "handling_fee":"200",
                                    "discount_rate":"0.1",
                                    "delay_days":60,
                                    "new_repay_date":"2025-12-31",
                                    "principal_reduction":"9000",
                                    "interest_reduction":"2000",
                                    "late_fee_reduction":"3000",
                                    "down_payment_ratio":"0.1",
                                    "installment_count":6,
                                    "repayment_amount_per_installment":"180",
                                    "first_repayment_grace_days":8,
                                    "monthly_repayment_grace_days":3
                                }
                            ]
                        },
                        "relief_plan_expiry_date":"2025-12-31",
                        "negotiable":true,
                        "case_status":1,
                        "out_user_id":"123456",
                        "app_id":"123456789",
                        "relief_performance_status":1
                    }
                ]
            }
        }
    }
}

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

taobao.auction.zc.relief.debt.query (借据明细列表查询)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ