消费平台接口

1. 回调接口

1.1 实时消费回调数据

接口说明：消费成功以后才会回调，接口需接受 post application/json 请求

header域

名称	类型	可空	描述
appKey	String	N	平台分配
timestamp	Long	N	当前时间，Unix毫秒时间戳
sign	String	N	MD5-32(appKey+timestamp+appSecret),32小写

body域

名称	类型	可空	描述
callbackType	String	N	CONSUME_REAL_CONSUME
data	对象	N
+userId	long	N	用户id
+userName	int	N	用户名称
+money	long	N	单位：分
+consume_time	string	N	消费时间

举例：

{
"callbackType": "CONSUME_REAL_CONSUME",
"data": {
"userId": 123456,
"userName": 789,
"money": 1000,
"consume_time": "2025-03-14 12:00:00"
    }
}

1.2 消费报餐回调数据

接口说明：报餐成功后才会回调，接口需接受 post application/json 请求

header域

名称	类型	可空	描述
appKey	String	N	平台分配
timestamp	Long	N	当前时间，Unix毫秒时间戳
sign	String	N	MD5-32(appKey+timestamp+appSecret),32小写

body域

名称	类型	可空	描述
callbackType	String	N	CONSUME_REPORT_MEAL
data	对象	N
+userId	long	N	用户id
+userName	int	N	用户名称
+report_time	String	N	报餐时间yyyy-MM-dd HH:mm:ss
+meal_period_id	Long	N	餐段id
+meal_period_name	string	N	餐段名称
+meal_period_price	int	N	餐段金额

举例：

{
"callbackType": "CONSUME_REPORT_MEAL",
"data": {
"userId": 123456,
"userName": 789,
"report_time": "2025-03-14 08:00:00",
"meal_period_id": 1,
"meal_period_name": "早餐",
"meal_period_price": 500
    }
}

1.3 消费充值回调数据

接口说明：只有支付成功后才会回调，接口需接受 post application/json 请求

header域

名称	类型	可空	描述
appKey	String	N	平台分配
timestamp	Long	N	当前时间，Unix毫秒时间戳
sign	String	N	MD5-32(appKey+timestamp+appSecret),32小写

body域

名称	类型	可空	描述
callbackType	String	N	CONSUME_RECHARGE
data	对象	N
+userId	long	N	用户id
+userName	int	N	用户名称
+report_time	String	N	报餐时间
+money	long	N	充值金额单位：分
+payMoney	long	N	实际支付金额单位：分
+discountMoney	long	N	优惠金额单位：分
+payTime	string	N	支付时间yyyy-MM-dd HH:mm:ss

举例：

{
"callbackType": "CONSUME_RECHARGE",
"data": {
"userId": 123456,
"userName": 789,
"report_time": "2025-03-14 10:00:00",
"money": 10000,
"payMoney": 9000,
"discountMoney": 1000,
"payTime": "2025-03-14 10:05:00"
    }
}

2. 查询接口

2.1 查询消费记录

接口地址：POST /open-api/consume/real-consume-list

接口说明：通过此接口获取消费记录列表

请求数据

header域

名称	类型	可空	默认	描述
AccessToken	String	N		接口1获取

body域

名称	类型	描述
pageNo	int	页码
pageSize	int	每页最大1000条
startTime	string	开始时间，yyyy-MM-dd HH:mm:ss
endTime	String	结束时间，yyyy-MM-dd HH:mm:ss 注意：开始时间和结束时间差不能超过24小时

请求示例：

{
"pageNo": 1,
"pageSize": 10,
"startTime": "2025-03-13 00:00:00",
"endTime": "2025-03-14 00:00:00"
}

返回数据

名称	类型	可空	描述
code	int		0成功 1失败
msg	string
data	Object		返回结果
+has_more	boolean		是否还有更多数据 true:有 false:没有
+data	Object[]
++userId	long	N	用户id
++userName	int	N	用户名称
++workNumber	string	Y	工号
++money	long	N	消费金额单位：分
++consume_time	string	N	消费时间
++id	long	N	id
++mealName	String	Y	餐段名称
++deviceId	long	Y	设备id
++deviceName	string	Y	设备名称
++canteenId	long	Y	餐厅id
++canteenName	String	Y	餐厅名称

