商户通过开放平台查询自己创建的现金活动详情
| 环境 | HTTPS请求地址 |
|---|---|
| 正式环境 | https://openapi.alipay.com/gateway.do |
| 参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
|---|---|---|---|---|---|
| app_id | String | 是 | 32 | 支付宝分配给开发者的应用ID | 2014072300007148 |
| method | String | 是 | 128 | 接口名称 | alipay.marketing.campaign.cash.detail.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 | 是 | 256 | 商户请求参数的签名串,详见签名 | 详见示例 |
| 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 | 是 | - | 请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递,具体参照各产品快速接入文档 |
| 参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
|---|---|---|---|---|---|
| crowd_no | String | 必须 | 128 | 要查询的现金红包活动号 | POYb84lfiKVdIfERAYsqPL_KQRIpfQbl47xfRmmPBlDMnSZ96O-zxUfKlHp5cxmx |
| 参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
|---|---|---|---|---|---|
| code | String | 是 | - | 网关返回码,详见文档 | 40004 |
| msg | String | 是 | - | 网关返回码描述,详见文档 | Business Failed |
| sub_code | String | 否 | - | 业务返回码,详见文档 | ACQ.TRADE_HAS_SUCCESS |
| sub_msg | String | 否 | - | 业务返回码描述,详见文档 | 交易已被支付 |
| sign | String | 是 | - | 签名,详见文档 | DZXh8eeTuAHoYE3w1J+POiPhfDxOYBfUNn1lkeT/V7P4zJdyojWEa6IZs6Hz0yDW5Cp/viufUb5I0/V5WENS3OYR8zRedqo6D+fUTdLHdc+EFyCkiQhBxIzgngPdPdfp1PIS7BdhhzrsZHbRqb7o4k3Dxc+AAnFauu4V6Zdwczo= |
| 参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
|---|---|---|---|---|---|
| crowd_no | String | 必填 | 128 | 活动号 | POYb84lfiKVdIfERAYsqPL_KQRIpfQbl47xfRmmPBlDMnSZ96O-zxUfKlHp5cxmx |
| coupon_name | String | 必填 | 64 | 红包名称 | XXX周年庆红包 |
| prize_msg | String | 必填 | 64 | 活动文案,用户在账单中看到的红包描述 | XX送您大红包 |
| prize_type | String | 必填 | 6 | 现金红包的发放形式, fixed为固定金额,random为随机金额 | random |
| start_time | Date | 必填 | 19 | 活动开始时间 | 2016-08-10 22:28:30 |
| end_time | Date | 必填 | 19 | 活动结束时间 | 2016-08-10 22:28:30 |
| total_amount | Price | 必填 | 12 | 活动总金额 | 20000.00 |
| send_amount | Price | 必填 | 12 | 活动已发放金额 | 200000.00 |
| total_num | Number | 必填 | 12 | 红包总个数(废弃) | 1000 |
| total_count | Number | 必填 | 12 | 红包总个数 | 1000 |
| origin_crowd_no | String | 必填 | 64 | 原始活动号,商户排查问题时提供的活动依据 | 20160901029410190092922308762004 |
| camp_status | String | 必填 | 10 |
活动状态,CREATED: 已创建未打款
PAID:已打款 READY:活动已开始 PAUSE:活动已暂停 CLOSED:活动已结束 SETTLE:活动已清算 |
CREATED、PAID、READY、PAUSE、CLOSED、SETTLE |
AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
AlipayMarketingCampaignCashDetailQueryRequest request = new AlipayMarketingCampaignCashDetailQueryRequest();
request.setBizContent("{" +
"\"crowd_no\":\"POYb84lfiKVdIfERAYsqPL_KQRIpfQbl47xfRmmPBlDMnSZ96O-zxUfKlHp5cxmx\"" +
"}");
AlipayMarketingCampaignCashDetailQueryResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}
{
"alipay_marketing_campaign_cash_detail_query_response":{
"msg":"Success",
"code":"10000",
"prize_msg":"XX送您大红包",
"total_count":1000,
"end_time":"2016-08-10 22:28:30",
"coupon_name":"XXX周年庆红包",
"start_time":"2016-08-10 22:28:30",
"send_amount":200000.00,
"crowd_no":"POYb84lfiKVdIfERAYsqPL_KQRIpfQbl47xfRmmPBlDMnSZ96O-zxUfKlHp5cxmx",
"origin_crowd_no":"20160901029410190092922308762004",
"total_amount":20000.00,
"total_num":1000,
"camp_status":"CREATED、PAID、READY、PAUSE、CLOSED、SETTLE",
"prize_type":"random"
},
"sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}
{
"alipay_marketing_campaign_cash_detail_query_response":{
"msg":"Service Currently Unavailable",
"code":"20000",
"sub_msg":"系统繁忙",
"sub_code":"isp.unknow-error"
},
"sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}
| 错误码 | 错误描述 | 解决方案 |
|---|---|---|
| UNKNOW_SYSTEM_ERROR | 系统繁忙,请稍后再试 | 请稍后再试 |
| CASH_CAMPAIGN_NOT_EXIST | 现金活动不存在 | 请填写正确的活动号 |
| BIZ_CONTENT_IS_EMPTY | 入参不合法,biz_content字段为空 | 在请求体中填充biz_content字段 |
| BIZ_CONTENT_FORMAT_ERROR | 入参不合法,biz_content字段格式错误 | 修改biz_content字段格式,符合json的格式 |
| PRODUCT_IS_NOT_OPENED | 产品未签约 | 请进行产品签约 |
| CALL_TOO_FREQUENCY | 调用过于频繁 | 请不要调用太频繁 |
| CAMP_OPERATOR_ILLEGAL | 活动创建人与调用者不一致 | 请查询调用者自己创建的活动 |