追加支付券预算

支付券激活成功后，调用该接口追加支付券预算。追加支付券预算接口同步返回请求受理结果，后续通过alipay.marketing.activity.message.appended消息接口异步发送追加支付券预算成功事件消息。 如果成功消息长时间未送达，请联系相关技术人员。

公共请求参数

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

请求参数

参数中文名	参数英文名	类型	是否必选	最大长度	描述	示例值
活动 id	activity_id	String	必选	128	活动id	2016042700826004508401111111
发行券的数量	voucher_quantity	Number	必选	10	券总预算值。 限制： 券总预算<= 99999999 特别说明： 该字段的含义是追加到的数量。 不可减少，只能增加。	100
外部业务单号	out_biz_no	String	必选	64	外部业务单号，用作幂等控制。 幂等作用： 参数不变的情况下，再次请求返回与上一次相同的结果。 外部接入方需保证业务单号唯一。	20170101000001654bb46ba
商户接入模式	merchant_access_mode	String	必选	32	商户接入模式枚举值商户自接入模式: SELF_MODE服务商代接入模式: AGENCY_MODE注意事项选择服务商代接入模式需配合 app_auth_token 代调用使用	SELF_MODE

公共响应参数

参数	类型	是否必选	最大长度	描述	示例值
code	String	必选	-	网关返回码,详见文档	40004
msg	String	必选	-	网关返回码描述,详见文档	Business Failed
sub_code	String	可选	-	业务返回码，参见具体的API接口文档	ACQ.TRADE_HAS_SUCCESS
sub_msg	String	可选	-	业务返回码描述，参见具体的API接口文档	交易已被支付
sign	String	必选	-	签名,详见文档	DZXh8eeTuAHoYE3w1J+POiPhfDxOYBfUNn1lkeT/V7P4zJdyojWEa6IZs6Hz0yDW5Cp/viufUb5I0/V5WENS3OYR8zRedqo6D+fUTdLHdc+EFyCkiQhBxIzgngPdPdfp1PIS7BdhhzrsZHbRqb7o4k3Dxc+AAnFauu4V6Zdwczo=

响应参数

参数中文名	参数英文名	类型	是否必选	最大长度	描述	示例值
预充值链接	recharge_url	String	特殊可选	256	预充值链接 限制 有效时间3天	https://voucherprod.alipay.com/coupon/templatepayment.htm?templateId=20210829000730015448005XXOO&authNo=2021082910002001170507729XX5&operationId=202X0829X45X35X1170X

请求示例

Java

C#

PHP

HTTP

package com.java.sdk.demo;

import com.alipay.api.AlipayApiException;
import com.alipay.api.AlipayClient;
import com.alipay.api.DefaultAlipayClient;
import com.alipay.api.CertAlipayRequest;
import com.alipay.api.AlipayConfig;
import com.alipay.api.request.AlipayMarketingActivityVoucherAppendRequest;
import com.alipay.api.response.AlipayMarketingActivityVoucherAppendResponse;
import com.alipay.api.domain.AlipayMarketingActivityVoucherAppendModel;
import com.alipay.api.FileItem;
import java.util.Base64;
import java.util.ArrayList;
import java.util.List;

public class AlipayMarketingActivityVoucherAppend {

    public static void main(String[] args) throws AlipayApiException {
        String privateKey = "<-- 请填写您的应用私钥，例如：MIIEvQIBADANB ... ... -->";
        String alipayPublicKey = "<-- 请填写您的支付宝公钥，例如：MIIBIjANBg... -->";
        AlipayConfig alipayConfig = new AlipayConfig();
        alipayConfig.setServerUrl("https://openapi.alipay.com/gateway.do");
        alipayConfig.setAppId("<-- 请填写您的AppId，例如：2019091767145019 -->");
        alipayConfig.setPrivateKey(privateKey);
        alipayConfig.setFormat("json");
        alipayConfig.setAlipayPublicKey(alipayPublicKey);
        alipayConfig.setCharset("UTF-8");
        alipayConfig.setSignType("RSA2");
        AlipayClient alipayClient = new DefaultAlipayClient(alipayConfig);
        AlipayMarketingActivityVoucherAppendRequest request = new AlipayMarketingActivityVoucherAppendRequest();
        AlipayMarketingActivityVoucherAppendModel model = new AlipayMarketingActivityVoucherAppendModel();
        model.setOutBizNo("20170101000001654bb46ba");
        model.setActivityId("2016042700826004508401111111");
        model.setVoucherQuantity(100L);
        model.setMerchantAccessMode("SELF_MODE");
        request.setBizModel(model);
        AlipayMarketingActivityVoucherAppendResponse response = alipayClient.execute(request);
        System.out.println(response.getBody());
        if (response.isSuccess()) {
            System.out.println("调用成功");
        } else {
            System.out.println("调用失败");
            // sdk版本是"4.38.0.ALL"及以上,可以参考下面的示例获取诊断链接
            // String diagnosisUrl = DiagnosisUtils.getDiagnosisUrl(response);
            // System.out.println(diagnosisUrl);
        }
    }
}

响应示例

json

xml

{
    "alipay_marketing_activity_voucher_append_response": {
        "code": "10000",
        "msg": "Success",
        "recharge_url": "https://voucherprod.alipay.com/coupon/templatepayment.htm?templateId=20210829000730015448005XXOO&authNo=2021082910002001170507729XX5&operationId=202X0829X45X35X1170X"
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

**说明：**本示例仅供参考。

异常示例

json

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

错误码

公共错误码

前往查看

业务错误码

错误码	错误描述	解决方案
SYSTEM_ERROR	系统繁忙	可能发生了网络或者系统异常，导致服务调用失败，商户可以用同样的请求发起重试
INVALID_PARAMETER	参数有误参数非法	请根据接口返回的参数非法的具体错误信息，修改参数后进行重试。