返回示例：

{
"code": 0,
"msg": "操作成功",
"data": {
"has_more": false,
"data": [
{
"userId": 123456,
"userName": 789,
"workNumber": "EMP123",
"money": 1000,
"consume_time": "2025-03-14 12:00:00",
"id": 1001,
"mealName": "午餐",
"deviceId": 201,
"deviceName": "食堂一楼POS机",
"canteenId": 301,
"canteenName": "一号食堂"
}
]
}
}

2.2 查询报餐记录

接口地址：POST /open-api/consume/meal-report-list

接口说明：通过此接口获取报餐数据列表

请求数据

header域

名称	类型	可空	默认	描述
AccessToken	String	N		接口1获取

body域

名称	类型	可空	默认	描述
pageNo	int	N		页码
pageSize	int	N		每页最大1000条

请求示例：

{
"pageNo": 1,
"pageSize": 10
}

返回数据

名称	类型	可空	描述
code	int		0成功 1失败
msg	string
result	Object		返回结果
+has_more	boolean		是否还有更多数据 true:有 false:没有
+data	Object[]
++userId	long	N	用户id
++userName	String	N	用户名称
++report_time	String	N	报餐时间yyyy-MM-dd
++meal_period_id	String	N	餐段id
++meal_period_name	String	N	餐段名称
++meal_price	long	N	消费金额单位：分

返回示例：

{
"code": 0,
"msg": "操作成功",
"result": {
"has_more": false,
"data": [
{
"userId": 123456,
"userName": "张三",
"report_time": "2025-03-14",
"meal_period_id": "1",
"meal_period_name": "早餐",
"meal_price": 500
}
]
}
}

2.3 查询充值记录

接口地址：POST /open-api/consume/recharge-list

接口说明：通过此接口获取充值列表

请求数据

header域

名称	类型	可空	默认	描述
AccessToken	String	N		接口1获取

body域

名称	类型	可空	默认	描述
pageNo	int			页码
pageSize	int			每页最大1000条

请求示例：

{
"pageNo": 1,
"pageSize": 10
}

返回数据

名称	类型	可空	描述
code	int		0成功 1失败
msg	string
result	Object		返回结果
+has_more	boolean		是否还有更多数据 true:有 false:没有
+data	Object[]
++userId	long	N	用户id
++userName	int	N	用户名称
++money	long	N	充值金额单位：分
++payMoney	long	N	实际支付金额单位：分
++discountMoney	long	N	优惠金额单位：分
++payTime	string	N	支付时间yyyy-MM-dd HH:mm:ss

返回示例：

{
"code": 0,
"msg": "操作成功",
"result": {
"has_more": false,
"data": [
{
"userId": 123456,
"userName": 789,
"money": 10000,
"payMoney": 9000,
"discountMoney": 1000,
"payTime": "2025-03-14 10:05:00"
}
]
}
}

2.4 查询报餐统计记录

接口地址：POST /open-api/consume/meal-report-count

接口说明：通过此接口获取报餐统计列表

请求数据

header域

名称	类型	可空	默认	描述
AccessToken	String	N		接口1获取

body域

名称	类型	可空	默认	描述
startTime	String			开始时间yyyy-MM-dd
endTime	String			结束时间yyyy-MM-dd

请求示例：

{
"startTime": "2025-03-10",
"endTime": "2025-03-14"
}

返回数据

名称	类型	可空	描述
code	int		0成功 1失败
msg	string
result	Object		返回结果
+has_more	boolean		是否还有更多数据 true:有 false:没有
+data	Object[]
++date	String	N	日期
++report	Object[]	N	套餐人数统计
+++mealName	String	N	套餐名称
+++mealNum	Long	N	报餐人数
+++manyMealNum	Long	N	报餐份数
+++noReportEatNum	Long	N	未报餐就餐人数
+++eatNum	Long	N	报餐就餐人数
+++unEatNum	Long	N	报餐未就餐人数

返回示例：

{
"code": 0,
"msg": "操作成功",
"result": {
"has_more": false,
"data": [
{
"date": "2025-03-14",
"report": [
{
"mealName": "早餐",
"mealNum": 50,
"manyMealNum": 55,
"noReportEatNum": 5,
"eatNum": 48,
"unEatNum": 2
}
]
}
]
}
}

