接口介绍
撤销接口。
参数简介
公共参数
| 参数名 |
参数类型 |
参数介绍 |
是否必填 |
| command |
String(32) |
接口名，固定为：open.api.reverse |
是 |
| app |
String(32) |
接入商标识 |
是 |
| operator_id |
String(32) |
收银员的id，用于标识收款账户 |
是 |
| version |
String(16) |
调用的接口版本，固定为：2.0 |
是 |
| sign_type |
String(32) |
签名类型 MD5、RSA，默认MD5 |
否 |
| request_id |
String(64) |
请求报文ID，唯一定位一次报文请求，由发起方生成，应答方原样返回，uuid生成，全局唯一 |
是 |
| request_time |
String(32) |
请求发起时间，格式：yyyyMMddHHmmss，请求发起时间，应答方原样返回 |
是 |
| sign |
String(32) |
签名，详见MD5签名、RSA256签名 |
是 |
参数简介
| 参数名 |
参数类型 |
参数介绍 |
是否必填 |
| local_order_no |
String(64) |
接入方的本地订单号 |
否，与cb_order_no二选一 |
| cb_order_no |
String(64) |
采宝订单号 |
否，与local_order_no二选一，优先级：cb_order_no > local_order_no |
返回值说明
公共返回值
| 参数名 |
所属结构 |
返回值类型 |
返回值说明 |
特殊备注 |
| success |
result |
boolean |
标识这次请求是否成功 |
|
| error_code |
result |
String |
错误码 |
|
| error_msg |
result |
String |
错误码的详细说明 |
|
| request_id |
data |
String(64) |
请求报文ID |
|
| request_time |
data |
String(32) |
请求发起时间，格式：yyyyMMddHHmmss |
|
| response_time |
data |
String(32) |
请求返回时间，格式：yyyyMMddHHmmss |
|
| sign |
sign |
String |
签名值 |
具体参照: 接口验签规则 |
数据返回值
| 参数名 |
所属结构 |
返回值类型 |
返回值说明 |
特殊备注 |
|
|
|
|
返回值举例
{
"data": {
"request_id": "9b78ec3d-0d7e-44d9-ac05-7cc764c8d423",
"request_time": "20180926165148",
"response_time": "20180926165259"
},
"result": {
"success": true
},
"sign": "YhUM3WW7QAwjOAziOqFIKKD2nAMmev2/7HGvA81XzISK7X/UTAnOgLOEmySKnPzzEnclekyaHBJOViEmzmJN0a4cWbtY830sMOD2oGH1+81LKE8PZxUpc48quC7fpoDN+0Zxf+zWq4FzZkRdVdKhTbt1oDJyD3oCBgy5+JsMBs6yGGjyrVhzs2jXJHxFP72nWYSp1D5Vfjj3DWPAIzL1TOSlHtPhU5VBLVv5bC1ZtrmPJQEyQEOxnNEu0oL0Onz/91zNi1Chki+k+girHbU/+8x47BaNsup7e/12AOhIl2tH4uGTEqhYe26NB5HUjMu/JuS2e1LzhHiqHRSkLMJr8g=="
}
特殊说明
如下几种情况，撤销将会返回失败，在这种情况下， 调用方重新发起一次查询请求就能获取到订单的最新状态。
接入方可以使用error_msg来进行字符串匹配是否是这其中的情况。
| 情形介绍 |
error_msg |
| 订单已经付款成功 |
当前订单已经收款成功，无法执行撤销。您可以使用刷新功能同步订单最新状态！ |
| 全额退款订单 |
当前订单已经全额退款，无法执行撤销！ |
| 交易失败的订单 |
交易失败的订单无法进行撤销！ |
| 非付款类型订单（例如退款） |
此订单不支持撤销操作，请查证（只有付款订单才可以撤销）！ |
Js Demo
http://openapi.caibaopay.com/test/api/v2/reverse.htm