淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
bill_notify_request_dto	BillNotifyRequestDTO	必须			请求实体
out_amount BillAmountDTO 可选下单后流出账户的金额 └ amount BigDecimal 可选 100.00 金额 └ currency String 可选 CNY 币种 └ order_no String 可选 123456789 订单编号 └ bill_type String 可选 CARD_PAYMENT 交易类型。当前默认取值为CARD_PAYMENT └ transaction_time String 可选 2026-03-31 12:30:23 交易单的创建时间，当地时间 └ merchant_name String 可选 happytrip 商户名称 trade_amount BillAmountDTO 可选交易金额 └ amount BigDecimal 可选 100.00 金额 └ currency String 可选 CNY 币种 └ card_nick_name String 可选 happytrip 由用户定义的卡昵称，可以帮助用户更方便地管理多张卡 bill_fail_reason BillFailReasonDTO 可选交易失败原因 └ error_desc String 可选 System error. 交易失败结果信息，对失败结果码的补充说明 └ error_code String 可选 SYSTEM_ERROR 交易失败结果码 └ payer_budget_account_id String 可选 123456789 预算账户ID └ payer_balance_type String 可选 NORMAL_BALANCE 该字段表示客户拥有的不同余额类型。客户在不同业务场景下，可使用不同的余额类型对资金余额做分隔管理，作用是为了风险管控。此字段的可取值为： NORMAL_BALANCE: 普通余额类型（即电商余额类型)。（默认） SAME_NAME_TOP_UP_BALANCE: 同名充值余额类型。 BUDGET_BALANCE : 预算账户余额类型 in_amount BillAmountDTO 可选下单后流入账户的金额，如：退款 └ amount BigDecimal 可选 100.00 金额 └ currency String 可选 HKD 币种 └ exchange_rate String 可选 0.936 汇率 └ asset_id String 可选 123456789 卡资产ID └ masked_card_no String 可选 1234*******4321 脱敏卡号 └ last_update String 可选 2026-03-31 12:30:23 最后一次更新时间 └ bill_status String 可选 WAITING_CLEARANCE 账单状态。可取值范围： WAITING_CLEARANCE 待结算 SUCCESS 成功 FAILED 失败 REFUNDED 已退款 CANCELLED 授权取消 PARTIAL_CANCEL 部分授权取消 PARTIAL_REFUND 部分退款 WAITING_DEDUCT 待扣款 └ trade_country String 可选 CN 代表交易所在国家/地区的二字母ISO-3166 代码 └ metadata String 可选 { "employeeNo": "454546", "transLocalTime": "2025-10-10 06:26:57" } 业务拓展数据

