开发者社区
社区提问意见反馈
开发者钉组织
扫描二维码
加入支付宝开发者钉组织
文档中心
网页&移动应用 
支付产品
私域产品
公域产品
营销产品
资金产品
会员产品
信用产品
安全产品
广告产品
其他通用产品
小程序交易投诉处理
收单资金结算到银行账户的到账消息
蚂蚁门店管理
ccm 插件化能力
学校库
分享到支付宝
商家账单数据查询及下载接口
商户自主监控
网站支付宝登录
支付宝卡包
接入指南
api 列表
相关资料
电子发票
生活缴费
中小学教育缴费
地铁线上购票
车主平台停车在线缴费
口碑开店
私域营销
支付宝加油
商家费率申请
开发 > 服务端 > 其他通用产品 > 支付宝卡包 > api 列表 > 卡券实例更新接口
收藏
订阅更新
我的文档
设置
对于已发放的卡券实例,可通过此接口更新信息,通常用于更新使用状态。

公共请求参数

参数类型是否必选最大长度描述示例值
app_idstring必选32
支付宝分配给开发者的应用id
2014072300007148
methodstring必选128
接口名称
alipay.pass.instance.update
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必选
请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递,具体参照各产品快速接入文档

业务请求参数

serial_number必选string(999)
【描述】商户指定卡券唯一值,卡券json模板中fileinfo->serialnumber字段对应的值
【示例值】209919213
channel_id必选string(999)
【描述】代理商代替商户发放卡券后,再代替商户更新卡券时,此值为商户的pid/appid
【示例值】2088918273
user_id特殊可选string(16)
【描述】支付宝用户id,新接入商户必填,历史已接入商户请尽快补传
新商户建议使用open_id替代该字段。对于新商户,user_id字段未来计划逐步回收,存量商户可继续使用。如使用open_id,请确认 应用-开发配置-openid配置管理 已启用。无该配置项,可查看openid配置申请
【示例值】2088012345678910
open_id特殊可选string(128)
【描述】支付宝用户id,新接入商户必填,历史已接入商户请尽快补传  详情可查看 openid简介
【示例值】074a1cctg1lelxke4xqc0zgndid0nxi95b5lsnpazwyoco5
tpl_params可选string(99999)
【描述】模版动态参数信息:对应模板中$变量名$的动态参数,见模板创建接口返回值中的tpl_params字段
【示例值】{"title":"券标题","channelid":"xxx","serialnumer":"xxxx"}
status可选string(99)
【描述】券状态,支持更新为used、closed两种状态
【示例值】used
verify_code可选string(999)
【描述】历史遗留,已废弃。当状态变更为used时,建议传,该值正常为模板中核销区域(operation)对应的message值。
【示例值】8612231273
verify_type可选string(99999)
【描述】历史遗留,已废弃。核销方式,该值正常为模板中核销区域(operation)对应的format值。verify_code和verify_type需同时传入。
【示例值】wave
常见请求示例
curl 'https://openapi.alipay.com/gateway.do?charset=utf-8&method=alipay.pass.instance.update&format=json&sign=${sign}&app_id=${appid}&version=1.0&sign_type=rsa2×tamp=${now}' \
 -f 'biz_content={
	"verify_type":"wave",
	"tpl_params":"{\"title\":\"券标题\",\"channelid\":\"xxx\",\"serialnumer\":\"xxxx\"}",
	"user_id":"2088012345678910",
	"open_id":"074a1cctg1lelxke4xqc0zgndid0nxi95b5lsnpazwyoco5",
	"serial_number":"209919213",
	"verify_code":"8612231273",
	"channel_id":"2088918273",
	"status":"used"
}' 
说明:本示例仅供参考。

公共响应参数

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

业务响应参数

success必选string(99)
【描述】操作成功标识【true:成功;false:失败】
【示例值】true
result必选string(9999)
【描述】接口调用返回结果信息
【示例值】{"serialnumber":"123555123","passid":"209919213","operate":"update","errorcode":"success","errormsg":"处理成功"}
响应示例
{
    "alipay_pass_instance_update_response": {
        "code": "10000",
        "msg": "success",
        "success": "true",
        "result": "{\"serialnumber\":\"123555123\",\"passid\":\"209919213\",\"operate\":\"update\",\"errorcode\":\"success\",\"errormsg\":\"处理成功\"}"
    },
    "sign": "eritjkeijkjhkkkkkkkhjereeeeeeeeeee"
}
说明:本示例仅供参考。

公共错误码

业务错误码

错误码错误描述凯发app官方网站的解决方案
kp.ae_alipass_char_not_gbk卡券传值中有非gbk的字符
确认传参字符为gbk编码
kp.ae_alipass_notexist卡券不存在
核查serial_number和channel_id传参是否符合预期,必要时请至支持中心(https://support.open.alipay.com/alipay/support/index.htm)提问,或点击右上角帮助支持→在线咨询,联系凯发k8官方网娱乐官方的技术客服来解决
kp.ae_alipass_parame_is_null参数值为null
根据返回值result的errormsg检查发券参数tpl_params是否缺失动态参数对应的值
kp.ae_alipass_params_format_error参数格式错误,一般是预期json格式的参数不符合json规范
检查参数格式是否符合json语法规范
kp.ae_alipass_params_value_invaild无效的参数传值
确认参数格式符合预期,确认传参biz_content符合json规范
kp.ae_alipass_update_error更新卡券失败
确认参数是否符合文档预期,尝试重试
kp.ae_system_error系统繁忙或系统异常
尝试重试,必要时请至支持中心(https://support.open.alipay.com/alipay/support/index.htm)提问,或点击右上角帮助支持→在线咨询,联系凯发k8官方网娱乐官方的技术客服来解决
内容没有解决您的问题?您还可以前往 或 寻求帮助
凯发k8官方网娱乐官方 copyright © 2022 支付宝(杭州)信息技术有限公司  | icp证浙b2-20160559
该文档对你是否有帮助?
当前页面目录
网站地图