创建支付券

商户通过调用此接口创建支付券，包括预充值&免充值支付券，接口同步返回创建处理结果。创建完成后将获得活动id，可用于各个营销场景的活动投放。

注意：

创建支付券活动接口同步返回创建请求受理结果，但并不代表创建成功，需要根据同步返回的活动id（activity_id），调用 alipay.marketing.activity.voucher.publish（发布支付券活动）接口，以alipay.marketing.activity.message.created（激活支付券回调通知）为准。

公共请求参数

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

请求参数

参数中文名	参数英文名	类型	是否必选	最大长度	描述	示例值
外部业务单号	out_biz_no	String	必选	64	外部业务单号，用作幂等控制注意事项1.外部接入方需保证业务单号唯一。 2.参数不变的情况下，再次请求返回与上一次相同的结果。	asdh12394nb23941234xasd2021
商户接入模式	merchant_access_mode	String	必选	32	商户接入模式枚举值商户自接入模式: SELF_MODE服务商代接入模式: AGENCY_MODE注意事项选择服务商代接入模式需配合 app_auth_token 代调用使用	SELF_MODE
活动基础信息	activity_base_info	ActivityBaseInfo	必选		活动基础信息
券发放信息	voucher_send_mode_info	VoucherSendModeInfo	必选		券发放信息
券优惠抵扣信息	voucher_deduct_info	VoucherDeductInfo	必选		券优惠信息
券可用范围	voucher_available_scope_info	VoucherAvailableScopeInfo	必选		券可用范围
券核销限制	voucher_use_rule_info	VoucherUseRuleInfo	必选		券核销限制
券引导信息	voucher_customer_guide_info	VoucherCustomerGuideInfo	必选		券引导信息
券展示信息	voucher_display_pattern_info	VoucherDisplayPatternInfo	可选		券展示信息
资金信息	voucher_budget_supply_info	VoucherBudgetSupplyInfo	必选		资金信息

公共响应参数

参数	类型	是否必选	最大长度	描述	示例值
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=

响应参数

参数中文名	参数英文名	类型	是否必选	最大长度	描述	示例值
活动id	activity_id	String	必选	128	活动id	2016042700826004508401111111

请求示例

Java

PHP

HTTP

响应示例

json

xml

{
    "alipay_marketing_activity_voucher_create_response": {
        "code": "10000",
        "msg": "Success",
        "activity_id": "2016042700826004508401111111"
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

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

异常示例

json

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

错误码

公共错误码

前往查看

业务错误码

错误码	错误描述	解决方案
SYSTEM_ERROR	服务器异常	可能发生了网络或者系统异常，导致服务调用失败，商户可以用同样的请求发起重试
INVALID_PARAMETER	参数有误参数非法	请根据接口返回的参数非法的具体错误信息，修改参数后进行重试。
BIZ_ERROR	业务异常缺少代运营关系	isv与商户进行代运营关系的授权
MATERIAL_AUDIT_WAITING	图片素材审核中	请等待素材审核完成后再调用创建接口

公共请求参数#

请求参数#

公共响应参数#

响应参数#

请求示例#

响应示例#

异常示例#

错误码#

公共错误码#

业务错误码#