接口说明
接口英文名称:alipay.marketing.card.template.modify
请求url:https://openapi.alipay.com/v3/alipay/marketing/card/template/modify
请求方式:post
path指该参数为路径参数
query指该参数需在请求url传参
body指该参数需在请求json传参
基础版
扩展版
包含模板创建的必要参数和功能,优先推荐接入
公共请求参数
业务请求参数
body参数
request_id|请求 id必选string[1,32]
【描述】请求 id,商户自定义且需确保每次请求唯一。
【示例值】2016072100000000001
template_id|会员卡模板id必选string[1,32]
【描述】会员卡模板id。调用alipay.marketing.card.template.create(会员卡模板创建接口)创建模板后同步返回。
【示例值】201607180000001
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[0,32]
【描述】接口接入版本
【枚举值】
基础版: basic
扩展版: extend
【必选条件】当接入基础版的时候,该参数必填
【示例值】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
【示例值】2014072300007148
card_level_conf|卡级别配置可选array [1,1000]
【描述】卡级别配置
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_mobile
性别: open_form_field_gender
姓名: open_form_field_name
【示例值】["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/modify" \
-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 '{
"write_off_type":"qrcode",
"card_level_conf":[
{
"level_show_name":"黄金会员",
"level":"vip1",
"level_icon":"1t8pp00at7eo9noajkmr3aaaacmaaqec",
"level_desc":"黄金会员享受免费停车"
}
],
"mdcode_notify_conf":{
"ext_params":"{\"param1\":\"value1\",\"param2\":\"value2\"}",
"url":"https://www.ali123.com/ant/mdcode"
},
"paid_outer_card_conf":{
"open_selling_conf":{
"end_date":"2031-01-01 12:00:00",
"price_detail":[
{
"price":"99.99",
"price_type":"fixed",
"worth":"199.99",
"desc":"99购超值会员卡"
}
],
"start_date":"2021-01-01 12:00:00",
"selling_url":"https://www.alipay.com"
},
"manage_url_conf":{
"refund_url":"https://www.alipay.com",
"cycle_manage_url":"https://www.alipay.com",
"downgrade_url":"https://www.alipay.com",
"renew_url":"https://www.alipay.com",
"upgrade_url":"https://www.alipay.com"
},
"cycle_selling_conf":{
"support_cycle_sell":true,
"cycle_type":[
"year",
"quarter"
],
"cycle_selling_url":"https://www.alipay.com"
}
},
"card_spec_tag":"none",
"template_style_info":{
"front_image_enable":false,
"color":"rgb(55,112,179)",
"logo_id":"1t8pp00at7eo9noajkmr3aaaacmaaqec",
"brand_name":"可乐",
"column_info_layout":"list",
"background_id":"1t8pp00at7eo9noajkmr3aaaacmaaqec",
"feature_descriptions":[
"使用花呗卡可享受免费分期"
],
"bg_color":"rgb(55,112,179)",
"front_text_list_enable":false,
"banner_img_id":"1t8pp00at7eo9noajkmr3aaaacmaaqec",
"slogan_img_id":"1t8pp00at7eo9noajkmr3aaaacmaaqec",
"card_show_name":"花呗联名卡",
"banner_url":"http://www.baidu.com",
"slogan":"会员权益享不停"
},
"open_card_conf":{
"source_app_id":"201609191111111",
"card_rights":[
{
"logo_id":"1t8pp00at7eo9noajkmr3aaaacmaaqec",
"detail":"积分随时查,积分换好礼",
"title":"积分兑换好礼"
}
],
"open_card_source_type":"isv",
"open_card_url":"https://www.alipay.com",
"conf":"\"\""
},
"template_benefit_info":[
{
"end_date":"2016-07-31 12:12:12",
"benefit_desc":[
"消费即折扣"
],
"title":"消费即折扣",
"start_date":"2016-07-18 15:17:23"
}
],
"column_info_list":[
{
"group_title":"校园助手",
"operate_type":"openweb",
"code":"benefit_info",
"more_info":{
"descs":[
"会员生日7折"
],
"title":"会员专享权益",
"params":"{}",
"url":"http://www.baidu.com"
},
"tag":"热门",
"title":"会员专享",
"icon_id":"1t8pp00at7eo9noajkmr3aaaacmaaqec",
"value":"80"
}
],
"biz_no_suffix_len":"10",
"spi_app_id":"2014072300007148",
"field_rule_list":[
{
"rule_name":"assign_from_request",
"rule_value":"balance",
"field_name":"balance"
}
],
"card_action_list":[
{
"code":"to_clock_in",
"url_type":"url",
"text":"打卡",
"mini_app_url":{
"mini_app_id":"2018xxxxxxx",
"mini_page_param":"/index",
"mini_query_param":"abc",
"display_on_list":"false"
},
"url":"https://merchant.ali.com/ee/clock_in.do"
}
],
"biz_no_prefix":"prex",
"pub_channels":[
{
"ext_info":"{\"key\":\"value\"}",
"pub_channel":"shop_detail"
}
],
"template_id":"201607180000001",
"request_id":"2016072100000000001",
"template_form_config":{
"open_card_mini_app_id":"2019091767145019",
"fields":{
"optional":[
"open_form_field_mobile"
],
"required":[
"open_form_field_mobile"
]
}
},
"access_version":"basic",
"shop_ids":[
"2015122900077000000002409504"
]
}'
说明:本示例仅供参考。
公共响应参数
业务响应参数
template_id|会员卡模版id必选string(32)
【描述】模板id
【示例值】2016071800000000001
响应示例
正常示例
异常示例
{
"template_id":"2016071800000000001"
}
说明:本示例仅供参考。
公共错误码
前往查看业务错误码
状态码 | 错误码 | 错误描述 | 凯发app官方网站的解决方案 |
---|---|---|---|
400 | system_error | 系统繁忙 | 系统错误,查看message获取实际错误原因 |
400 | invalid_parameter | 参数有误。参数有误。 | 查看message定位问题 |
400 | template_not_exit | 卡模板不存在 | 请确认卡模板id输入是否正确 |