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

tmall.nrt.order.refund.submit (创建退款请求)

创建退款请求,并执行退款

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
param_top_submit_refund_req_d_t_o TopSubmitRefundReqDto 可选 提交退款信息
  • └ memo
  • String
  • 可选
  • 备注
  • 备注
  • └ out_refund_order_id
  • String
  • 可选
  • 123456
  • 外部退款单号
  • └ refund_fee
  • String
  • 可选
  • 100
  • 退款金额
  • └ refund_reason
  • String
  • 可选
  • 不想要了
  • 退款原因
  • └ store_id
  • String
  • 可选
  • 1
  • 门店id
  • top_post_bank_card_d_t_o
  • TopPostBankCardDto
  • 可选
  • 银行卡是否T+0
  • └ bank_card_t0
  • Boolean
  • 可选
  • false
  • 是否T+0
  • └ need_pos_bank_card
  • Boolean
  • 可选
  • false
  • 是否有银行卡渠道退款
  • top_refund_channel_d_t_o_list
  • TopRefundChannelDto []
  • 可选
  • 退款渠道信息
  • └ instrument_no
  • String
  • 可选
  • 1
  • 支付流水号
  • └ max_refund_fee
  • String
  • 可选
  • 100
  • 最大可退金额
  • └ online
  • Boolean
  • 可选
  • false
  • 是否在线
  • └ paid_fee
  • String
  • 可选
  • 100
  • 支付金额
  • └ refund_channel_code
  • String
  • 可选
  • cash
  • 退款渠道
  • └ refund_channel_name
  • String
  • 可选
  • 现金
  • 退款渠道名称
  • └ refund_fee
  • String
  • 可选
  • 100
  • 退款金额
  • top_refund_channel_detail_d_t_o_s
  • TopRefundChannelDetailDto []
  • 可选
  • 渠道明细信息
  • └ amount
  • String
  • 可选
  • 1
  • 退款金额
  • └ channel_code
  • String
  • 可选
  • 1
  • 退款渠道编码
  • └ channel_desc
  • String
  • 可选
  • 1
  • 退款渠道名称
  • └ code
  • String
  • 可选
  • 1
  • 退款渠道组成编码
  • └ instrument_no
  • String
  • 可选
  • 1
  • 支付流水号
  • └ total_refund_amount
  • String
  • 可选
  • 1
  • 该渠道的退款总金额
  • └ voucher
  • Boolean
  • 可选
  • false
  • 是否是红包
  • └ trade_order_id
  • String
  • 可选
  • 1
  • 主交易单号

响应参数

