文档中心 > API类目 > 零售终端API

qimen.tmall.refundorder.syn (退款单同步)

将线下pos产生的退款单信息同步给第三方服务

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
trade_id String 可选 123456 订单号
f_fkpzh String 必须 234 退款单号
f_fksj String 必须 2018-10-10 12:12:12 退款时间yyyy-MM-dd hh:mm:ss
op_type String 必须 new 操作类型 基础类型 new 、update、delete、query
f_fdbh Number 可选 222 分店编号-商家门店编号
f_sky Number 必须 24234234 收银员-退款时的操作人信息
f_skymc String 可选 张三 收银员名称-退款时的操作人信息
f_fkje String 必须 12.1 退款金额-此次退款总金额(保留小数点后2位 单位元)
f_fkbz String 可选 不买了 退款备注-退款的备注信息(保留小数点后2位 单位元)
refund_items RefundItemsDO [] 必须
  • 最大列表长度:999
  • 退款明细
    • └ f_xtckh
    • String
    • 可选
    • 23445532
    • 系统参考号 银行支付返回的流水号/支付宝交款流水号/支票号/汇票号等
    • └ f_lsh
    • String
    • 可选
    • 22334555
    • 流水号-银行接口返回值
    • └ f_yh
    • String
    • 可选
    • 3
    • 银行代码
    • └ f_kh
    • String
    • 可选
    • 342234
    • 卡号 前六位数字,中间可以星号,最后四位用数字。
    • └ f_fkrq
    • String
    • 必须
    • 2018-10-10 12:12:12
    • 付款时间yyyy-MM-dd hh:mm:ss
    • └ f_skje
    • String
    • 必须
    • 1.1
    • 各渠道退款金额(保留小数点后2位 单位元)
    • └ f_skfs
    • String
    • 必须
    • cash
    • 收款渠道方式编码-每个渠道编码
    • └ f_jlbh
    • Number
    • 可选
    • 123
    • 记录编号(阿里订单号)
    • └ refund_channel_code
    • String
    • 可选
    • cash
    • 退款渠道类型
    • refund_item_detail
    • RefundItemDetailDO []
    • 可选
    • 退款详细
    • └ channel_refund_no
    • String
    • 可选
    • 20230326220014480905581230XX
    • 渠道退款单号(正向支付宝单号)
    • └ amount
    • String
    • 可选
    • 100
    • 退款金额
    • └ pay_detail_id
    • String
    • 可选
    • 6000000202030284
    • 支付明细单号
    • └ refund_channels
    • String
    • 可选
    • {}
    • 退款详细
    refund_type String 可选 1 :售中退款 2 :售后退款 退款类型
    out_refund_order_id String 可选 123 外部退款单号
    sub_order_id String 可选 1234 子订单号
    attributes String 可选 1:11;2:22 扩展信息
    f_jlbh Number 必须 123 合同编号

    响应参数

    名称 类型 示例值 描述
    result TopResultDO 返回结果
    • └ err_msg
    • String
    • 系统错误
    • 错误信息
    • └ err_code
    • String
    • sys_err
    • 错误码
    • └ success
    • Boolean
    • false
    • 服务端成功失败

    请求示例

    • JAVA
    • .NET
    • PHP
    • CURL
    • Python
    • C/C++
    • NodeJS
    QimenCloudClient client = new DefaultQimenCloudClient(url, appkey, secret);
    TmallRefundorderSynRequest req = new TmallRefundorderSynRequest();
    req.setTradeId("123456");
    req.setFFkpzh("234");
    req.setFFksj("2018-10-10 12:12:12");
    req.setOpType("new");
    req.setFFdbh(222L);
    req.setFSky(24234234L);
    req.setFSkymc("张三");
    req.setFFkje("12.1");
    req.setFFkbz("不买了");
    List<TmallRefundorderSynRequest.RefundItemsDO> list2 = new ArrayList<TmallRefundorderSynRequest.RefundItemsDO>();
    TmallRefundorderSynRequest.RefundItemsDO obj3 = new TmallRefundorderSynRequest.RefundItemsDO();
    list2.add(obj3);
    obj3.setFXtckh("23445532");
    obj3.setFLsh("22334555");
    obj3.setFYh("3");
    obj3.setFKh("342234");
    obj3.setFFkrq("2018-10-10 12:12:12");
    obj3.setFSkje("1.1");
    obj3.setFSkfs("cash");
    obj3.setFJlbh(123L);
    obj3.setRefundChannelCode("cash");
    List<TmallRefundorderSynRequest.RefundItemDetailDO> list6 = new ArrayList<TmallRefundorderSynRequest.RefundItemDetailDO>();
    TmallRefundorderSynRequest.RefundItemDetailDO obj7 = new TmallRefundorderSynRequest.RefundItemDetailDO();
    list6.add(obj7);
    obj7.setChannelRefundNo("20230326220014480905581230XX");
    obj7.setAmount("100");
    obj7.setPayDetailId("6000000202030284");
    list4.setRefundItemDetail(list6);
    obj3.setRefundChannels("{}");
    req.setRefundItems(list2);
    req.setRefundType("1 :售中退款 2 :售后退款");
    req.setOutRefundOrderId("123");
    req.setSubOrderId("1234");
    req.setAttributes("1:11;2:22");
    req.setFJlbh(123L);
    TmallRefundorderSynResponse rsp = client.execute(req);
    System.out.println(rsp.getBody());

    响应示例

    • XML示例
    • JSON示例
    <result>
        <err_msg>系统错误</err_msg>
        <err_code>sys_err</err_code>
        <success>false</success>
    </result>
    

    异常示例

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

    错误码解释

    错误码 错误描述 解决方案
    isp.http-read-timeout

    API工具

    如何获得此API

    FAQ

    返回
    顶部