淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	描述
cp_code	String	可选	1	cpcode
user_id	Number	可选	1	用户id
session_code	String	可选	1	session
is_bgx	Boolean	可选	true	是否包裹侠

名称	类型	示例值	描述
data	DeliveryWalletIndexDto	无	data
└ available_withdraw_desc String 每周二、周五为提现日提现文案 └ could_draw_money String 10 可提现金额 └ could_withdraw Boolean true 能否提现 funds_list FundsDto [] 无金额明细列表 └ amount String 2 金额 └ amount_desc String 2 金额描述 └ type String SEND 金额类型 └ type_desc String 寄件费金额类型描述 └ income String 2 收入 record_list WalletRecordDto [] recordList 记录列表 └ link_url String cainiao:// 链接地址 └ sub_txt String 驿站充值子文案 └ title String 充值名称 └ value String 20 值 └ icon_url String cainiao:// iconUrl └ link_txt String 连接文案，如【提现】 linkTxt └ type_code String MSG_CALL_COUNT("msg_call_count", "短信云呼卡", null), BALANCE_RECHARGE_STATION("balance_recharge_station", "充值余额", "驿站派件"), BALANCE_RECHARGE_CABINET("balance_recharge_cabinet", "充值余额", "自提柜派件"), BALANCE_INCOME_STATION("balance_income_station", "驿站揽件余额", null, "提现"); typeCode └ single_draw_money_limit String 5000 - 单笔提现限额单笔提现限额 └ today_income String 23 今日收入
status_code	String	2	参数返回码
status_message	String	1	返回信息
is_success	Boolean	false	是否成功

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
CainiaoYimaWalletIndexRequest req = new CainiaoYimaWalletIndexRequest();
req.setCpCode("1");
req.setUserId(1L);
req.setSessionCode("1");
req.setIsBgx(true);
CainiaoYimaWalletIndexResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
CainiaoYimaWalletIndexRequest req = new CainiaoYimaWalletIndexRequest();
req.CpCode = "1";
req.UserId = 1L;
req.SessionCode = "1";
req.IsBgx = true;
CainiaoYimaWalletIndexResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new CainiaoYimaWalletIndexRequest;
$req->setCpCode("1");
$req->setUserId("1");
$req->setSessionCode("1");
$req->setIsBgx("true");
$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.yima.wallet.index' \
-d 'partner_id=apidoc' \
-d 'sign=3667CEC0CCEBB9C3FEEE6046C92672D2' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-12+12%3A36%3A13' \
-d 'v=2.0' \
-d 'cp_code=1' \
-d 'is_bgx=true' \
-d 'session_code=1' \
-d 'user_id=1'

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

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

req.cp_code="1"
req.user_id=1
req.session_code="1"
req.is_bgx=true
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.yima.wallet.index");
add_param(pRequest,"cp_code","1");
add_param(pRequest,"user_id","1");
add_param(pRequest,"session_code","1");
add_param(pRequest,"is_bgx","true");
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.yima.wallet.index', {
	'cp_code':'1',
	'user_id':'1',
	'session_code':'1',
	'is_bgx':'true'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<cainiao_yima_wallet_index_response>
    <data>
        <available_withdraw_desc>每周二、周五为提现日</available_withdraw_desc>
        <could_draw_money>10</could_draw_money>
        <could_withdraw>true</could_withdraw>
        <funds_list>
            <funds_dto>
                <amount>2</amount>
                <amount_desc>2</amount_desc>
                <type>SEND</type>
                <type_desc>寄件费</type_desc>
            </funds_dto>
        </funds_list>
        <income>2</income>
        <record_list>
            <wallet_record_dto>
                <link_url>cainiao://</link_url>
                <sub_txt>驿站充值</sub_txt>
                <title>充值</title>
                <value>20</value>
                <icon_url>cainiao://</icon_url>
                <link_txt>连接文案，如【提现】</link_txt>
                <type_code>MSG_CALL_COUNT(&quot;msg_call_count&quot;, &quot;短信云呼卡&quot;, null),     BALANCE_RECHARGE_STATION(&quot;balance_recharge_station&quot;, &quot;充值余额&quot;, &quot;驿站派件&quot;),     BALANCE_RECHARGE_CABINET(&quot;balance_recharge_cabinet&quot;, &quot;充值余额&quot;, &quot;自提柜派件&quot;),     BALANCE_INCOME_STATION(&quot;balance_income_station&quot;, &quot;驿站揽件余额&quot;, null, &quot;提现&quot;);</type_code>
            </wallet_record_dto>
        </record_list>
        <single_draw_money_limit>5000 - 单笔提现限额</single_draw_money_limit>
        <today_income>23</today_income>
    </data>
    <status_code>2</status_code>
    <status_message>1</status_message>
    <is_success>false</is_success>
</cainiao_yima_wallet_index_response>

{
    "cainiao_yima_wallet_index_response":{
        "data":{
            "available_withdraw_desc":"每周二、周五为提现日",
            "could_draw_money":"10",
            "could_withdraw":true,
            "funds_list":{
                "funds_dto":[
                    {
                        "amount":"2",
                        "amount_desc":"2",
                        "type":"SEND",
                        "type_desc":"寄件费"
                    }
                ]
            },
            "income":"2",
            "record_list":{
                "wallet_record_dto":[
                    {
                        "link_url":"cainiao:\/\/",
                        "sub_txt":"驿站充值",
                        "title":"充值",
                        "value":"20",
                        "icon_url":"cainiao:\/\/",
                        "link_txt":"连接文案，如【提现】",
                        "type_code":"MSG_CALL_COUNT(\"msg_call_count\", \"短信云呼卡\", null),     BALANCE_RECHARGE_STATION(\"balance_recharge_station\", \"充值余额\", \"驿站派件\"),     BALANCE_RECHARGE_CABINET(\"balance_recharge_cabinet\", \"充值余额\", \"自提柜派件\"),     BALANCE_INCOME_STATION(\"balance_income_station\", \"驿站揽件余额\", null, \"提现\");"
                    }
                ]
            },
            "single_draw_money_limit":"5000 - 单笔提现限额",
            "today_income":"23"
        },
        "status_code":"2",
        "status_message":"1",
        "is_success":false
    }
}

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.yima.wallet.index (钱包首页接口)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