淘宝开放平台

请求地址：

环境	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_xfd_coupon_external_request	XfdCouponExternalRequest	可选			请求体
coupon Coupon 可选 [] 营销券列表 └ coupon_code String 可选 ABC 营销券代码 └ create_time Date 可选 2024-01-01 00:00:00 创建时间 └ description String 可选 XX 描述 └ start_time Date 可选 2024-01-01 00:00:00 生效时间 └ end_time Date 可选 2024-02-01 00:00:00 截止时间 └ extension String 可选 {} 扩展字段 └ name String 可选免息期营销券名称 └ status String 可选 USED 营销券状态 └ type String 可选 INTEREST_FREE 类型 └ used_time Date 可选 2024-01-01 00:00:00 使用时间 └ max_use_times Number 可选 1 券可用次数 └ activity_id String 可选 123 活动ID └ activity_rule_id String 可选 123 活动规则ID use_condition CouponUseCondition 可选 10000.00 使用条件 └ min_loan_amount String 可选 1 最低支用金额 └ max_loan_amount String 可选 100 最大支用金额 └ support_term_list String [] 可选 [3,6] 该卡券支持的期次列表 └ term_unit String 可选 MONTH 支持的期次单位 └ support_repaymethod_list String [] 可选 ["BALLOON_MORTGAGE"] 支持的还款方式 └ limit_interest String 可选 10 减免利息额度 └ limit_terms Number 可选 1 限制x天/期优惠，则有此值 └ limit_term_unit String 可选 MONTH 优惠期限单位 └ limit_term_stage String 可选 PRE 优惠的期限阶段 PRE/LAST ：前x期/后x期 └ subtitle String 可选 xxx 副标题 └ limit_quota String 可选 100 减免本金额度 └ apply_status String 可选 SUCCESS 发放状态 └ customer_id String 可选 123 用户ID └ request_id String 可选 123 幂等号 └ institution String 可选 DXM 机构 └ apply_no String 可选 FI123123 营销券发放单号 └ fail_reason_code String 可选 FAIL 发放失败码 └ fail_reason_message String 可选 FAIL 发放失败描述 └ credit_apply_no String 可选 FI123123 授信单号 └ alipay_user_id String 可选 111 支付宝用户ID

