1. 三方消费
智慧营养健康餐厅
  • 外部接口
    • 三方消费
      • 卡片信息查询
        POST
      • 订单结算
        POST
      • 订单退款
        POST
  1. 三方消费

卡片信息查询

POST
/api/shop/card

接口概述#

本文档描述了卡片查询接口的详细使用方法,包括请求参数、响应格式、错误码说明等信息。

接口信息#

接口地址:https://xxx.com/api/shop/card
请求方法:POST
Content-Type:application/json
接口版本:v1.0

请求头(Header)#

请求时需要在 Header 中携带以下认证信息:
参数名类型描述示例值
accountString账号account
pwdString密码pwd
keyStringAPI 密钥key

请求参数(Body)#

参数名类型是否必填描述示例值
card_idString是卡号990000001

响应格式#

查询成功响应#

{
    "code": 0,
    "message": "查询成功",
    "data": {
        "card_id": "990000001",
        "cash_balance": "88.88",
        "subsidy_balance": "66.66",
        "mobile": "15888888888"
        "name": "王XX",
        "identity_number": "7654321",
        "department_name": "XXX项目部",
        "parent_department_name": "XXXX公司"
    },
    "trace_id": "690ebaaa5e2cf"
}

查询失败响应#

{
    "code": 1,
    "message": "缺少参数",
    "data": [],
    "trace_id": "692931283c4d6"
}
{
    "code": 1,
    "message": "卡号不存在或者异常",
    "data": [],
    "trace_id": "692931283c4d6"
}
{
    "code": 1,
    "message": "查询失败",
    "data": [],
    "trace_id": "692931283c4d6"
}

状态码说明#

状态码描述
0查询成功
1查询失败(通用错误)
说明:状态码为 0 表示成功,非 0 表示失败。

响应字段说明#

字段名类型描述
codeInteger状态码,0 表示成功,非 0 表示失败
messageString响应消息,描述操作结果
dataObject/Array响应数据,成功时包含卡片信息
data.card_idString卡号
data.cash_balanceString现金余额
data.subsidy_balanceString补贴余额
data.mobileString手机号
data.nameString姓名
data.identity_numberString身份证号
data.department_nameString二级部门(举例:XXX项目部)
data.parent_department_nameString一级部门(举例:XXX公司)
trace_idString追踪 ID,用于问题排查

trace_id 说明#

trace_id字段用于接口调用的追踪和问题排查。当接口调用出现问题时,请提供该 ID 以便技术支持人员快速定位问题。

请求参数

Header 参数

Body 参数application/json

示例
{
	"card_id": "10000009"
}

请求示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location '/api/shop/card' \
--header 'account: {{account-dev}}' \
--header 'pwd: {{pwd-dev}}' \
--header 'key: {{key-dev}}' \
--header 'Content-Type: application/json' \
--data '{
	"card_id": "10000009"
}'

返回响应

🟢200成功
application/json
Bodyapplication/json

示例
{}
下一页
订单结算
Built with