通用场景
卡券模板生成后,如需将卡券发布给对应的用户,则调用此接口。
公共请求参数
业务请求参数
tpl_id必选string(999)
【描述】 支付宝pass模版id。通过alipay.pass.template.add(卡券模板创建接口)创建模板后返回的tpl_id。
【示例值】f038871a4b1151e8038bb9277c3d52e3
tpl_params必选string(99999)
【描述】模版动态参数信息,对应模板中$变量名$的动态参数。对应alipay.pass.template.add(卡券模板创建接口)创建模板后返回tpl_params字段。
【示例值】{"title":"券标题","channelid":"xxx","serialnumber":"xxxx"}
recognition_type必选string(999)
【描述】alipass添加对象识别类型,枚举如下:
1:订单信息;
2:基于用户信息识别。
说明:支付宝卡包场景暂仅支持 2。
【示例值】2
recognition_info必选string(999)
【描述】支付宝用户识别信息,详见 调用接口发券。
【示例值】{"recognition_info":{"user_id":"2088402021319452"}}
常见请求示例
默认示例
curl 'https://openapi.alipay.com/gateway.do?charset=utf-8&method=alipay.pass.instance.add&format=json&sign=${sign}&app_id=${appid}&version=1.0&sign_type=rsa2×tamp=${now}' \
-f 'app_auth_token=${app_auth_token}' \
-f 'biz_content={
"tpl_id":"f038871a4b1151e8038bb9277c3d52e3",
"tpl_params":"{\"title\":\"券标题\",\"channelid\":\"xxx\",\"serialnumber\":\"xxxx\"}",
"recognition_type":"2",
"recognition_info":"{\"recognition_info\":{\"user_id\":\"2088402021319452\"}}"
}' 说明:本示例仅供参考。
公共响应参数
业务响应参数
success必选string(99)
【描述】操作成功标识【true:成功;false:失败】
【示例值】true
result必选string(9999)
【描述】接口调用返回结果信息
serialnumber:唯一核销凭证串号(必须由动态传参指定)
passid:券唯一id
operation:本次调用的操作类型,add
errorcode:处理结果码(错误码)
errormsg:处理结果说明(错误说明)
【示例值】{"serialnumber":"123555123","passid":"209919213","operate":"add","errorcode":"success","errormsg":"处理成功"}
响应示例
正常示例
异常示例
{
"alipay_pass_instance_add_response": {
"code": "10000",
"msg": "success",
"success": "true",
"result": "{\"serialnumber\":\"123555123\",\"passid\":\"209919213\",\"operate\":\"add\",\"errorcode\":\"success\",\"errormsg\":\"处理成功\"}"
},
"sign": "eritjkeijkjhkkkkkkkhjereeeeeeeeeee"
}说明:本示例仅供参考。
公共错误码
业务错误码
| 错误码 | 错误描述 | 凯发app官方网站的解决方案 |
|---|---|---|
| kp.ae_alipass_appid_nosupport | 该appid在黑名单中,因而不支持发券 | 请至支持中心(https://support.open.alipay.com/alipay/support/index.htm)提问,或点击右上角帮助支持→在线咨询,联系凯发k8官方网娱乐官方的技术客服来解决 |
| kp.ae_alipass_char_not_gbk | 卡券传值中有非gbk的字符 | 确认传参字符为gbk编码 |
| kp.ae_alipass_json_format_error | 卡券实例数据结构错误 | 检查1.卡券模版动态变量格式必须为$var$,$必须成对出现。2.卡券实例变量值不包含$和'等容易造成json格式错乱的特殊符号。 |
| kp.ae_alipass_not_allowed_add_twice | 不支持多人添加 | 同一卡券实例不允许发给多个用户。 |
| kp.ae_alipass_parame_is_null | 参数值为null | 根据返回值result的errormsg检查发券参数tpl_params是否缺失动态参数对应的值 |
| kp.ae_alipass_params_format_error | 参数格式不正确或调用参数biz_content整体非json格式 | 确认参数格式符合预期,确认传参biz_content符合json规范 |
| kp.ae_alipass_params_value_invaild | 无效的参数传值 | 核查tpl_params中的参数格式是否正确,例如时间参数等。 |
| kp.ae_alipass_pass_add_nosupport | 无调用权限 | 该调用方存在风险,已被拦截 |
| kp.ae_alipass_recognition_type_invalid | 发券类型字段不合法 | 检查券recognition_type字段 |
| kp.ae_alipass_recognition_type_nosupport | alipass添加对象识别类型不识别 | 检查recongnition_type值是否为1,必要时请至支持中心(https://support.open.alipay.com/alipay/support/index.htm)提问,或点击右上角帮助支持→在线咨询,联系凯发k8官方网娱乐官方的技术客服来解决 |
| kp.ae_alipass_repeat_add_error | 不能重复添加 | 确认券是否重复添加,若幂等成功可不用重试。 |
| kp.ae_alipass_static_resource_null | 模版关键属性缺失 | 检查logo字段为合法的图片地址或动态变量,不可为空 |
| kp.ae_alipass_template_not_found | 模板不存在 | 检查tpl_id字段是否正确 |
| kp.ae_alipass_token_valid_fail | token令牌信息校验失败 | 确认user_token参数传入的是否是实时获取的token令牌 |
| kp.ae_alipass_userid_nosupport | 发券的目标用户在黑名单中,不支持发券 | 请至支持中心(https://support.open.alipay.com/alipay/support/index.htm)提问,或点击右上角帮助支持→在线咨询,联系凯发k8官方网娱乐官方的技术客服来解决 |
| kp.ae_illegal_parameters | 参数校验出错 | 检查请求参数是否符合期望 |
| kp.ae_system_error | 系统异常 | 尝试重试,必要时请至支持中心(https://support.open.alipay.com/alipay/support/index.htm)提问,或点击右上角帮助支持→在线咨询,联系凯发k8官方网娱乐官方的技术客服来解决 |