预算扣减状态查询

1.概述

当【预算扣减】接口由于网络异常等原因未收到正确的响应消息时，美团企业版会根据预算扣减流水号【payTradeNo】字段主动向客户平台查询预算扣减状态，根据客户平台接口返回的预算扣减状态更新美团企业版交易状态，进而更新订单状态，保持双方状态一致。

1、【预算扣减状态查询】接口关注的是扣减状态，而非订单状态，扣减状态应该与订单状态相互独立；
2、客户平台需要根据美团企业版侧预算扣减流水号【payTradeNo】字段保证幂等性。即对于同一个【payTradeNo】，多次请求时返回的响应结果是相同的。

2.接口基本信息

名称	描述
请求方式	POST
调用地址	客户平台提供
调用方	美团企业版
响应方	客户平台
响应超时时间	2秒，客户需要保证此接口性能

2.1.请求体

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

content加密前数据结构

名称	类型	是否必填	示例	说明
ts	Long	是	1617085650321	13位时间戳，标识请求时间
entId	Long	是	46574	企业ID
traceId	String	是	-9164046349443560550	日志查询ID
payTradeNo	String	是	554823186753411	美团企业版侧预算扣减流水号，客户平台需要根据此字段支持幂等

2.2.响应参数

名称	类型	是否必填	示例	说明
traceId	String	是	-9164046349443560550	日志查询ID，用于排查问题
status	Integer	是	0	接口响应编码，成功返回0，失败返回编码枚举值和场景详见企业响应错误码
msg	String	否	成功	响应信息
data	String	是	UgxoCGPQIzoP	响应数据，将响应参数JSON序列化后进行加密的结果值，解密秘钥使用secretKey参数，参照：签名实例

data解密后数据结构

名称	类型	是否必填	示例	说明
payTradeNo	String	是	554823186753411	美团企业版预算扣减流水号
outPayTradeNo	String	是	202004160000000007	客户平台侧预算扣减流水号
payStatus	Integer	是	2	扣减状态 ，0： 未扣减；1：扣减中；2：扣减成功；3：扣减失败。
entPayAmount	String	是	25.12	企业支付金额(不包含随单服务费)，单位元，精确到小数点后两位
serviceFeeAmount	String	否	0.12	随单服务费 （空值表示无服务费），单位元，精确到小数点后两位

3.示例

3.1.请求示例

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

{
  "accessKey": "B3GFJIEHNEM1RLV-TK",
  "content": "UgJn07uNgW7S7fJK0R0xVbaLxoCGPQIzoP-_K4Hmp4RduGszhm2mbUs2toZhCtXKP5JGXVTZ9kGts2Wx3IJQCd90ptMoJTDB0vu7mkedEr4KZCvZn77EZLssMC5SpXilmQ-5RXHzvMIT0ASH-IXepTP_O16U37QqCkEb5L1WLy4"
}

content 明文示例

{
  "ts":1626333171,
  "traceId":"-9164046349443560550",
  "entId":100570,
  "payTradeNo":"554823186753411"
}

3.2.响应示例

{
  "traceId": "-9164046349443560550",
  "status": 0,
  "msg": "成功",
  "data": "UgJn07uNgW7S7fJK0R0xVbaLxoCGPQIzoP-_K4Hmp4RduGszhm2mbUs2toZhCtXKP5JGXVTZ9kGts2Wx3IJQCd90ptMoJTDB0vu7mkedEr4KZCvZn77EZLssMC5SpXilmQ-5RXHzvMIT0ASH-IXepTP_O16U37QqCkEb5L1WLy4"
}

data 明文示例

{
  "payTradeNo":"554823186753411",
  "outPayTradeNo" : "202004160000000007",
  "payStatus":2,
  "entPayAmount":"25.12",
  "serviceFeeAmount":"0.12"
}

4.企业响应错误码

错误码	错误描述	场景描述
411	参数错误	当出现参数类型或参数值异常情况报411错误码，如entId非Long类型
412	参数缺失	当必填参数为空的情况报412，如entId为空或payTradeNo为空
413	解密验签失败	当根据secretKey解析请求参数出现异常时，报413
416	预算扣减流水不存在	当payTradeNo值在客户平台查不到时，报416
500	内部服务异常	客户平台系统内部处理逻辑异常时返回500，如无法取得企业支付金额
501	服务繁忙	当出现接口调用频次过多或接口性能较低导致无法响应请求时返回501

5.版本记录

版本号	版本日期	更新内容
v1.0	2023-02-16	预算扣减状态查询接口