开发者社区
社区提问意见反馈
开发者钉组织
扫描二维码
加入支付宝开发者钉组织
文档中心
开发文档(v3版) 
支付
私域
公域
营销
营销活动送红包
商家券
商家会员卡
接入指南
api 列表
相关资料
红包
棋盘密云
支付券
资金
会员
信用
安全
广告
小程序云
其他
api文档 > 营销 > 商家会员卡 >  > 会员卡更新接口
文档更新记录 >
收藏
订阅更新
我的文档
设置

接口说明

接口英文名称:alipay.marketing.card.update
请求url:https://openapi.alipay.com/v3/alipay/marketing/card/update
请求方式:post
path指该参数为路径参数
query指该参数需在请求url传参
body指该参数需在请求json传参
会员卡更新

公共请求参数

参数类型是否必选最大长度描述示例值
authorizationstring必选1024
请求身份信息,参考验签规则。在header参数中传递
content-typestring可选32
报文内容格式,默认需要使用application/json,加密请求使用text/plain,参考请求规则。在header参数中传递
application/json
x-http-method-overridestring可选16
http方法,对于部分不支持put、patch、delete等操作的情况,可以使用post发送请求,并通过该参数传输实际需要使用的http method,参考请求规则。在header参数中传递
put
alipay-request-idstring可选32
调用方的requestid,用于定位一次请求,需要每次请求保持唯一。排查问题时可以提供该字段,参考请求规则。在header参数中传递。
0ba7cddb1665744697169391253118
alipay-encrypt-typestring可选16
加密算法,请求使用加密能力时,需要指定加密算法,参考加解密规则。在header参数中传递
aes
alipay-root-cert-snstring可选128
支付宝根证书序列号。证书模式时,可传入该参数,支付宝服务端会校验序列号,确保调用方的证书未被篡改,参考验签规则。在header参数中传递
687b59193f3f462dd5336e5abf83c5d8_02941eef3187dddf3d3b83462e1dfcf6
alipay-app-auth-tokenstring可选128
应用授权令牌,参考代调用规则。在header参数中传递
201509bbeff9351ad1874306903e96b91d248a36

业务请求参数

