GET 停用页面
接口概览
| 项目 | 内容 |
|---|---|
| 文档类型 | 前台接口 |
| 请求方式 | GET |
| 接口地址 | /console/v1/refund |
| 所属业务 | 插件 |
| 来源模块/系统 | 退款 |
| 认证方式 | Bearer Token（用户令牌） |
完整请求
请求
正在加载示例…失败请求
正在加载示例…接口说明
停用页面
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| 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.allow_refund | integer(int32) | 否 | — | — | 是否允许退款 0否 1是 |
| data.reason_custom | integer(int32) | 否 | — | — | 是否允许自定义原因 0否 1是 |
| data.reasons | [object] | 否 | — | — | 停用原因列表 |
| data.reasons[].id | integer(int32) | 否 | — | — | 原因ID |
| data.reasons[].content | string | 否 | — | — | 内容 |
| data.host | object | 否 | — | — | 产品信息 |
| data.host.create_time | integer(int32) | 否 | — | — | 订购时间 |
| data.host.first_payment_amount | number(double) | 否 | — | — | 订购金额 |
| data.host.amount | number(double) | 否 | — | — | 退款金额 amount为-1表示不需要退款 |
| data.config_option | [string] | 否 | — | — | 产品配置 |
| data.need_security_verify | boolean | 否 | — | — | 是否需要安全验证 |
| data.available_methods | [object] | 否 | — | — | 可用的安全验证方式列表 |
| data.available_methods[].value | string | 否 | — | — | 验证方式标识 |
| data.available_methods[].label | string | 否 | — | — | 验证方式名称 |
| data.available_methods[].tip | string | 否 | — | — | 提示信息 |
| data.available_methods[].account | string | 否 | — | — | 脱敏账户 |
| data.available_methods[].security_verify_token | string | 否 | — | — | 安全验证token |
失败状态码 400、401、403、404、500 共用以下结构：
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| status | integer(int32) | 是 | — | — | 错误状态码 |
| msg | string | 是 | — | — | 错误提示 |