关单接口

1.概述

当订单超过支付时效，美团企业版通过关单接口向客户平台发起关单请求，客户平台需要将未付款的交易单关闭并拦截用户支付。

在交易创建后，用户在超过交易关单时间后仍然未支付成功，会触发交易关单。关单时间参考下单接口中的tradeExpiringTime。

2.接口基本信息

信息名称	信息描述
请求方式	POST
调用地址	客户平台提供
调用方	美团企业版
响应方	客户平台
响应超时时间	2.5s
调用限频	-

2.1 请求体

名称	类型	是否必填	示例	说明
accessKey	String	是	B3GFJIEHNEM1RLV-TK	美团企业版分配给客户的接入秘钥
content	String	是	UgxoCGPQIzoP	请求体内容，将请求参数JSON序列化后进行加密的结果值，参照：签名实例

content 加密前数据结构

名称	类型	是否必填	示例	说明
ts	Long	是	1617085650321	13位时间戳
traceId	String[64]	是	9042536864303509624	日志查询ID
entId	Long	是	46574	企业ID
method	String[64]	是	trade.third.pay.close	业务接口标识，此接口中的值为常量：trade.third.pay.close
tradeNo	String[64]	是	393033370136698	交易号，每笔支付的唯一标识，需要以此字段做幂等处理

2.2 响应体

名称	类型	是否必填	示例	说明
traceId	String	是	9042536864303509624	日志查询ID
status	Integer	是	0	0为成功，其他错误见错误码
msg	String	是		失败时的错误描述
data	String	是	UgJn07uNgW7S7fJK0R0xVbaLxoCGPQIzoP-_K4Hmp4RduGszhm2mbUs2toZhCtXKP5JGXVTZ9kGts2Wx3IJQCd90ptMoJTDB0vu7mkedEr4KZCvZn77EZLssMC5SpXilmQ-5RXHzvMIT0ASH-IXepTP_O16U37QqCkEb5L1WLy4	响应数据，将响应参数JSON序列化后进行加密的结果值，解密秘钥使用secretKey参数，参照：签名实例

data解密后数据结构

名称	类型	是否必填	示例	说明
tradeNo	String[64]	是	393033370136698	交易号
thirdTradeNo	String[45]	是	THIRD-393033370136698	客户平台交易号

3.请求示例

3.1 请求示例

POST /pay/close HTTP/1.1
Host: example.com
Content-Type: application/json; charset=utf-8
Accept: application/json

{
    "version": "2.0",
    "accessKey": "CC1NRDRJLC76-TK",
    "content": "xLui_V-tTTRuqDIp48uFsoCbwnemwtNaKut8miqTJutwdHrUHkzVzX0DTbhpLHBgobaOb1nm2WRBgTmFzwwuVjAHy0s6zu6p1Lw3_5ruURdHUmYhIib1Fyuc_8NjugGFo52oa-EGFk762yWtJ3PSJWg_FjNXcXIrrqAorKWJEYLEk7IYxswJHjXIbmRessLe"
}

content 明文

{
    "traceId": "5341066962544167684",
    "ts": 1676365475153,
    "entId": 101442,
    "method": "trade.third.pay.close",
    "tradeNo": "1625419465137066075"
}

3.2 响应示例

{
    "status": 0,
    "msg": "成功",
    "data": "X_1zO_wDnd_o2O9syhPYPclzSlHa--YWmYeb1NCgtD3ThvF6AlFMTsx1r8BB1as3bZtzD1fYpL81K6sWkdVHp62IumkMAPnnCSMdrGohwnA"
}

data 明文

{
    "tradeNo": "1625419465137066075",
    "thirdTradeNo": "757284834338648066"
}

4.错误码

错误码	场景	场景描述
401	参数错误
402	参数缺失	如员工信息中的参数缺失，导致无法匹配到消费人信息
403	解密验签失败
410	支付单不存在
411	退款超额
412	订单已支付	美团企业版在客户平台下单时，若客户平台发现此交易单已支付并拦截下单，应响应此错误码
500	服务端异常
501	服务繁忙（可重试）
510	员工账户不可用	员工账户不可产生消费

5.版本记录

版本号	版本日期	更新内容
V1.0	2022-11-05	初版