alibaba.nlife.b2c.trade.refund (零售+请求退款)

零售+平台请求退款接口,在零售+平台不会有资金流变动,只是订单状态的更新

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
trade_no String 可选 100004000000000045678
  • 最大长度:64
  • 零售+平台订单号,和out_trade_no不能同时为空
    out_request_no String 必须 765345354
  • 最大长度:64
  • 外部请求号
    refund_bill_list FundBill [] 必须
  • 最大列表长度:20
  • 退款资金列表
    • └ id
    • String
    • 可选
    • 201612310000000345354
    • 资金渠道的id,1. type=CASH:为空; 2. type=UNIONPAY:银联退款流水号; 3. type=ALIPAY:支付宝退款单号; 4. type=WECHAT_PAY:微信退款单号; 5. type=PROMOTION:零售+平台中的优惠id。6. type=CUSTOM_PROMOTION:7. type=CUSTOM_PREPAY_CARD;8. type=OFFLINE_PREPAY_CARD; 9. type=MOLING 为空
    • └ type
    • String
    • 必须
    • ALIPAY
    • 资金渠道类型,1. CASH:现金支付; 2. UNIONPAY:银联刷卡支付; 3. ALIPAY:支付宝支付; 4. WECHAT_PAY:微信支付; 5. PROMOTION: 零售+平台的优惠; 6. CUSTOM_PROMOTION:零售商自有优惠; 7. CUSTOM_PREPAY_CARD:ISV储值卡;8. OFFLINE_PREPAY_CARD: 线下储值卡(无ISV交互逻辑) 9. MOLING:支付时抹零
    • └ buyer_id
    • String
    • 可选
    • 53456456
    • 用户ID
    • └ buyer_id_type
    • String
    • 必须
    • WECHAT_OPENID
    • 用户类型,TAOBAO_OPENID 经阿里百川淘宝登录获取到的用户id ALIPAY_OPENID 经蚂蚁金服开放平台支付宝App登录获取到的用户id WECHAT_OPENID 经微信开放平台微信App登录获取到的用户id PHONE_NUMBER 通过手机号登录 APP_USERID 商户自有的用户id ANONYMOUS_USER 匿名用户
    • └ title
    • String
    • 必须
    • 支付宝支付
    • 资金渠道的名称。 1. type=CASH:现金支付; 2. type=UNIONPAY:银联刷卡支付; 3. type=ALIPAY:支付宝支付; 4. type=WECHAT_PAY:微信支付; 5. type=PROMOTION: 零售+平台的优惠名称; 6. type=CUSTOM_PROMOTION:零售商自有优惠名称; 7. type=CUSTOM_PREPAY_CARD:ISV储值卡;8. type=OFFLINE_PREPAY_CARD:线下储值卡; 9. type=MOLING:抹零;
    • └ amount
    • Number
    • 必须
    • 6000
    • 金额/优惠抵扣金额,单位:分
    • └ currency
    • String
    • 必须
    • CNY
    • 货币种类,CNY
    • └ extend_params
    • String
    • 可选
    • {"k1":v1}
    • 扩展参数,JSON格式
    • └ attachment
    • String
    • 可选
    • age:26,gender:female
    • 透传参数,格式自定,查询时原样返回
    refund_goods_list String [] 必须 547580683166_326040728,550217515160_3611278001
  • 最大列表长度:20
  • 所退货物的ID列表,逗号分隔商品组,冒号分隔商品和退货数量,支持三种方式退。 条码模式:barcode1:3,barcode2:2 表示barcode1退3件,barcode2退2件。 item_sku模式:itemId1_skuId1:3,itemId2_skuId2:2 表示itemId1_skuId1这个商品退3件,itemId2_skuId2这个商品退2件。 唯一码模式:uniqeueCodeA:1,uniqeueCodeA:1,因唯一码指定到唯一一件商品,退货数量都是1。
    out_trade_no String 可选 OT423895437564378
  • 最大长度:64
  • 外部订单号,和trade_no不能同时为空
    store_id String 可选 100004 零售+门店ID
    refund_points Number 可选 10 退积分,ISV自行算好

    响应参数

    名称 类型 示例值 描述
    gmt_refund Date 2016-12-31 23:59:59 退款时间
    extend_params String {"k1":v1} 扩展参数

    请求示例

    • JAVA
    • .NET
    • PHP
    • CURL
    • Python
    • C/C++
    • NodeJS
    TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
    AlibabaNlifeB2cTradeRefundRequest req = new AlibabaNlifeB2cTradeRefundRequest();
    req.setTradeNo("100004000000000045678");
    req.setOutRequestNo("765345354");
    List<AlibabaNlifeB2cTradeRefundRequest.FundBill> list2 = new ArrayList<AlibabaNlifeB2cTradeRefundRequest.FundBill>();
    AlibabaNlifeB2cTradeRefundRequest.FundBill obj3 = new AlibabaNlifeB2cTradeRefundRequest.FundBill();
    list2.add(obj3);
    obj3.setId("201612310000000345354");
    obj3.setType("ALIPAY");
    obj3.setBuyerId("53456456");
    obj3.setBuyerIdType("WECHAT_OPENID");
    obj3.setTitle("支付宝支付");
    obj3.setAmount(6000L);
    obj3.setCurrency("CNY");
    obj3.setExtendParams("{\"k1\":v1}");
    obj3.setAttachment("age:26,gender:female");
    req.setRefundBillList(list2);
    req.setRefundGoodsList("547580683166_326040728,550217515160_3611278001");
    req.setOutTradeNo("OT423895437564378");
    req.setStoreId("100004");
    req.setRefundPoints(10L);
    AlibabaNlifeB2cTradeRefundResponse rsp = client.execute(req, sessionKey);
    System.out.println(rsp.getBody());

    响应示例

    • XML示例
    • JSON示例
    <alibaba_nlife_b2c_trade_refund_response>
        <gmt_refund>2016-12-31 23:59:59</gmt_refund>
        <extend_params>{&quot;k1&quot;:v1}</extend_params>
    </alibaba_nlife_b2c_trade_refund_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

    返回
    顶部