接口介绍
撤销接口。
参数简介
| 参数名 | 参数类型 | 参数介绍 | 是否必填 | 是否参与签名 |
|---|---|---|---|---|
| command | String(32) | 接口名，用于标识调用哪个接口，交易撤销：open.pay.reverse | 是 | 否 |
| operator_id | String(32) | 收银员的id，用于标识收款账户 | 是 | 是 |
| app | String(32) | 接入商标识 | 是 | 是 |
| sign | String(32) | 签名，详见请求签名规则 | 是 | 否 |
| local_order_no | String(64) | 接入方的本地订单号 | 否，与order_no二选一 | 是 |
| order_no | String(64) | 采宝订单号 | 否，与local_order_no二选一，优先级：order_no > local_order_no | 是 |
| timestamp | Long | 时间戳，值为当前时间距离19700101的毫秒数 | 是 | 是 |
返回值说明
| 参数名 | 所属结构 | 返回值类型 | 返回值说明 | 特殊备注 |
|---|---|---|---|---|
| success | result | boolean | 标识这次请求是否成功 | 同时也标志撤销是否成功 |
| errorCode | result | String | 错误码 | |
| errorMsg | result | String | 错误码的详细说明 | |
| sign | data | String | 签名值 | 具体参照: 接口返回值的安全校验规则 |
| timestamp | data | String | 时间戳 | 参与签名 |
返回值举例
{
"result": {
"success": false,
"errorCode":"10",
"errorMsg": "command参数为空"
},
"data":{
"sign":"" ## 签名值
,"timestamp":"" ## 时间戳，参与签名
}
}
特殊说明
如下几种情况，撤销将会返回失败，在这种情况下， 调用方重新发起一次查询请求就能获取到订单的最新状态。
接入方可以使用errorMsg来进行字符串匹配是否是这其中的情况。
| 情形介绍 | errorMsg |
|---|---|
| 订单已经付款成功 | 当前订单已经收款成功，无法执行撤销。您可以使用刷新功能同步订单最新状态！ |
| 全额退款订单 | 当前订单已经全额退款，无法执行撤销！ |
| 交易失败的订单 | 交易失败的订单无法进行撤销！ |
| 非付款类型订单（例如退款） | 此订单不支持撤销操作，请查证（只有付款订单才可以撤销）！ |