接口描述:

  • 获取退款记录列表。

请求 URL:

  • http|https://host/api/v1/order_refund/method/get.refund.list/

请求方式:

  • GET
  • POST

是否授权:

  • 需要授权

业务参数:

参数名 类型 是否必须 范围值 默认值 示例值 描述
refund_no string max:50 TK_I6135… 退款流水号
order_no string max:50 PO_I10495… 订单号
out_trade_no string max:100 420000… 退款交易号
payment_no string max:50 ZF_I6135… 支付流水号
status integer in:0,1,2,3 1 退款状态,详见附属 B
begin_time datetime beforeTime:end_time 2018-06-01 00:00:00 开始时间
end_time datetime afterTime:begin_time 2018-06-30 00:00:00 结束时间
page_no integer gt:0 1 1 页码
page_size integer between:1,40 15 15 每页数量
order_type string in:asc,desc desc asc 排序方式
order_field string 见附属 A order_refund_id status 排序字段

附属 A:
in:order_refund_id,create_time,status

附属 B:
0=待处理 1=已处理 2=失败 3=撤销

响应参数:

参数名 类型 是否返回 示例值 描述
status integer 200 状态码
message string success 消息信息
data object [] 返回对象
data 类型 是否返回 示例值 描述
items array [] 列表项
total_result integer 3 合计计数
items 类型 是否返回 示例值 描述
refund_no string TK_I6135136017166080001 退款流水号
order_no string PO_I1049550470892680001 订单号
out_trade_no string 4200000112201806138875935999 退款交易号
out_trade_msg string 退款返回信息
user_id integer 1 账号编号
total_amount number 0.1 订单支付总额
amount number 0.1 退款金额
payment_no string ZF_I6135059629848380001 支付流水号
to_payment integer 3 退款方式
create_time datetime 2018-06-13 08:56:01 创建时间
update_time datetime 2018-06-13 08:56:01 更新时间
status integer 1 退款状态,详见附属 B

响应示例:

  1. {
  2. "status": 200,
  3. "message": "success",
  4. "data": {
  5. "items": [
  6. {
  7. "refund_no": "TK_I6135136017166080001",
  8. "order_no": "PO_I1049550470892680001",
  9. "out_trade_no": "4200000112201806138875935999",
  10. "out_trade_msg": "",
  11. "user_id": 1,
  12. "total_amount": 0.1,
  13. "amount": 0.1,
  14. "payment_no": "ZF_I6135059629848380001",
  15. "to_payment": 3,
  16. "create_time": "2018-06-13 08:56:01",
  17. "update_time": "2018-06-13 08:56:01",
  18. "status": 1
  19. },
  20. {
  21. "refund_no": "TK_I6135129344929870001",
  22. "order_no": "PO_I1049550470892680001",
  23. "out_trade_no": "4200000120201806130827213457",
  24. "out_trade_msg": "",
  25. "user_id": 1,
  26. "total_amount": 0.1,
  27. "amount": 0.1,
  28. "payment_no": "ZF_I6135078611653400001",
  29. "to_payment": 3,
  30. "create_time": "2018-06-13 08:54:54",
  31. "update_time": "2018-06-13 08:54:54",
  32. "status": 1
  33. },
  34. {
  35. "refund_no": "TK_I6135119346449680001",
  36. "order_no": "PO_I1049550470892680001",
  37. "out_trade_no": "2018061321001004680571090420",
  38. "out_trade_msg": "",
  39. "user_id": 1,
  40. "total_amount": 0.1,
  41. "amount": 0.1,
  42. "payment_no": "ZF_I6135096089631500001",
  43. "to_payment": 2,
  44. "create_time": "2018-06-13 08:53:14",
  45. "update_time": "2018-06-13 08:53:14",
  46. "status": 1
  47. }
  48. ],
  49. "total_result": 3
  50. }
  51. }

备注:

  1. 该接口支持条件搜索,如果不带入业务参数则使用默认值。
文档更新时间: 2018-06-24 22:20