阿里安全开放平台-阿里聚安全

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
agreement_pay_param	AgreementPayParam	可选			协议代扣参数
└ biz_order_id String 必须 897121234123 商户订单号（唯一建） └ plan_id String 必须 R1_897121234123_1 代扣计划 └ pay_biz_code String 必须 R1 R1:闲鱼回收代扣（V1版本）

名称	类型	示例值	描述
result	Result		接口返回model
└ success Boolean false 是否成功 └ err_code String 错误code module Serializable 服务出参 └ biz_order_id String 897121234123 商户订单号（唯一建） └ plan_id String R1_897121234123_1 代扣计划 └ alipay_trade_no String 2013112011001004330 000121536 支付宝流水号 └ pay_time String 2020-01-21 19:00:00 支付时间 └ total_amount Number 12300 申请扣款金额（单位分） └ receipt_amount Number 12300 实际支付金额（单位分） └ pay_status String SUCCESSED INIT:初始状态;PARTIAL_SUCCESSED:支付部分成功;SUCCESSED:支付成功;FAILED:支付失败 └ err_msg String 错误信息

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaIdleAgreementPayRequest req = new AlibabaIdleAgreementPayRequest();
AlibabaIdleAgreementPayRequest.AgreementPayParam obj1 = new AlibabaIdleAgreementPayRequest.AgreementPayParam();
obj1.setBizOrderId("897121234123");
obj1.setPlanId("R1_897121234123_1");
obj1.setPayBizCode("R1");
req.setAgreementPayParam(obj1);
AlibabaIdleAgreementPayResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaIdleAgreementPayRequest req = new AlibabaIdleAgreementPayRequest();
AlibabaIdleAgreementPayRequest.AgreementPayParamDomain obj1 = new AlibabaIdleAgreementPayRequest.AgreementPayParamDomain();
obj1.BizOrderId = "897121234123";
obj1.PlanId = "R1_897121234123_1";
obj1.PayBizCode = "R1";
req.AgreementPayParam_ = obj1;
AlibabaIdleAgreementPayResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaIdleAgreementPayRequest;
$agreement_pay_param = new AgreementPayParam;
$agreement_pay_param->biz_order_id="897121234123";
$agreement_pay_param->plan_id="R1_897121234123_1";
$agreement_pay_param->pay_biz_code="R1";
$req->setAgreementPayParam(json_encode($agreement_pay_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' \
-d 'partner_id=apidoc' \
-d 'session=d76fe0ff-4fd6-41fe-93cf-ce1945243ac7' \
-d 'sign=9536A1FD1D44547E68899E88B543CC1A' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-28+00%3A08%3A04' \
-d 'v=2.0' \
-d 'agreement_pay_param=null'

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

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

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

XML示例
JSON示例

<alibaba_idle_agreement_pay_response>
    <result>
        <success>false</success>
        <err_code></err_code>
        <module>
            <biz_order_id>897121234123</biz_order_id>
            <plan_id>R1_897121234123_1</plan_id>
            <alipay_trade_no>2013112011001004330 000121536</alipay_trade_no>
            <pay_time>2020-01-21 19:00:00</pay_time>
            <total_amount>12300</total_amount>
            <receipt_amount>12300</receipt_amount>
            <pay_status>SUCCESSED</pay_status>
        </module>
        <err_msg></err_msg>
    </result>
</alibaba_idle_agreement_pay_response>

{
    "alibaba_idle_agreement_pay_response":{
        "result":{
            "success":false,
            "err_code":"",
            "module":{
                "biz_order_id":"897121234123",
                "plan_id":"R1_897121234123_1",
                "alipay_trade_no":"2013112011001004330 000121536",
                "pay_time":"2020-01-21 19:00:00",
                "total_amount":12300,
                "receipt_amount":12300,
                "pay_status":"SUCCESSED"
            },
            "err_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下载

闲鱼

alibaba.idle.agreement.pay (闲鱼平台商户代扣)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ

用户导航

用户反馈

用户反馈

用户反馈