alipay.marketing.voucher.stock.use(外部商户券码券核销) 在线调试(沙箱环境)

核销外部商户的券码

公共参数

请求地址

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

公共请求参数

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

请求参数

参数 类型 是否必填 最大长度 描述 示例值
entity_no String 必选 128 券码,也就是商户在创建外部券码模板时,上传的文件中的内容 ABTRm55gkVTcZJjvY2Enjg==prIaQkv2_dsfRTETS
out_biz_no String 必选 128 数字和字母,每一次核销都必须唯一,如果重复,则认为是重复的请求 0156468653835689006788030091

响应参数

参数 类型 是否必填 最大长度 描述 示例值
voucher_id String 选填 28 返回如果为空,说明没有核销成功;如果不为空,长度一定是28,表示的是核销序号。该值唯一对应一个券码,即入参中的entity_no 0156468653835689006788030091

请求示例

AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
AlipayMarketingVoucherStockUseRequest request = new AlipayMarketingVoucherStockUseRequest();
request.setBizContent("{" +
"\"entity_no\":\"ABTRm55gkVTcZJjvY2Enjg==prIaQkv2_dsfRTETS\"," +
"\"out_biz_no\":\"0156468653835689006788030091\"" +
"}");
AlipayMarketingVoucherStockUseResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

{
    "alipay_marketing_voucher_stock_use_response": {
        "code": "10000",
        "msg": "Success",
        "voucher_id": "0156468653835689006788030091"
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

异常示例

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

业务错误码

公共错误码

错误码错误描述解决方案
DB_EXCEPTION 数据库异常 重新发起业务
REQUEST_PARAM_ILLEGAL 请求参数非法 请检查传入的entity_no是否是真实存在的,修改正确后重新发起业务
SLA_ERROR SLA服务限流业务异常 重新发起业务
VCC_INVOKE_ERROR VCC_INVOKE_ERROR 重新发起业务
VOUCHER_HAS_EXPIRED 券已过期 券已过期,不能再核销了,不要重新发起业务
onlineServer