通用场景
用户确认领卡后，通过该openspi，回调商家，商家通过该接口返回相关的会员卡信息
公共请求参数
业务请求参数
body参数
template_id｜会员卡模版id必选string(32)
【描述】template_id：会员卡模版id
【示例值】20200312000000000414103000300846
out_serial_no｜外部订单号必选string(32)
【描述】out_serial_no：外部流水号，标识一次用户的开卡动作，由卡包维护全局唯一。
【示例值】1621923366000
biz_card_no｜支付宝业务卡号必选string(32)
【描述】biz_card_no：支付宝业务卡号，对应返回出参card_info中的biz_card_no字段，需回传
【示例值】000001
user_info必选string(10240)
【描述】user_info：用户提交的表单信息，json数组格式。
通用表单字段名称如下示例：
open_form_field_mobile – 手机号
open_form_field_gender – 性别
open_form_field_name – 姓名
open_form_field_birthday – 生日
open_form_field_idcard – 身份证
open_form_field_email – 邮箱
open_form_field_address – 地址
详细字段名称列表见会员卡开卡表单模板配置接口：alipay.marketing.card.formtemplate.set
注：
1. 证件类型字段(open_form_field_cert_type)返回结果取值如下:
0 -- 身份证
1 -- 护照
2 -- 港澳居民通行证
3 -- 台湾居民通行证
【示例值】[{"open_form_field_gender":"男"},{"open_form_field_mobile":"13888888888"},{"open_form_field_name":"李四"}]
以下参数 可选 传入
user_id｜蚂蚁统一会员idstring(16)
【描述】user_id：蚂蚁统一会员id
新商户建议使用open_id替代该字段。对于新商户，user_id字段未来计划逐步回收，存量商户可继续使用。如使用open_id，请确认 应用-开发配置-openid配置管理 已启用。无该配置项，可查看openid配置申请。
【示例值】2088902351536970
open_id｜开放idstring(128)
【描述】开放id 详情可查看 openid简介
【示例值】074a1cctg1lelxke4xqc0zgndid0nxi95b5lsnpazwyoco5
union_id｜支付宝用户unionid可选string(47)
【描述】union_id是支付宝用户在开放平台的唯一标识符，在配置应用分组后会返回该值。 union_id在同一分组内应用保持一致
【示例值】092asprsmhtbexlh9zgoyb2uvznc4d8izcpgktem8qiioqb
scene_code｜场景code可选string(32)
【描述】场景类型
激活：memberactivate
入会：memberjoin
【枚举值】
激活: memberactivate
入会: memberjoin
【示例值】memberactivate
out_string｜商家拉起开卡组件的传递的out_string值可选string(1024)
【描述】该值为商家拉起开卡组件的传递的out_string值，可用于该值区分不同的业务场景，禁止将该字段作为开卡流程的必要字段，否则会导致会员推广场景下的入会失败
【示例值】test
ext_info｜扩展信息可选opencardreqextinfo
【描述】扩展信息
source_app_id｜开卡承接小程序id特殊可选string(16)
【描述】小程序场景下（弹层/私域插件）承接本次入会链路的小程序id
【示例值】2021001168675277
常见请求示例
默认示例
curl -x post 'spi_implementation_url?sign=${sign}&method=spi.alipay.user.opencard.get&charset=utf-8&version=1.0&utc_timestamp=${now}&sign_type=rsa2' \
--header 'content-type: application/x-www-form-urlencoded;charset=utf-8' \
--data-urlencode 'user_id=2088902351536970' \
--data-urlencode 'open_id=074a1cctg1lelxke4xqc0zgndid0nxi95b5lsnpazwyoco5' \
--data-urlencode 'union_id=092asprsmhtbexlh9zgoyb2uvznc4d8izcpgktem8qiioqb' \
--data-urlencode 'template_id=20200312000000000414103000300846' \
--data-urlencode 'out_serial_no=1621923366000' \
--data-urlencode 'biz_card_no=000001' \
--data-urlencode 'user_info=[{"open_form_field_gender":"男"},{"open_form_field_mobile":"13888888888"},{"open_form_field_name":"李四"}]' \
--data-urlencode 'scene_code=memberactivate' \
--data-urlencode 'out_string=test' \
--data-urlencode 'ext_info={
"source_app_id":"2021001168675277"
}' 说明：spi_implementation_url是开发者在开放平台实现spi接口时填写的后端服务地址，详情请查看
业务响应参数
response
code必选string
【描述】错误码，只有两种：
成功-10000
失败-40004
返回其他值会被认为非法响应，区分大小写。
成功-10000
失败-40004
返回其他值会被认为非法响应，区分大小写。
【示例值】40004
msg必选string
【描述】错误描述，只有两种：
成功-success
失败-business failed
返回其他值会被认为非法响应，区分大小写。
成功-success
失败-business failed
返回其他值会被认为非法响应，区分大小写。
【示例值】business failed
card_info｜商户卡信息必选merchantcard
【描述】card_info：商家定义的会员卡信息
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
biz_card_no｜支付宝业务卡号可选string(32)
【描述】支付宝业务卡号
说明：
1、开卡成功后返回该参数，需要保存留用；
2、开卡/更新/删卡/查询卡接口请求中不需要传该参数；
【示例值】000001
level｜会员卡等级可选string(64)
【描述】会员卡等级（由商户自定义，并可以在卡模板创建时，定义等级信息）
【示例值】vip1
point｜会员卡积分可选string(64)
【描述】会员卡积分，积分必须为数字型（可为浮点型，带2位小数点）
【示例值】88
balance｜资金卡余额可选string(64)
【描述】资金卡余额，单位：元，精确到小数点后两位。
【示例值】124.89
template_id｜会员卡模板id可选string(32)
【描述】会员卡更换不同的卡模板（该参数仅用在会员卡更新接口中）
【示例值】20170308000000000058101000300045
custom_assets｜资产可选string(64)
【描述】会员卡自定义资产值，只供特定业务使用，通常接入无需关注
【示例值】100元
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
sub_code可选string
【描述】业务错误码，在业务失败的情况下返回，与 spi 接口文档里的“业务错误码”保持一致，值不能为 null 或 “”，在业务成功的情况下不能返回。
【示例值】illega_param
sub_msg可选string
【描述】业务错误描述，在业务失败的情况下返回。
【示例值】无效参数
open_card_ext_info｜扩展信息可选opencardextinfo
【描述】open_card_ext_info：用于传递开卡过程中附加的扩展信息
is_new_member｜开卡的用户是否是新会员可选boolean(10)
【描述】开卡的用户是否是新会员
【示例值】true
activity_id｜营销权益对应的活动编号可选string(128)
【描述】营销权益对应的活动编号
【注意事项】iot 场景专用，普通场景无需关注
【示例值】12345
result｜开卡结果可选opencardspiresultcode
【描述】result: spi开卡接口结果信息
result_code｜结果码可选string(32)
【描述】成功:success,
失败:具体失败的错误码
【示例值】success
result_desc｜结果描述可选string(64)
【描述】成功:成功,
失败:具体失败原因描述
【示例值】成功
sign必选string
【描述】签名，详见
【示例值】dzxh8eetuahoye3w1j poiphfdxoybfunn1lket/v7p4zjdyojwea6izs6hz0ydw5cp/viufub5i0/v5wens3oyr8zredqo6d futdlhdc efyckiqhbxizgngpdpdfp1pis7bdhhzrszhbrqb7o4k3dxc aanfauu4v6zdwczo=
响应示例
正常示例
{
"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",
"custom_assets": "100元",
"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"
},
"open_card_ext_info": {
"is_new_member": true,
"activity_id": "12345"
},
"result": {
"result_code": "success",
"result_desc": "成功"
}
},
"sign": "eritjkeijkjhkkkkkkkhjereeeeeeeeeee"
}说明：本示例仅供参考。
业务错误码
无业务错误码
接口工具
spi使用文档
获取sdk