开发者社区
社区提问意见反馈
开发者钉组织
扫描二维码
加入支付宝开发者钉组织
文档中心
网页&移动应用 
支付产品
私域产品
公域产品
营销产品
支付券
商家券 2.0
商家会员卡
接入指南
api 列表
相关资料
历史文档
接入指南
api 列表
文件上传
会员卡模板管理
开卡组件
会员卡管理
营销活动送红包
红包
棋盘密云
资金产品
会员产品
信用产品
安全产品
广告产品
其他通用产品
开发 > 服务端 > 营销产品 > 商家会员卡 > 历史文档 > api 列表 > 会员卡管理 > 会员卡查询接口
文档更新记录 >
收藏
订阅更新
我的文档
设置
接入检测
即可查看检测结果)
若有未通过的接入检测项,接口将无法调通
根据卡号或者持卡人信息查询会员卡信息

公共请求参数

参数类型是否必选最大长度描述示例值
app_idstring必选32
支付宝分配给开发者的应用id
2014072300007148
methodstring必选128
接口名称
alipay.marketing.card.query
formatstring可选40
仅支持json
json
charsetstring必选10
请求使用的编码格式,如utf-8,gbk,gb2312等
utf-8
sign_typestring必选10
商户生成签名字符串所使用的签名算法类型,目前支持rsa2和rsa,推荐使用rsa2
rsa2
signstring必选344
商户请求参数的签名串,详见签名
详见示例
timestampstring必选19
发送请求的时间,格式"yyyy-mm-dd hh:mm:ss"
2014-07-24 03:07:50
versionstring必选3
调用的接口版本,固定为:1.0
1.0
app_auth_tokenstring可选40
biz_contentstring必选
请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递,具体参照各产品快速接入文档

业务请求参数

target_card_no_type|卡号id类型必选string(32)
【描述】卡号id类型
【枚举值】
外部卡号: external_card
业务卡号: biz_card
动态二维码: d_qr_code
【示例值】biz_card
target_card_no|支付宝业务卡号必选string(32)
【描述】操作卡号。 若target_card_no_type为 biz_card,则该值为业务卡号,即alipay.marketing.card.open(会员卡开卡)返回结果中的card_info#biz_card_no。 若target_card_no_type为 d_qr_code 或d_bar_code,则该值为动态码值。 若target_card_no_type为 external_card,则该值为外部卡号。
【示例值】0000001
card_user_info|持卡人信息可选carduserinfo
【描述】用户信息 填写则作为附加条件查询
user_uni_id_type|用户唯一标识类型必选string(32)
【描述】用户唯一标识类型
【枚举值】
支付宝用户id: uid
【示例值】uid
以下参数 二选一 传入必选
user_uni_id|用户唯一标识string(32)
【描述】用户唯一标识, 根据user_uni_id_type类型来定 (目前暂支持支付宝userid) 支付宝userid说明:支付宝用户号是以2088开头的16位纯数字组成
新商户建议使用open_id替代该字段。对于新商户,user_uni_id字段未来计划逐步回收,存量商户可继续使用。如使用open_id,请确认 应用-开发配置-openid配置管理 已启用。无该配置项,可查看openid配置申请
【示例值】2088302463082075
open_id|用户open_idstring(128)
【描述】用户open_id  详情可查看 openid简介
【示例值】074a1cctg1lelxke4xqc0zgndid0nxi95b5lsnpazwyoco5
ext_info|扩展信息可选string(1024)
【描述】扩展信息,暂时没有
【示例值】{"key":"value"}
template_id|会员卡模版id可选string(64)
【描述】会员卡模板id。调用alipay.marketing.card.template.create(会员卡模板创建接口)创建模板后同步返回。
【示例值】20200312000000000414103000300846
常见请求示例
curl 'https://openapi.alipay.com/gateway.do?charset=utf-8&method=alipay.marketing.card.query&format=json&sign=${sign}&app_id=${appid}&version=1.0&sign_type=rsa2×tamp=${now}' \
 -f 'biz_content={
	"target_card_no_type":"biz_card",
	"target_card_no":"0000001",
	"card_user_info":{
		"user_uni_id":"2088302463082075",
		"user_uni_id_type":"uid",
		"open_id":"074a1cctg1lelxke4xqc0zgndid0nxi95b5lsnpazwyoco5"
	},
	"template_id":"20200312000000000414103000300846",
	"ext_info":"{\"key\":\"value\"}"
}' 
说明:本示例仅供参考。

公共响应参数

