alipay.user.pass.grouplist.query (查询支付宝卡包列表数据)

查询支付宝卡包列表数据,当前只支持盒马

公共参数

请求地址:
环境 HTTPS请求地址
正式环境 https://openapi.alipay.com/gateway.do
公共请求参数:
参数 类型 是否必填 最大长度 描述 示例值
app_id String 32 支付宝分配给开发者的应用ID 2014072300007148
method String 128 接口名称 alipay.user.pass.grouplist.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 - 请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递,具体参照各产品快速接入文档

请求参数

参数 类型 是否必填 最大长度 描述 示例值
user_id String 必须 16 蚂蚁统一会员ID 2088888888888888
partner_id String 可选 16 商户和支付宝交互时,用于代表支付宝分配给商户ID 2088888888888888
group_type String 必须 10 卡券分组标识,当前值:card(卡)、voucher(券)、ticket(票)、cert(证件) voucher
time_status String 必须 10 pass有效状态: CURRENT:当前的, PAST:失效的 CURRENT
city_code String 可选 10 城市编码,国标码,如果need_shopinfo=true,必须传值 320100
need_shopinfo Boolean 可选 10 是否需要店铺信息,true表需要,false或空表不需要 false
page_size Number 必须 10 页大小 100
page_num Number 必须 10 页码 1

公共响应参数

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

响应参数

参数 类型 是否必填 最大长度 描述 示例值
pass_info_list PassInfoOpenApiModel [] 必填 - 券信息列表
  • └ pass_id
  • String
  • 必填
  • 100
  • 券ID
  • 7000790003
  • └ mechant_name
  • String
  • 选填
  • 100
  • 商家名称
  • 商家名称
  • └ logo_text
  • String
  • 选填
  • 100
  • 卡券第一行文字
  • 30份吮指鸡块
  • └ second_logo_text
  • String
  • 选填
  • 100
  • 卡券第二行文字
  • 30份吮指鸡块
  • └ item_id
  • String
  • 选填
  • 100
  • 商品id
  • 20171115011040030100030000009952
  • └ start_date
  • Date
  • 选填
  • 50
  • 有效期开始时间
  • 2017-11-15 10:41:43
  • └ end_date
  • Date
  • 选填
  • 50
  • 有效期结束时间
  • 2017-11-15 10:41:43
  • └ gmt_create
  • Date
  • 选填
  • 20
  • 券创建时间
  • 2017-11-20 10:41:23
  • └ shop_id_list
  • String []
  • 选填
  • 100
  • 可用门店信息
  • 2015092700077000000004491925
  • └ data_info
  • String
  • 选填
  • 10000
  • 凭证信息
  • {"logoText":"2元","brandName":"fengyunN","secondLogoText":"秦月单品满减优惠满5减2","itemDesc":"1212淘鲜达口碑核销券单品满减优惠券","btnDesc":"去买单"}
  • └ status
  • String
  • 选填
  • 10
  • 券状态,"can_use", "可使用";"used", "已使用";"expired", "已过期";"closed", "已失效"
  • can_use
  • └ ext_info
  • String
  • 选填
  • 10000
  • 扩展信息
  • {"logoText":"2元","brandName":"fengyunN","secondLogoText":"秦月单品满减优惠满5减2","itemDesc":"1212淘鲜达口碑核销券单品满减优惠券","btnDesc":"去买单"}

请求示例

  • JAVA
  • .NET
  • PHP
  • HTTP请求源码
AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
AlipayUserPassGrouplistQueryRequest request = new AlipayUserPassGrouplistQueryRequest();
request.setBizContent("{" +
"\"user_id\":\"2088888888888888\"," +
"\"partner_id\":\"2088888888888888\"," +
"\"group_type\":\"voucher\"," +
"\"time_status\":\"CURRENT\"," +
"\"city_code\":\"320100\"," +
"\"need_shopinfo\":false," +
"\"page_size\":100," +
"\"page_num\":1" +
"  }");
AlipayUserPassGrouplistQueryResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

  • JSON示例
{
	"sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE",
	"alipay_user_pass_grouplist_query_response":{
		"msg":"Success",
		"code":"10000",
		"pass_info_list":[
			{
				"second_logo_text":"30份吮指鸡块",
				"end_date":"2017-11-15 10:41:43",
				"gmt_create":"2017-11-20 10:41:23",
				"mechant_name":"商家名称",
				"data_info":"{\"logoText\":\"2元\",\"brandName\":\"fengyunN\",\"secondLogoText\":\"秦月单品满减优惠满5减2\",\"itemDesc\":\"1212淘鲜达口碑核销券单品满减优惠券\",\"btnDesc\":\"去买单\"}",
				"pass_id":"7000790003",
				"item_id":"20171115011040030100030000009952",
				"shop_id_list":[
					"2015092700077000000004491925"
				],
				"ext_info":"{\"logoText\":\"2元\",\"brandName\":\"fengyunN\",\"secondLogoText\":\"秦月单品满减优惠满5减2\",\"itemDesc\":\"1212淘鲜达口碑核销券单品满减优惠券\",\"btnDesc\":\"去买单\"}",
				"logo_text":"30份吮指鸡块",
				"start_date":"2017-11-15 10:41:43",
				"status":"can_use"
			}
		]
	}
}

异常示例

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

业务错误码

错误码 错误描述 解决方案
SYSTEM_ERROR 系统繁忙或系统异常 尝试重试,必要时请至支持中心(https://support.open.alipay.com/alipay/support/index.htm)提问,或点击右上角帮助支持→在线咨询,联系我们的技术客服来解决
INVALID_PARAMETER 参数有误全错误码是KP.AE_ALIPASS_PARAMS_VALUE_INVAILD,无效的参数传值 确认参数格式及内容是否符合预期,确认传参biz_content符合json规范
BIZ_ERROR 业务异常列表查询异常 尝试重试,必要时请至支持中心(https://support.open.alipay.com/alipay/support/index.htm)提问,或点击右上角帮助支持→在线咨询,联系我们的技术客服来解决

公共错误码

返回
顶部