计算订单可退金额

方法概览

项目	内容
文档类型	PHP 类方法
方法标识	`app\common\model\OrderModel::orderRefundIndex`
所属业务	订单管理
来源模块/系统	订单模型

功能说明

计算订单可退金额

调用示例

$param = ['order' => 'string', 'host_id' => 1, 'addon_refund_host_id' => 1];
$result = (new \app\common\model\OrderModel())->orderRefundIndex($param);

参数

参数	类型	必填	默认值	校验规则	说明
`param.order`	`int	OrderModel`	是	—	require
`param.host_id`	`int`	否	—	—	产品ID
`param.addon_refund_host_id`	`int`	否	—	—	正在插件退款的产品ID(credit还没减掉)

返回值

返回项	类型	说明
`gateway`	`string`	支付方式标识
`gateway_name`	`string`	支付方式名称
`refund_credit`	`string`	已退余额部分
`refund_gateway`	`string`	已退渠道部分
`refund_addon`	`string`	已退插件余额部分
`leave_total`	`string`	剩余可退
`leave_credit`	`string`	剩余可退余额
`leave_gateway`	`string`	剩余可退渠道
`leave_host_amount`	`string`	产品剩余可退
`gateway_to_credit`	`string`	渠道退到余额部分,记录正值
`host_order_item[].id`	`int`	订单子项ID
`host_order_item[].product_name`	`string`	商品名称
`host_order_item[].name`	`string`	产品标识
`host_order_item[].status`	`string`	Unpaid未付款Pending开通中Active已开通Suspended已暂停Deleted已删除Failed开通失败
`host_order_item[].amount`	`string`	金额
`host_order_item[].description`	`string`	描述

正常返回

{
  "gateway": "credit",
  "gateway_name": "credit",
  "refund_credit": "string",
  "refund_gateway": "credit",
  "refund_addon": "string",
  "leave_total": "string",
  "leave_credit": "string",
  "leave_gateway": "credit",
  "leave_host_amount": "string",
  "gateway_to_credit": "credit",
  "host_order_item": [
    {
      "id": 1,
      "product_name": "示例名称",
      "name": "示例名称",
      "status": "Active",
      "amount": "string",
      "description": "192.0.2.1"
    }
  ]
}

异常情况

异常类型	说明
`Throwable`	调用失败时由具体实现抛出异常，异常信息以运行时结果为准。

本页目录