阿里大于 -

请求地址：

环境	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	AgreementPayBillQueryParam	可选			入参
└ biz_order_id String 必须 12838882 订单号 └ pay_biz_code String 必须 R1 业务编码：R1:回收

名称	类型	示例值	描述
result	Result	{}	接口返回
└ success Boolean true 是否成功 └ err_code String err_code err_code module Serializable {} 账单查询结果 pay_details SubPayBillDto [] [] 明细 └ pay_time String 2020-01-10 10:00:00 支付时间 └ create_time String 2020-01-10 09:00:00 创建时间 └ pay_status_desc String 支付成功支付状态描述 └ pay_status String SUCCESSED 支付状态 └ err_msg String demo 代扣错误信息 └ err_code String demo 代扣错误码 └ alipay_trade_no String 20201023993212 支付宝流水号 └ amount String 50 金额 └ plan_id String R1_897121234123_1 计划id └ total_amount String 50 总金额 └ pay_biz_code String R1 业务编码：R1:回收 └ pay_status_desc String 支付成功状态描述 └ pay_status String SUCCESSED INIT:初始状态;PARTIAL_SUCCESSED:支付部分成功;SUCCESSED:支付成功;FAILED:支付失败 └ biz_order_id String 12838882 业务订单号 └ err_msg String success 错误信息

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaIdleAgreementPayQueryRequest req = new AlibabaIdleAgreementPayQueryRequest();
AlibabaIdleAgreementPayQueryRequest.AgreementPayBillQueryParam obj1 = new AlibabaIdleAgreementPayQueryRequest.AgreementPayBillQueryParam();
obj1.setBizOrderId("12838882");
obj1.setPayBizCode("R1");
req.setParam(obj1);
AlibabaIdleAgreementPayQueryResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaIdleAgreementPayQueryRequest req = new AlibabaIdleAgreementPayQueryRequest();
AlibabaIdleAgreementPayQueryRequest.AgreementPayBillQueryParamDomain obj1 = new AlibabaIdleAgreementPayQueryRequest.AgreementPayBillQueryParamDomain();
obj1.BizOrderId = "12838882";
obj1.PayBizCode = "R1";
req.Param_ = obj1;
AlibabaIdleAgreementPayQueryResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaIdleAgreementPayQueryRequest;
$param = new AgreementPayBillQueryParam;
$param->biz_order_id="12838882";
$param->pay_biz_code="R1";
$req->setParam(json_encode($param));
$resp = $c->execute($req, $sessionKey);

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.idle.agreement.pay.query' \
-d 'partner_id=apidoc' \
-d 'session=b522284c-dc8b-40fa-9852-aee57a6f0bc2' \
-d 'sign=9FDA8E3E5B8DA4D47011E0805CC8003C' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-27+22%3A36%3A32' \
-d 'v=2.0' \
-d 'param=null'

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

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

req.param=""
try:
	resp= req.getResponse(sessionkey)
	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.idle.agreement.pay.query");
add_param(pRequest,"param","数据结构JSON示例");
pResponse = top_execute(pClient,pRequest,sessionKey);
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.idle.agreement.pay.query', {
	'param':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_idle_agreement_pay_query_response>
    <result>
        <success>true</success>
        <err_code>err_code</err_code>
        <module>
            <pay_details>
                <sub_pay_bill_dto>
                    <pay_time>2020-01-10 10:00:00</pay_time>
                    <create_time>2020-01-10 09:00:00</create_time>
                    <pay_status_desc>支付成功</pay_status_desc>
                    <pay_status>SUCCESSED</pay_status>
                    <err_msg>demo</err_msg>
                    <err_code>demo</err_code>
                    <alipay_trade_no>20201023993212</alipay_trade_no>
                    <amount>50</amount>
                    <plan_id>R1_897121234123_1</plan_id>
                </sub_pay_bill_dto>
            </pay_details>
            <total_amount>50</total_amount>
            <pay_biz_code>R1</pay_biz_code>
            <pay_status_desc>支付成功</pay_status_desc>
            <pay_status>SUCCESSED</pay_status>
            <biz_order_id>12838882</biz_order_id>
        </module>
        <err_msg>success</err_msg>
    </result>
</alibaba_idle_agreement_pay_query_response>

{
    "alibaba_idle_agreement_pay_query_response":{
        "result":{
            "success":true,
            "err_code":"err_code",
            "module":{
                "pay_details":{
                    "sub_pay_bill_dto":[
                        {
                            "pay_time":"2020-01-10 10:00:00",
                            "create_time":"2020-01-10 09:00:00",
                            "pay_status_desc":"支付成功",
                            "pay_status":"SUCCESSED",
                            "err_msg":"demo",
                            "err_code":"demo",
                            "alipay_trade_no":"20201023993212",
                            "amount":"50",
                            "plan_id":"R1_897121234123_1"
                        }
                    ]
                },
                "total_amount":"50",
                "pay_biz_code":"R1",
                "pay_status_desc":"支付成功",
                "pay_status":"SUCCESSED",
                "biz_order_id":"12838882"
            },
            "err_msg":"success"
        }
    }
}

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下载

闲鱼

alibaba.idle.agreement.pay.query (代扣详情查询)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