企迈云-开放平台

API 2.0

API 2.0 > 7.2 礼品卡api > 7.2.7 我的礼品卡列表

7.2.7 我的礼品卡列表

开启令牌和权限后可调用。签名方式请查看开发指南

场景描述：我的礼品卡列表

餐饮

请求地址

请求方式	版本信息	请求地址
POST	V2	http://openapi.zvcms.com/api/v2

公共参数

参数	参数类型	是否必填	默认值	描述
OpenId	string	是		密钥Id
GrantCode	string	是		授权code
Token	string	是		签名，参考《数字签名sign》
Timestamp	string	是		当前时间戳
Nonce	string	是		随机正整数
Action	string	是	user.my-cards	接口方法
Params	array	是		业务参数

请求参数

参数	参数类型	是否必填	默认值	描述
user_id	string	是		用户id
needCycleCard	int	否		不可用礼品卡里是否返回已被回收的卡 1返回被回收的 0不返回被回收的

响应参数

参数	参数类型	描述
status	bool	成功或失败标识
code	int	成功失败状态
message	string	说明
data	array
├0	array
├id	string	卡号
├gift_card_id	string	礼品卡模板id
├gift_title	string	卡名称
├par_value	string	余额
├cover	string	卡图片
├expired_desc	string	有效期说明
├deduct_amount	string	卡面总值
├bind_status	string	绑定状态 0未绑定 1已绑定
├beginAt	string	有效期开始时间
├endAt	string	有效期结束时间
├createdAt	string	创建时间
├status_desc	string	状态描述
├status	string	礼品卡的状态: 0-未知状态，1-未绑定，2-赠送中，3-已赠送，4-已绑定，5-已过期，6-已回收，7-已用完
├validType	string	有效期类型：0-未知，1-长期有效,2-自绑定日起xxx有效，3-固定日期
├isErp	string	1 非码 0或者不存在这个字段企迈

请求示例

{
    "OpenId": "6dc05b4ac175cf316d226252b05cf685",
    "GrantCode": "782c281f62",
    "Timestamp": "1547186244",
    "Nonce": "658965",
    "Token": "0%2B%2B3c6hthjwAml4ABAXOYF4Q6UY%3D",
    "Action": "user.my-cards",
    "Params": {
        "user_id": "",
        "needCycleCard": ""
    }
}

响应示例

{
    "status": "true",
    "code": "0",
    "message": "说明",
    "data": [
        {
            "id": "",
            "gift_card_id": "",
            "gift_title": "",
            "par_value": "",
            "cover": "",
            "expired_desc": "",
            "deduct_amount": "",
            "bind_status": "",
            "beginAt": "",
            "endAt": "",
            "createdAt": "",
            "status_desc": "",
            "status": "",
            "validType": "",
            "isErp": ""
        }
    ]
}

异常示例

{
    "status": true,
    "code": "异常编码，根据不同的业务返回编码",
    "message": "异常说明：查询的信息不存在"
}

错误码

{
    "status": false,
    "code": "系统错误编码：详见全局返回编码",
    "message": "系统错误说明"
}