参数类型是否必选最大长度描述示例值
codestring必选-
网关返回码,
40004
msgstring必选-
网关返回码描述,
business failed
sub_codestring可选-
业务返回码,参见具体的api接口文档
acq.trade_has_success
sub_msgstring可选-
业务返回码描述,参见具体的api接口文档
交易已被支付
signstring必选-
签名,
dzxh8eetuahoye3w1j poiphfdxoybfunn1lket/v7p4zjdyojwea6izs6hz0ydw5cp/viufub5i0/v5wens3oyr8zredqo6d futdlhdc efyckiqhbxizgngpdpdfp1pis7bdhhzrszhbrqb7o4k3dxc aanfauu4v6zdwczo=

业务响应参数

card_info|商户卡信息必选merchantcard
【描述】商户卡信息
biz_card_no|支付宝业务卡号可选string(32)
【描述】支付宝业务卡号 说明: 1、开卡成功后返回该参数,需要保存留用; 2、开卡/更新/删卡/查询卡接口请求中不需要传该参数;
【示例值】000001
external_card_no|商户外部会员卡卡号可选string(64)
【描述】用户在商户crm系统中的会员卡卡号,该参数必填。
【示例值】ext0001
open_date|开卡时间可选date(32)
【描述】会员卡开卡时间,格式为yyyy-mm-dd hh:mm:ss。会员卡更新时,该时间不支持修改。
【示例值】2014-02-20 21:20:46
valid_date|有效期可选string(32)
【描述】会员卡有效期结束时间,格式为yyyy-mm-dd hh:mm:ss。会员卡更新时,该时间不支持修改。
【示例值】2020-02-20 21:20:46
level|会员卡等级可选string(64)
【描述】会员卡等级(由商户自定义,并可以在卡模板创建时,定义等级信息)
【示例值】vip1
point|会员卡积分可选string(64)
【描述】会员卡积分,积分必须为数字型(可为浮点型,带2位小数点)
【示例值】88
balance|资金卡余额可选string(64)
【描述】资金卡余额,单位:元,精确到小数点后两位。
【示例值】124.89
template_id|会员卡模板id可选string(32)
【描述】会员卡更换不同的卡模板(该参数仅用在会员卡更新接口中)
【示例值】20170308000000000058101000300045
mdcode_info|商户动态码回传信息可选mdcodeinfodto(1024)
【描述】商户动态码回传信息: 只用于当write_off_type核销类型为mdbarcode或mdqrcode时,商户调用卡更新接口回传动态码。如需使用商户动态码,请联系支付宝凯发app官方网站的技术支持获取相关文档。
code_status|动态码状态必选string(14)
【描述】本次回传动态码的状态: success: 本次发码成功 fail_retry: 本次发码失败,且需要支付宝重试(重新通知商户发码) fail_not_retry: 本次发码失败,且无需支付宝重试(无需重新通知商户发码)
【示例值】success
time_stamp|时间戳必选number(20)
【描述】商户回传动态码的时间戳 (单位秒)。 即商户调接口回传动态码时刻对应的long类型时间戳,用于区分不同的发码请求。
【示例值】1496996459
code_value|动态码状态可选string(128)
【描述】动态码的码值: code_status为success时必填; 基于此码值生成条形码或二维码用于扫码核销。
【示例值】1kfcdy0002
expire_time|过期时间可选date(19)
【描述】当前动态码的过期(失效)时间: code_status为success时必填。
【示例值】2017-06-09 16:25:53
front_text_list|卡面文案信息模型可选cardfronttextdto[](1024)
【描述】卡面文案列表,1项对应1行文案,最多只能传入4行文案; 单行文案展现分为左右两部分,左边对应label字段,右边对应value; 形如: 学院 新闻学院
label|标签可选string(4)
【描述】文案标签
【示例值】专业
value|展示文案可选string(32)
【描述】展示文案
【示例值】金融贸易
front_image_id|卡面图片id可选string(1024)
【描述】卡面展示图片的图片id,通过接口(alipay.offline.material.image.upload)上传图片 这里预期展示的是个人照片; 图片说明:1m以内,格式bmp、png、jpeg、jpg、gif; 图片尺寸为230*295px,可等比放大;
【示例值】9fxnkgt0qfmqkal5v2bqxqaaacmaaqed
schema_url|schema地址可选string(64)
【描述】商家会员卡页面跳转到支付宝卡券详情页面的schema地址
【示例值】alipays://platformapi/startapp?appid=20000021&b=m&p=111
pass_id商家会员卡页面跳转到支付宝卡券详情页的pass_id可选string(32)
【描述】商家会员卡页面跳转到支付宝卡券详情页的pass_id,对应schema地址中的参数p, 主要用于小程序跳往会员卡详情的链接拼接
【示例值】21942125
paid_outer_card_info|付费外卡信息可选paidoutercardextrainfodto
【描述】付费外卡信息,只供特定业务使用,通常接入无需关注
action|用户操作类型必选string(1024)
【描述】用户操作类型
【枚举值】
开通: open
升级: upgrade
降级: downgrade
【示例值】open
purchase_info|外卡基本信息必选paidoutercardpurchaseinfodto
【描述】用户购买付费外卡基本信息
source|用户操作来源必选string(20)
【描述】用户操作来源
【枚举值】
支付宝小程序: alipay_tiny_app
商家app: self_app
其他: other
【示例值】alipay_tiny_app
action_date|操作时间必选string(19)
【描述】用户购买、升级、降级、续费的操作时间。格式为:yyyy-mm-dd hh:mm:ss
【示例值】2021-08-12 12:12:12
price|用户购买金额可选string(12)
【描述】用户购买金额。当购买/升级/续费场景必填,单位元,精确到小数点后2位
【示例值】88.88
out_trade_no|商户订单号可选string(64)
【描述】商户订单号。与创建订单api:alipay.trade.create保持一致
【示例值】20150320010101001
alipay_trade_no|支付宝交易号可选string(64)
【描述】支付宝交易号,由api: alipay.trade.create 返回
【示例值】2015042321001004720200028594
cycle_info|用户连续购买付费卡信息必选paidoutercardcycleinfodto
【描述】用户连续购买付费卡信息
open_status|开通连续购买状态必选string(10)
【描述】开通连续购买状态。
【枚举值】
开通: open
关闭: close
【示例值】open
close_reason|关闭连续购买原因可选string(20)
【描述】关闭连续购买原因。
【枚举值】
手动关闭: manual_close
过期关闭: expire_close
关闭: close
【示例值】manual_close
cycle_type|用户开通连续购买类型可选string(20)
【描述】用户开通连续购买类型。
【枚举值】
年: year
季度: quarter
月: month
【示例值】year
alipay_deduct_scene|支付宝代扣场景码可选string(64)
【描述】支付宝代扣场景码
【示例值】paid_outer_card
alipay_deduct_product_code|支付宝代扣产品码可选string(64)
【描述】支付宝代扣产品码
【示例值】paid_outer_card
alipay_deduct_agreement|支付宝用户签约协议号可选string(64)
【描述】支付宝用户签约协议号
【示例值】20151127000928469118
响应示例
{
    "alipay_marketing_card_query_response": {
        "code": "10000",
        "msg": "success",
        "card_info": {
            "biz_card_no": "000001",
            "external_card_no": "ext0001",
            "open_date": "2014-02-20 21:20:46",
            "valid_date": "2020-02-20 21:20:46",
            "level": "vip1",
            "point": "88",
            "balance": "124.89",
            "template_id": "20170308000000000058101000300045",
            "mdcode_info": {
                "code_status": "success",
                "code_value": "1kfcdy0002",
                "expire_time": "2017-06-09 16:25:53",
                "time_stamp": 1496996459
            },
            "front_text_list": [
                {
                    "label": "专业",
                    "value": "金融贸易"
                }
            ],
            "front_image_id": "9fxnkgt0qfmqkal5v2bqxqaaacmaaqed"
        },
        "schema_url": "alipays://platformapi/startapp?appid=20000021&b=m&p=111",
        "pass_id": "21942125",
        "paid_outer_card_info": {
            "action": "open",
            "purchase_info": {
                "source": "alipay_tiny_app",
                "price": "88.88",
                "action_date": "2021-08-12 12:12:12",
                "out_trade_no": "20150320010101001",
                "alipay_trade_no": "2015042321001004720200028594"
            },
            "cycle_info": {
                "open_status": "open",
                "close_reason": "manual_close",
                "cycle_type": "year",
                "alipay_deduct_scene": "paid_outer_card",
                "alipay_deduct_product_code": "paid_outer_card",
                "alipay_deduct_agreement": "20151127000928469118"
            }
        }
    },
    "sign": "eritjkeijkjhkkkkkkkhjereeeeeeeeeee"
}
说明:本示例仅供参考。

公共错误码

业务错误码

错误码错误描述凯发app官方网站的解决方案
system_error系统繁忙
服务器异常 可能发生了网络或者系统异常,导致服务调用失败,商户可以用同样的请求发起重试
invalid_parameter参数有误
请根据接口返回的参数非法的具体错误信息,修改参数后进行重试
card_not_exit会员卡不存在
确认卡信息
no_card_type卡类型不正确
确认是否创建模板
凯发k8官方网娱乐官方 copyright © 2022 支付宝(杭州)信息技术有限公司  | icp证浙b2-20160559
该文档对你是否有帮助?
当前页面目录
为开发者能享受更简单的协议处理逻辑、更丰富的开源工具配套、更低的接口响应时延,支付宝开放平台推出符合oas3.0规范的,助力开发体验。新版本文档请点击“查看v3版本”进行访问。
网站地图