alipay.pass.instance.update(支付宝pass更新卡券实例接口) 在线调试(沙箱环境)

对于已经发布的卡券,如需更新内容,可通过此接口更新,主要用于更新卡券的使用状态。

公共参数

请求地址

环境HTTPS请求地址
正式环境 https://openapi.alipay.com/gateway.do

公共请求参数

参数 类型 是否必填最大长度描述示例值
app_id String 32 支付宝分配给开发者的应用ID 2014072300007148
method String 128 接口名称 alipay.pass.instance.update
format String 40 仅支持JSON JSON
charset String 10 请求使用的编码格式,如utf-8,gbk,gb2312等 utf-8
sign_type String 10 商户生成签名字符串所使用的签名算法类型,目前支持RSA2和RSA,推荐使用RSA2 RSA2
sign String 344 商户请求参数的签名串,详见签名 详见示例
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 请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递,具体参照各产品快速接入文档

请求参数

参数 类型 是否必填 最大长度 描述 示例值
serial_number String 必选 999 商户指定卡券唯一值,卡券JSON模板中fileInfo->serialNumber字段对应的值 209919213
channel_id String 必选 999 代理商代替商户发放卡券后,再代替商户更新卡券时,此值为商户的pid/appid 2088918273
tpl_params String 可选 99999 模版动态参数信息:对应模板中$变量名$的动态参数,见模板创建接口返回值中的tpl_params字段 {"title":"券标题","channelID":"xxx","serialNumer":"xxxx"}
status String 可选 99 券状态,支持更新为USED、CLOSED两种状态 USED
verify_code String 可选 999 核销码串值【当状态变更为USED时,建议传】 8612231273
verify_type String 可选 99999 核销方式,目前支持:wave(声波方式)、qrcode(二维码方式)、barcode(条码方式)、input(文本方式,即手工输入方式)。verify_code和verify_type需同时传入 wave

响应参数

参数 类型 是否必填 最大长度 描述 示例值
success String 必填 操作成功标识【true:成功;false:失败】 true
result String 必填 9999 接口调用返回结果信息 {"serialNumber":"123555123","passId":"209919213","operate":"UPDATE","errorCode":"SUCCESS","errorMsg":"处理成功"}

请求示例

AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
AlipayPassInstanceUpdateRequest request = new AlipayPassInstanceUpdateRequest();
request.setBizContent("{" +
"\"serial_number\":\"209919213\"," +
"\"channel_id\":\"2088918273\"," +
"\"tpl_params\":\"{\\\"title\\\":\\\"券标题\\\",\\\"channelID\\\":\\\"xxx\\\",\\\"serialNumer\\\":\\\"xxxx\\\"}\"," +
"\"status\":\"USED\"," +
"\"verify_code\":\"8612231273\"," +
"\"verify_type\":\"wave\"" +
"  }");
AlipayPassInstanceUpdateResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

{
    "alipay_pass_instance_update_response": {
        "code": "10000",
        "msg": "Success",
        "success": "true",
        "result": "{\"serialNumber\":\"123555123\",\"passId\":\"209919213\",\"operate\":\"UPDATE\",\"errorCode\":\"SUCCESS\",\"errorMsg\":\"处理成功\"}"
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

异常示例

{
    "alipay_pass_instance_update_response": {
        "code": "20000",
        "msg": "Service Currently Unavailable",
        "sub_code": "isp.unknow-error",
        "sub_msg": "系统繁忙"
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

业务错误码

公共错误码

错误码错误描述解决方案
KP.AE_SYSTEM_ERROR 系统繁忙或系统异常 尝试重试,必要时请至支持中心(https://support.open.alipay.com/alipay/support/index.htm)提问,或点击右上角帮助支持→在线咨询,联系我们的技术客服来解决
...ALIPASS_PARAMS_FORMAT_ERROR 全错误码为KP.AE_ALIPASS_PARAMS_FORMAT_ERROR,参数格式错误,一般是预期json格式的参数不符合JSON规范 检查参数格式是否符合JSON语法规范
KP.AE_ALIPASS_NOTEXIST 卡券不存在 核查serial_number和channel_id传参是否符合预期,必要时请至支持中心(https://support.open.alipay.com/alipay/support/index.htm)提问,或点击右上角帮助支持→在线咨询,联系我们的技术客服来解决
KP.AE_ALIPASS_UPDATE_ERROR 更新卡券失败 确认参数是否符合文档预期,尝试重试
KP.AE_ALIPASS_PARAME_IS_NULL 参数值为null 根据返回值result的errorMsg检查发券参数tpl_params是否缺失动态参数对应的值
...ALIPASS_PARAMS_VALUE_INVAILD 全错误码是KP.AE_ALIPASS_PARAMS_VALUE_INVAILD,无效的参数传值。 确认参数格式符合预期,确认传参biz_content符合json规范
KP.AE_ALIPASS_CHAR_NOT_GBK 卡券传值中有非GBK的字符 确认传参字符为GBK编码
onlineServer