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

cainiao.pickup.business.agentpay.trigger (触发代扣通知)

ISV平台代理用户在菜鸟下单后,并不是马上扣平台的支付宝账号的钱。而是在不超过一定时间的情况下,由ISV调本接口通知菜鸟可以扣钱了

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
biz_type String 可选 GuoGuoSMB
  • 默认值:GuoGuoSMB
  • 提供给合作伙伴使用的商家域业务类型
    order_id Number 必须 2088410099817215 裹裹寄件订单号

    响应参数

    名称 类型 示例值 描述
    result TdOpenServiceResult {} 返回对象
    • └ status_code
    • String
    • SYS_ERROIR
    • 错误码
    • └ status_message
    • String
    • 系统错误
    • 错误描述,如果不能使用服务,会在这里提示错误信息
    • └ retry
    • Boolean
    • false
    • 是否需要重试
    • └ success
    • Boolean
    • true
    • 是否操作成功
    • data
    • OpenTriggerAgentPayResponse
    • {}
    • 返回对象
    • └ success
    • Boolean
    • true
    • 当结果为true时,代扣触发成功

    请求示例

    • JAVA
    • .NET
    • PHP
    • CURL
    • Python
    • C/C++
    • NodeJS
    TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
    CainiaoPickupBusinessAgentpayTriggerRequest req = new CainiaoPickupBusinessAgentpayTriggerRequest();
    req.setBizType("GuoGuoSMB");
    req.setOrderId(2088410099817215L);
    CainiaoPickupBusinessAgentpayTriggerResponse rsp = client.execute(req, sessionKey);
    System.out.println(rsp.getBody());

    响应示例

    • XML示例
    • JSON示例
    <cainiao_pickup_business_agentpay_trigger_response>
        <result>
            <status_code>SYS_ERROIR</status_code>
            <status_message>系统错误</status_message>
            <retry>false</retry>
            <success>true</success>
            <data>
                <success>true</success>
            </data>
        </result>
    </cainiao_pickup_business_agentpay_trigger_response>

    异常示例

    • 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>

    错误码解释

    错误码 错误描述 解决方案

    API工具

    如何获得此API

    FAQ

    返回
    顶部