名称	类型	示例值	描述
is_success	Boolean	true	是否成功
err_no	String	00001	错误码
stack_trace	String	error	异常堆栈，可空
content	BillNotifyResultDTO		结果实体
└ result_code String SUCCESS 结果码 └ result_message String error 结果码信息 └ result_status String S 结果状态

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaHappytripBankBillNotifyRequest req = new AlibabaHappytripBankBillNotifyRequest();
AlibabaHappytripBankBillNotifyRequest.BillNotifyRequestDTO obj1 = new AlibabaHappytripBankBillNotifyRequest.BillNotifyRequestDTO();
AlibabaHappytripBankBillNotifyRequest.BillAmountDTO obj2 = new AlibabaHappytripBankBillNotifyRequest.BillAmountDTO();
obj2.setAmount("100.00");
obj2.setCurrency("CNY");
obj1.setOutAmount(obj2);
obj1.setOrderNo("123456789");
obj1.setBillType("CARD_PAYMENT");
obj1.setTransactionTime("2026-03-31 12:30:23");
obj1.setMerchantName("happytrip");
AlibabaHappytripBankBillNotifyRequest.BillAmountDTO obj3 = new AlibabaHappytripBankBillNotifyRequest.BillAmountDTO();
obj3.setAmount("100.00");
obj3.setCurrency("CNY");
obj1.setTradeAmount(obj3);
obj1.setCardNickName("happytrip");
AlibabaHappytripBankBillNotifyRequest.BillFailReasonDTO obj4 = new AlibabaHappytripBankBillNotifyRequest.BillFailReasonDTO();
obj4.setErrorDesc("System error.");
obj4.setErrorCode("SYSTEM_ERROR");
obj1.setBillFailReason(obj4);
obj1.setPayerBudgetAccountId("123456789");
obj1.setPayerBalanceType("NORMAL_BALANCE");
AlibabaHappytripBankBillNotifyRequest.BillAmountDTO obj5 = new AlibabaHappytripBankBillNotifyRequest.BillAmountDTO();
obj5.setAmount("100.00");
obj5.setCurrency("HKD");
obj1.setInAmount(obj5);
obj1.setExchangeRate("0.936");
obj1.setAssetId("123456789");
obj1.setMaskedCardNo("1234*******4321");
obj1.setLastUpdate("2026-03-31 12:30:23");
obj1.setBillStatus("WAITING_CLEARANCE");
obj1.setTradeCountry("CN");
obj1.setMetadata("{     \"employeeNo\": \"454546\",     \"transLocalTime\": \"2025-10-10 06:26:57\" }");
req.setBillNotifyRequestDto(obj1);
AlibabaHappytripBankBillNotifyResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaHappytripBankBillNotifyRequest req = new AlibabaHappytripBankBillNotifyRequest();
AlibabaHappytripBankBillNotifyRequest.BillNotifyRequestDTODomain obj1 = new AlibabaHappytripBankBillNotifyRequest.BillNotifyRequestDTODomain();
AlibabaHappytripBankBillNotifyRequest.BillAmountDTODomain obj2 = new AlibabaHappytripBankBillNotifyRequest.BillAmountDTODomain();
obj2.Amount = "100.00";
obj2.Currency = "CNY";
obj1.OutAmount= obj2;
obj1.OrderNo = "123456789";
obj1.BillType = "CARD_PAYMENT";
obj1.TransactionTime = "2026-03-31 12:30:23";
obj1.MerchantName = "happytrip";
AlibabaHappytripBankBillNotifyRequest.BillAmountDTODomain obj3 = new AlibabaHappytripBankBillNotifyRequest.BillAmountDTODomain();
obj3.Amount = "100.00";
obj3.Currency = "CNY";
obj1.TradeAmount= obj3;
obj1.CardNickName = "happytrip";
AlibabaHappytripBankBillNotifyRequest.BillFailReasonDTODomain obj4 = new AlibabaHappytripBankBillNotifyRequest.BillFailReasonDTODomain();
obj4.ErrorDesc = "System error.";
obj4.ErrorCode = "SYSTEM_ERROR";
obj1.BillFailReason= obj4;
obj1.PayerBudgetAccountId = "123456789";
obj1.PayerBalanceType = "NORMAL_BALANCE";
AlibabaHappytripBankBillNotifyRequest.BillAmountDTODomain obj5 = new AlibabaHappytripBankBillNotifyRequest.BillAmountDTODomain();
obj5.Amount = "100.00";
obj5.Currency = "HKD";
obj1.InAmount= obj5;
obj1.ExchangeRate = "0.936";
obj1.AssetId = "123456789";
obj1.MaskedCardNo = "1234*******4321";
obj1.LastUpdate = "2026-03-31 12:30:23";
obj1.BillStatus = "WAITING_CLEARANCE";
obj1.TradeCountry = "CN";
obj1.Metadata = "{     \"employeeNo\": \"454546\",     \"transLocalTime\": \"2025-10-10 06:26:57\" }";
req.BillNotifyRequestDto_ = obj1;
AlibabaHappytripBankBillNotifyResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaHappytripBankBillNotifyRequest;
$bill_notify_request_dto = new BillNotifyRequestDTO;
$out_amount = new BillAmountDTO;
$out_amount->amount="100.00";
$out_amount->currency="CNY";
$bill_notify_request_dto->out_amount = $out_amount;
$bill_notify_request_dto->order_no="123456789";
$bill_notify_request_dto->bill_type="CARD_PAYMENT";
$bill_notify_request_dto->transaction_time="2026-03-31 12:30:23";
$bill_notify_request_dto->merchant_name="happytrip";
$trade_amount = new BillAmountDTO;
$trade_amount->amount="100.00";
$trade_amount->currency="CNY";
$bill_notify_request_dto->trade_amount = $trade_amount;
$bill_notify_request_dto->card_nick_name="happytrip";
$bill_fail_reason = new BillFailReasonDTO;
$bill_fail_reason->error_desc="System error.";
$bill_fail_reason->error_code="SYSTEM_ERROR";
$bill_notify_request_dto->bill_fail_reason = $bill_fail_reason;
$bill_notify_request_dto->payer_budget_account_id="123456789";
$bill_notify_request_dto->payer_balance_type="NORMAL_BALANCE";
$in_amount = new BillAmountDTO;
$in_amount->amount="100.00";
$in_amount->currency="HKD";
$bill_notify_request_dto->in_amount = $in_amount;
$bill_notify_request_dto->exchange_rate="0.936";
$bill_notify_request_dto->asset_id="123456789";
$bill_notify_request_dto->masked_card_no="1234*******4321";
$bill_notify_request_dto->last_update="2026-03-31 12:30:23";
$bill_notify_request_dto->bill_status="WAITING_CLEARANCE";
$bill_notify_request_dto->trade_country="CN";
$bill_notify_request_dto->metadata="{     \"employeeNo\": \"454546\",     \"transLocalTime\": \"2025-10-10 06:26:57\" }";
$req->setBillNotifyRequestDto(json_encode($bill_notify_request_dto));
$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.happytrip.bank.bill.notify' \
-d 'partner_id=apidoc' \
-d 'sign=94751B82A365D8A7E7FFA5DA8508B61D' \
-d 'sign_method=hmac' \
-d 'timestamp=2026-05-23+01%3A24%3A14' \
-d 'v=2.0' \
-d 'bill_notify_request_dto=null'

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

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

req.bill_notify_request_dto="数据结构示例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.happytrip.bank.bill.notify");
add_param(pRequest,"bill_notify_request_dto","数据结构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('alibaba.happytrip.bank.bill.notify', {
	'bill_notify_request_dto':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_happytrip_bank_bill_notify_response>
    <is_success>true</is_success>
    <err_no>00001</err_no>
    <stack_trace>error</stack_trace>
    <content>
        <result_code>SUCCESS</result_code>
        <result_message>error</result_message>
        <result_status>S</result_status>
    </content>
</alibaba_happytrip_bank_bill_notify_response>

{
    "alibaba_happytrip_bank_bill_notify_response":{
        "is_success":true,
        "err_no":"00001",
        "stack_trace":"error",
        "content":{
            "result_code":"SUCCESS",
            "result_message":"error",
            "result_status":"S"
        }
    }
}

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.happytrip.bank.bill.notify (银行账单流水同步)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