文档中心 > API类目 > 淘宝小程序API

taobao.miniapp.trade.order.refund (轻交易退款API)

轻交易退款API

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
refund_dto RefundDTO 必须 body
  • └ out_request_no
  • String
  • 必须
  • 1345223ddd
  • 外部请求号,保证请求唯一
  • └ miniapp_id
  • Number
  • 必须
  • 123455
  • 小程序id
  • └ sub_order_id
  • Number
  • 必须
  • 34455667
  • 子订单id,退款以子订单维度。主订单只有一个子订单的话,就传主订单id
  • └ order_id
  • Number
  • 可选
  • 33577899
  • 主订单id
  • └ refund_reason
  • String
  • 可选
  • 退款说明
  • 退款说明
  • └ out_order_id
  • String
  • 可选
  • 外部订单id
  • 外部订单id
  • └ refund_price
  • Number
  • 必须
  • 2
  • 退款金额,单位:分

响应参数

名称 类型 示例值 描述
successful Boolean true true or false
error_type Number 1 错误码
model RefundOrderResult 返回内容
  • └ out_request_no
  • String
  • 2367938232160328571-2
  • 外部请求号,保证请求唯一
  • └ refund_start_time
  • Date
  • 2021-12-22 11:58:53
  • 发起的退款时间
  • └ sub_order_id
  • Number
  • 2367938232160328700
  • 子订单id
  • └ order_id
  • Number
  • 2367938232158328300
  • 主订单id
  • └ refund_reason
  • String
  • 测试退款2
  • 退款说明
  • └ out_order_id
  • String
  • 99999911
  • 外部订单id
  • └ refund_end_time
  • Date
  • 2021-12-22 11:58:53
  • 退款结束时间
  • └ refund_price
  • Number
  • 2
  • 退款金额
  • └ open_id
  • String
  • 2212848258020
  • 买家id
  • └ refund_id
  • Number
  • 150190742022327200
  • 退款id
error_msg String 错误信息 错误信息

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
MiniappTradeOrderRefundRequest req = new MiniappTradeOrderRefundRequest();
MiniappTradeOrderRefundRequest.RefundDTO obj1 = new MiniappTradeOrderRefundRequest.RefundDTO();
obj1.setOutRequestNo("1345223ddd");
obj1.setMiniappId(123455L);
obj1.setSubOrderId(34455667L);
obj1.setOrderId(33577899L);
obj1.setRefundReason("退款说明");
obj1.setOutOrderId("外部订单id");
obj1.setRefundPrice(2L);
req.setRefundDto(obj1);
MiniappTradeOrderRefundResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<miniapp_trade_order_refund_response>
    <successful>true</successful>
    <error_type>1</error_type>
    <model>
        <out_request_no>2367938232160328571-2</out_request_no>
        <refund_start_time>2021-12-22 11:58:53</refund_start_time>
        <sub_order_id>2367938232160328700</sub_order_id>
        <order_id>2367938232158328300</order_id>
        <refund_reason>测试退款2</refund_reason>
        <out_order_id>99999911</out_order_id>
        <refund_end_time>2021-12-22 11:58:53</refund_end_time>
        <refund_price>2</refund_price>
        <open_id>2212848258020</open_id>
        <refund_id>150190742022327200</refund_id>
    </model>
    <error_msg>错误信息</error_msg>
</miniapp_trade_order_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

返回
顶部