关闭订单接口

1.修订记录

版本 日期 说明 作者
V0.1 2016/4/13 新接口参数定义 郭勇
V0.2 2016/4/25 修改请求方法名称 易显群
V0.3 2016/5/20 增加业务参数说明,订单号优先于银盛流水号 易显群
V0.4 2016/6/24 修改参数trade_no字符长度 莫尚校
V0.5 2018/05/25 补充shopdate参数 黄国强
V0.6 2021/01/21 修改ACQ_QUERY_NO_RECORD的描述 王晶
V0.7 2021/12/27 支持国密 王晶

2.业务说明

(1)场景说明

1、对于不需要支付的订单,可以调用接口进行关闭操作

(2)接口说明

1、商户根据实情情况,调用接口关闭订单操作

3.请求地址

环境 HTTPS请求地址
正式环境 https://openapi.ysepay.com/gateway.do

4.参数说明

4.1公共请求参数

参数 类型(长度) Y 参数说明
method String(128) Y 接口名称 固定值 ysepay.online.trade.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 当前版本 3.0
biz_content String Y 业务请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递

4.2 业务请求参数

参数名biz_content,值为一个json格式对象,下面列表描述json对象的值

参数 类型(字节长度) 必填 参数说明
out_trade_no String(1,32) N 商户系统内部订单号 示例值:201805256843192280647118
shopdate String(8,8) Y 商户日期(该参数与做交易时一致)
trade_no String(1,30) N 该交易在银盛支付系统中的交易流水号。商户订单号和银盛交易号不能同时为空

5.响应参数

银盛支付对商户的请求数据处理完成后,会将处理的结果数据同步回执给商户。

请注意:银盛后期会对返回参数保留扩展的权力,扩展方式为新增参数但不会删除参数,请商户在解析银盛返回参数时要支持银盛可能扩展参数这种情况。

5.1 公共响应参数

参数 类型(字节长度) 必填 参数说明
sign String Y 签名字符串,Base64编码
ysepay_online_trade_close_response String Y 业务响应参数的集合,最大长度不限

5.2 业务响应参数

参数 类型(字节长度) 必填 参数说明
code String Y 响应代码
msg String Y 响应代码描述
out_trade_no String(1,32) N 商户系统内部订单号
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 暂未查询到交易,请检查订单号/流水号后重试 该状态为未知状态,请勿当成失败状态处理 检查传入的订单号是否正确,修改后重新发起请求或继续查询

results matching ""

    No results matching ""