预算查询

1.概述

在企业员工下单后，美团企业版交易平台通过【预算查询接口】获取企业员工预算额度，预算额度会在接下来的美团企业版收银台中展示出，引导企业员工在支付页面完成支付。

1、在美团企业版交易平台发起请求后，若企业不允许该员工支付，需要响应错误码，并将阻断支付的原因返回到【msg】字段中，该文案会直接呈现给员工；
2、如果预算额度很大（如部门预算）且企业不想在收银台展示，就需要使用到【estimateAmount】预估金额字段。预估金额通常是订单金额，但在员工承担服务费时，预估金额=订单金额+服务费金额。当预算额度比预估金额大时，企业【预算查询接口】返回的预算额度可以设置为预估金额。

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
budgetKey	String	是	12345	预算标识
estimateAmount	String	是	32.00	预估金额 ，单位元，精确到小数点后两位（不包含服务费）
sqtBizOrderId	Long	否	1531811894960001	美团企业版订单ID

2.2.响应参数

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

data解密后数据结构

名称	类型	是否必填	示例	说明
budgetKey	String	是	12345	预算标识
availableBalance	String	是	33.00	预算可用余额，单位元，支持小数点后两位

3.示例

3.1.请求示例

POST /budget/query 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,
  "budgetKey": "123",
  "sqtBizOrderId": 1531811894960001,
  "estimateAmount": "123.12"
}

3.2.响应示例

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

data 明文示例

{
  "budgetKey": "123",
  "availableBalance": "123.12"
}

4.企业响应错误码

错误码	错误描述	场景描述
411	参数错误	当出现参数类型或参数值异常情况报411错误码，如entId非Long类型
412	参数缺失	当必填参数为空的情况报412，如entId为空或tradeNo为空
413	解密验签失败	当根据secretKey解析请求参数出现异常时，报413
414	金额校验失败	当estimateAmount传值异常时，报414，如金额为0或者金额单位错误
500	内部服务异常	客户平台系统内部处理逻辑异常时返回500，如无法取得预算可用余额
501	服务繁忙	当出现接口调用频次过多或接口性能较低导致无法响应请求时返回501
502	员工账户不可用	预算余额不足或者员工账户不可用等情况返回502

5.版本记录

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