GET 计算订单可退金额
接口概览
| 项目 | 内容 |
|---|---|
| 文档类型 | 后台接口 |
| 请求方式 | GET |
| 接口地址 | /DIR_ADMIN/v1/order/{id}/refund_amount |
| 所属业务 | 订单管理 |
| 来源模块/系统 | 订单管理 |
| 认证方式 | Bearer Token（管理员令牌） |
完整请求
请求
正在加载示例…失败请求
正在加载示例…接口说明
计算订单可退金额
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| id | path | integer(int32) | 是 | 订单 ID |
| host_id | query | integer(int32) | 否 | 产品 ID |
成功响应
正在加载示例…失败响应 400：请求参数或业务校验失败
正在加载示例…失败响应 401：未认证或登录已失效
正在加载示例…失败响应 403：无权执行当前操作
正在加载示例…失败响应 404：接口或业务资源不存在
正在加载示例…失败响应 500：服务器内部错误
正在加载示例…响应状态
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功响应 | 内联对象 |
| 400 | Bad Request | 请求参数或业务校验失败 | 内联对象 |
| 401 | Unauthorized | 未认证或登录已失效 | 内联对象 |
| 403 | Forbidden | 无权执行当前操作 | 内联对象 |
| 404 | Not Found | 接口或业务资源不存在 | 内联对象 |
| 500 | Internal Server Error | 服务器内部错误 | 内联对象 |
响应参数
状态码 200
| 名称 | 类型 | 必选 | 约束 | 说明 |
|---|---|---|---|---|
status | integer(int32) | 否 | — | 状态码 |
msg | string | 否 | — | 提示信息 |
data | object | 否 | — | — |
data.gateway | string | 否 | — | 支付方式标识 |
data.gateway_name | string | 否 | — | 支付方式名称 |
data.refund_credit | string | 否 | — | 已退余额部分 |
data.refund_gateway | string | 否 | — | 已退渠道部分 |
data.refund_addon | string | 否 | — | 已退插件余额部分 |
data.leave_total | string | 否 | — | 剩余可退 |
data.leave_credit | string | 否 | — | 剩余可退余额 |
data.leave_gateway | string | 否 | — | 剩余可退渠道 |
data.leave_host_amount | string | 否 | — | 产品剩余可退 |
data.host_order_item | [object] | 否 | — | — |
data.host_order_item[].id | integer(int32) | 否 | — | 订单子项 ID |
data.host_order_item[].product_name | string | 否 | — | 商品名称 |
data.host_order_item[].name | string | 否 | — | 产品标识 |
data.host_order_item[].status | string | 否 | — | 状态 Unpaid未付款 Pending开通中 Active已开通 Suspended已暂停 Deleted已删除 Failed开通失败 |
data.host_order_item[].amount | string | 否 | — | 金额 |
data.host_order_item[].description | string | 否 | — | 描述 |
失败状态码 400、401、403、404、500 共用以下结构：
| 名称 | 类型 | 必选 | 约束 | 说明 |
|---|---|---|---|---|
status | integer(int32) | 是 | — | 错误状态码 |
msg | string | 是 | — | 错误提示 |