名称 类型 示例值 描述
result ResultDo 1 返回结果
  • data
  • TopSubmitRefundRspDto
  • true
  • 是否成功
  • └ out_refund_order_id
  • String
  • 1123
  • 外部退款单号
  • └ refund_fee
  • String
  • 100
  • 退款金额
  • └ refund_order_id
  • String
  • 123456
  • 淘宝退款单号
  • └ refund_time
  • String
  • 2019-04-24 23:23:23
  • 退款时间
  • result_channel_list
  • TopRefundChannelDetailDto []
  • 1
  • 退款渠道信息
  • └ amount
  • String
  • 100
  • 退款金额
  • └ channel_code
  • String
  • CASH
  • 退款渠道编码
  • └ channel_desc
  • String
  • 现金
  • 退款渠道描述
  • └ code
  • String
  • CASH
  • 退款渠道组成编码
  • └ device_id
  • String
  • 1
  • 设备id
  • └ instrument_no
  • String
  • 112321
  • 支付流水号
  • └ pay_time
  • String
  • 1
  • 支付时间
  • └ pay_type
  • String
  • 1
  • 支付方式
  • └ status
  • String
  • SUCCESS
  • 渠道退款状态 SUCCEEDED("SUCCEEDED", "成功"),FAILED("FAILED", "失败"),PROCESSING("PROCESSING", "处理中")
  • └ total_refund_amount
  • String
  • 100
  • 该渠道的退款总金额
  • └ voucher
  • Boolean
  • false
  • 是否是红包
  • └ success
  • Boolean
  • true
  • 是否成功
  • └ tid
  • String
  • 123456
  • 淘宝主订单号
  • └ trade_order_id
  • String
  • 123456
  • 主订单号
  • └ err_code
  • String
  • SYS_ERROR
  • 错误码
  • └ err_msg
  • String
  • 系统异常
  • 错误消息
  • └ success
  • Boolean
  • true
  • 调用是否成功

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
TmallNrtOrderRefundSubmitRequest req = new TmallNrtOrderRefundSubmitRequest();
TmallNrtOrderRefundSubmitRequest.TopSubmitRefundReqDto obj1 = new TmallNrtOrderRefundSubmitRequest.TopSubmitRefundReqDto();
obj1.setMemo("备注");
obj1.setOutRefundOrderId("123456");
obj1.setRefundFee("100");
obj1.setRefundReason("不想要了");
obj1.setStoreId("1");
TmallNrtOrderRefundSubmitRequest.TopPostBankCardDto obj2 = new TmallNrtOrderRefundSubmitRequest.TopPostBankCardDto();
obj2.setBankCardT0(false);
obj2.setNeedPosBankCard(false);
obj1.setTopPostBankCardDTO(obj2);
List<TmallNrtOrderRefundSubmitRequest.TopRefundChannelDto> list4 = new ArrayList<TmallNrtOrderRefundSubmitRequest.TopRefundChannelDto>();
TmallNrtOrderRefundSubmitRequest.TopRefundChannelDto obj5 = new TmallNrtOrderRefundSubmitRequest.TopRefundChannelDto();
list4.add(obj5);
obj5.setInstrumentNo("1");
obj5.setMaxRefundFee("100");
obj5.setOnline(false);
obj5.setPaidFee("100");
obj5.setRefundChannelCode("cash");
obj5.setRefundChannelName("现金");
obj5.setRefundFee("100");
List<TmallNrtOrderRefundSubmitRequest.TopRefundChannelDetailDto> list8 = new ArrayList<TmallNrtOrderRefundSubmitRequest.TopRefundChannelDetailDto>();
TmallNrtOrderRefundSubmitRequest.TopRefundChannelDetailDto obj9 = new TmallNrtOrderRefundSubmitRequest.TopRefundChannelDetailDto();
list8.add(obj9);
obj9.setAmount("1");
obj9.setChannelCode("1");
obj9.setChannelDesc("1");
obj9.setCode("1");
obj9.setInstrumentNo("1");
obj9.setTotalRefundAmount("1");
obj9.setVoucher(false);
list6.setTopRefundChannelDetailDTOS(list8);
obj1.setTopRefundChannelDTOList(list4);
obj1.setTradeOrderId("1");
req.setParamTopSubmitRefundReqDTO(obj1);
TmallNrtOrderRefundSubmitResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<tmall_nrt_order_refund_submit_response>
    <result>
        <data>
            <out_refund_order_id>1123</out_refund_order_id>
            <refund_fee>100</refund_fee>
            <refund_order_id>123456</refund_order_id>
            <refund_time>2019-04-24 23:23:23</refund_time>
            <result_channel_list>
                <top_refund_channel_detail_dto>
                    <amount>100</amount>
                    <channel_code>CASH</channel_code>
                    <channel_desc>现金</channel_desc>
                    <code>CASH</code>
                    <device_id>1</device_id>
                    <instrument_no>112321</instrument_no>
                    <pay_time>1</pay_time>
                    <pay_type>1</pay_type>
                    <status>SUCCESS</status>
                    <total_refund_amount>100</total_refund_amount>
                    <voucher>false</voucher>
                </top_refund_channel_detail_dto>
            </result_channel_list>
            <success>true</success>
            <tid>123456</tid>
            <trade_order_id>123456</trade_order_id>
        </data>
        <err_code>SYS_ERROR</err_code>
        <err_msg>系统异常</err_msg>
        <success>true</success>
    </result>
</tmall_nrt_order_refund_submit_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

返回
顶部