单笔订单交易关闭

最新更新时间：2021.11.25

将未完成交易的订单关闭。

---

接口说明

请求URL： https://{domain}/os-base/trade/close/v1/open

请求方式： POST

公共请求参数

参数名	必填	类型	说明
access_id	是	string	开发者唯一标识
sign_type	是	string	固定传RSA2
time_stamp	是	long	请求时间，Linux时间戳，单位毫秒
sign	是	string	签名结果
data	是	string	将业务参数转为JSON字符串，然后使用BASE64编码的数据

详细签名方法请阅读接口加密方案

业务请求参数

名称	必填	类型	说明
ownerTradeNo	条件必填	string	商户传给开放平台的交易订单号, 与osTradeNo至少传一个
osTradeNo	条件必填	string	开放平台为商户生成的交易订单号, 与ownerTradeNo至少传一个

公共响应参数

名称	必传	类型	说明
code	是	int	请求结果code,详细请参考错误码说明)
msg	是	string	请求结果描述，失败时会返回错误原因
data	否	object	请求结果返回的业务响应参数，若无业务参数则返回空

业务响应参数

    该接口没有业务响应参数，当公共响应参数code为8888时，则代表请求成功。

SDK方法

// 创建上传数据client
TyhPaymentClient client = TyhPaymentClient.create(TyhOptions.builder()
                .accessId(ACCESS_ID)
                .secretKey(SECRET_KEY)
                .allowUpload(Boolean.TRUE)
                .build());

// 构造关闭交易参数
TradeCloseCmd cmd = TradeCloseCmd.builder()
                .ownerTradeNo("1292103218")
                .osTradeNo("329121821")   //参数二选一，至少填一个
                .build();

// 开始请求关闭交易订单
try {
    Results<String> results = client.closeTrade(cmd);
} catch (Exception e) {
    e.printStackTrace();
}
     

入参格式

{
    "ownerTradeNo" : "owner_trade_32192182",
    "osTradeNo" : "329121821"
}

出参格式：

{
  "code": 8888,
  "msg": "处理成功",
  "data": null
}

code 为 8888 表示操作成功，其它值则为失败，具体内容参见错误码说明)。