alipay.marketing.card.benefit.query(会员卡模板外部权益查询) 在线调试(沙箱环境)

会员卡模板外部权益查询

公共参数

请求地址

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

公共请求参数

参数 类型 是否必填最大长度描述示例值
app_id String 32 支付宝分配给开发者的应用ID 2014072300007148
method String 128 接口名称 alipay.marketing.card.benefit.query
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 必选 32 会员卡模板ID 20170322000000000068101000300041
benefit_id String 可选 32 权益ID 20170322000000000068101000300041

响应参数

参数 类型 是否必填 最大长度 描述 示例值
mcard_template_benefit_query McardTemplateBenefitQuery 必填 会员卡模板外部权益列表
benefit_id String 必填 32 权益ID 20170322000000000068101000300041
template_id String 必填 32 会员卡模板ID 20170322000000000068101000300041
title String 必填 16 权益标题 使用会员卡消费享8折优惠
benefit_desc String 必填 1024 权益描述信息 使用会员卡享8折优惠
start_date Date 必填 64 权益开始时间 2017-04-18 15:10:23
end_date Date 必填 64 权益结束时间 2017-04-18 15:10:23
ext_info String 必填 4000 会员卡模板权益扩展信息:JSON格式; openUrl 说明:跳转到商户的优惠活动页面 {"openUrl":"http://www.koubei.com"}

请求示例

AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
AlipayMarketingCardBenefitQueryRequest request = new AlipayMarketingCardBenefitQueryRequest();
request.setBizContent("{" +
"\"template_id\":\"20170322000000000068101000300041\"," +
"\"benefit_id\":\"20170322000000000068101000300041\"" +
"}");
AlipayMarketingCardBenefitQueryResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

{
    "alipay_marketing_card_benefit_query_response": {
        "code": "10000",
        "msg": "Success",
        "mcard_template_benefit_query": [
            {
                "benefit_id": "20170322000000000068101000300041",
                "template_id": "20170322000000000068101000300041",
                "title": "使用会员卡消费享8折优惠",
                "benefit_desc": "使用会员卡享8折优惠",
                "start_date": "2017-04-18 15:10:23",
                "end_date": "2017-04-18 15:10:23",
                "ext_info": "{\"openUrl\":\"http://www.koubei.com\"}"
            }
        ]
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

异常示例

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

业务错误码

公共错误码

错误码错误描述解决方案
INVALID_PARAMETER 参数有误 查看message错误原因
SYSTEM_ERROR 系统繁忙 查看message错误原因
TEMPLATE_NOT_EXIST 卡模板不存在 查看message定位问题
BENEFIT_NOT_EXIST 权益不存在 查看message定位问题
onlineServer