淘宝开放平台

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
customer_help_charge_request	CustomerHelpChargeRequest	必须			淘客请求入参
└ payer_alipay_id String 必须 223333 付款人支付宝账号ID └ payee_account_no String 必须 tb_334555 收款人淘宝账号 sign_data SignData 必须签名 └ partner_uid String 必须 45645 签名被授予方的支付宝账号。当前场景为淘宝业务平台的支付宝uid └ ori_char_set String 必须 UTF-8 淘客平台签名编码。大小写敏感， UTF-8 └ ori_sign_type String 必须 RSA2 淘客平台签名算法。大小写敏感，如 RSA2 └ ori_sign String 必须 653fhfjt5566gtttt 淘客平台用私钥签名的密文 └ ori_app_id String 必须 334556 淘客平台的签名应用ID └ ori_out_biz_no String 必须 2314425545 淘客平台签名订单号 └ charge_amt Number 必须 100 充值金额（分） └ out_order_no String 必须 234555 外部订单号 └ order_source String 必须 xixi 外部订单来源 └ extension String 可选扩展属性一般不填，会被过滤掉

名称	类型	示例值	描述
result	Result	{}	接口返回结果
data CustomerHelpChargeResp 1234 返回的结果数据 └ order_source String 1 订单来源 └ out_order_no String 1 外部订单号 └ order_id Number 1 淘宝订单id └ comment String "" 订单备注 └ ali_pay_order_id String "20210827110070001506580045681664" 支付宝订单id └ order_status String SUCCESS 订单状态 └ error_code String "isv.invalid-parameter" 错误码 └ success Boolean false 是否成功 └ error_msg String "参数错误" 错误信息

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
GrandetCustomerHelpChargeRequest req = new GrandetCustomerHelpChargeRequest();
GrandetCustomerHelpChargeRequest.CustomerHelpChargeRequest obj1 = new GrandetCustomerHelpChargeRequest.CustomerHelpChargeRequest();
obj1.setPayerAlipayId("223333");
obj1.setPayeeAccountNo("tb_334555");
GrandetCustomerHelpChargeRequest.SignData obj2 = new GrandetCustomerHelpChargeRequest.SignData();
obj2.setPartnerUid("45645");
obj2.setOriCharSet("UTF-8");
obj2.setOriSignType("RSA2");
obj2.setOriSign("653fhfjt5566gtttt");
obj2.setOriAppId("334556");
obj2.setOriOutBizNo("2314425545");
obj1.setSignData(obj2);
obj1.setChargeAmt(100L);
obj1.setOutOrderNo("234555");
obj1.setOrderSource("xixi");
obj1.setExtension("扩展属性");
req.setCustomerHelpChargeRequest(obj1);
GrandetCustomerHelpChargeResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
GrandetCustomerHelpChargeRequest req = new GrandetCustomerHelpChargeRequest();
GrandetCustomerHelpChargeRequest.CustomerHelpChargeRequestDomain obj1 = new GrandetCustomerHelpChargeRequest.CustomerHelpChargeRequestDomain();
obj1.PayerAlipayId = "223333";
obj1.PayeeAccountNo = "tb_334555";
GrandetCustomerHelpChargeRequest.SignDataDomain obj2 = new GrandetCustomerHelpChargeRequest.SignDataDomain();
obj2.PartnerUid = "45645";
obj2.OriCharSet = "UTF-8";
obj2.OriSignType = "RSA2";
obj2.OriSign = "653fhfjt5566gtttt";
obj2.OriAppId = "334556";
obj2.OriOutBizNo = "2314425545";
obj1.SignData= obj2;
obj1.ChargeAmt = 100L;
obj1.OutOrderNo = "234555";
obj1.OrderSource = "xixi";
obj1.Extension = "扩展属性";
req.CustomerHelpChargeRequest_ = obj1;
GrandetCustomerHelpChargeResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new GrandetCustomerHelpChargeRequest;
$customer_help_charge_request = new CustomerHelpChargeRequest;
$customer_help_charge_request->payer_alipay_id="223333";
$customer_help_charge_request->payee_account_no="tb_334555";
$sign_data = new SignData;
$sign_data->partner_uid="45645";
$sign_data->ori_char_set="UTF-8";
$sign_data->ori_sign_type="RSA2";
$sign_data->ori_sign="653fhfjt5566gtttt";
$sign_data->ori_app_id="334556";
$sign_data->ori_out_biz_no="2314425545";
$customer_help_charge_request->sign_data = $sign_data;
$customer_help_charge_request->charge_amt="100";
$customer_help_charge_request->out_order_no="234555";
$customer_help_charge_request->order_source="xixi";
$customer_help_charge_request->extension="扩展属性";
$req->setCustomerHelpChargeRequest(json_encode($customer_help_charge_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.grandet.customer.help.charge' \
-d 'partner_id=apidoc' \
-d 'sign=8F58902B9FC0E7EF73DAE623785EEA02' \
-d 'sign_method=hmac' \
-d 'timestamp=2024-05-07+09%3A21%3A23' \
-d 'v=2.0' \
-d 'customer_help_charge_request=null'

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

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

req.customer_help_charge_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.grandet.customer.help.charge");
add_param(pRequest,"customer_help_charge_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',
	'REST_URL': 'http://gw.api.taobao.com/router/rest'
});

client.execute('taobao.grandet.customer.help.charge', {
	'customer_help_charge_request':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<grandet_customer_help_charge_response>
    <result>
        <data>
            <order_source>1</order_source>
            <out_order_no>1</out_order_no>
            <order_id>1</order_id>
            <comment>&quot;&quot;</comment>
            <ali_pay_order_id>&quot;20210827110070001506580045681664&quot;</ali_pay_order_id>
            <order_status>SUCCESS</order_status>
        </data>
        <error_code>&quot;isv.invalid-parameter&quot;</error_code>
        <success>false</success>
        <error_msg>&quot;参数错误&quot;</error_msg>
    </result>
</grandet_customer_help_charge_response>

{
    "grandet_customer_help_charge_response":{
        "result":{
            "data":{
                "order_source":"1",
                "out_order_no":"1",
                "order_id":1,
                "comment":"\"\"",
                "ali_pay_order_id":"\"20210827110070001506580045681664\"",
                "order_status":"SUCCESS"
            },
            "error_code":"\"isv.invalid-parameter\"",
            "success":false,
            "error_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

taobao.grandet.customer.help.charge (淘客帮充淘宝零钱接口)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