卡券模板生成后,如需将卡券发布给对应的用户,则调用此接口。
环境 | HTTPS请求地址 |
---|---|
正式环境 | https://openapi.alipay.com/gateway.do |
参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
---|---|---|---|---|---|
app_id | String | 是 | 32 | 支付宝分配给开发者的应用ID | 2014072300007148 |
method | String | 是 | 128 | 接口名称 | alipay.pass.instance.add |
format | String | 否 | 40 | 仅支持JSON | JSON |
charset | String | 是 | 10 | 请求使用的编码格式,如utf-8,gbk,gb2312等 | utf-8 |
sign_type | String | 是 | 10 | 商户生成签名字符串所使用的签名算法类型,目前支持RSA2和RSA,推荐使用RSA2 | RSA2 |
sign | String | 是 | 256 | 商户请求参数的签名串,详见签名 | 详见示例 |
timestamp | String | 是 | 19 | 发送请求的时间,格式"yyyy-MM-dd HH:mm:ss" | 2014-07-24 03:07:50 |
version | String | 是 | 3 | 调用的接口版本,固定为:1.0 | 1.0 |
app_auth_token | String | 否 | 40 | 详见应用授权概述 | |
biz_content | String | 是 | - | 请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递,具体参照各产品快速接入文档 |
参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
---|---|---|---|---|---|
tpl_id | String | 必须 | 999 | 支付宝pass模版ID | f038871a4b1151e8038bb9277c3d52e3 |
tpl_params | String | 必须 | 99999 | 模版动态参数信息:对应模板中$变量名$的动态参数,见模板创建接口返回值中的tpl_params字段 | {"title":"券标题","channelID":"xxx","serialNumer":"xxxx"} |
recognition_type | String | 必须 | 999 | Alipass添加对象识别类型:1–订单信息 | 1 |
recognition_info | String | 必须 | 999 | 支付宝用户识别信息:
包括partner_id(商户的签约账号)和out_trade_no(某笔订单号) |
{"partner_id":"2088102114633762","out_trade_no":"1234567"} |
参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
---|---|---|---|---|---|
code | String | 是 | - | 网关返回码,详见文档 | 40004 |
msg | String | 是 | - | 网关返回码描述,详见文档 | Business Failed |
sub_code | String | 否 | - | 业务返回码,详见文档 | ACQ.TRADE_HAS_SUCCESS |
sub_msg | String | 否 | - | 业务返回码描述,详见文档 | 交易已被支付 |
sign | String | 是 | - | 签名,详见文档 | DZXh8eeTuAHoYE3w1J+POiPhfDxOYBfUNn1lkeT/V7P4zJdyojWEa6IZs6Hz0yDW5Cp/viufUb5I0/V5WENS3OYR8zRedqo6D+fUTdLHdc+EFyCkiQhBxIzgngPdPdfp1PIS7BdhhzrsZHbRqb7o4k3Dxc+AAnFauu4V6Zdwczo= |
参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
---|---|---|---|---|---|
success | String | 必填 | - | 操作成功标识【true:成功;false:失败】 | true |
result | String | 必填 | 9999 |
接口调用返回结果信息
serialNumber:唯一核销凭证串号(必须由动态传参指定) passId:券唯一id operation:本次调用的操作类型,ADD errorCode:处理结果码(错误码) errorMsg:处理结果说明(错误说明) |
{"serialNumber":"123555123","passId":"209919213","operate":"ADD","errorCode":"SUCCESS","errorMsg":"处理成功"} |
AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2"); AlipayPassInstanceAddRequest request = new AlipayPassInstanceAddRequest(); request.setBizContent("{" + "\"tpl_id\":\"f038871a4b1151e8038bb9277c3d52e3\"," + "\"tpl_params\":\"{\\\"title\\\":\\\"券标题\\\",\\\"channelID\\\":\\\"xxx\\\",\\\"serialNumer\\\":\\\"xxxx\\\"}\"," + "\"recognition_type\":\"1\"," + "\"recognition_info\":\"{\\\"partner_id\\\":\\\"2088102114633762\\\",\\\"out_trade_no\\\":\\\"1234567\\\"}\"" + " }"); AlipayPassInstanceAddResponse response = alipayClient.execute(request); if(response.isSuccess()){ System.out.println("调用成功"); } else { System.out.println("调用失败"); }
{ "alipay_pass_instance_add_response":{ "msg":"Success", "result":"{\"serialNumber\":\"123555123\",\"passId\":\"209919213\",\"operate\":\"ADD\",\"errorCode\":\"SUCCESS\",\"errorMsg\":\"处理成功\"}", "code":"10000", "success":"true" }, "sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE" }
{ "alipay_pass_instance_add_response":{ "msg":"Service Currently Unavailable", "code":"20000", "sub_msg":"系统繁忙", "sub_code":"isp.unknow-error" }, "sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE" }
错误码 | 错误描述 | 解决方案 |
---|---|---|
KP.AE_ALIPASS_PARAME_IS_NULL | 参数值为null | 根据返回值result的errorMsg检查发券参数tpl_params是否缺失动态参数对应的值 |
...RECOGNITION_TYPE_NOSUPPORT | 全错误码为KP.AE_ALIPASS_RECOGNITION_TYPE_NOSUPPORT,说明Alipass添加对象识别类型不识别 | 检查recongnition_type值是否为1,必要时请至支持中心(https://support.open.alipay.com/alipay/support/index.htm)提问,或点击右上角帮助支持→在线咨询,联系我们的技术客服来解决 |
KP.AE_SYSTEM_ERROR | 系统异常 | 尝试重试,必要时请至支持中心(https://support.open.alipay.com/alipay/support/index.htm)提问,或点击右上角帮助支持→在线咨询,联系我们的技术客服来解决 |
KP.AE_ALIPASS_APPID_NOSUPPORT | 该appId在黑名单中,因而不支持发券 | 请至支持中心(https://support.open.alipay.com/alipay/support/index.htm)提问,或点击右上角帮助支持→在线咨询,联系我们的技术客服来解决 |
KP.AE_ALIPASS_USERID_NOSUPPORT | 发券的目标用户在黑名单中,不支持发券 | 请至支持中心(https://support.open.alipay.com/alipay/support/index.htm)提问,或点击右上角帮助支持→在线咨询,联系我们的技术客服来解决 |
...ALIPASS_PARAMS_VALUE_INVAILD | 全错误码为KP.AE_ALIPASS_PARAMS_VALUE_INVAILD,无效的参数传值。 | 核查tpl_params中的参数格式是否正确,例如时间参数等。 |
...ALIPASS_PARAMS_FORMAT_ERROR | 全错误码为KP.AE_ALIPASS_PARAMS_FORMAT_ERROR,参数格式不正确或调用参数biz_content整体非json格式。 | 确认参数格式符合预期,确认传参biz_content符合json规范 |
KP.AE_ALIPASS_CHAR_NOT_GBK | 卡券传值中有非GBK的字符 | 确认传参字符为GBK编码 |