基本信息
| Item |
Info |
| URL |
/nsc/v1/orders/{order_id}/cancel |
| Method |
POST |
| Content-Type: |
application/json |
接口输入参数
| 参数名 |
必选 |
类型 |
说明 |
| channel |
是 |
string |
渠道，系统会对 channel 和 app_id 做相关性校验 |
| user_id |
否 |
string |
用户名，nio 用户传入 |
| channel_user_id |
否 |
string |
渠道用户名，企业对接必传 |
| order_id |
是 |
string |
用户订单 id。全局唯一, 路径参数 |
| reasons |
否 |
list |
取消原因列表，参见 枚举值定义-CancelReason |
| -- code |
是 |
integer |
取消原因 code |
| -- name |
是 |
string |
取消原因 name |
注意：user_id和channel_user_id必传且只传其一
返回参数说明
| 键 |
类型 |
说明 |
| request_id |
string |
见 API 规范 |
| result_code |
string |
见 API 规范 |
| debug_msg |
string |
见 API 规范 |
| display_msg |
string |
见 API 规范 |
| server_time |
long |
见 API 规范 |
返回示例
{
"request_id":"12334q83mdcc0-22435",
"result_code":"success",
"debug_msg":"success",
"display_msg":"success",
"server_time":1518143886
}
取消订单 result code
| result_code |
说明 |
| illegal_state_transfer |
状态转移不合法 |
| illegal_order_cancellation |
专员已经开始加电，取消订单失败 |
| service_consumption_not_found |
订单无支付方式相关信息 |
| invalid_service_consumption_type |
无效的订单支付方式 |