代金券核销通知
1、修订记录
修订记录 |
日期 |
说明 |
1.0 |
2024.05.27 |
初版 |
2、业务说明
2.1、接口说明
当微信代金券核销后,微信会通知银盛,银盛统一转发相应的业务方(透传)。
注意:
1、接入方接受异步通知结果后,返回success表示该次异步通知成功,银盛将会按成功处理该次异步通知。
2、因接口为参数透传,接收方需要做到密等性
3、httpStatus 2**,视为成功。
2.2、接入方接受异步通知接口的要求:
1、接受方式:POST
2、接受主体类型:application/json
3、需要对通知的数据进行验签,验签使用公钥验签,详见demo
4、必须要有一个返回值 该值为String类型。
5、接入方必须能够正确处理重复的通知,以避免函数重入造成的数据混乱。
3、异步通知报文结构
3.1、公共请求参数
参数 |
类型(长度) |
必填 |
参数说明 |
timeStamp |
String |
Y |
发送请求的时间,格式"yyyy-MM-dd HH:mm:ss" |
src |
String |
Y |
异步通知来源,固定"couponCenter" |
reqId |
String |
Y |
请求流水号 |
charset |
String(10) |
Y |
编码格式 固定为UTF-8 |
sign |
String |
Y |
签名,需要银盛公钥验签,详见demo |
bizContent |
String |
Y |
业务响应数据 json字符串 |
3.2、业务请求参数
(bizContent加密前的json数据明文字符串)
参数 |
类型(长度) |
必填 |
参数说明 |
noticePlatform |
String |
Y |
通知归属平台 WX:微信;ALI:支付宝; |
noticeMessage |
Object |
Y |
通知内容 |
noticeCount |
int |
Y |
当前是第几次通知 |
couponId |
String(10) |
Y |
通知内容归属代金券ID |
微信平台券核销通知:noticeMessage对象描述
参数 |
类型(长度) |
必填 |
参数说明 |
availableBeginTime |
String |
N |
可用开始时间, |
availableEndTime |
String |
N |
可用结束时间, |
consumeInformation |
Object |
N |
已实扣代金券信息。 |
couponId |
String |
N |
代金券id |
couponName |
String |
N |
代金券名称 |
couponType |
String |
N |
NORMAL:满减券CUT_TO:减至券 |
createTime |
String |
N |
领券时间 |
description |
String |
N |
代金券描述说明字段。 |
noCash |
boolean |
N |
true:是,false 否 |
normalCouponInformation |
Object |
N |
普通满减券面额、门槛信息。 |
singleitem |
boolean |
N |
true:是,false 否 |
status |
String |
N |
代金券状态:SENDED:可用USED:已实扣 EXPIRED:已过期 |
stockCreatorMchid |
String(2) |
N |
批次创建方商户号。 |
stockId |
string |
N |
微信为每个代金券批次分配的唯一ID |
参数 |
类型(长度) |
必填 |
参数说明 |
consumeMchid |
String(25) |
N |
核销代金券的商户号。 |
consumeTime |
String(200) |
N |
代金券核销时间 |
transactionId |
String |
N |
微信支付系统生成的订单号。 |
参数 |
类型(长度) |
必填 |
参数说明 |
couponAmount |
String(25) |
N |
面额,单位:分。 |
transaction_minimum |
String(200) |
N |
使用券金额门槛,单位:分。 |
支付宝平台券核销通知:noticeMessage对象描述
参数 |
类型(长度) |
必填 |
参数说明 |
id |
int |
N |
随机标识 |
requestId |
String |
N |
请求流水号, |
sendCouponSource |
String |
N |
请求发起方标识 |
userAccountId |
String |
N |
用户账号id |
userAccount |
String |
N |
手机号,一般为空 |
activityOrderId |
String |
N |
活动流水唯一记录 |
outBizNo |
String |
N |
外部流水号 |
activityId |
String |
N |
活动id |
activityName |
boolean |
N |
活动名 |
sendStatus |
String |
N |
发放流水状态 |
discountType |
boolean |
N |
立减类型 reduce:满立减(满5元减3元) random:随机立减(满10元随机立减1元到3元) |
discountThresholdAmt |
String |
N |
优惠门槛金额 ,以分为单位 |
discountValue |
String(2) |
N |
优惠金额 以分为单位 |
sendAmount |
string |
N |
发送金额 以分为单位 |
voucherId |
string |
N |
银行券 |
accountNo |
string |
N |
支付宝账号 |
sendVoucherFlag |
string |
N |
领券用户标识 |
getSendVoucherFlagType |
string |
N |
领券人标识类型,openid,phoneid,logonid |
4、接入方返回值定义
接入方返回参数为String,不返回和非success都为失败,如果接入方处理失败,可以返回处理失败原因,以供查找问题
接口http状态为2**,同样视为成功