- 3.4.1实时添加白名单
- 3.4.2白名单查询
- 3.4.3发券
- 3.4.4微信核销流水下载
- 3.4.5券激活
- 3.4.6 微信/云闪付/支付宝/基础营销券核销通知
- 3.4.7后台用户同步
- 3.4.8微信代金券详情查询
- 3.4.9发券状态查询
- 3.4.10 更新活动信息
- 3.4.11微信批次退款流水下载
- 3.4.12查询活动详情
- 3.4.13 通惠券发放核销综合明细分页查询
- 3.4.14 微信券发放核销实时明细表分页查询
- 3.4.15 互动营销发放核销明细分页查询
- 3.4.16 支付宝发放核销明细分页查询
- 3.4.17 云闪付发放核销流水查询
- 3.4.18 微信券发放核销明细准确查询
- 3.4.19 通惠合作店铺查询接口
- 3.4.20 云闪付/支付宝券撤销通知
- 3.4.21 通惠网点发券配置及统计
- 3.4.22 基础营销券发放核销明细分页查询
- 3.4.23 券兑换
- 3.4.24 券兑换码查询
- 3.4.25 报名活动效果查询
- 3.4.26 报名活动详情查询
- 3.4.27 微信活动详情查询
3.4.1实时添加白名单
实时为银行活动添加白名单卡号、卡BIN、手机号
method: allinpay.shopoint.bankService.addWhiteList
version: 1.0
业务请求参数
|
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
|
cardType |
Integer |
是 |
4 |
白名单类型 |
1卡BIN、2卡号、3手机号 |
|
cardNo |
String |
是 |
4000 |
白名单值(支持多个) |
多个用逗号隔开 |
|
promotionId |
Integer |
是 |
11 |
活动ID |
|
业务响应参数
|
字段名 |
参数类型 |
必填 |
说明 |
取值 |
|
code |
Integer |
是 |
返回码 |
0：表示成功； 3：表示失败，具体失败原因参见msg字段； 其他：参见4.1 公共返回码 |
|
msg |
String |
是 |
错误信息 |
|
请求示例
{" cardType":1, “cardNo”:”12345678”,” promotionId”:1111 }
响应示例
{
"code": 0,
"data": {}
"token": "DlRXdIjEBLRLCJgwTP37sZW6ls--NflxVS2-KUHl"
}
3.4.2白名单查询
通过卡号、卡BIN、手机号，查询银行活动白名单。
method: allinpay.shopoint.bankService.queryWhiteList
version: 1.0
业务请求参数
|
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
|
cardType |
Integer |
否 |
4 |
白名单类型 |
1卡BIN、2卡号、3手机号 |
|
cardNo |
String |
否 |
50 |
白名单值(单个) |
|
|
promotionId |
Integer |
是 |
11 |
活动ID |
|
业务响应参数
|
字段名 |
参数类型 |
必填 |
说明 |
取值 |
|
|
code |
Integer |
是 |
返回码 |
0：表示成功； 3：表示失败，具体失败原因参见msg字段； 其他：参见4.1 公共返回码 |
|
|
msg |
String |
是 |
错误信息 |
|
|
|
data |
|
ArrayList |
是 |
|
|
|
cardType |
Integer |
是 |
白名单类型 |
|
|
|
cardNo |
String |
是 |
白名单值(支持多个) |
多个用逗号隔开 |
|
请求示例
{" cardType":1, “cardNo”:”12345678”,” promotionId”:1111 }
响应示例
{
"code": 0,
"data": [{
"cardType": 1,
"cardNo":”12345678,2323232,4323232343”
},
{
"cardType": 1,
"cardNo":”12345678,2323232,4323232343”
}]
"token": "DlRXdIjEBLRLCJgwTP37sZW6ls--NflxVS2-KUHl"
}
3.4.3发券
为指定用户（白名单、联合授权openid)发银行/机构券.
method: allinpay.shopoint.bankService.couponSend
version: 1.0
业务请求参数
|
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
|
idType |
Integer |
是 |
4 |
发券对象类型 |
1联合授权openid、2银行Openid、3手机号、4收银宝openid、5 支付宝帐号,7-基础营销userid,8-外部用户id |
|
idValue |
String |
必填 |
50 |
发券对象值 |
|
|
promotionId |
Integer |
是 |
11 |
活动ID |
商点活动ID |
|
orderId |
String |
否 |
64 |
外部发券订单号 |
|
|
bankOutletsId |
Integer |
否 |
11 |
银行网点ID |
通惠后台配置的银行网点ID |
|
initAmount |
Integer |
否 |
11 |
当活动配置是面额为0的金额券(即动态面额券)时必填 |
大于0的正整数,单位为分 |
业务响应参数
|
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
|
|
code |
Integer |
是 |
|
返回码 |
0：表示成功；（仅表示请求接收成功） 3：表示失败，具体失败原因参见msg字段； 其他：参见4.1 公共返回码 |
|
|
msg |
String |
是 |
|
错误信息 |
|
|
|
data |
value |
String |
否 |
|
返回值 |
返回情况： a-外部微信券：给授权OPENID或银行Openid发券直接到账，返回券ID(券号） b-外部云闪付券：给手机号发券直接到账(无返回值) c-通联内部券： 给银行Openid或手机号发券直接到账，返回券ID(券号）； d-支付宝券:给手机号或者支付宝帐号发券 |
|
|
couponId |
Integer |
是 |
|
券ID |
通联内部券ID（该字段值大于0时表示发券成功） |
|
|
batchCode |
String |
是 |
18 |
发券批次号 |
|
|
|
initAmount |
Integer |
是 |
|
面额 |
单位为分 |
请求示例
{"idType":1, “value”:”12345678”,” promotionId”:1111 }
响应示例
{
"code": 0,
"data": {
"value": 1111
}
"token": "DlRXdIjEBLRLCJgwTP37sZW6ls--NflxVS2-KUHl"
}
特殊报错解释
直接发微信券时报错信息为 "微信领券失败:" + 下图中红框信息 的解释, 解释中的常见问题见常见问题列表见https://developers.weixin.qq.com/community/pay/doc/0000046f16862087608adcdf959c08
常见问题：
Q1：如何确认发券状态（成功、失败、未决）？
A1：
- 当业务响应参数code=0且data.couponId>0时，可判定为发券成功。
- 当业务响应参数code=3或3999时，可判定为发券失败。
- 其他情况均按照状态未决情况处理，需通过调用“3.4.9发券状态查询”接口获取发券状态（业务响应参数code=0时的data.status字段值）
3.4.4微信核销流水下载
微信核销流水下载接口.
method: allinpay.shopoint.couponService.couponUse
version: 1.0
业务请求参数
|
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
|
promotionId |
Integer |
是 |
11 |
活动id |
|
|
extendId |
String |
否 |
|
微信活动批次号, 如果活动配置多个批次号时必填, 只配置一个批次号可不填 |
|
|
version |
Integer |
否 |
11 |
微信API版本 |
1-1.0版本;2-2.0版本 对接方未填默认为1 |
|
billDate |
String |
否 |
10 |
账单日期,仅version=2时必填 |
yyyy-MM-dd |
业务响应参数
|
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
|
|
code |
Integer |
是 |
|
返回码 |
0：表示成功； 3：表示失败，具体失败原因参见msg字段； 其他：参见4.1 公共返回码 |
|
|
msg |
String |
是 |
|
错误信息 |
|
|
|
data |
Authorization |
String |
是 |
|
认证口令 |
|
|
url |
String |
是 |
|
下载地址 |
|
|
请求示例
{promotionId”:1111 }
响应示例
{
"code": 0,
"data": {
"Authorization": “1daege111”,
"url": “https://”
}
"token": "DlRXdIjEBLRLCJgwTP37sZW6ls--NflxVS2-KUHl"
}
3.4.5券激活
外部接口方式传激活码，根据活动类型反馈激活成功（内部券号），或者领券二维码（针对微信号的激活），或者外部券号（导入券号）
method: allinpay.shopoint.bankService.couponActivation
version: 1.0
业务请求参数
|
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
|
activityCode |
String |
是 |
100 |
激活码 |
加密传输（详见2.3.4） |
|
shopId |
Integer |
是 |
10 |
激活网点 |
|
|
guideSysno |
Integer |
是 |
10 |
激活人 |
|
业务响应参数
|
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
|
|
code |
Integer |
是 |
|
返回码 |
0：表示成功； 3：表示失败，具体失败原因参见msg字段； 其他：参见4.1 公共返回码 |
|
|
msg |
String |
是 |
|
错误信息 |
|
|
|
data |
qrCode |
String |
否 |
|
领券二维码 |
|
请求示例
{
"activityCode": "ASAJSKDAKSHSAHDKASHFKAFJD",
"shopId": 1,
"guideSysno": 1
}
响应示例
{
"code": 0,
"data": {"qrCode": “1212121212121”}
}
特殊报错解释
见3.4.3特殊报错解释
3.4.6 微信/云闪付/支付宝/基础营销券核销通知
通过微信/云闪付/支付宝/基础营销券核销通知
method: allinpay.third.consume.couponno
version: 1.0
业务请求参数
|
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
|
promotionId |
Integer |
是 |
11 |
活动ID |
|
|
couponId |
String |
是 |
100 |
代金券id |
|
|
idType |
String |
否 |
100 |
发券类型 |
1联合授权openid、2银行Openid、3手机号、4支付宝账号、5基础营销用户id |
|
idValue |
String |
否 |
100 |
发券ID |
|
|
consumeTime |
String |
否 |
100 |
核销时间 |
|
|
consumeMchid |
String |
否 |
100 |
核销商户号 |
|
|
transactionId |
String |
否 |
100 |
核销订单号 |
|
|
extendId |
String |
否 |
100 |
微信/云闪付/支付宝/基础营销活动id |
|
业务响应参数
|
字段名 |
参数类型 |
必填 |
说明 |
取值 |
|
|
code |
Integer |
是 |
返回码 |
0：表示成功； 其他：表示失败。 |
|
|
msg |
String |
是 |
错误信息 |
|
|
|
data |
|
|
|
|
|
请求示例
{ “promotionId”:123,” couponId”:”2323432432423”}
响应示例
{
"code": 0,
"data":””,
"token": "DlRXdIjEBLRLCJgwTP37sZW6ls--NflxVS2-KUHl"
}
3.4.7后台用户同步
用户信息同步接口，创建平台用户
method: allinpay.shopoint.bankService.addSysUser
version: 1.0
业务请求参数
|
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
|
|
userType |
Integer |
是 |
4 |
同步用户类型 |
1.userId,以传入的userId为用户账号唯一标识 2. mobile，以传入的手机号为用户账号唯一标识 |
|
|
userList |
ArrayList |
是 |
|
用户信息列表 |
|
|
|
userId |
String |
否 |
30 |
外部系统用户id |
当userType为1的时候必填 |
|
|
mobile |
String |
否 |
11 |
柜员手机号 |
当userType为2的时候必填,加密传输（详见2.3.4） |
|
|
openid |
String |
否 |
64 |
微信机构公众号openid |
|
|
|
pwd |
String |
是 |
100 |
密码 |
加密传输（详见2.3.4） |
|
|
name |
String |
否 |
50 |
姓名 |
|
|
|
roleId |
Integer |
是 |
4 |
角色ID |
|
|
|
branchCode |
String |
否 |
20 |
网点编号 |
|
|
|
branchName |
String |
否 |
50 |
网点名称 |
|
|
业务响应参数
|
字段名 |
参数类型 |
必填 |
说明 |
取值 |
|
code |
Integer |
是 |
返回码 |
0：表示成功； 3：表示失败，具体失败原因参见msg字段； 其他：参见4.1 公共返回码 |
|
msg |
String |
是 |
错误信息 |
|
请求示例
{" userType":1, “userList”:[{ “userId”:”12345678”,” roleId”:123}]}
响应示例
{
"code": 0,
"data": true
"token": "DlRXdIjEBLRLCJgwTP37sZW6ls--NflxVS2-KUHl"
}
3.4.8微信代金券详情查询
通过此接口可查询代金券信息，包括代金券的基础信息、状态。如代金券已核销，会包括代金券核销的订单信息（订单号、单品信息等）。
method: allinpay.shopoint.bankService.wechatCoupon.query
version: 1.0
业务请求参数
|
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
|
couponId |
String |
是 |
20 |
微信券id |
|
业务响应参数
|
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
|
||||||
|
code |
Integer |
是 |
|
返回码 |
0：表示成功； 3：表示失败，具体失败原因参见msg字段； 其他：参见4.1 公共返回码 |
|
||||||
|
msg |
String |
是 |
|
错误信息 |
|
|
||||||
|
data |
stock_creator_mchid |
String |
是 |
|
创建批次的商户号 |
|
|
|||||
|
stock_id |
String |
是 |
|
批次号 |
|
|
||||||
|
coupon_id |
String |
是 |
|
代金券ID |
|
|
||||||
|
cut_to_message |
|
object |
否 |
|
单品优惠信息 |
|
|
|||||
|
single_price_max |
Integer |
是 |
|
可用优惠的商品最高单价 |
单位：分。 示例值：100 |
|
||||||
|
cut_to_price |
Integer |
是 |
|
减至后的优惠单价 |
单位：分。 示例值：100 |
|
||||||
|
coupon_name |
String |
是 |
|
代金券名称 |
|
|
||||||
|
status |
String |
是 |
|
代金券状态 |
代金券状态： SENDED：可用 USED：已实扣 EXPIRED：已过期 示例值：EXPIRED |
|
||||||
|
description |
String |
是 |
|
使用说明 |
|
|
||||||
|
create_time |
String |
是 |
|
领券时间 |
领券时间，遵循rfc3339标准格式，格式为YYYY-MM-DDTHH:mm:ss.sss+TIMEZONE，YYYY-MM-DD表示年月日，T出现在字符串中，表示time元素的开头，HH:mm:ss.sss表示时分秒毫秒，TIMEZONE表示时区（+08:00表示东八区时间，领先UTC 8小时，即北京时间）。例如：2015-05-20T13:29:35.120+08:00表示，北京时间2015年5月20日 13点29分35秒。 示例值: 2015-05-20T13:29:35.120+08:00 |
|
||||||
|
coupon_type |
String |
是 |
|
券类型 |
券类型： NORMAL：满减券 CUT_TO：减至券 示例值：CUT_TO |
|
||||||
|
no_cash |
Boolean |
是 |
|
是否无资金流 |
枚举值： true：是 false：否 示例值：true |
|
||||||
|
available_begin_time |
String |
是 |
|
可用开始时间 |
可用开始时间，遵循rfc3339标准格式，格式为YYYY-MM-DDTHH:mm:ss.sss+TIMEZONE，YYYY-MM-DD表示年月日，T出现在字符串中，表示time元素的开头，HH:mm:ss.sss表示时分秒毫秒，TIMEZONE表示时区（+08:00表示东八区时间，领先UTC 8小时，即北京时间）。例如：2015-05-20T13:29:35.120+08:00表示，北京时间2015年5月20日 13点29分35秒。 示例值: 2015-05-20T13:29:35.120+08:00 |
|
||||||
|
available_end_time |
String |
是 |
|
可用结束时间 |
可用开始时间，遵循rfc3339标准格式，格式为YYYY-MM-DDTHH:mm:ss.sss+TIMEZONE，YYYY-MM-DD表示年月日，T出现在字符串中，表示time元素的开头，HH:mm:ss.sss表示时分秒毫秒，TIMEZONE表示时区（+08:00表示东八区时间，领先UTC 8小时，即北京时间）。例如：2015-05-20T13:29:35.120+08:00表示，北京时间2015年5月20日 13点29分35秒。 示例值: 2015-05-20T13:29:35.120+08:00 |
|
||||||
| singleitem | Boolean | 是 | 是否单品优惠 |
枚举值： true：是 false：否 示例值：true |
|
|||||||
|
|
normal_coupon_information | Object | 否 | 满减券信息 |
普通满减券面额、门槛信息。 |
|
||||||
|
|
coupon_amount | Integer | 是 | 面额 |
面额，单位：分。 示例值：100 |
|
||||||
|
|
transaction_minimum | Integer | 是 | 门槛 |
使用券金额门槛，单位：分。 示例值：100 |
|
||||||
|
|
consume_information | Object | 否 | 已实扣代金券核销信息 |
|
|
||||||
|
|
consume_time | String | 是 | 核销时间 |
核销时间，遵循rfc3339标准格式，格式为YYYY-MM-DDTHH:mm:ss.sss+TIMEZONE，YYYY-MM-DD表示年月日，T出现在字符串中，表示time元素的开头，HH:mm:ss.sss表示时分秒毫秒，TIMEZONE表示时区（+08:00表示东八区时间，领先UTC 8小时，即北京时间）。例如：2015-05-20T13:29:35.120+08:00表示，北京时间2015年5月20日 13点29分35秒。 示例值: 2015-05-20T13:29:35.120+08:00 |
|
||||||
|
|
consume_mchid | String | 是 | 核销商户号 |
|
|
||||||
|
|
transaction_id | String | 是 | 核销订单号 |
|
|
||||||
|
|
goods_detail | Array | 是 | 单品信息 |
商户下单单品信息 |
|||||||
|
|
goods_id | String | 是 | 商品编码 |
|
|||||||
|
|
quantity | Integer | 是 | 商品数量 |
|
|||||||
|
|
price | Integer | 是 | 商品价格 |
|
|||||||
|
|
discount_amount | Integer | 是 | 优惠金额 |
|
|||||||
请求示例
{" couponId ": “9856888” }
响应示例
{
"code": 0,
"data": {
"stock_creator_mchid": "9800064",
"stock_id": "9865888",
"coupon_id": "98674556",
"cut_to_message": {
"single_price_max": 100,
"cut_to_price":100
},
"coupon_name": "微信支付代金券",
"status": "EXPIRED",
"description": "微信支付营销",
"create_time": "2015-05-20T13:29:35.120+08:00",
"coupon_type": "CUT_TO",
"no_cash": null,
"available_begin_time": "2015-05-20T13:29:35.120+08:00",
"available_end_time": "2015-05-20T13:29:35.120+08:00",
"singleitem": null,
"normal_coupon_information": {
"coupon_amount": 100,
"transaction_minimum": 100
},
"consume_information": {
"consume_time": "2015-05-20T13:29:35.120+08:00",
"consume_mchid": "9856081",
"transaction_id": "2345234523",
"goods_detail": [
{
"goods_id": "a_goods1",
"quantity": 7,
"price": 1,
"discount_amount": 4
}
]
}
} "token": "DlRXdIjEBLRLCJgwTP37sZW6ls--NflxVS2-KUHl"
}
3.4.9发券状态查询
调用3.4.3接口网络错误等情况时可调用该接口查询发券状态
method: allinpay.shopoint.bankService.couponSendQuery
version: 1.0
业务请求参数
|
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
|
orderId |
String |
否 |
64 |
外部发券订单号 |
3.4.3的外部发券订单号 |
业务响应参数
|
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
|
|
code |
Integer |
是 |
|
返回码 |
0：表示成功； 3：表示失败，具体失败原因参见msg字段； 其他：参见4.1 公共返回码 |
|
|
msg |
String |
是 |
|
错误信息 |
|
|
|
data |
status |
Integer |
是 |
|
返回值 |
三种情况： 0- 处理中 1- 成功 2- 失败 |
|
createTime |
String |
否 |
|
发券时间 |
yyyy-MM-dd HH:mm:ss |
|
|
couponNo |
String |
否 |
|
券号 |
3.4.3发券成功时返回的券号 |
|
|
failReason |
String |
否 |
|
失败原因 |
|
|
请求示例
{“orderId”:”12345678”}
响应示例
{
"code": 0,
"data": {
"status": 0
}
"token": "DlRXdIjEBLRLCJgwTP37sZW6ls--NflxVS2-KUHl"
}
3.4.10 更新活动信息
实时更新活动信息
method: allinpay.shopoint.bankService.updatePromotion
version: 1.0
业务请求参数
|
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
|
|
promotionId |
Integer |
是 |
11 |
活动ID |
|
|
|
objectInfo |
String |
否 |
200 |
活动对象说明 |
|
|
|
instruction |
String |
否 |
500 |
活动介绍 |
|
|
|
appendWhiteList |
List |
否 |
200 |
需要追加的白名单列表,最多200个 |
|
|
|
|
itemNo |
String |
是 |
50 |
白名单值最大长度50 |
|
|
itemType |
Integer |
是 |
1 |
白名单类型 |
1卡BIN、2卡号、3手机号 |
|
业务响应参数
|
字段名 |
参数类型 |
必填 |
说明 |
取值 |
|
code |
Integer |
是 |
返回码 |
0：表示成功； 3：表示失败，具体失败原因参见msg字段； 其他：参见4.1 公共返回码 |
|
msg |
String |
是 |
错误信息 |
|
请求示例
{
"promotionId": 1,
"instruction": "活动介绍修改",
"appendWhiteList": [
{
"itemType": 3,
"itemNo": "13488888888"
},
{
"itemType": 3,
"itemNo": "13599999999"
}
]
}
响应示例
{
"code": 0,
"data": {}
"token": "DlRXdIjEBLRLCJgwTP37sZW6ls--NflxVS2-KUHl"
}
3.4.11微信批次退款流水下载
微信批次退款流水下载接口.
method: allinpay.shopoint.bankService.wechat.refundFlow.query
version: 1.0
业务请求参数
|
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
|
promotionId |
Integer |
否 |
11 |
活动id |
与extendId必填其一 |
|
extendId |
String |
否 |
|
微信活动批次号 |
根据promotionId下载时，如果活动配置多个批次号时必填, 只配置一个批次号可不填 |
|
version |
Integer |
否 |
11 |
微信API版本 |
1-1.0版本;2-2.0版本 对接方未填默认为1 |
|
billDate |
String |
否 |
10 |
账单日期,仅version=2时必填 |
yyyy-MM-dd |
业务响应参数
|
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
|
|
code |
Integer |
是 |
|
返回码 |
0：表示成功； 3：表示失败，具体失败原因参见msg字段； 其他：参见4.1 公共返回码 |
|
|
msg |
String |
是 |
|
错误信息 |
|
|
|
data |
refundFlowUrl |
String |
是 |
|
退款流水下载地址 |
有效期2分钟 |
|
Authorization |
String |
否 |
|
认证口令 |
仅version=2时必填 |
|
|
url |
String |
否 |
|
下载地址 |
仅version=2时必填 |
|
请求示例
{promotionId”:1111 }
响应示例
{
"code": 0,
"data": {
"authorization": “1daege111”,
"refundFlowUrl": “https://”
}
"token": "DlRXdIjEBLRLCJgwTP37sZW6ls--NflxVS2-KUHl"
}
3.4.12查询活动详情
查询通惠活动详情.
method: allinpay.shopoint.bankService.promotion.query
version: 1.0
业务请求参数
|
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
|
promotionId |
Integer |
是 |
11 |
活动id |
|
|
extendId |
String |
否 |
128 |
微信/支付宝/云闪付活动批次号 |
|
业务响应参数
|
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
||
|
code |
Integer |
是 |
4 |
返回码 |
0：表示成功； 3：表示失败，具体失败原因参见msg字段； 其他：参见4.1 公共返回码 |
||
|
msg |
String |
是 |
200 |
错误信息 |
|
||
|
data |
promotionId |
Integer |
是 |
11 |
活动ID |
|
|
|
promotionName |
String |
是 |
50 |
活动名称 |
|
||
|
promotionType |
Integer |
是 |
4 |
活动类型 |
10-银行返券活动 11-银行打折 12-银行满减 13-银行领券活动 14-银行售券活动 15-银行积分换券活动 16-银行积分抵扣活动 21-微信打折 22-微信立减 23-微信领全场满减券活动 25-银行积分换微信券活动 33-云闪付领券 43-支付宝领券 45-银行积分换支付宝券活动 |
||
| promotionDiscount
|
discountPercent
|
BigDecimal |
是 |
14 |
折扣百分比 |
无百分号，8.5代表8.5% |
|
|
minAmount |
BigDecimal |
否 |
14 |
折扣最低支付金额 |
单位：元 |
||
|
maxAmount |
BigDecimal |
否 |
14 |
最高折扣优惠金额 |
单位：元 |
||
|
promotionOff |
offSetting |
String |
是 |
5000 |
满减设置(json字符串) |
minAmount 门槛金额 offAmount优惠金额 maxAmount最大优惠金额 当offType=0时，只有1条记录，每满minAmount减offAmount，最大可减maxAmount 当offType=1时，满minAmount 减offAmount 当offType=2时，满minAmount随机减offAmount到maxAmount |
|
|
offType |
Integer |
是 |
4 |
满减类型 |
0-每满减 1-阶梯满减 2-随机立减 |
||
|
totalStockNum |
Integer |
是 |
11 |
总库存 |
|
||
|
startTime |
String |
是 |
19 |
活动开始时间 |
yyyy-MM-dd HH:mm:ss |
||
|
endTime |
String |
是 |
19 |
活动结束时间 |
yyyy-MM-dd HH:mm:ss |
||
|
rangeMonth |
String |
否 |
26 |
可用月份 |
1～12，多个以逗号分隔 |
||
|
rangeDate |
String |
否 |
83 |
可用日期 |
1～31，多个以逗号分隔 |
||
|
rangeDayOfWeek |
String |
否 |
14 |
每周几可用 |
1～7，多个以逗号分隔 |
||
|
rangeTime |
String |
否 |
11 |
活动时段 |
HH:mm~HH:mm |
||
|
inHoliday |
Integer |
否 |
1 |
节假日 |
0-节假日不可参与，1-仅节假日可参与 |
||
|
displayStartTime |
String |
否 |
19 |
活动上架时间 |
yyyy-MM-dd HH:mm:ss |
||
|
displayEndTime |
String |
否 |
19 |
活动下架时间 |
yyyy-MM-dd HH:mm:ss |
||
|
maxNumEveryone |
Integer |
否 |
11 |
每人总限领 |
每个顾客每个活动限领数量 |
||
|
maxNumEveryoneFrequency |
String |
否 |
20 |
每人领取频率 |
N/每人每日、周、月） |
||
|
maxNumFrequency |
String |
否 |
20 |
活动总限领 |
N/日、周、月 |
||
|
totalBudget |
String |
否 |
14 |
活动银行总预算 |
单位元 |
||
|
totalMchtBudget |
String |
否 |
14 |
活动商户总预算 |
单位元 |
||
|
limitBudgetList |
ArrayList |
否 |
|
活动预算限制 |
参见limitBudgetList字段说明 |
||
|
authorityType |
Integer |
否 |
1 |
活动归属类型 |
0-所有网点、1-指定区县、2-指定网点 |
||
|
authorityId |
Integer |
否 |
11 |
活动归属 |
活动归属类型为1时返回区县ID，为2时返回网点ID |
||
|
authorityName |
String |
否 |
50 |
活动归属名称 |
|
||
|
instruction |
String |
否 |
1500 |
活动说明 |
|
||
|
templateList |
ArrayList |
是 |
|
券模板信息 |
详见templateList字段说明 |
||
|
stockDetail |
JSONString |
否 |
|
微信批次明细 |
详见stockDetail字段说明，仅请求extendId不为空或活动仅有一个批次ID时返回 |
||
|
wechatTemplateList |
ArrayList |
否 |
|
微信批次明细列表 |
详见stockDetail字段说明 |
||
|
alipayTemplateList |
ArrayList |
否 |
|
支付宝活动明细 |
详见alipayTemplateList字段说明 |
||
|
unionpayTemplateList |
ArrayList |
否 |
|
云闪付活动明细 |
详见unionpayTemplateList字段说明 |
||
limitBudgetList字段：
|
limitObject |
String |
否 |
8 |
限制对象 |
银行预算、商户预算 |
|
limitTime |
String |
否 |
4 |
限制时间 |
每日、每周、每月 |
|
limitAmount |
String |
否 |
14 |
限制金额 |
单位元 |
templateList字段明细：
|
templateId |
Integer |
是 |
11 |
券模板ID |
|
|
couponName |
String |
是 |
50 |
券名称 |
|
|
couponType |
String |
是 |
8 |
券类型 |
金额券、满减券、计次券 |
|
initAmount |
Integer |
是 |
11 |
面额 |
单位分 |
|
unit |
String |
是 |
5 |
单位 |
非计次券为分，计次券根据配置的单位 |
|
validityType |
Integer |
是 |
4 |
有效期类型 |
0-指定日期范围，1-领用之日起n天内 |
|
validityBeginDate |
String |
否 |
19 |
有效期开始日期 |
yyyy-MM-dd HH:mm:ss |
|
validityEndDate |
String |
否 |
19 |
有效期结束日期 |
yyyy-MM-dd HH:mm:ss |
|
validityBeginDays |
Integer |
否 |
11 |
领用后多少天后生效 |
|
|
validityDays |
Integer |
否 |
11 |
领用之日起多少天内有效 |
|
|
rangeDate |
String |
否 |
83 |
可用日期 |
|
|
rangeDayOfWeek |
String |
否 |
14 |
每周几可用 |
|
|
rangeTime |
String |
否 |
100 |
每天哪些时间段可用 |
|
|
inHoliday |
Integer |
否 |
1 |
节假日 |
0-节假日不可参与，1-仅节假日可参与 |
|
usableAmount |
String |
否 |
16 |
每满多少金额可用1张 |
|
|
usableMaxNum |
Integer |
否 |
11 |
每订单最多使用多少张 |
|
|
extendId |
String |
否 |
128 |
微信/支付宝/云闪付活动批次号 |
|
stockDetail字段明细：
|
availableBeginTime |
String |
否 |
32 |
可用开始时间 |
yyyy-MM-dd HH:mm:ss |
|
availableEndTime |
String |
否 |
32 |
可用结束时间 |
yyyy-MM-dd HH:mm:ss |
|
description |
String |
否 |
3000 |
使用说明 |
|
|
distributedCoupons |
Integer |
否 |
11 |
已发券数量 |
|
|
status |
String |
否 |
12 |
批次状态 |
UNACTIVATED：未激活 AUDIT：审核中 RUNNING：运行中 STOPED：已停止 PAUSED：暂停发放 |
|
stockCreatorMchid |
String |
否 |
20 |
创建批次商户号 |
|
|
stockId |
String |
否 |
20 |
批次号 |
|
|
stockName |
String |
否 |
20 |
批次名称 |
|
|
stockType |
String |
否 |
16 |
批次类型 |
NORMAL-代金券批次 DISCOUNT_CUT-立减与折扣 OTHER-其他 |
|
stockUseRule |
JSONString |
否 |
|
满减券批次使用规则 |
详见stockUseRule |
stockUseRule字段明细：
|
couponType |
String |
否 |
16 |
券类型 |
NORMAL：满减券 CUT_TO：减至券 |
|
maxAmount |
Integer |
否 |
20 |
总预算 |
|
|
maxCoupons |
Integer |
否 |
20 |
发放总上限 |
|
|
maxCouponsPerUser |
Integer |
否 |
11 |
单个用户可领个数 |
|
|
fixedNormalCoupon |
JSONString |
否 |
|
固定面额批次特定信息 |
详见fixedNormalCoupon |
fixedNormalCoupon字段明细：
|
couponAmount |
Integer |
否 |
20 |
面额，单位分 |
|
|
transactionMinimum |
Integer |
否 |
20 |
门槛，单位分 |
|
alipayTemplateList字段明细：
|
acticityId |
String |
是 |
128 |
支付宝活动ID |
|
|
activityName |
String |
是 |
100 |
支付宝活动名称 |
|
|
activityStatus |
String |
是 |
32 |
活动状态 |
CREATED-已创建,PUBLISHING-发布中,PUBLISHED_FAILED-发布失败,GREY-已发布(白名单验证中),GOING-已发布,PAUSED-已暂停,ENDED-已结束 |
|
bankCardType |
String |
是 |
32 |
卡类型 |
CREDIT-信用卡,DEBIT-借记卡,DEBIT_CREDIT-借记卡或信用卡 |
|
cardBinList |
String |
否 |
2000 |
银行卡卡bin配置 |
逗号分割 |
|
totalBudget |
Long |
否 |
20 |
活动总预算值 |
单位分 |
|
minSendCount |
Integer |
否 |
11 |
最少发放红包份数 |
|
|
userInstructionList |
String |
否 |
2000 |
使用说明 |
|
|
discountType |
String |
否 |
32 |
立减类型 |
reduce-固定立减，random-随机立减 |
|
discountThresholdAmt |
Long |
否 |
20 |
门槛金额 |
单位分 |
|
discountValue |
String |
否 |
64 |
优惠立减值 |
单位分 |
|
sendBeginTime |
String |
否 |
19 |
红包发放开始时间 |
yyyy-MM-dd HH:mm:ss |
|
sendEndTime |
String |
否 |
19 |
红包发放结束时间 |
yyyy-MM-dd HH:mm:ss |
|
cyclePeriodType |
String |
否 |
32 |
限定周期时间类型 |
DAY_OF_WEEK-星期维度 |
|
cyclePeriodValue |
String |
否 |
500 |
发放周期类型下具体值 |
|
|
subCyclePeriodType |
String |
否 |
32 |
子限定周期时间类型 |
在周期时间范围下,子周期限定时间类型,SECOND_OF_DAY-一天内具体时间点(秒为单位) |
|
subCyclePeriodValue |
String |
否 |
500 |
发放子周期类型下具体值 |
|
|
couponAvailablePeriodType |
String |
否 |
32 |
时间周期类型 |
ABSOLUTELY-绝对时间, RELATIVE-相对时间 |
|
couponAbsolutelyBeginTime |
String |
否 |
19 |
红包发放开始时间 |
yyyy-MM-dd HH:mm:ss |
|
couponAbsolutelyEndTime |
String |
否 |
19 |
红包发放结束时间 |
yyyy-MM-dd HH:mm:ss |
|
couponRelativeBeginRoundingType |
String |
否 |
64 |
红包发放开始时间周期类型 |
DAYS-天级,MINUTES-分钟级 |
|
couponRelativeBeginValue |
Integer |
否 |
11 |
红包发放开始时间相对值 |
|
|
couponRelativeEndRoundingType |
String |
否 |
64 |
红包发放结束时间周期类型 |
DAYS-天级,MINUTES-分钟级 |
|
couponRelativeEndValue |
Integer |
否 |
11 |
红包发放结束时间相对值 |
|
|
receiveCount |
Integer |
否 |
11 |
该活动上已领取红包数量 |
|
|
receiveAmount |
Long |
否 |
20 |
该活动上已领取红包金额 |
单位分 |
|
usedCount |
Integer |
否 |
11 |
该活动上已核销红包数量 |
|
|
usedAmount |
Long |
否 |
20 |
该活动上已核销红包金额 |
单位分 |
|
refundAmount |
Long |
否 |
20 |
该活动上已退款红包金额 |
单位分 |
|
availableAmount |
Long |
否 |
20 |
该活动上剩余红包金额 |
单位分 |
unionpayTemplateList字段明细：
|
extendId |
String |
是 |
50 |
批次号 |
|
|
activityType |
String |
是 |
2 |
活动类型 |
02-优惠券 |
|
activityName |
String |
是 |
64 |
活动名称 |
|
|
beginTime |
String |
否 |
19 |
开始时间 |
yyyy-MM-dd HH:mm:ss |
|
endTime |
String |
否 |
19 |
结束时间 |
yyyy-MM-dd HH:mm:ss |
|
activityStatus |
String |
否 |
2 |
活动状态 |
00-停用，01-启用 |
|
limitType |
String |
否 |
2 |
限制类型 |
01-金额限制,02-次数限制,03-金额次数同时限制 |
|
activityMark |
String |
否 |
2 |
活动标识 |
01-活动全部分配,02-活动按日平均分配,03-活动按指定日或周几分配,04-活动按月平均分配 |
|
startMark |
String |
否 |
1 |
启动标识 |
1-今天是活动日,2-今天不是活动日 |
|
dayCount |
String |
否 |
20 |
当天总张数 |
|
|
dayRemainCount |
String |
否 |
20 |
当天剩余总张数 |
|
|
dayRemainCountPercent |
String |
否 |
8 |
当天剩余张数百分比 |
|
|
lastRemainTime |
String |
否 |
19 |
当天总张数用完时间 |
|
|
allCount |
String |
否 |
20 |
活动总张数 |
|
|
allRemainCount |
String |
否 |
20 |
活动剩余总张数 |
|
|
allRemainCountPercent |
String |
否 |
8 |
活动剩余张数百分比 |
|
|
allCountUseupTime |
String |
否 |
19 |
活动总张数用完时间 |
|
请求示例
{promotionId”:1111 }
响应示例
{
"code": 0,
"data": {
"authorization": “1daege111”,
"refundFlowUrl": “https://”
}
"token": "DlRXdIjEBLRLCJgwTP37sZW6ls--NflxVS2-KUHl"
}
3.4.13 通惠券发放核销综合明细分页查询
method: allinpay.shopoint.bankService.couponSendConsumeQuery
version: 1.0
前置接口：需要先调用3.1.6统一登录注册入口（scope=4登录商户后台）获取到token
业务请求参数
|
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
|
token |
String |
是 |
|
调用3.1.6 统一登录（scope=4）后获得的token。 |
|
|
pageNo |
Integer |
否 |
|
页码 |
不填默认1, 最小为1
|
|
sendStartTime |
String |
否 |
|
领券开始时间 |
格式：yyyy-MM-dd HH:mm:ss 1.控制发放/核销查询条件的日期范围在一年内2.当未指定领券时间范围时，默认领券时间范围为:近7天3.未指定领券时间范围，但指定了核销时间范围时，设置领券时间的范围为近一年内。
|
|
sendEndTime |
String |
否 |
|
领券结束时间 |
|
|
consumeStartTime |
String |
否 |
|
核销开始时间 |
|
|
consumeEndTime |
String |
否 |
|
核销结束时间 |
|
|
promotionId |
Integer |
否 |
|
活动Id |
|
|
outUserId |
String |
否 |
|
外部客户号 |
|
|
promotionOrgId |
Integer |
否 |
|
活动归属机构id |
|
|
createSource |
Integer |
否 |
|
发放方式 |
19，领券活动 27，导购发券活动 28，积分售券活动 |
|
mobile |
String |
否 |
|
领券手机号 |
|
|
couponNo |
String |
否 |
|
券号 |
|
|
bankOutletsShopId |
Integer |
否 |
|
发券网点id |
|
|
bankOutletsShopCode |
String |
否 |
|
发券网点编码 |
|
|
sendShopName |
String |
否 |
|
发券网点名称 |
|
|
consumeShopName |
String |
否 |
|
核销网点名称 |
|
|
status |
Integer |
否 |
|
券状态 |
2，待激活 3，待核销 4，部分核销 5，已核销 |
|
privilegeOrgId |
Integer |
否 |
|
归属机构 |
|
|
privilegeGroupId |
Integer |
否 |
|
归属区县 |
|
|
privilegeShopId |
Integer |
否 |
|
归属网点 |
|
业务响应参数
|
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
||
|
code |
Integer |
是 |
|
返回码 |
0：表示成功； 3：表示失败，具体失败原因参见msg字段； 其他：参见4.1 公共返回码 |
||
|
msg |
String |
是 |
|
错误信息 |
|
||
|
data |
total |
Integer |
否 |
|
总数 |
只在第1页中返回交易流水总条数 |
|
|
current |
Integer |
是 |
|
分页页码 |
|
||
|
size |
Integer |
是 |
|
分页大小 |
|
||
|
records |
List |
否 |
|
流水分页 |
|
||
|
|
promotionId |
Integer |
否 |
|
活动Id |
|
|
|
promotionName |
String |
否 |
|
活动名称 |
|
||
|
couponName |
String |
是 |
|
券名称 |
|
||
|
couponType |
Integer |
是 |
|
券类型 |
|
||
|
receivedTime |
DateTime |
是 |
|
领券时间 |
|
||
|
validityBeginDate |
DateTime |
是 |
|
券有效开始日 |
|
||
|
validityEndDate |
DateTime |
是 |
|
券有效结束日 |
|
||
|
createSource |
Integer |
是 |
|
发券方式 |
|
||
|
promotionType |
Integer |
否 |
|
活动类型 |
|
||
|
needActivate |
Boolean |
是 |
|
是否需要激活 |
|
||
|
outUserId |
String |
是 |
|
外部客户号 |
|
||
|
bankMobile |
String |
否 |
|
持卡人手机号 |
|
||
|
promotionOrgId |
Integer |
否 |
|
活动归属机构id |
|
||
|
bankCardNum |
String |
否 |
|
持卡人银行卡号 |
|
||
|
bankCardBelongBank |
String |
否 |
|
持卡人银行卡归属银行 |
|
||
|
openId |
String |
否 |
|
openId |
|
||
|
mobile |
String |
否 |
|
领券人手机号 |
|
||
|
initAmount |
BigDecimal |
是 |
|
面额（元/次） |
|
||
|
couponNo |
String |
是 |
|
券号 |
|
||
|
couponSenderUserId |
String |
否 |
|
发券人账号 |
|
||
|
couponSenderUserName |
String |
否 |
|
发券人姓名 |
|
||
|
couponSenderUserMobile |
String |
否 |
|
发券人电话 |
|
||
|
sendOutletsName |
String |
否 |
|
发券网点名称 |
|
||
|
bankOutletsShopId |
Integer |
否 |
|
发券网点ID |
|
||
|
bankOutletsShopCode |
String |
否 |
|
发券网点编号 |
|
||
|
sendOutletsGroupName |
String |
否 |
|
发券网点归属区县 |
|
||
|
sendShopName |
String |
否 |
|
发券店铺名称 |
|
||
|
sendCouponRemark |
String |
否 |
|
发券备注 |
|
||
|
businessId |
Integer |
否 |
|
任务ID |
|
||
|
businessName |
String |
否 |
|
任务名称 |
|
||
|
remarkActivateShopId |
Integer |
否 |
|
激活网点ID |
|
||
|
remarkActivateShopName |
String |
否 |
|
激活网点名称 |
|
||
|
remarkActivateUserName |
String |
否 |
|
激活人名称 |
|
||
|
remarkActivateUserMobile |
String |
否 |
|
激活人电话 |
|
||
|
orderId |
String |
否 |
|
外部发券订单号 |
|
||
|
receivedRemark |
String |
否 |
|
领券备注 |
|
||
|
activeRemark |
String |
否 |
|
激活备注 |
|
||
|
businessInfo |
String |
否 |
|
收集业务信息 |
|
||
|
consumeOrderId |
Integer |
否 |
|
核券订单号 |
|
||
|
consumeBalance |
BigDecimal |
是 |
|
核券金额 |
|
||
|
balance |
BigDecimal |
是 |
|
券余额 |
|
||
|
bankSubsidyAmount |
BigDecimal |
否 |
|
银行补贴金额（补贴） |
|
||
|
mchtSubsidyAmount |
BigDecimal |
否 |
|
商户补贴金额 |
|
||
|
consumeTime |
DateTime |
是 |
|
使用时间 |
|
||
|
consumeOrgName |
String |
是 |
|
使用机构名称 |
|
||
|
consumeOrgId |
Integer |
是 |
|
使用机构编号 |
|
||
|
consumeShopName |
String |
否 |
|
使用门店名称 |
|
||
|
consumeMchtCd |
String |
否 |
|
使用门店商户号 |
|
||
|
consumeUserId |
String |
否 |
|
核销人账号 |
|
||
|
consumeUserName |
String |
否 |
|
核销人姓名 |
|
||
|
consumeOutletsShopName |
String |
否 |
|
核销网点名称 |
|
||
|
consumeOutletsShopGroupName |
String |
否 |
|
核销网点归属区县名称 |
|
||
|
orderCode |
String |
否 |
|
交易订单号 |
|
||
|
orderAmount |
BigDecimal |
否 |
|
订单金额 |
|
||
|
consumeRemark |
String |
否 |
|
核销备注 |
|
||
|
mchtOutlets |
String |
否 |
|
商户归属网点 |
|
||
|
status |
Integer |
是 |
|
券状态 |
|
||
|
settleStatus |
Integer |
否 |
|
结算状态 |
|
||
请求示例
{
"pageNo": "1",
"pageSize": "10",
"consumeTimeStart": "2022-08-26 14:00:00",
"consumeTimeEnd": "2022-08-26 17:00:00"
}
响应示例
{
"total": 2,
"pageNo": 1,
"pageSize": 10,
"resultList": [
{
"changeSource": 311,
"couponName": "lq121401",
"createTime": "2022-08-26 14:41:02",
"couponType": 0,
"newBalance": 400,
"couponNo": "83000100000000055331",
"changeId": 272525,
"shopId": 147,
"templateId": 6244620,
"balanceChanged": 400,
"createUserLoginName": "hl导购"
},
{
"changeSource": 31,
"couponName": "lq121401",
"createUserId": 358,
"createTime": "2022-08-26 14:39:16",
"couponType": 0,
"newBalance": 0,
"couponNo": "83000100000000055331",
"changeId": 272522,
"shopId": 147,
"templateId": 6244620,
"balanceChanged": -400,
"createUserLoginName": "hl导购"
}
]
}
3.4.14 微信券发放核销实时明细表分页查询
method: allinpay.shopoint.bankService.wechatCouponSendConsumeQuery
version: 1.0
前置接口：需要先调用3.1.6统一登录注册入口（scope=4登录商户后台）获取到token
业务请求参数
|
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
|
token |
String |
是 |
|
调用3.1.6 统一登录（scope=4）后获得的token。 |
|
|
pageNo |
Integer |
否 |
|
页码 |
不填默认1, 最小为1
|
|
sendStartTime |
String |
否 |
|
领券开始时间 |
格式：yyyy-MM-dd HH:mm:ss 1.控制发放/核销查询条件的日期范围在一年内2.当未指定领券时间范围时，默认领券时间范围为:近7天3.未指定领券时间范围，但指定了核销时间范围时，设置领券时间的范围为近一年内。
|
|
sendEndTime |
String |
否 |
|
领券结束时间 |
|
|
consumeStartTime |
String |
否 |
|
核销开始时间 |
|
|
consumeEndTime |
String |
否 |
|
核销结束时间 |
|
|
stockId |
String |
否 |
|
批次ID |
|
|
couponId |
String |
否 |
|
优惠券ID |
|
|
outUserId |
String |
否 |
|
外部客户号 |
|
|
promotionOrgId |
Integer |
否 |
|
活动归属机构id |
|
|
mobile |
String |
否 |
|
领券人手机号 |
|
|
bankOutletsShopId |
Integer |
否 |
|
发券网点id |
|
|
bankOutletsShopCode |
String |
否 |
|
发券网点编码 |
|
|
sendShopName |
String |
否 |
|
发券网点名称 |
|
|
status |
Integer |
否 |
|
券状态 |
1, 待核销 2，已核销 |
|
privilegeOrgId |
Integer |
否 |
|
归属机构 |
|
|
privilegeGroupId |
Integer |
否 |
|
归属区县 |
|
|
privilegeShopId |
Integer |
否 |
|
归属网点 |
|
业务响应参数
|
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
||
|
code |
Integer |
是 |
|
返回码 |
0：表示成功； 3：表示失败，具体失败原因参见msg字段； 其他：参见4.1 公共返回码 |
||
|
msg |
String |
是 |
|
错误信息 |
|
||
|
data |
total |
Integer |
否 |
|
总数 |
只在第1页中返回交易流水总条数 |
|
|
current |
Integer |
是 |
|
分页页码 |
|
||
|
size |
Integer |
是 |
|
分页大小 |
|
||
|
records |
List |
否 |
|
流水分页 |
|
||
|
|
promotionId |
Integer |
否 |
|
活动Id |
|
|
|
promotionName |
String |
否 |
|
活动名称 |
|
||
|
promotionStatusDesc |
String |
否 |
|
活动状态 |
|
||
|
stockId |
String |
是 |
|
批次ID |
|
||
|
couponId |
String |
是 |
|
优惠券ID |
|
||
|
couponType |
String |
是 |
|
优惠券类型 |
|
||
|
couponName |
String |
是 |
|
优惠券名称 |
|
||
|
bankCardNum |
String |
否 |
|
持卡人银行卡号 |
|
||
|
bankCardBelongBank |
String |
否 |
|
持卡人银行卡归属银行 |
|
||
|
outUserId |
String |
是 |
|
外部客户号 |
|
||
|
openId |
String |
否 |
|
领取用户openid |
|
||
|
mobile |
String |
否 |
|
领取用户手机号 |
|
||
|
promotionOrgId |
Integer |
否 |
|
活动归属机构id |
|
||
|
createUserShopName |
String |
否 |
|
活动归属 |
|
||
|
mobileAccount |
String |
否 |
|
领取账户 |
|
||
|
initAmount |
BigDecimal |
是 |
|
面额 |
|
||
|
stockNum |
Integer |
否 |
|
发行数量 |
|
||
|
couponSenderUserId |
String |
否 |
|
发券人ID |
|
||
|
couponSenderUserName |
String |
否 |
|
发券人姓名 |
|
||
|
bankOutletsShopId |
Integer |
否 |
|
发券网点id |
|
||
|
bankOutletsShopCode |
String |
否 |
|
发券网点编码 |
|
||
|
sendOutletsName |
String |
否 |
|
发券网点名称 |
|
||
|
sendTime |
DateTIme |
是 |
|
发放时间 |
|
||
|
sendCouponRemark |
String |
否 |
|
发券备注 |
|
||
|
businessId |
Integer |
否 |
|
任务ID |
|
||
|
businessName |
String |
否 |
|
任务名称 |
|
||
|
businessInfo |
String |
否 |
|
收集业务信息 |
|
||
|
consumeAmount |
BigDecimal |
是 |
|
核销金额 |
|
||
|
consumeTime |
DateTime |
是 |
|
核销时间 |
|
||
|
consumeMchtId |
String |
否 |
|
核券商户号 |
|
||
|
consumeOrderId |
String |
否 |
|
核销订单号 |
|
||
|
status |
String |
是 |
|
券状态 |
|
||
请求示例
{
"pageNo": "1",
"pageSize": "10",
"consumeTimeStart": "2022-08-26 14:00:00",
"consumeTimeEnd": "2022-08-26 17:00:00"
}
响应示例
{
"total": 2,
"pageNo": 1,
"pageSize": 10,
"resultList": [
{
"changeSource": 311,
"couponName": "lq121401",
"createTime": "2022-08-26 14:41:02",
"couponType": 0,
"newBalance": 400,
"couponNo": "83000100000000055331",
"changeId": 272525,
"shopId": 147,
"templateId": 6244620,
"balanceChanged": 400,
"createUserLoginName": "hl导购"
},
{
"changeSource": 31,
"couponName": "lq121401",
"createUserId": 358,
"createTime": "2022-08-26 14:39:16",
"couponType": 0,
"newBalance": 0,
"couponNo": "83000100000000055331",
"changeId": 272522,
"shopId": 147,
"templateId": 6244620,
"balanceChanged": -400,
"createUserLoginName": "hl导购"
}
]
}
3.4.15 互动营销发放核销明细分页查询
method: allinpay.shopoint.bankService.marketingCouponConsumePageQuery
version: 1.0
前置接口：需要先调用3.1.6统一登录注册入口（scope=4登录商户后台）获取到token
业务请求参数
|
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
|
token |
String |
是 |
|
调用3.1.6 统一登录（scope=4）后获得的token。 |
|
|
pageNo |
Integer |
否 |
|
页码 |
不填默认1, 最小为1
|
|
sendStartTime |
String |
否 |
|
领券开始时间 |
格式：yyyy-MM-dd HH:mm:ss |
|
sendEndTime |
String |
否 |
|
领券结束时间 |
格式：yyyy-MM-dd HH:mm:ss |
|
consumeStartTime |
String |
否 |
|
核销开始时间 |
格式：yyyy-MM-dd HH:mm:ss |
|
consumeEndTime |
String |
否 |
|
核销结束时间 |
格式：yyyy-MM-dd HH:mm:ss |
|
outUserId |
String |
否 |
|
外部客户号 |
|
|
activityId |
Integer |
是 |
|
活动编号 |
|
|
promotionId |
Integer |
否 |
|
奖品活动id |
|
|
detailType |
Integer |
是 |
|
明细类型 |
1-发放明细; 2-核销明细 |
|
promotionCouponType |
Integer |
是 |
|
券类型 |
1-通联券; 2-微信券；4-支付宝券 |
|
privilegeOrgId |
Integer |
否 |
|
归属机构 |
|
|
privilegeGroupId |
Integer |
否 |
|
归属区县 |
|
|
privilegeShopId |
Integer |
否 |
|
归属网点 |
|
业务响应参数
|
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
||
|
code |
Integer |
是 |
|
返回码 |
0：表示成功； 3：表示失败，具体失败原因参见msg字段； 其他：参见4.1 公共返回码 |
||
|
msg |
String |
是 |
|
错误信息 |
|
||
|
data |
total |
Integer |
否 |
|
总数 |
只在第1页中返回交易流水总条数 |
|
|
current |
Integer |
是 |
|
分页页码 |
|
||
|
size |
Integer |
是 |
|
分页大小 |
|
||
|
records |
List |
否 |
|
流水分页 |
|
||
|
|
activityId |
Integer |
是 |
|
互动营销活动id |
|
|
| name |
String |
是 |
|
互动营销活动名称 |
|
||
| orgId |
Integer |
是 |
|
机构id |
|
||
| orgName |
String |
是 |
|
机构名称 |
|
||
| promotionId |
Integer |
是 |
|
活动Id |
|
||
|
promotionName |
String |
是 |
|
活动名称 |
|
||
|
promotionType |
Integer |
是 |
|
活动类型 |
13：通联领券活动； 23：微信领券活动；33：云闪付领券活动；43：支付宝领券活动 |
||
|
channel |
Integer |
否 |
|
投放渠道 |
1：通联；2：微信；3：云闪付；4：支付宝 |
||
|
extendId |
String |
否 |
|
外部活动批次id |
根据channel取值对应其类型的批次号 |
||
|
serviceOrgName |
String |
否 |
|
服务商名称 |
|
||
|
outUserId |
String |
是 |
|
外部客户号 |
|
||
|
couponId |
Integer |
否 |
|
优惠券ID |
|
||
|
couponName |
String |
是 |
|
优惠券名称 |
|
||
|
couponNo |
String |
否 |
|
优惠券号 |
|
||
|
couponType |
Integer |
否 |
|
优惠券类型 |
0：现金卡； 1: 代金券； 2:计次券; 3:满减活动券; 4 会员积分 |
||
|
status |
Integer |
否 |
|
券状态 |
0 ：有效；1：冻结；2：已作废； 3 ： 已核销 |
||
|
prizeName |
String |
否 |
|
奖品名称 |
|
||
|
createSource |
Integer |
否 |
|
发放方式 |
21:接口发券 |
||
|
num |
Integer |
否 |
|
发券数量 |
|
||
|
initAmount |
String |
否 |
|
发券面额 |
单位:元 |
||
|
openid |
String |
否 |
|
领取用户openid |
|
||
|
mobile |
String |
否 |
|
领取用户手机号 |
|
||
|
receiveUserName |
String |
否 |
|
领券用户名 |
|
||
|
createTime |
String |
否 |
|
领券时间 |
|
||
|
county |
String |
否 |
|
发券区县信息 |
|
||
|
alipayAccount |
String |
否 |
|
领取用户支付宝账户 |
|
||
|
linkDesc |
String |
否 |
|
收购点信息 |
|
||
|
balance |
String |
否 |
|
通联券发券余额/次数 |
次数：单位：次 金额：单位：元 |
||
|
newBalance |
String |
否 |
|
通联券核销剩余余额/次数 |
次数：单位：次 金额：单位：元 |
||
|
balanceChanged |
String |
否 |
|
通联券核销余额变动值 |
次数：单位：次 金额：单位：元 |
||
|
orderCode |
String |
否 |
|
通联券核销订单号 |
|
||
|
changeSource |
Integer |
否 |
|
通联券核销来源 |
31：订单核销； 32：次卡核销 |
||
|
tranNo |
String |
否 |
|
通联券核销订单号 |
|
||
|
bankAmount |
String |
否 |
|
通联券核销银行补贴金额（补贴） |
金额：单位：元 |
||
|
saleAmount |
String |
否 |
|
通联券核销银行补贴金额（售券） |
金额：单位：元 |
||
|
mchtAmount |
String |
否 |
|
通联券核销商户补贴金额 |
金额：单位：元 |
||
|
consumeOrgId |
Integer |
否 |
|
通联券核销机构id |
|
||
|
consumeOrgName |
String |
否 |
|
通联券核销机构名称 |
|
||
|
consumeshopId |
Integer |
否 |
|
通联券核销网点id |
|
||
|
consumeShopName |
String |
否 |
|
通联券核销网点名称 |
|
||
|
consumeTime |
String |
否 |
|
核销时间 |
|
||
|
consumeUserName |
String |
否 |
|
核销券顾客姓名 |
|
||
|
guideUserId |
String |
否 |
|
核销客户经理登录帐号 |
|
||
|
bankMobile |
String |
否 |
|
通联券持卡人手机号 |
|
||
|
bankCardNum |
String |
否 |
|
持卡人银行卡号 |
|
||
|
remarkActivate |
String |
否 |
|
通联券激活备注 |
|
||
|
remarkActivateUserId |
String |
否 |
|
激活人id |
|
||
|
remarkActivateUserName |
String |
否 |
|
激活人姓名 |
|
||
|
remarkActivateUserMobile |
String |
否 |
|
激活人电话 |
|
||
|
remarkActivateShopId |
Integer |
否 |
|
激活网点id |
|
||
|
remarkActivateShopName |
String |
否 |
|
激活网点名称 |
|
||
|
couponValue |
String |
否 |
|
微信券面额 |
金额：单位：元 |
||
|
bankTransNo |
String |
否 |
|
微信券核销银行流水号 |
|
||
|
wechatCouponId |
String |
否 |
|
微信优惠券id |
|
||
|
wechatCouponType |
Integer |
否 |
|
微信优惠类型 |
1：代金券批次； 2：立减与折扣 |
||
|
mchid |
String |
否 |
|
微信核销商户号 |
|
||
|
useRefundTime |
String |
否 |
|
支付宝券核销/退款时间 |
|
||
|
useRefundAmount |
String |
否 |
|
支付宝券核销/退款金额 |
单位:元 |
||
|
tradeNo |
String |
否 |
|
支付宝交易号 |
|
||
|
orderAmount |
String |
否 |
|
核销订单金额 |
|
||
|
scope |
Integer |
否 |
|
核销场景 |
1：店铺 2：网点 |
||
|
shareSysno |
Integer |
否 |
|
分享人id |
|
||
|
shareName |
String |
否 |
|
分享人姓名 |
|
||
|
bankOutletsShopId |
Integer |
否 |
|
抽奖网点id |
|
||
|
bankOutletsShopName |
String |
否 |
|
抽奖网点名称 |
|
||
请求示例
{
"pageNo": "1",
"pageSize": "10",
"activityId": "730"
"promotionCouponType": "1"
"promotionCouponType": "1"
"consumeStartTime": "2022-05-01 00:00:00"
"consumeEndTime": "2023-05-29 23:59:59"
}
响应示例
{
"activityId":730,
"couponId":"99418302949",
"couponName":"20元代金券",
"couponValue":"20.00",
"createSource":"21",
"createTime":"2023-04-28 15:36:18",
"mobile":"13681694175",
"name":"跑马灯",
"num":2,
"orgId":100152,
"orgName":"通惠商城",
"prizeName":"3",
"promotionId":6289,
"promotionName":"互动42403",
"promotionType":"13",
"openid":"o969_syjWWcAasMcrxctY5z_YVew",
"serviceOrgName":"通联商务服务有限公司",
}
3.4.16 支付宝发放核销明细分页查询
method: allinpay.shopoint.bankService.alipayCouponSendConsumePageQuery
version: 1.0
前置接口：需要先调用3.1.6统一登录注册入口（scope=4登录商户后台）获取到token
业务请求参数
|
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
|
token |
String |
是 |
|
调用3.1.6 统一登录（scope=4）后获得的token。 |
|
|
pageNo |
Integer |
否 |
|
页码 |
不填默认1, 最小为1
|
|
activityId |
String |
否 |
|
批次ID |
|
|
voucherId |
String |
否 |
|
优惠券ID |
|
|
mobile |
String |
否 |
|
领券人手机号 |
|
|
alipayAccount |
String |
否 |
|
领券人支付宝账户 |
|
|
bankOutletsShopId |
Integer |
否 |
|
发券网点id |
|
|
bankOutletsShopCode |
String |
否 |
|
发券网点编码 |
|
|
sendShopName |
String |
否 |
|
发券网点名称 |
|
|
status |
Integer |
否 |
|
券状态 |
1-待核销；2-已核销 |
|
createSource |
Integer |
否 |
|
发券方式 |
43-支付宝满减券； 44-客户经理发支付宝满减券 |
|
promotionOrgId |
Integer |
否 |
|
活动归属机构id |
|
|
sendStartTime |
String |
否 |
|
领券开始时间 |
格式：yyyy-MM-dd HH:mm:ss 1.控制发放/核销查询条件的日期范围在一年内2.当未指定领券时间范围时，默认领券时间范围为:近7天3.未指定领券时间范围，但指定了核销时间范围时，设置领券时间的范围为近一年内。
|
|
sendEndTime |
String |
否 |
|
领券结束时间 |
|
|
consumeStartTime |
String |
否 |
|
核销开始时间 |
|
|
consumeEndTime |
String |
否 |
|
核销结束时间 |
|
|
authorityId |
Integer |
否 |
|
活动归属ID |
|
|
authorityType |
Integer |
否 |
|
活动归属类型 |
0-全部网点 1-指定区县 2-指定网点 |
|
promotionStatus |
Integer |
否 |
|
活动状态 |
0-停用 1-启用 11-未开始 12-进行中 14-已停止 |
业务响应参数
|
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
||
|
code |
Integer |
是 |
|
返回码 |
0：表示成功； 3：表示失败，具体失败原因参见msg字段； 其他：参见4.1 公共返回码 |
||
|
msg |
String |
是 |
|
错误信息 |
|
||
|
data |
total |
Integer |
否 |
|
总数 |
只在第1页中返回交易流水总条数 |
|
|
current |
Integer |
是 |
|
分页页码 |
|
||
|
size |
Integer |
是 |
|
分页大小 |
|
||
|
records |
List |
否 |
|
流水分页 |
|
||
|
|
promotionId |
Integer |
是 |
|
活动Id |
|
|
|
promotionName |
String |
是 |
|
活动名称 |
|
||
|
promotionStatusDesc |
String |
是 |
|
活动状态 |
|
||
|
bankCardNum |
String |
否 |
|
持卡人银行卡号 |
|
||
|
bankCardBelongBank |
String |
否 |
|
持卡人银行卡归属银行 |
|
||
|
createSource |
String |
否 |
|
发放方式 |
|
||
|
activityId |
String |
是 |
|
批次ID |
|
||
|
voucherId |
String |
否 |
|
优惠券ID |
|
||
|
couponType |
String |
是 |
|
优惠券类型 |
|
||
|
promotionType |
String |
是 |
|
活动类型 |
|
||
|
createUserShopName |
String |
否 |
|
活动归属 |
|
||
|
uid |
String |
是 |
|
领取用户UID |
|
||
|
mobile |
String |
否 |
|
领取用户手机号 |
|
||
|
promotionOrgId |
Integer |
否 |
|
活动归属机构id |
|
||
|
alipayAccount |
String |
否 |
|
领取用户支付宝账户 |
|
||
|
outUserId |
String |
否 |
|
外部客户号 |
|
||
|
initAmount |
Bigdecimal |
是 |
|
发放面额 |
|
||
|
stockNum |
Integer |
是 |
|
发放数量 |
1 |
||
|
couponSenderUserId |
String |
否 |
|
发券人ID |
|
||
|
couponSenderUserName |
String |
是 |
|
发券人姓名 |
|
||
|
bankOutletsShopId |
Integer |
否 |
|
发券网点id |
|
||
|
bankOutletsShopCode |
String |
否 |
|
发券网点编码 |
|
||
|
sendOutletsName |
String |
是 |
|
发券网点 |
|
||
|
sendTime |
String |
是 |
|
发放时间 |
|
||
|
sendCouponRemark |
String |
否 |
|
发券备注 |
|
||
|
businessId |
Integer |
否 |
|
任务ID |
|
||
|
businessName |
String |
否 |
|
任务名称 |
|
||
|
businessInfo |
String |
否 |
|
收集业务信息 |
|
||
|
consumeTime |
String |
否 |
|
核销/退款时间 |
|
||
|
consumeAmount |
BigDecimal |
否 |
|
核销/退款金额 |
|
||
|
consumeOrderId |
String |
否 |
|
支付宝交易号 |
|
||
请求示例
{
"pageNo": "1",
"authorityType": "0",
"voucherId": "202305090007300221650IHES5ND"
}
响应示例
{
"code": "0",
"data": {
"activityId": "ACT655CCV01157399",
"consumeAmount": 0.01,
"consumeMchtId": "",
"consumeOrderId": "2023051022001465211433668558",
"consumeTime": "2023-05-10 14:47:42",
"couponSenderUserId": "testhl",
"couponSenderUserName": "导购hl",
"couponType": "满减券",
"createSource": "支付宝满减券",
"createUserShopName": "武侯区",
"initAmount": 0.01,
"mobile": "13882177387",
"promotionId": 6407,
"promotionName": "支付宝手机号套券商城端",
"promotionStatusDesc": "停用",
"promotionType": "支付宝领券",
"sendCouponRemark": "remark",
"sendTime": "2023-05-09 14:27:13",
"stockNum": 1,
"uid": "2088502820165214",
"voucherId": "202305090007300221650IHES5ND"
},
"token": "DlRXdIjEBLRLCJgwTP37sZW6ls--NflxVS2-KUHl"
}
3.4.17 云闪付发放核销流水查询
method: allinpay.shopoint.bankService.unionpayCouponSendConsumePageQuery
version: 1.0
前置接口：需要先调用3.1.6统一登录注册入口（scope=4登录商户后台）获取到token
业务请求参数
|
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
|
||||
|
token |
String |
是 |
|
调用3.1.6 统一登录（scope=4）后获得的token。 |
|
|
||||
|
pageNo |
Integer |
否 |
|
页码 |
不填默认1, 最小为1
|
|
||||
|
extendId |
Integer |
否 |
|
批次ID |
|
|
||||
|
couponId |
String |
否 |
|
优惠券ID |
|
|
||||
|
mobile |
String |
否 |
|
领取用户手机号 |
|
|
||||
|
promotionOrgId |
Integer |
否 |
|
活动归属机构id |
|
|
||||
|
bankOutletsShopId |
Integer |
否 |
|
发券网点id |
|
|
||||
|
bankOutletsShopCode |
String |
否 |
|
发券网点编码 |
|
|
|
|
|
|
|
sendShopName |
String |
否 |
|
发券网点名称 |
|
|
||||
|
status |
Integer |
否 |
|
券状态 |
0-待核销；3-已核销 |
|
||||
|
createSource |
Integer |
否 |
|
发券方式 |
29-微信领券活动 33-积分换微信券 38-客户经理发微信领券活动 |
|
||||
|
sendStartTime |
String |
否 |
|
领券开始时间 |
格式：yyyy-MM-dd HH:mm:ss 1.控制发放/核销查询条件的日期范围在一年内2.当未指定领券时间范围时，默认领券时间范围为:近7天3.未指定领券时间范围，但指定了核销时间范围时，设置领券时间的范围为近一年内。
|
|
||||
|
sendEndTime |
String |
否 |
|
领券结束时间 |
|
|||||
|
consumeStartTime |
String |
否 |
|
核销开始时间 |
|
|||||
|
consumeEndTime |
String |
否 |
|
核销结束时间 |
|
|||||
|
authorityId |
Integer |
否 |
|
活动归属ID |
|
|
||||
|
authorityType |
Integer |
否 |
|
活动归属类型 |
0-全部网点 1-指定区县 2-指定网点 |
|
||||
|
promotionStatus |
Integer |
否 |
|
活动状态 |
0-停用 1-启用 11-未开始 12-进行中 14-已停止 |
|
||||
业务响应参数
|
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
||
|
code |
Integer |
是 |
|
返回码 |
0：表示成功； 3：表示失败，具体失败原因参见msg字段； 其他：参见4.1 公共返回码 |
||
|
msg |
String |
是 |
|
错误信息 |
|
||
|
data |
total |
Integer |
否 |
|
总数 |
只在第1页中返回交易流水总条数 |
|
|
current |
Integer |
是 |
|
分页页码 |
|
||
|
size |
Integer |
是 |
|
分页大小 |
|
||
|
records |
List |
否 |
|
流水分页 |
|
||
|
|
promotionId |
Integer |
是 |
|
活动Id |
|
|
|
promotionName |
String |
是 |
|
活动名称 |
|
||
|
promotionStatusDesc |
String |
是 |
|
活动状态 |
|
||
|
createSource |
String |
否 |
|
发放方式 |
|
||
|
extendId |
String |
是 |
|
批次ID |
|
||
|
transSeqId |
String |
否 |
|
发券流水号 |
|
||
|
couponCd |
String |
否 |
|
发放券码 |
|
||
|
couponType |
String |
是 |
|
优惠券类型 |
|
||
|
bankCardNum |
String |
否 |
|
持卡人银行卡号 |
|
||
|
bankCardBelongBank |
String |
否 |
|
持卡人银行卡归属银行 |
|
||
|
promotionTypeDesc |
String |
是 |
|
活动类型 |
|
||
|
sendNum |
Integer |
是 |
|
发放数量 |
|
||
|
createUserShopName |
String |
否 |
|
活动归属 |
|
||
|
mobile |
String |
否 |
|
领取用户手机号 |
|
||
|
promotionOrgId |
Integer |
否 |
|
活动归属机构id |
|
||
|
outUserId |
String |
否 |
|
外部客户号 |
|
||
|
couponSenderUserId |
String |
否 |
|
发券人ID |
|
||
|
couponSenderUserName |
String |
否 |
|
发券人姓名 |
|
||
|
bankOutletsShopId |
Integer |
否 |
|
发券网点id |
|
||
|
bankOutletsShopCode |
String |
否 |
|
发券网点编码 |
|
||
|
sendOutletsName |
String |
否 |
|
发券网点 |
|
||
|
sendTime |
String |
是 |
|
发放时间 |
|
||
|
sendCouponRemark |
String |
否 |
|
发券备注 |
|
||
|
businessId |
Integer |
否 |
|
任务ID |
|
||
|
businessName |
String |
否 |
|
任务名称 |
|
||
|
businessInfo |
String |
否 |
|
收集业务信息 |
|
||
|
orderAmount |
BigDecimal |
否 |
|
消费订单金额 |
|
||
|
useRefundTime |
String |
否 |
|
券核销/退款时间 |
|
||
|
useRefundAmount |
BigDecimal |
否 |
|
券核销/退款核销金额 |
|
||
|
consumeMchtId |
String |
否 |
|
核券商户号 |
|
||
|
transId |
String |
是 |
|
云闪付交易流水号 |
|
||
请求示例
{
"pageNo": "1",
"mobile": "13681694175"
}
响应示例
{
"code": "0",
"data": {
"couponCd": "97163008106",
"couponId": 6910771,
"couponType": "满减券",
"createSource": "云闪付满减券",
"createUserShopName": "通惠商城",
"extendId": "987612",
"initAmount": 0.02,
"mobile": "13681694175",
"promotionId": 7898,
"promotionName": "张先生的人",
"promotionStatusDesc": "进行中",
"promotionTypeDesc": "云闪付领券",
"sendNum": 1,
"sendTime": "2023-11-22 14:46:23",
"status": "有效",
"transSeqId": "1700635583220"
},
"token": "DlRXdIjEBLRLCJgwTP37sZW6ls--NflxVS2-KUHl"
}
3.4.18 微信券发放核销明细准确查询
method: allinpay.shopoint.bankService.wechatCouponSendConsumeAccurateQuery
version: 1.0
前置接口：需要先调用3.1.6统一登录注册入口（scope=4登录商户后台）获取到token
业务请求参数
|
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
|
token |
String |
是 |
|
调用3.1.6 统一登录（scope=4）后获得的token。 |
|
|
pageNo |
Integer |
否 |
|
页码 |
不填默认1, 最小为1
|
|
sendStartTime |
String |
否 |
|
领券开始时间 |
格式：yyyy-MM-dd HH:mm:ss 1.控制发放/核销查询条件的日期范围在一年内2.当未指定领券时间范围时，默认领券时间范围为:近7天3.未指定领券时间范围，但指定了核销时间范围时，设置领券时间的范围为近一年内。
|
|
sendEndTime |
String |
否 |
|
领券结束时间 |
|
|
consumeStartTime |
String |
否 |
|
核销开始时间 |
|
|
consumeEndTime |
String |
否 |
|
核销结束时间 |
|
|
promotionOrgId |
Integer |
否 |
|
活动归属机构id |
|
|
stockId |
String |
否 |
|
批次ID |
|
|
couponId |
String |
否 |
|
优惠券ID |
|
|
outUserId |
String |
否 |
|
外部客户号 |
|
|
mobile |
String |
否 |
|
领券人手机号 |
|
|
bankOutletsShopId |
Integer |
否 |
|
发券网点id |
|
|
bankOutletsShopCode |
String |
否 |
|
发券网点编码 |
|
|
sendShopName |
String |
否 |
|
发券网点名称 |
|
|
status |
Integer |
否 |
|
券状态 |
1, 待核销 2，已核销 |
|
privilegeOrgId |
Integer |
否 |
|
归属机构 |
|
|
privilegeGroupId |
Integer |
否 |
|
归属区县 |
|
|
privilegeShopId |
Integer |
否 |
|
归属网点 |
|
业务响应参数
|
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
||
|
code |
Integer |
是 |
|
返回码 |
0：表示成功； 3：表示失败，具体失败原因参见msg字段； 其他：参见4.1 公共返回码 |
||
|
msg |
String |
是 |
|
错误信息 |
|
||
|
data |
total |
Integer |
否 |
|
总数 |
只在第1页中返回交易流水总条数 |
|
|
current |
Integer |
是 |
|
分页页码 |
|
||
|
size |
Integer |
是 |
|
分页大小 |
|
||
|
records |
List |
否 |
|
流水分页 |
|
||
|
|
promotionId |
Integer |
否 |
|
活动Id |
|
|
|
promotionName |
String |
否 |
|
活动名称 |
|
||
|
promotionStatusDesc |
String |
否 |
|
活动状态 |
|
||
|
promotionOrgId |
Integer |
否 |
|
活动归属机构id |
|
||
|
stockId |
String |
是 |
|
批次ID |
|
||
|
couponId |
String |
是 |
|
优惠券ID |
|
||
|
couponType |
String |
是 |
|
优惠券类型 |
|
||
|
couponName |
String |
是 |
|
优惠券名称 |
|
||
|
bankCardNum |
String |
否 |
|
持卡人银行卡号 |
|
||
|
bankCardBelongBank |
String |
否 |
|
持卡人银行卡归属银行 |
|
||
|
outUserId |
String |
是 |
|
外部客户号 |
|
||
|
openId |
String |
否 |
|
领取用户openid |
|
||
|
mobile |
String |
否 |
|
领取用户手机号 |
|
||
|
createUserShopName |
String |
否 |
|
活动归属 |
|
||
|
mobileAccount |
String |
否 |
|
领取账户 |
|
||
|
initAmount |
BigDecimal |
是 |
|
面额 |
|
||
|
stockNum |
Integer |
否 |
|
发行数量 |
|
||
|
couponSenderUserId |
String |
否 |
|
发券人ID |
|
||
|
couponSenderUserName |
String |
否 |
|
发券人姓名 |
|
||
|
bankOutletsShopId |
Integer |
否 |
|
发券网点id |
|
||
|
bankOutletsShopCode |
String |
否 |
|
发券网点编码 |
|
||
|
sendOutletsName |
String |
否 |
|
发券网点名称 |
|
||
|
sendTime |
DateTIme |
是 |
|
发放时间 |
|
||
|
sendCouponRemark |
String |
否 |
|
发券备注 |
|
||
|
businessId |
Integer |
否 |
|
任务ID |
|
||
|
businessName |
String |
否 |
|
任务名称 |
|
||
|
businessInfo |
String |
否 |
|
收集业务信息 |
|
||
|
consumeAmount |
BigDecimal |
是 |
|
核销金额 |
|
||
|
consumeTime |
DateTime |
是 |
|
核销时间 |
|
||
|
consumeMchtId |
String |
否 |
|
核券商户号 |
|
||
|
consumeOrderId |
String |
否 |
|
核销订单号 |
|
||
|
status |
String |
是 |
|
券状态 |
|
||
请求示例
{
"pageNo": "1",
"pageSize": "10",
"consumeTimeStart": "2022-08-26 14:00:00",
"consumeTimeEnd": "2022-08-26 17:00:00"
}
响应示例
{
"total": 2,
"pageNo": 1,
"pageSize": 10,
"resultList": [
{
"changeSource": 311,
"couponName": "lq121401",
"createTime": "2022-08-26 14:41:02",
"couponType": 0,
"newBalance": 400,
"couponNo": "83000100000000055331",
"changeId": 272525,
"shopId": 147,
"templateId": 6244620,
"balanceChanged": 400,
"createUserLoginName": "hl导购"
},
{
"changeSource": 31,
"couponName": "lq121401",
"createUserId": 358,
"createTime": "2022-08-26 14:39:16",
"couponType": 0,
"newBalance": 0,
"couponNo": "83000100000000055331",
"changeId": 272522,
"shopId": 147,
"templateId": 6244620,
"balanceChanged": -400,
"createUserLoginName": "hl导购"
}
]
}
3.4.19 通惠合作店铺查询接口
method: allinpay.shopoint.bankService.bankCollaboratorShopPageQuery
version: 1.0
前置接口：需要先调用3.1.6统一登录注册入口（scope=4登录商户后台）获取到token
业务请求参数
|
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
|
token |
String |
是 |
|
调用3.1.6 统一登录（scope=4）后获得的token。 |
|
|
pageNo |
Integer |
否 |
|
页码 |
不填默认1, 最小为1
|
| orgId
|
Integer |
否 |
|
合作商户机构ID |
|
| shopId
|
Integer |
否 |
|
合作商户店铺ID |
|
业务响应参数
|
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
||
|
code |
Integer |
是 |
|
返回码 |
0：表示成功； 3：表示失败，具体失败原因参见msg字段； 其他：参见4.1 公共返回码 |
||
|
msg |
String |
是 |
|
错误信息 |
|
||
|
data |
total |
Integer |
否 |
|
总数 |
只在第1页中返回交易流水总条数 |
|
|
current |
Integer |
是 |
|
分页页码 |
|
||
|
size |
Integer |
是 |
|
分页大小 |
|
||
|
records |
List |
否 |
|
流水分页 |
|
||
|
|
orgId |
Integer |
是 |
|
机构id |
|
|
|
orgName |
String |
是 |
|
商户名称 |
|
||
|
optionValue |
String |
是 |
|
商户行业 |
|
||
|
createTime |
DateTime |
否 |
|
创建时间 |
|
||
|
shopId |
Integer |
是 |
|
店铺id |
|
||
|
shopName |
String |
是 |
|
店铺名称 |
|
||
|
address |
String |
否 |
|
店铺地址 |
|
||
|
tradeMode |
String |
是 |
|
店铺经营类型 |
|
||
|
statusDescription |
String |
是 |
|
店铺状态 |
|
||
|
mchtCd |
String |
否 |
|
店铺收银宝商户号 |
|
||
|
mchtOutlets |
String |
否 |
|
店铺归属网点id |
店铺归属多个网点，逗号分割 |
||
|
mchtOutletsName |
String |
否 |
|
店铺归属网点名称 |
店铺归属多个网点，逗号分割 |
||
请求示例
{3
"pageNo": "1"，
"shopId": "266885"
}
响应示例
{
"total": 1,
"pageNo": 1,
"pageSize": 10,
"data":
{
"orgId": 100152,
"orgName": "通惠商城",
"optionValue": "化妆品",
"createTime": "2023-12-06 16:03:20",
"shopId": 266885,
"shopName": "120602",
"tradeMode": "未知",
"statusDescription": "启用"
}
}
3.4.20 云闪付/支付宝券撤销通知
通过云闪付/支付宝券撤销通知
method: allinpay.third.cancel.couponno
version: 1.0
业务请求参数
|
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
|
promotionId |
Integer |
是 |
11 |
活动ID |
|
|
couponId |
String |
是 |
100 |
代金券id |
|
|
idType |
String |
否 |
100 |
发券类型 |
1联合授权openid、2银行Openid、3手机号、4支付宝账号 |
|
idValue |
String |
否 |
100 |
发券ID |
|
|
consumeTime |
String |
否 |
100 |
撤销时间 |
|
|
consumeMchid |
String |
否 |
100 |
撤销商户号 |
|
|
transactionId |
String |
否 |
100 |
撤销订单号 |
|
|
extendId |
String |
否 |
100 |
支付宝/云闪付活动id |
|
业务响应参数
|
字段名 |
参数类型 |
必填 |
说明 |
取值 |
|
|
code |
Integer |
是 |
返回码 |
10000：表示成功； 其他：表示失败。 |
|
|
msg |
String |
是 |
错误信息 |
|
|
|
data |
|
|
|
|
|
请求示例
{ “promotionId”:123,” couponId”:”2323432432423”}
响应示例
{
"code": 0,
"data":””,
"token": "DlRXdIjEBLRLCJgwTP37sZW6ls--NflxVS2-KUHl"
}
3.4.21 通惠网点发券配置及统计
method: allinpay.shopoint.bankService.promotioBankOutletsconfigQuery
version: 1.0
业务请求参数
|
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
|
promotionId |
Integer |
是 |
|
活动id |
|
|
sendPageNo |
Integer |
否 |
|
发券效果页码 |
不填默认1, 最小为1，最大100
|
|
sendPageSize |
Integer |
否 |
|
发券效果每页数量 |
不填默认20，最小为1，最大200
|
|
configPageNo |
Integer |
否 |
|
网点配置查询页码
|
不填默认1, 最小为1，最大100
|
| configPageSize
|
Integer |
否 |
|
网点配置查询每页数量
|
不填默认20，最小为1，最大200
|
业务响应参数
|
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
||
|
code |
Integer |
是 |
|
返回码 |
0：表示成功； 3：表示失败，具体失败原因参见msg字段； 其他：参见4.1 公共返回码 |
||
|
msg |
String |
是 |
|
错误信息 |
|
||
|
|
config |
|
否 |
|
网点配置信息 |
|
|
|
stockType
|
Integer |
|
|
库存分配方式 |
1-共享库存,2-独立库存 |
||
|
stockNum |
Integer
|
|
|
活动库存配置数量 |
|
||
|
list |
List |
|
|
网点配置列表 |
|
||
|
|
shopId |
Integer |
否 |
|
网点ID |
|
|
|
shopName |
String |
否 |
|
网点名称 |
|
||
|
shopGroupId |
Integer |
否 |
|
区县ID |
|
||
|
shopGroupName |
String |
否 |
|
区县名称 |
|
||
|
stockNum |
Integer |
否 |
|
独立库存配置数量 |
|
||
|
|
stat
|
|
否 |
|
网点发券信息 |
|
|
|
|
list |
List |
|
|
网点发券效果列表 |
|
|
|
|
|
shopId |
Integer |
否 |
|
网点ID |
|
|
|
shopName |
String |
否 |
|
网点名称 |
|
|
|
|
createNum |
Integer |
否 |
|
网点发券数量 |
|
|
请求示例
{
"promotionId": "8602"
}
响应示例
{
"code": "0",
"data": {
"stat": {
"list": [
{
"createNum": 0,
"shopName": "test网点10",
"shopId": 266577
},
{
"createNum": 0,
"shopName": "test网点9",
"shopId": 264562
}
]
},
"config": {
"stockType": 2,
"stockNum": 1000,
"list": [
{
"shopGroupId": 47,
"shopGroupName": "成华区",
"stockNum": 400
},
{
"shopGroupId": 44,
"shopGroupName": "武侯区",
"stockNum": 100
}
]
}
}
}
3.4.22 基础营销券发放核销明细分页查询
method: allinpay.shopoint.bankService.dsktCouponSendConsumePageQuery
version: 1.0
前置接口：需要先调用3.1.6统一登录注册入口（scope=4登录商户后台）获取到token
业务请求参数
|
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
|
||||
|
token |
String |
是 |
|
调用3.1.6 统一登录（scope=4）后获得的token。 |
|
|
||||
|
pageNo |
Integer |
否 |
|
页码 |
不填默认1, 最小为1
|
|
||||
|
extendId |
Integer |
否 |
|
批次ID |
|
|
||||
|
couponId |
String |
否 |
|
优惠券ID |
|
|
||||
|
promotionOrgId |
Integer |
否 |
|
活动归属机构id |
|
|
||||
|
bankOutletsShopId |
Integer |
否 |
|
发券网点id |
|
|
||||
|
bankOutletsShopCode |
String |
否 |
|
发券网点编码 |
|
|
|
|
|
|
|
sendShopName |
String |
否 |
|
发券网点名称 |
|
|
||||
|
status |
Integer |
否 |
|
券状态 |
1-待使用；2-已使用 |
|
||||
|
createSource |
Integer |
否 |
|
发券方式 |
48-客户经理发基础营销券活动 |
|
||||
|
sendStartTime |
String |
否 |
|
领券开始时间 |
格式：yyyy-MM-dd HH:mm:ss 1.控制发放/核销查询条件的日期范围在一年内2.当未指定领券时间范围时，默认领券时间范围为:近7天3.未指定领券时间范围，但指定了核销时间范围时，设置领券时间的范围为近一年内。
|
|
||||
|
sendEndTime |
String |
否 |
|
领券结束时间 |
|
|||||
|
consumeStartTime |
String |
否 |
|
核销开始时间 |
|
|||||
|
consumeEndTime |
String |
否 |
|
核销结束时间 |
|
|||||
|
authorityId |
Integer |
否 |
|
活动归属ID |
|
|
||||
|
authorityType |
Integer |
否 |
|
活动归属类型 |
0-全部网点 （默认） 1-指定区县 2-指定网点 |
|
||||
|
actState |
String |
否 |
|
活动状态 |
WAITCFM-待审核 RUNNING-投放中 PAUSE-暂停 TERMINAL-已停止 |
|
||||
业务响应参数
|
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
||
|
code |
Integer |
是 |
|
返回码 |
0：表示成功； 3：表示失败，具体失败原因参见msg字段； 其他：参见4.1 公共返回码 |
||
|
msg |
String |
是 |
|
错误信息 |
|
||
|
data |
total |
Integer |
否 |
|
总数 |
只在第1页中返回交易流水总条数 |
|
|
current |
Integer |
是 |
|
分页页码 |
|
||
|
size |
Integer |
是 |
|
分页大小 |
|
||
|
records |
List |
否 |
|
流水分页 |
|
||
|
|
promotionId |
Integer |
是 |
|
活动Id |
|
|
|
actName |
String |
是 |
|
活动名称 |
|
||
|
actState |
String |
是 |
|
活动状态 |
|
||
|
createSourceDesc |
String |
是 |
|
发放方式 |
|
||
|
actId |
String |
是 |
|
批次ID |
|
||
|
tplId |
String |
是 |
|
券模板id |
|
||
|
cpId |
String |
是 |
|
优惠券id |
|
||
|
cpType |
String |
否 |
|
优惠券类型 |
|
||
|
cpName |
String |
是 |
|
优惠券名称 |
|
||
|
bankCardNum |
String |
否 |
|
持卡人银行卡号 |
|
||
|
bankCardBelongBank |
String |
否 |
|
持卡人银行卡归属银行 |
|
||
|
userId |
String |
否 |
|
领取用户UID |
|
||
|
outUserId |
String |
否 |
|
外部客户号 |
|
||
|
createUserShopName |
String |
否 |
|
活动归属 |
|
||
|
couponValue |
String |
否 |
|
面额 |
|
||
|
cpAmt |
Integer |
否 |
|
发放数量 |
|
||
|
couponSenderUserId |
String |
否 |
|
发券人ID |
|
||
|
couponSenderUserName |
String |
否 |
|
发券人姓名 |
|
||
|
bankOutletsShopId |
Integer |
否 |
|
发券网点id |
|
||
|
bankOutletsShopCode |
String |
否 |
|
发券网点编码 |
|
||
|
sendOutletsName |
String |
否 |
|
发券网点名称 |
|
||
|
sendTime |
String |
否 |
|
发放时间 |
|
||
|
sendCouponRemark |
String |
否 |
|
发券备注 |
|
||
|
businessId |
Integer |
否 |
|
任务ID |
|
||
|
businessName |
String |
否 |
|
任务名称 |
|
||
|
businessInfo |
String |
否 |
|
收集业务信息 |
|
||
|
consumeBalanceChanged |
String |
否 |
|
核销金额 |
|
||
|
consumeCouponTime |
String |
否 |
|
券核销/退款时间 |
|
||
|
cusId |
String |
否 |
|
核券商户号 |
|
||
|
branchNo |
String |
否 |
|
核销门店号 |
|
||
|
trxId |
String |
否 |
|
核销订单号 |
|
||
|
cpStatus |
String |
是 |
|
券状态 |
|
||
|
remarkActivateShopId |
Integer |
否 |
|
激活网点ID |
|
||
|
remarkActivateShopName |
String |
否 |
|
激活网点名称 |
|
||
|
activeGuideUserId |
String |
否 |
|
激活人账号 |
|
||
|
remarkActivateUserName
|
String |
否 |
|
激活人名称 |
|
||
|
remarkActivateUserMobile
|
String |
否 |
|
激活人电话
|
|
||
|
activeRemark
|
String |
否 |
|
激活备注
|
|
||
请求示例
{
"token": "3ce31784-403c-4011-bf83-eb04e7c308e8"
}
响应示例
{
"code": "0",
"data": {
"current": 1,
"total": 1,
"pages": "1",
"size": "500",
"records": [
{
"tid": 361,
"couponId": 7057056,
"customerId": 261126,
"orgId": 100152,
"tplId": "00009Ay",
"actId": "00009A",
"appId": "10000008",
"buttId": "1000",
"cpAmt": 1,
"cpName": "lq测试2",
"cpNature": "SYS",
"cpType": "代金券",
"tranNo": "100000084556083275659148",
"cpId": "96366472327",
"userId": "U_09Br23UNsYa",
"createSource": 49,
"sourceId": 9004,
"validBegin": "2024-07-16T00:00:00",
"validEnd": "2024-08-31T23:59:59",
"cpStatus": "待使用",
"promotionId": 9004,
"createTime": "2024-08-12T13:59:33",
"createUserId": 0,
"actName": "n选n111",
"couponValue": "0.01",
"sendNum": 1,
"outUserId": "waibubianhao",
"sendTime": "2024-08-12 13:59:33",
"createUserShopName": "通惠商城",
"actState": "投放中",
"createSourceDesc": "基础营销领券活动",
"promotionOrgId": 100152
}
]
}
}
3.4.23 券兑换
传兑换码及兑换人信息进行券兑换
method: allinpay.shopoint.bankService.cdkeyExchange
version: 1.0
业务请求参数
|
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
|
cdkey |
String |
是 |
100 |
兑换码 |
|
|
orderId |
String |
是 |
64 |
外部发券订单号 |
|
|
idType |
Integer |
是 |
4 |
兑换人信息类型 |
1指定微信openid、3手机号 |
|
idValue |
String |
是 |
50 |
兑换人信息值 |
|
|
remark |
String |
否 |
50 |
兑换备注 |
|
业务响应参数
|
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
||
|
code |
Integer |
是 |
|
返回码 |
0：表示成功； 3：表示失败，具体失败原因参见msg字段； 其他：参见4.1 公共返回码 |
||
|
msg |
String |
是 |
|
错误信息 |
|
||
|
data |
usedTime |
String |
是 |
|
兑换时间 |
yyyy-MM-dd HH:mm:ss |
|
|
used |
Boolean |
是 |
|
是否兑换 |
|
||
|
remark |
String |
是 |
50 |
兑换备注 |
|
||
|
couponList |
|
List |
是 |
|
券信息列表 |
|
|
|
initAmount |
Integer |
是 |
|
券面额 |
单位为分 |
||
|
couponName |
String |
是 |
|
券名称 |
|
||
|
couponNo |
String |
是 |
|
券号 |
|
||
请求示例
{}
响应示例
{}
3.4.24 券兑换码查询
传兑换码查询兑换信息
method: allinpay.shopoint.bankService.cdkeyQuery
version: 1.0
业务请求参数
|
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
|
cdkey |
String |
是 |
100 |
兑换码 |
|
|
orderId |
String |
是 |
64 |
外部查询订单号 |
|
业务响应参数
|
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
||
|
code |
Integer |
是 |
|
返回码 |
0：表示成功； 3：表示失败，具体失败原因参见msg字段； 其他：参见4.1 公共返回码 |
||
|
msg |
String |
是 |
|
错误信息 |
|
||
|
data |
usedTime |
String |
否 |
|
兑换时间 |
yyyy-MM-dd HH:mm:ss |
|
|
used |
Boolean |
是 |
|
是否兑换 |
|
||
|
remark |
String |
否 |
50 |
兑换备注 |
|
||
|
couponList |
|
List |
否 |
|
券信息列表 |
|
|
|
initAmount |
Integer |
是 |
|
券面额 |
单位为分 |
||
|
couponName |
String |
是 |
|
券名称 |
|
||
|
couponNo |
String |
是 |
|
券号 |
|
||
请求示例
{}
响应示例
{}
3.4.25 报名活动效果查询
报名活动效果查询
method: allinpay.shopoint.promotionService.signUpList
version: 1.0
业务请求参数
|
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
|
token |
String |
是 |
|
调用3.1.6 统一登录（scope=4）后获得的token。 |
|
|
pageNo |
Integer |
否 |
|
页码 |
不填默认1, 最小为1
|
|
promotionType |
Integer |
是 |
100 |
类型,固定传101 |
101-报名活动 |
|
promotionId |
Integer |
是 |
64 |
报名活动id |
|
业务响应参数
|
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
|
|
code |
Integer |
是 |
|
返回码 |
0：表示成功； 3：表示失败，具体失败原因参见msg字段； 其他：参见4.1 公共返回码 |
|
|
msg |
String |
是 |
|
错误信息 |
|
|
|
data |
publicOpenId |
String |
否 |
|
机构公众号openid |
|
|
dealFlag |
Boolean |
是 |
|
是否处理 |
|
|
|
dealResult |
String |
否 |
50 |
处理结果 |
|
|
|
dealTime |
DateTime |
否 |
|
处理时间 |
yyyy-MM-dd HH:mm:ss |
|
|
customerMobile |
String |
否 |
|
报名人手机 |
|
|
|
auditStatus |
Integer |
是 |
|
审核状态 |
0-无需审核,1-待审核 |
|
|
promotionName |
String |
是 |
|
活动名称 |
|
|
|
promotionId |
Integer |
是 |
|
活动id |
|
|
|
signUpId |
Integer |
是 |
|
报名记录id |
|
|
请求示例
{}
响应示例
{}
3.4.26 报名活动详情查询
传报名记录id查询报名填写详情
method: allinpay.shopoint.promotionService.signUpDetail
version: 1.0
业务请求参数
|
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
|
token |
String |
是 |
|
调用3.1.6 统一登录（scope=4）后获得的token。 |
|
|
signUpId |
Integer |
是 |
64 |
报名记录id |
|
业务响应参数
|
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
||
|
code |
Integer |
是 |
|
返回码 |
0：表示成功； 3：表示失败，具体失败原因参见msg字段； 其他：参见4.1 公共返回码 |
||
|
msg |
String |
是 |
|
错误信息 |
|
||
|
data |
signUpId |
Integer |
是 |
|
报名记录id |
|
|
|
promotionId |
Integer |
是 |
|
活动id |
|
||
|
promotionName |
String |
否 |
|
活动名称 |
|
||
|
promotionType |
Integer |
是 |
|
活动类型 |
101-报名活动 |
||
|
objectInfo |
String |
否 |
|
活动对象说明 |
|
||
|
signUpTime |
DateTime |
否 |
|
报名时间 |
yyyy-MM-dd HH:mm:ss |
||
|
beginTime |
DateTime |
是 |
|
活动开始时间 |
yyyy-MM-dd HH:mm:ss |
||
|
endTime |
DateTime |
是 |
|
活动结束时间 |
yyyy-MM-dd HH:mm:ss |
||
|
mobile |
String |
否 |
|
联系人手机号 |
|
||
|
auditStatus |
Integer |
是 |
|
审核状态 |
0-无需审核,1-待审核 |
||
|
customerMobile |
String |
否 |
|
报名人手机 |
|
||
|
dealFlagDesc |
String |
是 |
|
是否处理 |
|
||
|
status |
Integer |
是 |
|
活动状态 |
0-已停止,1-已启动 |
||
|
formColumnInfoDTOList |
|
List |
是 |
|
报名人提交的信息字段 |
|
|
|
columnName |
String |
是 |
|
字段名称 |
|
||
|
info |
String |
是 |
|
字段内容 |
|
||
请求示例
{}
响应示例
{}
3.4.27 微信活动详情查询
通过此接口可实时查询微信批次详情
method: allinpay.shopoint.bankService.wechatStock.query
version: 1.0
业务请求参数
|
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
|
stockId |
String |
是 |
20 |
微信批次id |
|
业务响应参数
|
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
|
code |
Integer |
是 |
|
返回码 |
0：表示成功； 3：表示失败，具体失败原因参见msg字段； 其他：参见4.1 公共返回码 |
|
msg |
String |
是 |
|
错误信息 |
|
|
data |
String |
是 |
|
微信报文 |
|
请求示例
响应示例