淘宝开放平台

登录
文档中心 > API类目 > 菜鸟裹裹API

菜鸟裹裹API

cainiao.guoguo.delivery.alipay.sign.withhold (包裹侠)

包裹侠查询和签署支付宝代扣协议

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
session_code String 必须 111 session_code
user_id Number 必须 111 user_id
logon_id String 可选 logon_id logon_id

响应参数

名称 类型 示例值 描述
data SignAlipayWithHoldResponse 134523^4351232 model
  • └ alipay_url
  • String
  • app_id=2017072407878893&biz_content=%7B%22personal_product_code%22%3A%22GENERAL_WITHHOLDING_P
  • alipayUrl
  • └ sign_flag
  • Boolean
  • false
  • signFlag
  • └ title
  • String
  • 请同意平台代扣协议
  • title
  • └ content
  • String
  • 完成包裹侠揽件业务需知晓且同意以下协议，并签署支付宝代扣协议：
  • content
status_code String 1 msgCode
status_message String 1 msgInfo
is_success Boolean false success

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
1
2
3
4
5
6
7
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
CainiaoGuoguoDeliveryAlipaySignWithholdRequest req = new CainiaoGuoguoDeliveryAlipaySignWithholdRequest();
req.setSessionCode("111");
req.setUserId(111L);
req.setLogonId("logon_id");
CainiaoGuoguoDeliveryAlipaySignWithholdResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
1
2
3
4
5
6
7
8
9
10
11
<cainiao_guoguo_delivery_alipay_sign_withhold_response>
    <data>
        <alipay_url>app_id=2017072407878893&amp;biz_content=%7B%22personal_product_code%22%3A%22GENERAL_WITHHOLDING_P</alipay_url>
        <sign_flag>false</sign_flag>
        <title>请同意平台代扣协议</title>
        <content>完成包裹侠揽件业务需知晓且同意以下协议，并签署支付宝代扣协议：</content>
    </data>
    <status_code>1</status_code>
    <status_message>1</status_message>
    <is_success>false</is_success>
</cainiao_guoguo_delivery_alipay_sign_withhold_response>

异常示例

  • XML示例
  • JSON示例
1
2
3
4
5
6
<error_response>
    <code>50</code>
    <msg>Remote service error</msg>
    <sub_code>isv.invalid-parameter</sub_code>
    <sub_msg>非法参数</sub_msg>
</error_response>

错误码解释

错误码 错误描述 解决方案

API工具

API测试工具 错误码查询工具 SDK下载

如何获得此API

FAQ

我要提问
返回
顶部