名称	类型	示例值	描述
result	XfdExternalResponse		响应体
└ response_code String SUCCESS 返回码 └ response_message String SUCCESS 返回描述 └ trace_id String 123 调用ID └ success Boolean true 是否成功

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaFinanceXfdCouponNotifyRequest req = new AlibabaFinanceXfdCouponNotifyRequest();
AlibabaFinanceXfdCouponNotifyRequest.XfdCouponExternalRequest obj1 = new AlibabaFinanceXfdCouponNotifyRequest.XfdCouponExternalRequest();
AlibabaFinanceXfdCouponNotifyRequest.Coupon obj2 = new AlibabaFinanceXfdCouponNotifyRequest.Coupon();
obj2.setCouponCode("ABC");
obj2.setCreateTime(StringUtils.parseDateTime("2024-01-01 00:00:00"));
obj2.setDescription("XX");
obj2.setStartTime(StringUtils.parseDateTime("2024-01-01 00:00:00"));
obj2.setEndTime(StringUtils.parseDateTime("2024-02-01 00:00:00"));
obj2.setExtension("{}");
obj2.setName("免息期");
obj2.setStatus("USED");
obj2.setType("INTEREST_FREE");
obj2.setUsedTime(StringUtils.parseDateTime("2024-01-01 00:00:00"));
obj2.setMaxUseTimes(1L);
obj2.setActivityId("123");
obj2.setActivityRuleId("123");
AlibabaFinanceXfdCouponNotifyRequest.CouponUseCondition obj3 = new AlibabaFinanceXfdCouponNotifyRequest.CouponUseCondition();
obj3.setMinLoanAmount("1");
obj3.setMaxLoanAmount("100");
obj3.setSupportTermList("3,6");
obj3.setTermUnit("MONTH");
obj3.setSupportRepaymethodList(""BALLOON_MORTGAGE"");
obj2.setUseCondition(obj3);
obj2.setLimitInterest("10");
obj2.setLimitTerms(1L);
obj2.setLimitTermUnit("MONTH");
obj2.setLimitTermStage("PRE");
obj2.setSubtitle("xxx");
obj2.setLimitQuota("100");
obj1.setCoupon(obj2);
obj1.setApplyStatus("SUCCESS");
obj1.setCustomerId("123");
obj1.setRequestId("123");
obj1.setInstitution("DXM");
obj1.setApplyNo("FI123123");
obj1.setFailReasonCode("FAIL");
obj1.setFailReasonMessage("FAIL");
obj1.setCreditApplyNo("FI123123");
obj1.setAlipayUserId("111");
req.setParamXfdCouponExternalRequest(obj1);
AlibabaFinanceXfdCouponNotifyResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaFinanceXfdCouponNotifyRequest req = new AlibabaFinanceXfdCouponNotifyRequest();
AlibabaFinanceXfdCouponNotifyRequest.XfdCouponExternalRequestDomain obj1 = new AlibabaFinanceXfdCouponNotifyRequest.XfdCouponExternalRequestDomain();
AlibabaFinanceXfdCouponNotifyRequest.CouponDomain obj2 = new AlibabaFinanceXfdCouponNotifyRequest.CouponDomain();
obj2.CouponCode = "ABC";
obj2.CreateTime = DateTime.Parse(2024-01-01 00:00:00");
obj2.Description = "XX";
obj2.StartTime = DateTime.Parse(2024-01-01 00:00:00");
obj2.EndTime = DateTime.Parse(2024-02-01 00:00:00");
obj2.Extension = "{}";
obj2.Name = "免息期";
obj2.Status = "USED";
obj2.Type = "INTEREST_FREE";
obj2.UsedTime = DateTime.Parse(2024-01-01 00:00:00");
obj2.MaxUseTimes = 1L;
obj2.ActivityId = "123";
obj2.ActivityRuleId = "123";
AlibabaFinanceXfdCouponNotifyRequest.CouponUseConditionDomain obj3 = new AlibabaFinanceXfdCouponNotifyRequest.CouponUseConditionDomain();
obj3.MinLoanAmount = "1";
obj3.MaxLoanAmount = "100";
obj3.SupportTermList = "3,6";
obj3.TermUnit = "MONTH";
obj3.SupportRepaymethodList = ""BALLOON_MORTGAGE"";
obj2.UseCondition= obj3;
obj2.LimitInterest = "10";
obj2.LimitTerms = 1L;
obj2.LimitTermUnit = "MONTH";
obj2.LimitTermStage = "PRE";
obj2.Subtitle = "xxx";
obj2.LimitQuota = "100";
obj1.Coupon= obj2;
obj1.ApplyStatus = "SUCCESS";
obj1.CustomerId = "123";
obj1.RequestId = "123";
obj1.Institution = "DXM";
obj1.ApplyNo = "FI123123";
obj1.FailReasonCode = "FAIL";
obj1.FailReasonMessage = "FAIL";
obj1.CreditApplyNo = "FI123123";
obj1.AlipayUserId = "111";
req.ParamXfdCouponExternalRequest_ = obj1;
AlibabaFinanceXfdCouponNotifyResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaFinanceXfdCouponNotifyRequest;
$param_xfd_coupon_external_request = new XfdCouponExternalRequest;
$coupon = new Coupon;
$coupon->coupon_code="ABC";
$coupon->create_time="2024-01-01 00:00:00";
$coupon->description="XX";
$coupon->start_time="2024-01-01 00:00:00";
$coupon->end_time="2024-02-01 00:00:00";
$coupon->extension="{}";
$coupon->name="免息期";
$coupon->status="USED";
$coupon->type="INTEREST_FREE";
$coupon->used_time="2024-01-01 00:00:00";
$coupon->max_use_times="1";
$coupon->activity_id="123";
$coupon->activity_rule_id="123";
$use_condition = new CouponUseCondition;
$use_condition->min_loan_amount="1";
$use_condition->max_loan_amount="100";
$use_condition->support_term_list="[3,6]";
$use_condition->term_unit="MONTH";
$use_condition->support_repaymethod_list="[\"BALLOON_MORTGAGE\"]";
$coupon->use_condition = $use_condition;
$coupon->limit_interest="10";
$coupon->limit_terms="1";
$coupon->limit_term_unit="MONTH";
$coupon->limit_term_stage="PRE";
$coupon->subtitle="xxx";
$coupon->limit_quota="100";
$param_xfd_coupon_external_request->coupon = $coupon;
$param_xfd_coupon_external_request->apply_status="SUCCESS";
$param_xfd_coupon_external_request->customer_id="123";
$param_xfd_coupon_external_request->request_id="123";
$param_xfd_coupon_external_request->institution="DXM";
$param_xfd_coupon_external_request->apply_no="FI123123";
$param_xfd_coupon_external_request->fail_reason_code="FAIL";
$param_xfd_coupon_external_request->fail_reason_message="FAIL";
$param_xfd_coupon_external_request->credit_apply_no="FI123123";
$param_xfd_coupon_external_request->alipay_user_id="111";
$req->setParamXfdCouponExternalRequest(json_encode($param_xfd_coupon_external_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=alibaba.finance.xfd.coupon.notify' \
-d 'partner_id=apidoc' \
-d 'sign=3975AB46DCC30E1534FA22F0CF503D6C' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-02+15%3A22%3A58' \
-d 'v=2.0' \
-d 'param_xfd_coupon_external_request=null'

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

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

req.param_xfd_coupon_external_request="数据结构示例JSON格式"
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.finance.xfd.coupon.notify");
add_param(pRequest,"param_xfd_coupon_external_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('alibaba.finance.xfd.coupon.notify', {
	'param_xfd_coupon_external_request':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_finance_xfd_coupon_notify_response>
    <result>
        <response_code>SUCCESS</response_code>
        <response_message>SUCCESS</response_message>
        <trace_id>123</trace_id>
        <success>true</success>
    </result>
</alibaba_finance_xfd_coupon_notify_response>

{
    "alibaba_finance_xfd_coupon_notify_response":{
        "result":{
            "response_code":"SUCCESS",
            "response_message":"SUCCESS",
            "trace_id":"123",
            "success":true
        }
    }
}

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.finance.xfd.coupon.notify (消费贷营销券发放推送)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