接口说明
接口英文名称：alipay.marketing.card.template.create
请求url：https://openapi.alipay.com/v3/alipay/marketing/card/template/create
请求方式：post
path指该参数为路径参数
query指该参数需在请求url传参
body指该参数需在请求json传参
基础版
扩展版
包含模板创建的必要参数和功能，优先推荐接入
公共请求参数
业务请求参数
body参数
request_id｜请求 id必选string[0,32]
【描述】请求id，商家自定义且并保证唯一性。
【示例值】2024072100000001234
template_style_info｜模板样式信息必选templatestyleinfodto
【描述】模板样式信息
card_show_name｜钱包端显示名称必选string[0,10]
【描述】钱包端显示名称
【示例值】花呗联名卡
logo_id｜logo的图片id必选string[0,1000]
【描述】logo的图片id，通过接口（alipay.offline.material.image.upload）上传图片
图片说明：1m以内，格式bmp、png、jpeg、jpg、gif；
尺寸不小于500*500px的正方形；
请优先使用商家logo；
图片说明：1m以内，格式bmp、png、jpeg、jpg、gif；
尺寸不小于500*500px的正方形；
请优先使用商家logo；
【示例值】1t8pp00at7eo9noajkmr3aaaacmaaqec
background_id｜背景图片id必选string[0,1000]
【描述】背景图片id，通过接口（alipay.offline.material.image.upload）上传图片
图片说明：2m以内，格式：bmp、png、jpeg、jpg、gif；
尺寸不小于1020*643px；
图片不得有圆角，不得拉伸变形
图片说明：2m以内，格式：bmp、png、jpeg、jpg、gif；
尺寸不小于1020*643px；
图片不得有圆角，不得拉伸变形
【示例值】1t8pp00at7eo9noajkmr3aaaacmaaqec
brand_name｜品牌商名称必选string[0,100]
【描述】品牌商名称
【示例值】可乐
access_version｜接入版本条件必选string[5,6]
【描述】接入版本
【枚举值】
basic: 基础版
extend: 扩展版
【必选条件】当选择基础版本的时候需要传入access_version
【示例值】basic
spi_app_id｜spi应用id条件必选string[0,32]
【描述】spi应用id，为实现spi.alipay.user.opencard.get接口的app_id。若是第三方代理模式，可以设置成服务商的 appid 或者是商家自己的 appid；
若不是第三方代理模式，只能设置商家自己的 appid。
若不是第三方代理模式，只能设置商家自己的 appid。
【必选条件】当接入的版本为3.1(极速版)的时候必须传入此appid
【示例值】2021001160639010
notify_url｜通知地址可选string
【描述】支付宝服务器主动通知商户服务器里指定的页面http/https路径。在body参数中传递
【示例值】http://api.test.alipay.net/atinterface/receive_notify.htm
card_level_conf｜卡级别配置可选array
【描述】卡级别配置
level｜会员级别必选string[0,64]
【描述】会员级别 该级别和开卡接口中的level要一致
【示例值】vip1
level_show_name｜会员级别显示名称必选string[0,64]
【描述】会员级别显示名称
【示例值】黄金会员
level_icon｜会员级别对应icon图片可选string[0,64]
【描述】会员级别对应icon图片，
会员信息预留字段，暂不在用户端展示；
通过接口（alipay.offline.material.image.upload）上传图片
会员信息预留字段，暂不在用户端展示；
通过接口（alipay.offline.material.image.upload）上传图片
【示例值】1t8pp00at7eo9noajkmr3aaaacmaaqec
level_desc｜会员级别描述可选string[0,4000]
【描述】会员级别描述
【示例值】黄金会员享受免费停车
template_form_config｜入会表单配置可选templateformconfig
【描述】入会表单配置，包括入会表单的字段，入会弹层承接小程序appid等
fields｜表单字段可选templateformfields
【描述】表单可选字段，required里面的选项与optional里面的选项不能存在重复
required｜必填字段可选array[0,10]
【描述】开卡表单必填字段，必填字段必须有一个值，并且不能与可选字段optional里面重复，字段有效值如下列表所示：
【枚举值】
姓名: open_form_field_name
手机号: open_form_field_mobile
性别: open_form_field_gender
【示例值】["open_form_field_mobile"]
optional｜可选字段可选array[0,10]
【描述】表单可填字段，可选字段选项不能与必填字段required重复，字段有效值如下列表所示：
【枚举值】
姓名: open_form_field_name
手机号: open_form_field_mobile
性别: open_form_field_gender
【示例值】["open_form_field_mobile"]
open_card_mini_app_id｜入会承接弹层的小程序appid可选string[0,64]
【描述】入会时承接入会弹层的小程序appid
【示例值】2019091767145019
常见请求示例
创建标准会员卡模版
默认示例
curl -x post \
"https://openapi.alipay.com/v3/alipay/marketing/card/template/create" \
-h "authorization: alipay-sha256withrsa app_id=${appid},timestamp=${now},nonce=${uuid},expired_seconds=600,sign=${sign}" \
-h "alipay-request-id: ${requestid}" \
-h "alipay-app-auth-token: ${app_auth_token}" \
-h "content-type: application/json" \
-d '{
"access_version":"basic",
"request_id":"20211131123123538021",
"template_style_info":{
"card_show_name":"这是卡名称",
"logo_id":"1t8pp00at7eo9noajkmr3aaaacmaaqec",
"background_id":"1t8pp00at7eo9noajkmr3aaaacmaaqec",
"brand_name":"这是商户名称"
},
"card_level_conf":[
{
"level":"vip1",
"level_show_name":"黄金会员"
},
{
"level":"vip2",
"level_show_name":"铂金会员"
}
],
"template_form_config":{
"open_card_mini_app_id":"2024001234502222",
"fields":{
"required":[
"open_form_field_name"
],
"optional":[
"open_form_field_gender"
]
}
},
"spi_app_id":"2024001234502222"
}'
说明：本示例仅供参考。
公共响应参数
业务响应参数
template_id｜会员卡模板id必选string(32)
【描述】支付宝卡模板id
【示例值】201607180000001
响应示例
正常示例
异常示例
{
"template_id":"201607180000001"
}说明：本示例仅供参考。
公共错误码
前往查看业务错误码
| 状态码 | 错误码 | 错误描述 | 凯发app官方网站的解决方案 |
|---|---|---|---|
| 400 | system_error | 系统繁忙，请稍后重试 | 系统繁忙，请稍后重试 |
| 400 | invalid_parameter | 参数有误。参数有误。 | 查看message定位问题 |
| 400 | no_card_type | card_type类型不存在 | 请检查card_type是否按文档要求范围传入 |
| 400 | template_not_exit | 模板不存在 | 查看模板 |
| 400 | template_over_limit | 模板数量超限 | 每个商家可创建的会员卡模板数量有限，请尽量复用已有模板。若为合理诉求需要增加，突破默认限制，请联系商务申请扩大数量配额 |
关联异步通知
触发通知类型
| 通知类型 | 描述 | 默认开启 |
|---|---|---|
| tradestatus.trade_success | 处理成功 | 1 |
触发通知示例
https://www.merchant.com/receive_notify.htm?notify_type=trade_status_sync¬ify_id=91722adff935e8cfa58b3aabf4dead6ibe¬ify_time=2017-02-16 21:46:15&sign_type=rsa2&sign=wco t3d8kg71dtlkwn7r9pzuoxeabjwp8/fousxcuskxsovyxbpsaidpryscjhcjmaglncjokjqlj28/asl93jotw39fx6i07lxhnbpknezalwmvpdnqui01hzszf9v1i6ggzjbiad5lg8bzttxzoj87ub2i9guj3nr/nuc9vey=&card_type=null&external_card_no=null&user_id=null&card_status=null&template_id=null&request_id=null&process_time=null&event_code=treate_pay&biz_card_no=1000000089&trade_no=20170425000000000001&out_trade_no=201704250000000000001&total_amount=23.20&buyer_pay_amount=23.23&gmt_payment=2017-04-25 14:51:22&merchant_uid=2088202855218634&open_id=用户openid