alipay.marketing.cashlessvoucher.template.modify(无资金券模板修改接口) 在线调试(沙箱环境)

修改无资金券模板

公共参数

请求地址

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

公共请求参数

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

请求参数

参数 类型 是否必填 最大长度 描述 示例值
template_id String 必选 28 券模板ID ,参数值通过调用alipay.marketing.cashlessvoucher.template.create接口返回 20140601000730010040000000EB
out_biz_no String 必选 32 模板修改操作外部业务号,用于修改时的幂等控制,注意这里不是修改业务号 2017000xxx_modify
publish_end_time Date 必选 19 发放结束时间,晚于该时间不能发券。券的发放结束时间和发放开始时间跨度不能大于90天。发放结束时间必须晚于发放开始时间。格式为:yyyy-MM-dd HH:mm:ss。 2017-04-30 19:00:00
rule_conf String 可选 1024 规则配置,JSON字符串,{"PID": "2088512417841101,2088512417841102", "STORE": "123456,678901"},其中PID表示可以核销该券的pid列表,多个值用英文逗号隔开,STORE表示可以核销该券的内部门店ID,多个值用英文逗号隔开,不传此参数则不修改规则,若有要修改规则那么必须包含PID,规则修改仅支持代金券 {"PID": "2088512417841101,2088512417841102,2088512417841103", "STORE": "123456,678901"}

响应参数

参数 类型 是否必填 最大长度 描述 示例值

请求示例

AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
AlipayMarketingCashlessvoucherTemplateModifyRequest request = new AlipayMarketingCashlessvoucherTemplateModifyRequest();
request.setBizContent("{" +
"\"template_id\":\"20140601000730010040000000EB\"," +
"\"out_biz_no\":\"2017000xxx_modify\"," +
"\"publish_end_time\":\"2017-04-30 19:00:00\"," +
"\"rule_conf\":\"{\\\"PID\\\": \\\"2088512417841101,2088512417841102,2088512417841103\\\", \\\"STORE\\\": \\\"123456,678901\\\"}\"" +
"  }");
AlipayMarketingCashlessvoucherTemplateModifyResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

{
    "alipay_marketing_cashlessvoucher_template_modify_response": {
        "code": "10000",
        "msg": "Success"
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

异常示例

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

业务错误码

公共错误码

错误码错误描述解决方案
SYSTEM_ERROR 系统繁忙 1.发起业务重试 2.联系技术支持
SYSTEM_ERROR 系统繁忙 1.发起业务重试 2.联系技术支持
SYSTEM_ERROR 系统繁忙 1.发起业务重试 2.联系技术支持
SYSTEM_ERROR 系统繁忙 1.发起业务重试 2.联系技术支持
INVALID_DATE_PARAMETER 参数有误,无效的时间 券的发放有效期跨度不能大于90天。
DATE_FORMAT_ERROR 参数有误,日期数据格式错误 日期格式必须为 yyyy-MM-dd H:mm:ss
TEMPLATE_STATUS_NOT_MATCH 模板状态不匹配 确认模板状态未过期
TEMPLATE_NOT_EXIST 模板不存在 传入存在的模板ID
PERMISSION_DENIED 没有修改模板权限 没有修改模板权限
INVALID_PARAMETER 参数有误 请检查入参是否符合接口要求
onlineServer