2.5 访客就餐记录【内测中】

接口地址：POST /open-api/consume/visitor-consume-list

接口说明：通过此接口获取访客消费记录列表

请求数据

header域

名称	类型	可空	默认	描述
AccessToken	String	N		接口1获取

body域

名称	类型	描述
pageNo	int	页码
pageSize	int	每页最大1000条
day	string	查询日期yyyy-MM-dd

请求示例：

{
"pageNo": 1,
"pageSize": 10,
"day": "2025-03-14"
}

返回数据

名称	类型	可空	描述
code	int		0成功 1失败
msg	string
data	Object		返回结果
+has_more	boolean		是否还有更多数据 true:有 false:没有
+data	Object[]
++id	long	N	id,唯一标识
++money	long	N	消费金额单位：分
++remainingMoney	long		剩余金额单位：分
++deviceId	long		设备id
++deviceName	string		设备名称
++canteenId	long		餐厅id
++canteenName	String		餐厅名称
++visitorName	string		访客姓名
+mealId	Long	N	餐段id
+mealName	string	N	餐段名称
++consumeTime	string		消费时间yyyy-MM-dd HH:mm:ss

返回示例：

{
"code": 0,
"msg": "操作成功",
"data": {
"has_more": false,
"data": [
{
"id": 5001,
"money": 2000,
"remainingMoney": 3000,
"deviceId": 201,
"deviceName": "食堂一楼POS机",
"canteenId": 301,
"canteenName": "一号食堂",
"visitorName": "李四",
"mealId": 2,
"mealName": "午餐",
"consumeTime": "2025-03-14 12:15:00"
}
]
}
}

3. 支付接口

3.1 付款码支付【内测中】

接口地址：POST /open-api/consume/real-code-pay

接口说明：通过此接口进行用户付款码实时消费

请求数据

header域

名称	类型	可空	描述
AccessToken	String	N	接口1获取
appKey	String	N	平台分配
timestamp	Long	N	当前时间，Unix毫秒时间戳
sign	String	N	MD5-32(appKey+timestamp+appSecret),32小写

body域

名称	类型	可空	描述
code	String	N	付款码字符串， 99开头的长度为24位的数字
totalAmount	long	N	订单金额单位：分
discountAmount	long		优惠金额单位：分
payAmount	long	N	实际需支付金额单位：分
orderNo	string	N	商户订单号
memo	string	N	商品描述
shopId	string	N	商家id
showName	string	N	商家名称

请求示例：

{
"code": "991234567890123456789012",
"totalAmount": 1500,
"discountAmount": 200,
"payAmount": 1300,
"orderNo": "ORD20250314001",
"memo": "午餐消费",
"shopId": "SHOP001",
"showName": "一号食堂"
}

返回数据

名称	类型	描述
code	int	0成功 101余额不足 102用户不存在 103账号封禁 104用户未授权 109 其他原因
msg	string
result	Object
+userName	string	用户名称
+userBalance	long	用户余额单位：分
+userSubsidyBalance	long	用户补贴余额单位：分
+tradeNO	string	平台交易单号
+totalAmount	long	订单金额
+tradeTime	string	支付时间yyyy-MM-dd HH:mm:ss

返回示例：

{
"code": 0,
"msg": "支付成功",
"result": {
"userName": "张三",
"userBalance": 8700,
"userSubsidyBalance": 5000,
"tradeNO": "TRA20250314001",
"totalAmount": 1500,
"tradeTime": "2025-03-14 12:30:00"
}
}

1. 回调接口#

1.1 实时消费回调数据#

1.2 消费报餐回调数据#

1.3 消费充值回调数据#

2. 查询接口#

2.1 查询消费记录#

2.2 查询报餐记录#

2.3 查询充值记录#

2.4 查询报餐统计记录#

2.5 访客就餐记录【内测中】#

3. 支付接口#

3.1 付款码支付【内测中】#

1. 回调接口

1.1 实时消费回调数据

1.2 消费报餐回调数据

1.3 消费充值回调数据

2. 查询接口

2.1 查询消费记录

2.2 查询报餐记录

2.3 查询充值记录

2.4 查询报餐统计记录

2.5 访客就餐记录【内测中】

3. 支付接口

3.1 付款码支付【内测中】