订单撤销请求
1.修订记录
| 版本 | 日期 | 说明 | 作者 |
|---|---|---|---|
| V0.1 | 2018/4/9 | 新接口参数定义 | 郭勇 |
| V0.2 | 2018/05/25 | 补充shopdate参数 | 黄国强 |
| V0.3 | 2021/01/21 | 修改ACQ_QUERY_NO_RECORD的描述 | 王晶 |
| V0.4 | 2021/12/27 | 支持国密 | 王晶 |
2.业务说明
（1）场景说明
1、对于支付交易，支付交易返回失败或支付系统超时，调用此接口来进行撤销
（2）接口说明
1、商户根据实情情况，调用撤销接口进行撤销
3.请求地址
| 环境 | HTTPS请求地址 |
|---|---|
| 正式环境 | https://openapi.ysepay.com/gateway.do |
3.1 调用说明
支付交易返回失败或支付系统超时，调用该接口撤销交易。如果此订单用户支付失败，银盛系统会将此订单关闭；如果用户支付成功，银盛系统会将此订单资金退还给用户。 注意：只有发生支付系统超时或者支付结果未知时可调用撤销，其他正常支付的单如需实现相同功能请调用申请退款API。提交支付交易后调用【查询订单API】，没有明确的支付结果再调用【撤销订单API】。
温馨提示：调用下单接口后请勿立即调用撤销订单API，建议支付后至少15s后再调用撤销订单接口
4.参数说明
4.1公共请求参数
| 参数 | 类型(长度） | Y | 参数说明 |
|---|---|---|---|
| method | String(128) | Y | 接口名称 固定值 ysepay.online.trade.cancel |
| partner_id | String(20) | Y | 在银盛支付开设的服务商商户号，请联系客户经理提供 |
| timestamp | String(19) | Y | 发送请求的时间，格式"yyyy-MM-dd HH:mm:ss" 示例值：2014-07-24 03:07:50 |
| charset | String(10) | Y | 商户网站使用的编码格式，如UTF-8、GBK、GB2312等，默认值 GBK |
| sign_type | String(10) | Y | 报文签名算法，RSA/SM |
| sign | String(256) | Y | 签名字符串，再用Base64编码 |
| version | String(3) | Y | 接口版本3.0 当前版本 3.0 |
| biz_content | String | Y | 业务请求参数的集合，最大长度不限，除公共参数外所有请求参数都必须放在这个参数中传递 |
4.2 业务请求参数
参数名biz_content,值为一个json格式对象，下面列表描述json对象的值
| 参数 | 类型(字节长度） | 必填 | 参数说明 |
|---|---|---|---|
| out_trade_no | String(1,32) | N | 商户系统生成的订单号，生成规则前8位必须为交易日期，如20180525，范围跨度支持包含当天在内的前后一天，且只能由大小写英文字母、数字、下划线及横杠组成 示例值：201805256843192280647118 |
| shopdate | String(8,8) | Y | 商户日期(该参数做交易与查询时需要一致) 该日期需在当日的前后一天时间范围之内 示例值：20180525 |
| trade_no | String(1，30) | Y | 银盛交易号 示例值：311160414497667096 |
5.响应参数说明
银盛支付对商户的请求数据处理完成后，会将处理的结果数据同步回执给商户。
请注意：银盛后期会对返回参数保留扩展的权力，扩展方式为新增参数但不会删除参数，请商户在解析银盛返回参数时要支持银盛可能扩展参数这种情况。
5.1 公共响应参数
| 参数 | 类型(字节长度） | 必填 | 参数说明 |
|---|---|---|---|
| sign | String | Y | 签名字符串，Base64编码 |
| ysepay_online_trade_cancel_response | String | Y | 业务响应参数的集合，最大长度不限 |
5.2 业务响应参数
| 参数 | 类型(字节最大长度） | 必填 | 参数说明 |
|---|---|---|---|
| code | String | Y | 响应代码 |
| msg | String | Y | 响应代码描述 |
| trade_no | String(1，30) | Y | 银盛支付平台的订单交易流水 示例值：311160414497667096 |
| out_trade_no | String(1，32) | Y | 订单支付时传入的商户订单号 示例值：68431922806471166 |
| action | String(1,10) | Y | 本次撤销触发的交易动作success:撤销成功 |
6.样例
无
7.附录
7.1 撤销请求错误码
| 错误码 | 错误描述 | 解决方案 |
|---|---|---|
| ACQ.SYSTEM_ERROR | 系统错误 | 请使用相同的参数再次调用 |
| ACQ.INVALID_PARAMETER | 参数无效 | 请求参数有错，重新检查请求后，再调用退款 |
| ACQ.ORDER_STATE_ERROR | 订单状态不支持撤销 | 请立即调用订单查询API，查询当前订单状态，并根据订单的状态决定下一步的操作。 |
| ACQ.QUERY_NO_RECORD | 暂未查询到交易，请检查订单号/流水号后重试 |