订单关闭接口
1.修订记录
版本号 |
日期 |
说明 |
作者 |
0.1 |
2021/9/15 |
新接口参数定义 |
王亮 |
0.2 |
2021/12/27 |
支持国密 |
王晶 |
2.业务说明
(1)场景说明
1、合单关闭订单接口
(2)接口说明
1、当订单不需要进行支付时,商户可以调用此接口关闭订单
3.请求地址
4.请求参数说明
4.1公共请求参数
参数 |
类型(字节长度) |
必填 |
参数说明 |
method |
String(128) |
Y |
接口名称,固定值 ysepay.online.trade.combine.close |
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 |
biz_content |
String |
Y |
业务请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递 |
4.2 业务请求参数
参数名biz_content,值为一个json格式对象,下面列表描述json对象的值
参数 |
类型(字节长度) |
必填 |
参数说明 |
combine_out_trade_no |
String(1,32) |
N |
商户生成的合单订单号,生成规则前8位必须为交易日期,如20180525,范围跨度支持包含当天在内的前后一天,且只能由大小写英文字母、数字、下划线及横杠组成 示例值:201805256843192280647118 |
combine_trade_no |
String(1,30) |
N |
该交易在银盛支付系统中的交易流水号。combine_out_trade_no 和 combine_trade_no 需要填一个 |
5.响应参数说明
银盛支付对商户的请求数据处理完成后,会将处理的结果数据同步回执给商户。
请注意:银盛后期会对返回参数保留扩展的权力,扩展方式为新增参数但不会删除参数,请商户在解析银盛返回参数时要支持银盛可能扩展参数这种情况。
5.1 公共响应参数
参数 |
类型(字节长度) |
必填 |
参数说明 |
sign |
String |
Y |
签名字符串,Base64编码 |
ysepay_online_trade_combine_close_response |
String |
Y |
业务响应参数的集合,最大长度不限 |
5.2 业务响应参数
参数 |
类型(字节长度) |
必填 |
参数说明 |
code |
String |
Y |
响应代码 |
msg |
String |
Y |
响应代码描述 |
combine_out_trade_no |
String(1,32) |
N |
商户生成的合单订单号。示例值:6843192280647118 |
combine_trade_no |
String(1,30) |
N |
该交易在银盛支付系统中的交易流水号。 |
6.样例
无
7.附录
7.1 关闭订单申请报文业务错误码
错误码 |
错误描述 |
解决方案 |
AQC.SYSTEM_ERROR |
系统错误 |
请使用相同的参数再次调用 |
ACQ.INVALID_PARAMETER |
参数无效 |
请求参数有错,重新检查请求后,再调用撤销 |
ACQ.REASON_TRADE_BEEN_FREEZEN |
当前交易已在支付中,不允许进行关闭 |
确认该笔交易的具体情况 |
ACQ.QUERY_NO_RECORD |
暂未查询到交易,请检查订单号/流水号后重试 |
该状态为未知状态,请勿当成失败状态处理 检查传入的订单号是否正确,修改后重新发起请求或继续查询 |