body参数
target_card_no|支付宝业务卡号必选string[1,32]
【描述】支付宝业务卡号:1、3.0(历史版本)版本来源于alipay.marketing.card.open(会员卡开卡)接口开卡后获取的 card_info.biz_card_no 值;2、极速版来源于spi.alipay.user.opencard.get(会员卡开通,获取会员卡信息)请求参数中的biz_card_no值。
【示例值】000001
target_card_no_type|卡号id类型必选string[0,32]
【描述】卡号id类型
【枚举值】
支付宝业务卡号: biz_card
【示例值】biz_card
occur_time|业务发生时间必选date
【描述】业务发生时间,时间格式为"yyyy-mm-dd hh:mm:ss"。
匹配格式yyyy-mm-dd hh:mm:ss的date类型
【示例值】2020-12-27 12:12:12
card_info|商户卡信息必选merchantcard
【描述】需要修改的最新卡信息
biz_card_no|支付宝业务卡号可选string[1,32]
【描述】支付宝业务卡号 说明: 1、开卡成功后返回该参数,需要保存留用; 2、开卡/更新/删卡/查询卡接口请求中不需要传该参数;
【示例值】000001
external_card_no|商户外部会员卡卡号可选string[1,64]
【描述】用户在商户crm系统中的会员卡卡号,该参数必填。
【示例值】ext0001
open_date|开卡时间可选date
【描述】会员卡开卡时间,格式为yyyy-mm-dd hh:mm:ss。会员卡更新时,该时间不支持修改。
匹配格式yyyy-mm-dd hh:mm:ss的date类型
【示例值】2014-02-20 21:20:46
valid_date|有效期可选string[1,32]
【描述】会员卡有效期结束时间,格式为yyyy-mm-dd hh:mm:ss。会员卡更新时,该时间不支持修改。
【示例值】2020-02-20 21:20:46
level|会员卡等级可选string[0,64]
【描述】会员卡等级(由商户自定义,并可以在卡模板创建时,定义等级信息)
【示例值】vip1
point|会员卡积分可选string[0,64]
【描述】会员卡积分,积分必须为数字型(可为浮点型,带2位小数点)
【示例值】88
balance|资金卡余额可选string[0,64]
【描述】资金卡余额,单位:元,精确到小数点后两位。
【示例值】124.89
template_id|会员卡模板id可选string[1,32]
【描述】会员卡更换不同的卡模板(该参数仅用在会员卡更新接口中)
【示例值】20170308000000000058101000300045
mdcode_info|商户动态码回传信息可选mdcodeinfodto
【描述】商户动态码回传信息: 只用于当write_off_type核销类型为mdbarcode或mdqrcode时,商户调用卡更新接口回传动态码。如需使用商户动态码,请联系支付宝凯发app官方网站的技术支持获取相关文档。
code_status|动态码状态必选string[0,14]
【描述】本次回传动态码的状态: success: 本次发码成功 fail_retry: 本次发码失败,且需要支付宝重试(重新通知商户发码) fail_not_retry: 本次发码失败,且无需支付宝重试(无需重新通知商户发码)
【示例值】success
time_stamp|时间戳必选number[1,9999999999]
【描述】商户回传动态码的时间戳 (单位秒)。 即商户调接口回传动态码时刻对应的long类型时间戳,用于区分不同的发码请求。
【示例值】1496996459
code_value|动态码状态可选string[0,128]
【描述】动态码的码值: code_status为success时必填; 基于此码值生成条形码或二维码用于扫码核销。
【示例值】1kfcdy0002
expire_time|过期时间可选date
【描述】当前动态码的过期(失效)时间: code_status为success时必填。
匹配格式yyyy-mm-dd hh:mm:ss的date类型
【示例值】2017-06-09 16:25:53
front_text_list|卡面文案信息模型可选array[1,4]
【描述】卡面文案列表,1项对应1行文案,最多只能传入4行文案; 单行文案展现分为左右两部分,左边对应label字段,右边对应value; 形如: 学院 新闻学院
label|标签可选string[0,4]
【描述】文案标签
【示例值】专业
value|展示文案可选string[0,32]
【描述】展示文案
【示例值】金融贸易
front_image_id|卡面图片id可选string[0,1024]
【描述】卡面展示图片的图片id,通过接口(alipay.offline.material.image.upload)上传图片 这里预期展示的是个人照片; 图片说明:1m以内,格式bmp、png、jpeg、jpg、gif; 图片尺寸为230*295px,可等比放大;
【示例值】9fxnkgt0qfmqkal5v2bqxqaaacmaaqed
ext_info|扩展信息可选string[0,1024]
【描述】扩展信息(暂时无用)
【示例值】{"key":"value"}
merchant_card_msg_info商家会员卡消息信息可选merchantcardmsginfo
【描述】商家会员卡消息信息
changed_point|本次消息通知的变动积分可选string[0,64]
【描述】本次消息通知的变动积分,积分必须为数字型(可为浮点型,带2位小数点),格式非法则不发送消息。例如: 100,则代表增加100积分。 -100,则代表减少100积分。
【示例值】100.00
paid_outer_card_info|付费外卡信息可选paidoutercardextrainfodto
【描述】付费外卡信息,只供特定业务使用,通常接入无需关注
action|用户操作类型必选string[0,1024]
【描述】用户操作类型
【枚举值】
开通: open
升级: upgrade
降级: downgrade
【示例值】open
purchase_info|外卡基本信息必选paidoutercardpurchaseinfodto
【描述】用户购买付费外卡基本信息
source|用户操作来源必选string[0,20]
【描述】用户操作来源
【枚举值】
支付宝小程序: alipay_tiny_app
商家app: self_app
其他: other
【示例值】alipay_tiny_app
action_date|操作时间必选string[19,19]
【描述】用户购买、升级、降级、续费的操作时间。格式为:yyyy-mm-dd hh:mm:ss
【示例值】2021-08-12 12:12:12
price|用户购买金额可选string[0,12]
【描述】用户购买金额。当购买/升级/续费场景必填,单位元,精确到小数点后2位
【示例值】88.88
out_trade_no|商户订单号可选string[0,64]
【描述】商户订单号。与创建订单api:alipay.trade.create保持一致
【示例值】20150320010101001
alipay_trade_no|支付宝交易号可选string[0,64]
【描述】支付宝交易号,由api: alipay.trade.create 返回
【示例值】2015042321001004720200028594
cycle_info|用户连续购买付费卡信息必选paidoutercardcycleinfodto
【描述】用户连续购买付费卡信息
open_status|开通连续购买状态必选string[1,10]
【描述】开通连续购买状态。
【枚举值】
开通: open
关闭: close
【示例值】open
close_reason|关闭连续购买原因可选string[1,20]
【描述】关闭连续购买原因。
【枚举值】
手动关闭: manual_close
过期关闭: expire_close
关闭: close
【示例值】manual_close
cycle_type|用户开通连续购买类型可选string[1,20]
【描述】用户开通连续购买类型。
【枚举值】
年: year
季度: quarter
月: month
【示例值】year
alipay_deduct_scene|支付宝代扣场景码可选string[0,64]
【描述】支付宝代扣场景码
【示例值】paid_outer_card
alipay_deduct_product_code|支付宝代扣产品码可选string[0,64]
【描述】支付宝代扣产品码
【示例值】paid_outer_card
alipay_deduct_agreement|支付宝用户签约协议号可选string[0,64]
【描述】支付宝用户签约协议号
【示例值】20151127000928469118
常见请求示例
curl -x post \
 "https://openapi.alipay.com/v3/alipay/marketing/card/update" \
 -h "authorization: alipay-sha256withrsa app_id=${appid},timestamp=${now},nonce=${uuid},expired_seconds=600,sign=${sign}" \
 -h "alipay-request-id: ${requestid}" \
 -h "content-type: application/json" \
 -d '{
	"target_card_no_type":"biz_card",
	"occur_time":"2020-12-27 12:12:12",
	"target_card_no":"000001",
	"paid_outer_card_info":{
		"action":"open",
		"cycle_info":{
			"alipay_deduct_product_code":"paid_outer_card",
			"alipay_deduct_agreement":"20151127000928469118",
			"close_reason":"manual_close",
			"cycle_type":"year",
			"open_status":"open",
			"alipay_deduct_scene":"paid_outer_card"
		},
		"purchase_info":{
			"alipay_trade_no":"2015042321001004720200028594",
			"out_trade_no":"20150320010101001",
			"price":"88.88",
			"action_date":"2021-08-12 12:12:12",
			"source":"alipay_tiny_app"
		}
	},
	"ext_info":"{\"key\":\"value\"}",
	"card_info":{
		"open_date":"2014-02-20 21:20:46",
		"front_text_list":[
			{
				"label":"专业",
				"value":"金融贸易"
			}
		],
		"external_card_no":"ext0001",
		"valid_date":"2020-02-20 21:20:46",
		"balance":"124.89",
		"level":"vip1",
		"mdcode_info":{
			"time_stamp":1496996459,
			"code_value":"1kfcdy0002",
			"expire_time":"2017-06-09 16:25:53",
			"code_status":"success"
		},
		"front_image_id":"9fxnkgt0qfmqkal5v2bqxqaaacmaaqed",
		"biz_card_no":"000001",
		"template_id":"20170308000000000058101000300045",
		"point":"88"
	},
	"merchant_card_msg_info":{
		"changed_point":"100.00"
	}
}'
说明:本示例仅供参考。

