淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
param_uncharge_open_req	UnchargeOpenReq	必须			入参
└ brand_id String 可选 1234532 SaaS品牌ID(不能和outbrandid同时为空) └ card_id String 可选 213142351341234 卡号 └ operator_id String 必须 232353534 操作人ID(SaaS Id） └ outer_order_id String 必须 43426234265234 退储值订单Id，必填（kry是paymentItemId）,外部保证唯一，作为退款幂等号 └ remark String 可选接口红腹锦鸡等备注 └ shop_id String 可选 3432757445 SaaS门店ID(不能和outshopid同时为空) └ src_outer_order_id String 必须 786237558237459862 原充值订单Id，必填（kry是srcPaymentItemId） └ out_shop_id String 可选 1231 外部门店ID(不能和sopid同时为空) └ out_brand_id String 可选 3213 外部品牌ID(不能和brandid同时为空) └ request_id String 必须 hjj3b23b4b2b 请求id，幂等 └ biz_channel String 必须 CS CS是辰森，KRY是客如云 └ src_out_pay_id String 可选 3223 原支付单号

名称	类型	示例值	描述
result	CommonResult		接口结果
└ biz_success Boolean true 成功状态 result RechargeAccountFlowDetailOpenInfo null 返回结果 └ account_id String 782364726 储值账户id affected_property_list RechargeAccountPropertyOpenInfo [] null 操作储值资产信息列表 └ type String REAL 账户类型 └ value Number 2000 账户值 after_property_list RechargeAccountPropertyOpenInfo [] null 操作后储值资产信息列表 └ type String GIFT 账户类型 └ value Number 100 账户值 before_property_list RechargeAccountPropertyOpenInfo [] null 操作前储值资产信息列表 └ type String PRE 账户类型 └ value Number 200 账户值 └ brand_id String 452342344 品牌Id └ current_value Number 3000 交易后剩余总金额 ext_info Extinfo null 扩展信息 └ empty Boolean null null └ flow_id String 4634523433434 储值账户流水id └ flow_type String UNCHARGE 储值相关的交易类型 └ operator String 12532424123 操作人ID └ operator_name String 小明操作人 └ order_src Number 1 外部订单来源 └ order_time Date 2019-04-05 12:13:14 交易时间 └ order_value Number -6372 交易总金额，增加为正数，减少为负数 └ outer_order_id String 786238748723469826348 外部交易单号id └ remark String 哈就睡得好备注 └ shop_id String 8723876 交易门店ID └ shop_name String 花花小吃交易门店名称 └ result_code String 200 结果码 └ result_desc String 成功结果描述 └ result_view String "" 错误结果显示

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaAlscCrmRechargeUnchargeUpdateRequest req = new AlibabaAlscCrmRechargeUnchargeUpdateRequest();
AlibabaAlscCrmRechargeUnchargeUpdateRequest.UnchargeOpenReq obj1 = new AlibabaAlscCrmRechargeUnchargeUpdateRequest.UnchargeOpenReq();
obj1.setBrandId("1234532");
obj1.setCardId("213142351341234");
obj1.setOperatorId("232353534");
obj1.setOuterOrderId("43426234265234");
obj1.setRemark("接口红腹锦鸡等");
obj1.setShopId("3432757445");
obj1.setSrcOuterOrderId("786237558237459862");
obj1.setOutShopId("1231");
obj1.setOutBrandId("3213");
obj1.setRequestId("hjj3b23b4b2b");
obj1.setBizChannel("CS");
obj1.setSrcOutPayId("3223");
req.setParamUnchargeOpenReq(obj1);
AlibabaAlscCrmRechargeUnchargeUpdateResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaAlscCrmRechargeUnchargeUpdateRequest req = new AlibabaAlscCrmRechargeUnchargeUpdateRequest();
AlibabaAlscCrmRechargeUnchargeUpdateRequest.UnchargeOpenReqDomain obj1 = new AlibabaAlscCrmRechargeUnchargeUpdateRequest.UnchargeOpenReqDomain();
obj1.BrandId = "1234532";
obj1.CardId = "213142351341234";
obj1.OperatorId = "232353534";
obj1.OuterOrderId = "43426234265234";
obj1.Remark = "接口红腹锦鸡等";
obj1.ShopId = "3432757445";
obj1.SrcOuterOrderId = "786237558237459862";
obj1.OutShopId = "1231";
obj1.OutBrandId = "3213";
obj1.RequestId = "hjj3b23b4b2b";
obj1.BizChannel = "CS";
obj1.SrcOutPayId = "3223";
req.ParamUnchargeOpenReq_ = obj1;
AlibabaAlscCrmRechargeUnchargeUpdateResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaAlscCrmRechargeUnchargeUpdateRequest;
$param_uncharge_open_req = new UnchargeOpenReq;
$param_uncharge_open_req->brand_id="1234532";
$param_uncharge_open_req->card_id="213142351341234";
$param_uncharge_open_req->operator_id="232353534";
$param_uncharge_open_req->outer_order_id="43426234265234";
$param_uncharge_open_req->remark="接口红腹锦鸡等";
$param_uncharge_open_req->shop_id="3432757445";
$param_uncharge_open_req->src_outer_order_id="786237558237459862";
$param_uncharge_open_req->out_shop_id="1231";
$param_uncharge_open_req->out_brand_id="3213";
$param_uncharge_open_req->request_id="hjj3b23b4b2b";
$param_uncharge_open_req->biz_channel="CS";
$param_uncharge_open_req->src_out_pay_id="3223";
$req->setParamUnchargeOpenReq(json_encode($param_uncharge_open_req));
$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=alibaba.alsc.crm.recharge.uncharge.update' \
-d 'partner_id=apidoc' \
-d 'sign=EAB17AC9BE130B1149247709DFBFE2D6' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-05+19%3A29%3A37' \
-d 'v=2.0' \
-d 'param_uncharge_open_req=null'

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

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

req.param_uncharge_open_req=""
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,"alibaba.alsc.crm.recharge.uncharge.update");
add_param(pRequest,"param_uncharge_open_req","数据结构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('alibaba.alsc.crm.recharge.uncharge.update', {
	'param_uncharge_open_req':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_alsc_crm_recharge_uncharge_update_response>
    <result>
        <biz_success>true</biz_success>
        <result>
            <account_id>782364726</account_id>
            <affected_property_list>
                <recharge_account_property_open_info>
                    <type>REAL</type>
                    <value>2000</value>
                </recharge_account_property_open_info>
            </affected_property_list>
            <after_property_list>
                <recharge_account_property_open_info>
                    <type>GIFT</type>
                    <value>100</value>
                </recharge_account_property_open_info>
            </after_property_list>
            <before_property_list>
                <recharge_account_property_open_info>
                    <type>PRE</type>
                    <value>200</value>
                </recharge_account_property_open_info>
            </before_property_list>
            <brand_id>452342344</brand_id>
            <current_value>3000</current_value>
            <ext_info>
                <empty>null</empty>
            </ext_info>
            <flow_id>4634523433434</flow_id>
            <flow_type>UNCHARGE</flow_type>
            <operator>12532424123</operator>
            <operator_name>小明</operator_name>
            <order_src>1</order_src>
            <order_time>2019-04-05 12:13:14</order_time>
            <order_value>-6372</order_value>
            <outer_order_id>786238748723469826348</outer_order_id>
            <remark>哈就睡得好</remark>
            <shop_id>8723876</shop_id>
            <shop_name>花花小吃</shop_name>
        </result>
        <result_code>200</result_code>
        <result_desc>成功</result_desc>
        <result_view>&quot;&quot;</result_view>
    </result>
</alibaba_alsc_crm_recharge_uncharge_update_response>

{
    "alibaba_alsc_crm_recharge_uncharge_update_response":{
        "result":{
            "biz_success":true,
            "result":{
                "account_id":"782364726",
                "affected_property_list":{
                    "recharge_account_property_open_info":[
                        {
                            "type":"REAL",
                            "value":2000
                        }
                    ]
                },
                "after_property_list":{
                    "recharge_account_property_open_info":[
                        {
                            "type":"GIFT",
                            "value":100
                        }
                    ]
                },
                "before_property_list":{
                    "recharge_account_property_open_info":[
                        {
                            "type":"PRE",
                            "value":200
                        }
                    ]
                },
                "brand_id":"452342344",
                "current_value":3000,
                "ext_info":{
                    "empty":null
                },
                "flow_id":"4634523433434",
                "flow_type":"UNCHARGE",
                "operator":"12532424123",
                "operator_name":"小明",
                "order_src":1,
                "order_time":"2019-04-05 12:13:14",
                "order_value":-6372,
                "outer_order_id":"786238748723469826348",
                "remark":"哈就睡得好",
                "shop_id":"8723876",
                "shop_name":"花花小吃"
            },
            "result_code":"200",
            "result_desc":"成功",
            "result_view":"\"\""
        }
    }
}

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

alibaba.alsc.crm.recharge.uncharge.update (充值退款)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