2.6. 查询会员持有卡
接口介绍:
API endpoint: {api_domain}/api/lite-member/v1/members/cards
Verb: POST
Signature :需要签名,参考统一签名说明
请求参数:
参数 | 必填 | 类型 | 约束 | 描述 |
---|---|---|---|---|
brand_code | 1 | String | 数字,最大 32 位 | 品牌编号,系统对接前由“收钱吧”提供 |
user_channel | 1 | String | 字符串,最大 36 位 | 会员渠道。1, wechat; 2, alipay; 3, 手机号 |
user_id | 1 | String | 字符串,最大255 位 | 微信用户为 UnionID,支付宝为用户 ID,手机号用户为手机号 |
country_code | 0-1 | String | 字符串,最大36位 | 手机号区号,比如"86",如果会员渠道为3且传入手机号区号,则根据手机号码和区号去查询 |
client_member_id | 0-1 | String | 字符串,最大 36 位 | 商户端的用户 id |
balance_filter | 0-1 | String | 数字,1 位 | 0-不过滤;1-仅返回余额大于0的卡 不传该参数则不进行余额过滤 |
expired_filter | 0-1 | String | 数字,1 位 | 0-不过滤;1-仅返回未过期的卡 不传该参数则不进行过期过滤 |
返回参数:
参数 | 必填 | 类型 | 约束 | 描述 |
---|---|---|---|---|
brand_code | 1 | String | 数字,最大 32 位 | 品牌编号,返回调用方传入的值 |
user_id | 1 | String | 字符串,最大 36 位 | 微信用户为 UnionID,支付宝为用户 ID,手机号用户为手机号 |
user_channel | 1 | String | 字符串,最大 36 位 | 会员渠道。1, wechat; 2, alipay; 3, 手机号 |
client_member_id | 0-1 | String | 字符串,最大 36 位 | 商户端的用户 id |
merchant_sn | 0-1 | String | 字符串,最大 36 位 | 发卡商户编号 |
merchant_name | 0-1 | String | 字符串,最大 80 位 | 发卡商户名称 |
account_balance | 1 | String | 字符串,最大 11 位 | 账户总余额,以分为单位 |
account_available_balance | 1 | String | 字符串,最大 11 位 | 账户总可用余额,以分为单位 |
cards | 1 | Array | - | 用户持有的会员卡的集合 |
备注:如果用户尚未拥有会员卡,则cards为空数组,cards的具体定义见下的‘cards‘
cards:
参数 | 必填 | 类型 | 约束 | 描述 |
---|---|---|---|---|
card_number | 1 | String | 字符串,最大 36 位 | 卡号 |
card_name | 1 | String | 字符串,最大 36 位 | 卡名 |
card_type | 1 | String | 字符串,最大 4 位 | 1:礼品卡;3:储值账户 |
card_surface_id | 1 | String | 字符串 | 卡面 id |
card_spec_id | 1 | String | 字符串 | 卡规则 id |
card_surface_name | 0-1 | String | 字符串,最大 36 位 | 卡面名称 |
card_surface_url | 0-1 | String | 字符串 | 卡面图片地址 |
card_denomination | 1 | String | 字符串,最大 20 位 | 面额,以分为单位 |
card_balance | 1 | String | 字符串,最大 20 位 | 余额,以分为单位 |
card_net_balance | 1 | String | 字符串,最大 20 位 | 净额,以分为单位 |
discount_rate | 1 | String | 字符串,最大 20 位 | 折扣率 |
status | 1 | String | 字符串,最大 4 位 | 卡状态 1:未激活(未领取/转赠中) 2:已激活(已领取) 3:已过期 4:冻结中(退卡中) 6:已失效(已退卡) |
received_at | 1 | String | 字符串,13 位 | 领取时间,毫秒级时间戳 |
disabled_at | 1 | String | 字符串,13 位 | 失效时间,毫秒级时间戳 |
issue_store_id | 0-1 | String | 字符串,最大 36 位 | 发行门店 id |
issue_store_name | 0-1 | String | 字符串,最大 128 位 | 发行门店名 |
exchange_no | 0-1 | String | 字符串,最大 128 位 | 券兑换码 |