公共响应参数

参数中文名参数英文名类型是否必选最大长度描述示例值
支付宝响应时间戳alipay-timestampstring可选32
unix时间戳,用于验签及问题排查,参考验签规则。在header参数中传递
1666004496123
支付宝响应签名alipay-signaturestring可选512
支付宝响应报文签名,参考验签规则。在header中返回
支付宝traceidalipay-traceidstring可选64
支付宝traceid ,用于排查问题使用,参考请求规则。在header中返回
0ba7cddb1665744697169391253118
支付宝随机串alipay-noncestring可选64
支付宝nonce标记,每次请求会生成不同的nonce,可用于防重放判断,参考请求规则。在header中返回
515cf24c2f78b13564e94c2a495695ab

业务响应参数

result_code|处理结果码可选string(64)
【描述】二级错误处理结果(如果公用返回结果为false,则可以看这个接口判断明细原因) 如果公用返回为true,则该字段为空
【示例值】isv.update-usercard-fail
响应示例
{
	"result_code":"isv.update-usercard-fail"
}
说明:本示例仅供参考。

公共错误码

前往查看

业务错误码

状态码错误码错误描述凯发app官方网站的解决方案
400system_error系统繁忙
服务器异常 可能发生了网络或者系统异常,导致服务调用失败,商户可以用同样的请求发起重试
400invalid_parameter参数有误
请根据接口返回的参数非法的具体错误信息,修改参数后进行重试
400card_not_exit会员卡不存在
核对所有描述卡号的字段,和开卡时的是否一致(包括支付宝业务卡号、商户外部卡号)
400no_card_type没有卡类型
卡类型判断
400paidoutercard_lack_template_config付费外卡缺少模版配置
核对付费外卡模板号是否正确
内容没有解决您的问题?您还可以前往 或 寻求帮助
凯发k8官方网娱乐官方 copyright © 支付宝(杭州)信息技术有限公司  | icp证浙b2-20160559
该文档对你是否有帮助?
当前页面目录
网站地图